Class TensorsInfo

    Definition

    Namespace:
    Tizen.MachineLearning.Inference
    Assembly:
    Tizen.MachineLearning.Inference.dll

    The TensorsInfo class manages each Tensor information such as Name, Type and Dimension.

    public class TensorsInfo : IDisposable, IEquatable<TensorsInfo>
    Inheritance
    object
    TensorsInfo
    Implements
    System.IDisposable
    System.IEquatable<T><TensorsInfo>

    Constructors

    View Source

    TensorsInfo()

    Creates a TensorsInfo instance.

    Declaration
    public TensorsInfo()
    Exceptions
    Type Condition
    System.NotSupportedException

    Thrown when the feature is not supported.

    Properties

    View Source

    Count

    Get the number of Tensor information which is added.

    Declaration
    public int Count { get; }
    Property Value
    Type Description
    int

    Methods

    View Source

    AddTensorInfo(string, TensorType, int[])

    Add a Tensor information to the TensorsInfo instance. Note that we support up to 16 tensors in TensorsInfo.

    Declaration
    public void AddTensorInfo(string name, TensorType type, int[] dimension)
    Parameters
    Type Name Description
    string name

    Name of Tensor.

    TensorType type

    Data element type of Tensor.

    int[] dimension

    Dimension of Tensor. Note that we support up to 4th ranks.

    Exceptions
    Type Condition
    System.IndexOutOfRangeException

    Thrown when the number of Tensor already exceeds the size limits (i.e. Tensor.SizeLimit)

    System.ArgumentException

    Thrown when the method failed due to an invalid parameter.

    System.NotSupportedException

    Thrown when the feature is not supported.

    View Source

    AddTensorInfo(TensorType, int[])

    Add a Tensor information to the TensorsInfo instance. Note that we support up to 256 tensors in TensorsInfo.

    Declaration
    public void AddTensorInfo(TensorType type, int[] dimension)
    Parameters
    Type Name Description
    TensorType type

    Data element type of Tensor.

    int[] dimension

    Dimension of Tensor. Note that we support up to 16th ranks.

    Exceptions
    Type Condition
    System.IndexOutOfRangeException

    Thrown when the number of Tensor already exceeds the size limits (i.e. Tensor.SizeLimit)

    System.ArgumentException

    Thrown when the method failed due to an invalid parameter.

    System.NotSupportedException

    Thrown when the feature is not supported.

    View Source

    Dispose()

    Releases any unmanaged resources used by this object.

    Declaration
    public void Dispose()
    View Source

    Dispose(bool)

    Releases any unmanaged resources used by this object. Can also dispose any other disposable objects.

    Declaration
    protected virtual void Dispose(bool disposing)
    Parameters
    Type Name Description
    bool disposing

    If true, disposes any disposable objects. If false, does not dispose disposable objects.

    View Source

    Equals(object)

    Compare TensorsInfo, which is its contents are the same or not.

    Declaration
    public override bool Equals(object obj)
    Parameters
    Type Name Description
    object obj

    Object to compare

    Returns
    Type Description
    bool

    True if the given object is the same object or its contents are the same

    Overrides
    object.Equals(object)
    View Source

    Equals(TensorsInfo)

    Compare TensorsInfo, which is its contents are the same or not.

    Declaration
    public bool Equals(TensorsInfo other)
    Parameters
    Type Name Description
    TensorsInfo other

    TensorsInfo instance to compare

    Returns
    Type Description
    bool

    True if the given object is the same object or its contents are the same

    View Source

    ~TensorsInfo()

    Destroys the TensorsInfo resource.

    Declaration
    protected ~TensorsInfo()
    View Source

    GetDimension(int)

    Gets the tensor dimension with given index.

    Declaration
    public int[] GetDimension(int idx)
    Parameters
    Type Name Description
    int idx

    The index of the tensor.

    Returns
    Type Description
    int[]

    The tensor dimension.

    Exceptions
    Type Condition
    System.ArgumentException

    Thrown when the method failed due to an invalid parameter.

    System.NotSupportedException

    Thrown when the feature is not supported.

    View Source

    GetHashCode()

    Gets the the hash code of this TensorsInfo object

    Declaration
    public override int GetHashCode()
    Returns
    Type Description
    int

    The hash code

    Overrides
    object.GetHashCode()
    View Source

    GetTensorName(int)

    Gets the tensor name with given index.

    Declaration
    public string GetTensorName(int idx)
    Parameters
    Type Name Description
    int idx

    The index of the tensor.

    Returns
    Type Description
    string

    The tensor name

    Exceptions
    Type Condition
    System.ArgumentException

    Thrown when the method failed due to an invalid parameter.

    System.NotSupportedException

    Thrown when the feature is not supported.

    View Source

    GetTensorsData()

    Creates a TensorsData instance based on informations of TensorsInfo

    Declaration
    public TensorsData GetTensorsData()
    Returns
    Type Description
    TensorsData

    TensorsData instance

    Exceptions
    Type Condition
    System.ArgumentException

    Thrown when the method failed due to TensorsInfo's information is invalid.

    System.NotSupportedException

    Thrown when the feature is not supported.

    View Source

    GetTensorSize(int)

    Calculates the byte size of tensor data.

    Declaration
    public int GetTensorSize(int idx)
    Parameters
    Type Name Description
    int idx

    The index of the tensor information in the list

    Returns
    Type Description
    int

    The byte size of tensor

    Exceptions
    Type Condition
    System.ArgumentException

    Thrown when the method failed due to an invalid parameter.

    System.NotSupportedException

    Thrown when the feature is not supported.

    View Source

    GetTensorType(int)

    Gets the tensor type with given index.

    Declaration
    public TensorType GetTensorType(int idx)
    Parameters
    Type Name Description
    int idx

    The index of the tensor.

    Returns
    Type Description
    TensorType

    The tensor type

    Exceptions
    Type Condition
    System.ArgumentException

    Thrown when the method failed due to an invalid parameter.

    System.NotSupportedException

    Thrown when the feature is not supported.

    View Source

    SetDimension(int, int[])

    Sets the tensor dimension with given index and dimension.

    Declaration
    public void SetDimension(int idx, int[] dimension)
    Parameters
    Type Name Description
    int idx

    The index of the tensor to be updated.

    int[] dimension

    The tensor dimension to be set.

    Exceptions
    Type Condition
    System.ArgumentException

    Thrown when the method failed due to an invalid parameter.

    System.NotSupportedException

    Thrown when the feature is not supported.

    View Source

    SetTensorName(int, string)

    Sets the tensor name with given index.

    Declaration
    public void SetTensorName(int idx, string name)
    Parameters
    Type Name Description
    int idx

    The index of the tensor to be updated.

    string name

    The tensor name to be set.

    Exceptions
    Type Condition
    System.ArgumentException

    Thrown when the method failed due to an invalid parameter.

    System.NotSupportedException

    Thrown when the feature is not supported.

    View Source

    SetTensorType(int, TensorType)

    Sets the tensor type with given index and its type.

    Declaration
    public void SetTensorType(int idx, TensorType type)
    Parameters
    Type Name Description
    int idx

    The index of the tensor to be updated.

    TensorType type

    The tensor type to be set.

    Exceptions
    Type Condition
    System.ArgumentException

    Thrown when the method failed due to an invalid parameter.

    System.NotSupportedException

    Thrown when the feature is not supported.

    Implements

    System.IDisposable
    System.IEquatable<T>
    • View Source
    Back to top Copyright © 2016-2024 Samsung
    Generated by DocFX