docs.unity3d.com
    Show / Hide Table of Contents

    Struct TensorNDIterator

    Represents a struct used to iterate over a TensorShape.

    Inherited Members
    ValueType.Equals(Object)
    ValueType.GetHashCode()
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetType()
    Namespace: Unity.Sentis
    Syntax
    public struct TensorNDIterator

    Constructors

    TensorNDIterator(TensorNDIterator)

    Returns a copy of another TensorNDIterator.

    Declaration
    public TensorNDIterator(TensorNDIterator other)
    Parameters
    Type Name Description
    TensorNDIterator other

    TensorNDIterator(TensorShape)

    Initializes and returns an instance of TensorNDIterator with a given shape.

    Declaration
    public TensorNDIterator(TensorShape shape)
    Parameters
    Type Name Description
    TensorShape shape

    TensorNDIterator(TensorShape, Int32)

    Initializes and returns an instance of TensorNDIterator with a given shape, and uses a given index in the flattened 1D version of the shape.

    Declaration
    public TensorNDIterator(TensorShape shape, int index)
    Parameters
    Type Name Description
    TensorShape shape
    Int32 index

    Fields

    index

    The 1D flattened index.

    Declaration
    public int index
    Field Value
    Type Description
    Int32

    Properties

    Item[Int32]

    Gets or sets the iterator at a given axis.

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

    shape

    The shape that is iterated over.

    Declaration
    public readonly TensorShape shape { get; }
    Property Value
    Type Description
    TensorShape

    Methods

    Broadcast(TensorShape)

    Creates a new iterator by broadcasting this iterator on a given shape following the broadcast rule.

    Declaration
    public TensorNDIterator Broadcast(TensorShape shapeToBroadcast)
    Parameters
    Type Name Description
    TensorShape shapeToBroadcast
    Returns
    Type Description
    TensorNDIterator

    CopyNDIndex(TensorNDIterator)

    Copies the dimension indices from another iterator. If the shapes of the iterators are not the same the final flattened index may be different.

    Declaration
    public void CopyNDIndex(TensorNDIterator other)
    Parameters
    Type Name Description
    TensorNDIterator other

    HasNext()

    Whether the iterator is yet to reach the end of the shape.

    Declaration
    public bool HasNext()
    Returns
    Type Description
    Boolean

    HasNext(Int32)

    Whether the iterator is yet to reach the end of the shape on a given axis.

    Declaration
    public bool HasNext(int axis)
    Parameters
    Type Name Description
    Int32 axis
    Returns
    Type Description
    Boolean

    MoveNext()

    Increments the flattened index by one.

    Declaration
    public void MoveNext()

    MoveNextAxis(Int32)

    Increments the index at a given axis by one.

    Declaration
    public void MoveNextAxis(int axis)
    Parameters
    Type Name Description
    Int32 axis

    RemoveDim(Int32)

    Creates a new iterator by skipping an axis of this iterator.

    Declaration
    public TensorNDIterator RemoveDim(int axis)
    Parameters
    Type Name Description
    Int32 axis
    Returns
    Type Description
    TensorNDIterator

    Reset()

    Resets the iterator to the start of the shape.

    Declaration
    public void Reset()

    ToString()

    Returns a string that represents the TensorNDIterator.

    Declaration
    public override string ToString()
    Returns
    Type Description
    String
    Overrides
    ValueType.ToString()

    Transpose()

    Creates a new iterator by transposing this iterator reversing the axes.

    Declaration
    public TensorNDIterator Transpose()
    Returns
    Type Description
    TensorNDIterator

    Transpose(Int32[])

    Creates a new iterator by transposing this iterator using the given permutations.

    Declaration
    public TensorNDIterator Transpose(int[] permutations)
    Parameters
    Type Name Description
    Int32[] permutations
    Returns
    Type Description
    TensorNDIterator
    In This Article
    • Constructors
      • TensorNDIterator(TensorNDIterator)
      • TensorNDIterator(TensorShape)
      • TensorNDIterator(TensorShape, Int32)
    • Fields
      • index
    • Properties
      • Item[Int32]
      • shape
    • Methods
      • Broadcast(TensorShape)
      • CopyNDIndex(TensorNDIterator)
      • HasNext()
      • HasNext(Int32)
      • MoveNext()
      • MoveNextAxis(Int32)
      • RemoveDim(Int32)
      • Reset()
      • ToString()
      • Transpose()
      • Transpose(Int32[])
    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