neureka.devices

Class AbstractDeviceData<T>

java.lang.Object

neureka.devices.AbstractDeviceData<T>

All Implemented Interfaces:

Data<T>, DeviceData<T>

public abstract class AbstractDeviceData<T>
extends java.lang.Object
implements DeviceData<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Object	_dataRef
protected DataType<T>	_dataType
protected AbstractBaseDevice<?>	_owner
protected ReferenceCounter	_refCounter

Constructor Summary

Constructors

Constructor and Description
AbstractDeviceData(AbstractBaseDevice<?> owner, java.lang.Object ref, DataType<T> dataType, java.lang.Runnable cleanup)

Method Summary

Modifier and Type	Method and Description
DataType<T>	dataType()
void	decrementUsageCount()
java.lang.Object	getOrNull() This returns the underlying raw data object of a nd-array or tensor of a backend specific type (e.g.
void	incrementUsageCount()
Device<T>	owner()
int	usages() This method returns the number of times this data object is currently in use by a nd-array, meaning that the number of usages is also the number of nd-arrays which are currently referencing this data object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface neureka.Data

as, get, none, of, of, of, of, of, of, of, of, of, of

Field Detail

_owner

protected final AbstractBaseDevice<?> _owner

_dataRef

protected final java.lang.Object _dataRef

_dataType

protected final DataType<T> _dataType

_refCounter

protected final ReferenceCounter _refCounter

Constructor Detail

AbstractDeviceData

public AbstractDeviceData(AbstractBaseDevice<?> owner,
                          java.lang.Object ref,
                          DataType<T> dataType,
                          java.lang.Runnable cleanup)

Method Detail

owner

public final Device<T> owner()

Specified by:

owner in interface Data<T>

Returns:

The owner of this data array wrapper (the device which allocated the memory).

getOrNull

public final java.lang.Object getOrNull()

Description copied from interface: Data

This returns the underlying raw data object of a nd-array or tensor of a backend specific type (e.g. OpenCL memory object or JVM array). Contrary to the Nda.getItems() ()} method, this will return an unbiased view on the raw data of this tensor. Be careful using this, as it exposes mutable state!

Specified by:

getOrNull in interface Data<T>

Returns:

The raw data object underlying a nd-array/tensor, or null if the data is not present.

dataType

public final DataType<T> dataType()

Specified by:

dataType in interface Data<T>

Returns:

The data type of the raw data array.

incrementUsageCount

public final void incrementUsageCount()

Specified by:

incrementUsageCount in interface DeviceData<T>

decrementUsageCount

public final void decrementUsageCount()

Specified by:

decrementUsageCount in interface DeviceData<T>

usages

public final int usages()

Description copied from interface: Data

This method returns the number of times this data object is currently in use by a nd-array, meaning that the number of usages is also the number of nd-arrays which are currently referencing this data object.
The reason why this can be greater than one is because of the existence of sliced, transposed and reshaped nd-arrays which all share the same data object as their parent nd-array.

Specified by:

usages in interface Data<T>

Returns:

The number of times this data object is currently in use by a nd-array.