docs.unity3d.com
    Show / Hide Table of Contents

    Struct SymbolicTensorShape

    Represents the shape of an input tensor, or the predicted shape of a tensor before Sentis executes.

    Inherited Members
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetType()
    Namespace: Unity.Sentis
    Syntax
    [Serializable]
    public struct SymbolicTensorShape

    Constructors

    SymbolicTensorShape(Int32)

    Declaration
    public SymbolicTensorShape(int d0)
    Parameters
    Type Name Description
    Int32 d0

    SymbolicTensorShape(Int32, Int32)

    Declaration
    public SymbolicTensorShape(int d0, int d1)
    Parameters
    Type Name Description
    Int32 d0
    Int32 d1

    SymbolicTensorShape(Int32, Int32, Int32)

    Declaration
    public SymbolicTensorShape(int d0, int d1, int d2)
    Parameters
    Type Name Description
    Int32 d0
    Int32 d1
    Int32 d2

    SymbolicTensorShape(Int32, Int32, Int32, Int32)

    Declaration
    public SymbolicTensorShape(int d0, int d1, int d2, int d3)
    Parameters
    Type Name Description
    Int32 d0
    Int32 d1
    Int32 d2
    Int32 d3

    SymbolicTensorShape(SymbolicTensorDim)

    Initializes and returns an instance of SymbolicTensorShape with a rank of 1: (d0).

    For example (9).

    Declaration
    public SymbolicTensorShape(SymbolicTensorDim d0)
    Parameters
    Type Name Description
    SymbolicTensorDim d0

    SymbolicTensorShape(SymbolicTensorDim, SymbolicTensorDim)

    Initializes and returns an instance of SymbolicTensorShape with a rank of 2: (d1, d0).

    For example (8, 9).

    Declaration
    public SymbolicTensorShape(SymbolicTensorDim d1, SymbolicTensorDim d0)
    Parameters
    Type Name Description
    SymbolicTensorDim d1
    SymbolicTensorDim d0

    SymbolicTensorShape(SymbolicTensorDim, SymbolicTensorDim, SymbolicTensorDim)

    Initializes and returns an instance of SymbolicTensorShape with a rank of 3: (d2, d1, d0).

    For example (7, 8, 9).

    Declaration
    public SymbolicTensorShape(SymbolicTensorDim d2, SymbolicTensorDim d1, SymbolicTensorDim d0)
    Parameters
    Type Name Description
    SymbolicTensorDim d2
    SymbolicTensorDim d1
    SymbolicTensorDim d0

    SymbolicTensorShape(SymbolicTensorDim, SymbolicTensorDim, SymbolicTensorDim, SymbolicTensorDim)

    Initializes and returns an instance of SymbolicTensorShape with a rank of 4: (d3, d2, d1, d0).

    For example (6, 7, 8, 9).

    Declaration
    public SymbolicTensorShape(SymbolicTensorDim d3, SymbolicTensorDim d2, SymbolicTensorDim d1, SymbolicTensorDim d0)
    Parameters
    Type Name Description
    SymbolicTensorDim d3
    SymbolicTensorDim d2
    SymbolicTensorDim d1
    SymbolicTensorDim d0

    SymbolicTensorShape(SymbolicTensorDim, SymbolicTensorDim, SymbolicTensorDim, SymbolicTensorDim, SymbolicTensorDim)

    Initializes and returns an instance of SymbolicTensorShape with a rank of 5: (d4, d3, d2, d1, d0).

    For example (5, 6, 7, 8, 9).

    Declaration
    public SymbolicTensorShape(SymbolicTensorDim d4, SymbolicTensorDim d3, SymbolicTensorDim d2, SymbolicTensorDim d1, SymbolicTensorDim d0)
    Parameters
    Type Name Description
    SymbolicTensorDim d4
    SymbolicTensorDim d3
    SymbolicTensorDim d2
    SymbolicTensorDim d1
    SymbolicTensorDim d0

    SymbolicTensorShape(SymbolicTensorDim, SymbolicTensorDim, SymbolicTensorDim, SymbolicTensorDim, SymbolicTensorDim, SymbolicTensorDim)

    Initializes and returns an instance of SymbolicTensorShape with a rank of 6: (d5, d4, d3, d2, d1, d0).

    For example (4, 5, 6, 7, 8, 9).

    Declaration
    public SymbolicTensorShape(SymbolicTensorDim d5, SymbolicTensorDim d4, SymbolicTensorDim d3, SymbolicTensorDim d2, SymbolicTensorDim d1, SymbolicTensorDim d0)
    Parameters
    Type Name Description
    SymbolicTensorDim d5
    SymbolicTensorDim d4
    SymbolicTensorDim d3
    SymbolicTensorDim d2
    SymbolicTensorDim d1
    SymbolicTensorDim d0

    SymbolicTensorShape(SymbolicTensorDim, SymbolicTensorDim, SymbolicTensorDim, SymbolicTensorDim, SymbolicTensorDim, SymbolicTensorDim, SymbolicTensorDim)

    Initializes and returns an instance of SymbolicTensorShape with a rank of 7: (d6, d5, d4, d3, d2, d1, d0).

    For example (3, 4, 5, 6, 7, 8, 9).

    Declaration
    public SymbolicTensorShape(SymbolicTensorDim d6, SymbolicTensorDim d5, SymbolicTensorDim d4, SymbolicTensorDim d3, SymbolicTensorDim d2, SymbolicTensorDim d1, SymbolicTensorDim d0)
    Parameters
    Type Name Description
    SymbolicTensorDim d6
    SymbolicTensorDim d5
    SymbolicTensorDim d4
    SymbolicTensorDim d3
    SymbolicTensorDim d2
    SymbolicTensorDim d1
    SymbolicTensorDim d0

    SymbolicTensorShape(SymbolicTensorDim, SymbolicTensorDim, SymbolicTensorDim, SymbolicTensorDim, SymbolicTensorDim, SymbolicTensorDim, SymbolicTensorDim, SymbolicTensorDim)

    Initializes and returns an instance of SymbolicTensorShape with a rank of 8: (d7, d6, d5, d4, d3, d2, d1, d0).

    For example (2, 3, 4, 5, 6, 7, 8, 9).

    Declaration
    public SymbolicTensorShape(SymbolicTensorDim d7, SymbolicTensorDim d6, SymbolicTensorDim d5, SymbolicTensorDim d4, SymbolicTensorDim d3, SymbolicTensorDim d2, SymbolicTensorDim d1, SymbolicTensorDim d0)
    Parameters
    Type Name Description
    SymbolicTensorDim d7
    SymbolicTensorDim d6
    SymbolicTensorDim d5
    SymbolicTensorDim d4
    SymbolicTensorDim d3
    SymbolicTensorDim d2
    SymbolicTensorDim d1
    SymbolicTensorDim d0

    SymbolicTensorShape(SymbolicTensorShape)

    Returns a copy of another SymbolicTensorShape.

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

    SymbolicTensorShape(TensorShape)

    Initializes and returns an instance of SymbolicTensorShape with a given TensorShape, and no unknown or dynamic dimensions. For example: SymbolicTensorShape(new TensorShape(3, 4, 5, 6)) returns a symbolic tensor shape of (3, 4, 5, 6).

    Declaration
    public SymbolicTensorShape(TensorShape other)
    Parameters
    Type Name Description
    TensorShape other

    Properties

    Item[Int32]

    Gets or sets the tensor shape at a given axis. Ex: shape (3, 4, 5, 6) index 0, 1, 2, 3 -4,-3,-2,-1 shape (7, 3, 2) index 0, 1, 2 -3,-2,-1

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

    rank

    The rank of a SymbolicTensorShape, For example, a tensor of shape (5) has a rank of 1. A tensor of shape (7, 3, 5) has a rank of 3.

    Declaration
    public readonly int rank { get; }
    Property Value
    Type Description
    Int32

    Methods

    Equals(Object)

    Determines whether the specified object is equal to the current SymbolicTensorShape.

    Declaration
    public override bool Equals(object obj)
    Parameters
    Type Name Description
    Object obj
    Returns
    Type Description
    Boolean
    Overrides
    ValueType.Equals(Object)

    GetHashCode()

    Serves as the default hash function.

    Declaration
    public override int GetHashCode()
    Returns
    Type Description
    Int32
    Overrides
    ValueType.GetHashCode()

    IsFullyKnown()

    Checks if the SymbolicTensorShape is fully defined and converted to a TensorShape.

    Declaration
    public bool IsFullyKnown()
    Returns
    Type Description
    Boolean

    ToString()

    Returns a string that represents the SymbolicTensorShape.

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

    ToTensorShape()

    Converts the SymbolicTensorShape to a TensorShape. You should call IsFullyKnown before you call this method.

    Declaration
    public TensorShape ToTensorShape()
    Returns
    Type Description
    TensorShape

    Operators

    Equality(SymbolicTensorShape, SymbolicTensorShape)

    Compares two SymbolicTensorShape objects. Returns true if the two objects have the same rank, and all their dimensions are equal.

    Declaration
    public static bool operator ==(SymbolicTensorShape a, SymbolicTensorShape b)
    Parameters
    Type Name Description
    SymbolicTensorShape a
    SymbolicTensorShape b
    Returns
    Type Description
    Boolean

    Inequality(SymbolicTensorShape, SymbolicTensorShape)

    Compares two SymbolicTensorShape objects. Returns true if the two shapes have a different or unknown rank, or at least one of their dimensions are not equal.

    Declaration
    public static bool operator !=(SymbolicTensorShape a, SymbolicTensorShape b)
    Parameters
    Type Name Description
    SymbolicTensorShape a
    SymbolicTensorShape b
    Returns
    Type Description
    Boolean
    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