Class ArrayTensorData

Internal Tensor data backed by managed array

Inheritance

Object

UniqueResourceId

ArrayTensorData

Inherited Members

UniqueResourceId.uniqueId

UniqueResourceId.GetUniqueId()

Object.Equals(Object)

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Namespace: Unity.Barracuda

Syntax

public class ArrayTensorData : UniqueResourceId, ITensorData, IDisposable, ITensorDataStatistics, IUniqueResource

Constructors

ArrayTensorData(Int32, DataType)

Create ArrayTensorData and allocate storage for count elements

Declaration

public ArrayTensorData(int count, DataType dataType = DataType.Float)

Parameters

Type	Name	Description
Int32	count	number of elements to pre-allocate
DataType	dataType

ArrayTensorData(TensorShape, DataType)

Create ArrayTensorData and allocate storage for Tensor described by shape

Declaration

public ArrayTensorData(TensorShape shape, DataType dataType = DataType.Float)

Parameters

Type	Name	Description
TensorShape	shape	shape
DataType	dataType

Properties

array

Data storage array

Declaration

public BarracudaArray array { get; }

Property Value

Type	Description
BarracudaArray

dataType

Returns the type of the elements this tensorData can contain.

Declaration

public virtual DataType dataType { get; }

Property Value

Type	Description
DataType

Implements

ITensorDataStatistics.dataType

inUse

Declaration

public virtual bool inUse { get; }

Property Value

Type	Description
Boolean

isGPUMem

Declaration

public virtual bool isGPUMem { get; }

Property Value

Type	Description
Boolean

maxCapacity

Returns the maximum number of element this tensorData can contain.

Declaration

public virtual int maxCapacity { get; }

Property Value

Type	Description
Int32

Implements

ITensorDataStatistics.maxCapacity

Methods

Dispose()

Dispose storage

Declaration

public virtual void Dispose()

Implements

IDisposable.Dispose()

Download(TensorShape)

Returns an array filled with the values of a tensor. Depending on the implementation and underlying device this array might be a copy or direct reference to the tensor values. This is a blocking call, unless data from device was requested via ScheduleAsyncDownload beforehand and has already arrived.

Declaration

public virtual float[] Download(TensorShape shape)

Parameters

Type	Name	Description
TensorShape	shape	the TensorShape (and thus length) of the data to copy

Returns

Type	Description
Single[]	Tensor data as float arrary

Implements

ITensorData.Download(TensorShape)

Finalize()

Finalizer

Declaration

protected void Finalize()

Reserve(Int32)

Reserve uninitialized memory.

Declaration

public virtual void Reserve(int count)

Parameters

Type	Name	Description
Int32	count	element count to reserve

Implements

ITensorData.Reserve(Int32)

ScheduleAsyncDownload(Int32)

Schedule an asynchronous download from device memory. count is the number of element to readback.

Declaration

public virtual bool ScheduleAsyncDownload(int count)

Parameters

Type	Name	Description
Int32	count	count of elements to download

Returns

Type	Description
Boolean	false until data from device arrives to CPU and is ready for access

Implements

ITensorData.ScheduleAsyncDownload(Int32)

SharedAccess(out Int32)

Returns an array filled with the values of multiple tensors that share the same tensorData on device. Depending on the implementation and underlying device this array might be a copy or direct reference to tensor values, no conversion from on device memory layout will occur. This is a blocking call, unless data from device was requested via ScheduleAsyncDownload beforehand and has already arrived.

Declaration

public virtual BarracudaArray SharedAccess(out int offset)

Parameters

Type	Name	Description
Int32	offset	This function outputs offset from the beginning of the array to location of values for specific tensor. offset parameters is specified in float elements

Returns

Type	Description
BarracudaArray	array filled with the values of multiple tensors that share the same tensorData on device

Implements

ITensorData.SharedAccess(out Int32)

ToString()

Storage summary as string

Declaration

public override string ToString()

Returns

Type	Description
String	storage summary as string

Overrides

Object.ToString()

Upload(Single[], TensorShape, Int32)

Initialize with data. shape is the TensorShape (and thus length) of the data to copy. managedBufferStartIndex is the offset where to start the copy in the data

Declaration

public virtual void Upload(float[] data, TensorShape shape, int managedBufferStartIndex = 0)

Parameters

Type	Name	Description
Single[]	data	data as float array
TensorShape	shape	Tensor shape
Int32	managedBufferStartIndex	managed buffer start index

Implements

ITensorData.Upload(Single[], TensorShape, Int32)

Extension Methods

DeprecatedTensorDataExtensions.GetMaxCount(ITensorData)