docs.unity3d.com
    Show / Hide Table of Contents

    Class TensorFloat

    Represents data in a multidimensional array-like structure of floats.

    Inheritance
    Object
    Tensor
    TensorFloat
    Inherited Members
    Tensor.m_TensorOnDevice
    Tensor.m_TensorAllocator
    Tensor.m_Shape
    Tensor.m_Disposed
    Tensor.shape
    Tensor.tensorOnDevice
    Tensor.allocator
    Tensor.PinToDevice(ITensorData, Boolean)
    Tensor.AttachToDevice(ITensorData)
    Tensor.DetachFromDevice(Boolean)
    Tensor.MakeReadable()
    Tensor.IsAsyncReadbackRequestDone()
    Tensor.AsyncReadbackRequest(Action<Boolean>)
    Tensor.CompleteAllPendingOperations()
    Tensor.ShallowCopy()
    Tensor.TakeOwnership()
    Tensor.Dispose()
    Tensor.ToString()
    Object.Equals(Object)
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetHashCode()
    Object.GetType()
    Object.MemberwiseClone()
    Namespace: Unity.Sentis
    Syntax
    public class TensorFloat : Tensor, IDisposable

    Constructors

    TensorFloat(Single)

    Initializes and returns a scalar tensor with the value of srcData.

    Declaration
    public TensorFloat(float srcData)
    Parameters
    Type Name Description
    Single srcData

    TensorFloat(TensorShape, Single[])

    Initializes and returns a tensor with the specified shape and a float[] array of srcData data.

    Declaration
    public TensorFloat(TensorShape shape, float[] srcData)
    Parameters
    Type Name Description
    TensorShape shape
    Single[] srcData

    TensorFloat(TensorShape, Single[], Int32)

    Initializes and returns a tensor with specified shape and a float[] array of srcData data. Sentis reads srcData from dataStartIndex.

    srcData.Length - dataStartIndex must be bigger than or equal to shape.length.

    Declaration
    public TensorFloat(TensorShape shape, float[] srcData, int dataStartIndex = 0)
    Parameters
    Type Name Description
    TensorShape shape
    Single[] srcData
    Int32 dataStartIndex

    TensorFloat(TensorShape, NativeArray<Single>, Int32)

    Declaration
    public TensorFloat(TensorShape shape, NativeArray<float> srcData, int dataStartIndex = 0)
    Parameters
    Type Name Description
    TensorShape shape
    NativeArray<Single> srcData
    Int32 dataStartIndex

    Properties

    dataType

    The data type of the elements of the tensor.

    Declaration
    public override DataType dataType { get; }
    Property Value
    Type Description
    DataType
    Overrides
    Tensor.dataType

    Item[Int32]

    Returns the tensor element at offset d0.

    Declaration
    public float this[int d0] { get; set; }
    Parameters
    Type Name Description
    Int32 d0
    Property Value
    Type Description
    Single

    Item[Int32, Int32]

    Returns the tensor element at offset (d1, d0), which is position d1 * stride0 + d0.

    Declaration
    public float this[int d1, int d0] { get; set; }
    Parameters
    Type Name Description
    Int32 d1
    Int32 d0
    Property Value
    Type Description
    Single

    Item[Int32, Int32, Int32]

    Returns the tensor element at offset (d2, d1, d0), which is position d2 * stride1 + d1 * stride0 + d0.

    Declaration
    public float this[int d2, int d1, int d0] { get; set; }
    Parameters
    Type Name Description
    Int32 d2
    Int32 d1
    Int32 d0
    Property Value
    Type Description
    Single

    Item[Int32, Int32, Int32, Int32]

    Returns the tensor element at offset (d3, d2, d1, d0), which is position d3 * stride2 + d2 * stride1 + d1 * stride0 + d0 in this tensor.

    Declaration
    public float this[int d3, int d2, int d1, int d0] { get; set; }
    Parameters
    Type Name Description
    Int32 d3
    Int32 d2
    Int32 d1
    Int32 d0
    Property Value
    Type Description
    Single

    Item[Int32, Int32, Int32, Int32, Int32]

    Returns the tensor element at offset (d4, d3, d2, d1, d0), which is position d4 * stride3 + d3 * stride2 + d2 * stride1 + d1 * stride0 + d0.

    Declaration
    public float this[int d4, int d3, int d2, int d1, int d0] { get; set; }
    Parameters
    Type Name Description
    Int32 d4
    Int32 d3
    Int32 d2
    Int32 d1
    Int32 d0
    Property Value
    Type Description
    Single

    Item[Int32, Int32, Int32, Int32, Int32, Int32]

    Returns the tensor element at offset (d5, d4, d3, d2, d1, d0), which is position d5 * stride4 + d4 * stride3 + d3 * stride2 + d2 * stride1 + d1 * stride0 + d0.

    Declaration
    public float this[int d5, int d4, int d3, int d2, int d1, int d0] { get; set; }
    Parameters
    Type Name Description
    Int32 d5
    Int32 d4
    Int32 d3
    Int32 d2
    Int32 d1
    Int32 d0
    Property Value
    Type Description
    Single

    Item[Int32, Int32, Int32, Int32, Int32, Int32, Int32]

    Returns the tensor element at offset (d6, d5, d4, d3, d2, d1, d0), which is position d6 * stride5 + d5 * stride4 + d4 * stride3 + d3 * stride2 + d2 * stride1 + d1 * stride0 + d0.

    Declaration
    public float this[int d6, int d5, int d4, int d3, int d2, int d1, int d0] { get; set; }
    Parameters
    Type Name Description
    Int32 d6
    Int32 d5
    Int32 d4
    Int32 d3
    Int32 d2
    Int32 d1
    Int32 d0
    Property Value
    Type Description
    Single

    Item[Int32, Int32, Int32, Int32, Int32, Int32, Int32, Int32]

    Returns the tensor element at offset (d7, d6, d5, d4, d3, d2, d1, d0), which is position d7 * stride6 + d6 * stride5 + d5 * stride4 + d4 * stride3 + d3 * stride2 + d2 * stride1 + d1 * stride0 + d0.

    Declaration
    public float this[int d7, int d6, int d5, int d4, int d3, int d2, int d1, int d0] { get; set; }
    Parameters
    Type Name Description
    Int32 d7
    Int32 d6
    Int32 d5
    Int32 d4
    Int32 d3
    Int32 d2
    Int32 d1
    Int32 d0
    Property Value
    Type Description
    Single

    Methods

    DeepCopy()

    Returns a deep copy of the current Tensor.

    Declaration
    public override Tensor DeepCopy()
    Returns
    Type Description
    Tensor
    Overrides
    Tensor.DeepCopy()

    ShallowReshape(TensorShape)

    Returns a shallow copy of the Tensor with a new shape. The copy shares data storage with the original tensor.

    newShape.length must be equal to this.shape.length.

    Declaration
    public override Tensor ShallowReshape(TensorShape newShape)
    Parameters
    Type Name Description
    TensorShape newShape
    Returns
    Type Description
    Tensor
    Overrides
    Tensor.ShallowReshape(TensorShape)

    ToReadOnlyArray()

    Returns a copy of linear memory representation of the data in this tensor.

    the returned array is a deepcopy of the tensor, the caller of this methods is now responsible for it. If you modify the contents of the returned array, it will not modify the underlying tensor

    Declaration
    public float[] ToReadOnlyArray()
    Returns
    Type Description
    Single[]

    ToReadOnlySpan()

    Returns a ReadOnlySpan on the linear memory representation of the data in this tensor.

    Declaration
    public ReadOnlySpan<float> ToReadOnlySpan()
    Returns
    Type Description
    ReadOnlySpan<Single>

    UploadToDevice(ITensorData)

    Declaration
    public override void UploadToDevice(ITensorData destination)
    Parameters
    Type Name Description
    ITensorData destination
    Overrides
    Tensor.UploadToDevice(ITensorData)

    Zeros(TensorShape)

    Initializes and returns a tensor with the specified shape and filled with 0.

    Declaration
    public static TensorFloat Zeros(TensorShape shape)
    Parameters
    Type Name Description
    TensorShape shape
    Returns
    Type Description
    TensorFloat

    Extension Methods

    TensorExtensions.PrintDataPart(Tensor, Int32, String)
    In This Article
    • Constructors
      • TensorFloat(Single)
      • TensorFloat(TensorShape, Single[])
      • TensorFloat(TensorShape, Single[], Int32)
      • TensorFloat(TensorShape, NativeArray<Single>, Int32)
    • Properties
      • dataType
      • Item[Int32]
      • Item[Int32, Int32]
      • Item[Int32, Int32, Int32]
      • Item[Int32, Int32, Int32, Int32]
      • Item[Int32, Int32, Int32, Int32, Int32]
      • Item[Int32, Int32, Int32, Int32, Int32, Int32]
      • Item[Int32, Int32, Int32, Int32, Int32, Int32, Int32]
      • Item[Int32, Int32, Int32, Int32, Int32, Int32, Int32, Int32]
    • Methods
      • DeepCopy()
      • ShallowReshape(TensorShape)
      • ToReadOnlyArray()
      • ToReadOnlySpan()
      • UploadToDevice(ITensorData)
      • Zeros(TensorShape)
    • Extension Methods
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023