Tensor<T>.GetValue Method

Definition

Namespace: Numerics.NET.Tensors
Assembly: Numerics.NET.Tensors (in Numerics.NET.Tensors.dll) Version: 9.0.0

Overload List

GetValue(Index)	Gets the value at the specified position in a 1D tensor.
GetValue(Index[])	Gets the element at the specified position.
GetValue(Int32)	Gets the value at the specified index in a 1D tensor.
GetValue(Int32[])	Gets the element at the specified position.
GetValue(ReadOnlySpan<Index>)	Gets the element at the specified position.
GetValue(ReadOnlySpan<Int32>)	Gets the element at the specified position.
GetValue(Index, Index)	Gets the value at the specified position in a 2D tensor.
GetValue(Int32, Int32)	Gets the value at the specified position in a 2D tensor.
GetValue(Index, Index, Index)	Gets the value at the specified position in a 3D tensor.
GetValue(Int32, Int32, Int32)	Gets the value at the specified position in a 2D tensor.
GetValue(Index, Index, Index, Index)	Gets the value at the specified position in a 4D tensor.
GetValue(Int32, Int32, Int32, Int32)	Gets the value at the specified position in a 4D tensor.

GetValue(Index)

Gets the value at the specified position in a 1D tensor.

public virtual T GetValue(
	Index index
)

Visual Basic

Public Overridable Function GetValue ( 
	index As Index
) As T

C++/CLI

public:
virtual T GetValue(
	Index index
)

abstract GetValue : 
        index : Index -> 'T 
override GetValue : 
        index : Index -> 'T

Parameters

index Index: The position of the element.

Return Value

T
The element with index index.

GetValue(Index[])

Gets the element at the specified position.

public T GetValue(
	params Index[] indexes
)

Visual Basic

Public Function GetValue ( 
	ParamArray indexes As Index()
) As T

C++/CLI

public:
T GetValue(
	... array<Index>^ indexes
)

member GetValue : 
        indexes : Index[] -> 'T

Parameters

indexes Index[]: An array of Index values of the element.

Return Value

T
The element in the position specified by indexes.

Remarks

This method does not perform bounds checking. It is provided for optimized access in situations where the argument is known to be within bounds. If the argument is outside its valid range, the result is unspecified.

Exceptions

DimensionMismatchException

The length of indexes is not equal to the rank of the tensor.

GetValue(Int32)

Gets the value at the specified index in a 1D tensor.

public virtual T GetValue(
	int index
)

Visual Basic

Public Overridable Function GetValue ( 
	index As Integer
) As T

C++/CLI

public:
virtual T GetValue(
	int index
)

abstract GetValue : 
        index : int -> 'T 
override GetValue : 
        index : int -> 'T

Parameters

index Int32: The position of the element.

Return Value

T
The element at position index.

GetValue(Int32[])

Gets the element at the specified position.

public T GetValue(
	params int[] indexes
)

Visual Basic

Public Function GetValue ( 
	ParamArray indexes As Integer()
) As T

C++/CLI

public:
T GetValue(
	... array<int>^ indexes
)

member GetValue : 
        indexes : int[] -> 'T

Parameters

indexes Int32[]: An array of zero-based indexes of the element.

Return Value

T
The element in the position specified by indexes.

Remarks

Exceptions

DimensionMismatchException

The length of indexes is not equal to the rank of the tensor.

GetValue(ReadOnlySpan<Index>)

Gets the element at the specified position.

public virtual T GetValue(
	ReadOnlySpan<Index> indexes
)

Visual Basic

Public Overridable Function GetValue ( 
	indexes As ReadOnlySpan(Of Index)
) As T

C++/CLI

public:
virtual T GetValue(
	ReadOnlySpan<Index> indexes
)

abstract GetValue : 
        indexes : ReadOnlySpan<Index> -> 'T 
override GetValue : 
        indexes : ReadOnlySpan<Index> -> 'T

Parameters

indexes ReadOnlySpan<Index>: A read-only span of Index values of the element.

Return Value

T
The element in the position specified by indexes.

Remarks

Exceptions

DimensionMismatchException

The length of indexes is not equal to the rank of the tensor.

GetValue(ReadOnlySpan<Int32>)

Gets the element at the specified position.

public abstract T GetValue(
	ReadOnlySpan<int> indexes
)

Visual Basic

Public MustOverride Function GetValue ( 
	indexes As ReadOnlySpan(Of Integer)
) As T

C++/CLI

public:
virtual T GetValue(
	ReadOnlySpan<int> indexes
) abstract

abstract GetValue : 
        indexes : ReadOnlySpan<int> -> 'T

Parameters

indexes ReadOnlySpan<Int32>: A read-only span of zero-based indexes of the element.

Return Value

T
The element in the position specified by indexes.

Remarks

Exceptions

DimensionMismatchException

The length of indexes is not equal to the rank of the tensor.

GetValue(Index, Index)

Gets the value at the specified position in a 2D tensor.

public virtual T GetValue(
	Index index1,
	Index index2
)

Visual Basic

Public Overridable Function GetValue ( 
	index1 As Index,
	index2 As Index
) As T

C++/CLI

public:
virtual T GetValue(
	Index index1, 
	Index index2
)

abstract GetValue : 
        index1 : Index * 
        index2 : Index -> 'T 
override GetValue : 
        index1 : Index * 
        index2 : Index -> 'T

Parameters

index1 Index: The position of the element in the first dimension.
index2 Index: The position of the element in the second dimension.

Return Value

T
The element with indices index1 and index2.

GetValue(Int32, Int32)

Gets the value at the specified position in a 2D tensor.

public virtual T GetValue(
	int index1,
	int index2
)

Visual Basic

Public Overridable Function GetValue ( 
	index1 As Integer,
	index2 As Integer
) As T

C++/CLI

public:
virtual T GetValue(
	int index1, 
	int index2
)

abstract GetValue : 
        index1 : int * 
        index2 : int -> 'T 
override GetValue : 
        index1 : int * 
        index2 : int -> 'T

Parameters

index1 Int32: The position of the element in the first dimension.
index2 Int32: The position of the element in the second dimension.

Return Value

T
The element with indices index1 and index2.

GetValue(Index, Index, Index)

Gets the value at the specified position in a 3D tensor.

public virtual T GetValue(
	Index index1,
	Index index2,
	Index index3
)

Visual Basic

Public Overridable Function GetValue ( 
	index1 As Index,
	index2 As Index,
	index3 As Index
) As T

C++/CLI

public:
virtual T GetValue(
	Index index1, 
	Index index2, 
	Index index3
)

abstract GetValue : 
        index1 : Index * 
        index2 : Index * 
        index3 : Index -> 'T 
override GetValue : 
        index1 : Index * 
        index2 : Index * 
        index3 : Index -> 'T

Parameters

index1 Index: The position of the element in the first dimension.
index2 Index: The position of the element in the second dimension.
index3 Index: The position of the element in the third dimension.

Return Value

T
The element with indices index1, index2, and index3.

GetValue(Int32, Int32, Int32)

Gets the value at the specified position in a 2D tensor.

public virtual T GetValue(
	int index1,
	int index2,
	int index3
)

Visual Basic

Public Overridable Function GetValue ( 
	index1 As Integer,
	index2 As Integer,
	index3 As Integer
) As T

C++/CLI

public:
virtual T GetValue(
	int index1, 
	int index2, 
	int index3
)

abstract GetValue : 
        index1 : int * 
        index2 : int * 
        index3 : int -> 'T 
override GetValue : 
        index1 : int * 
        index2 : int * 
        index3 : int -> 'T

Parameters

index1 Int32: The position of the element in the first dimension.
index2 Int32: The position of the element in the second dimension.
index3 Int32: The position of the element in the third dimension.

Return Value

T
The element with indices index1, index2, and index3.

GetValue(Index, Index, Index, Index)

Gets the value at the specified position in a 4D tensor.

public virtual T GetValue(
	Index index1,
	Index index2,
	Index index3,
	Index index4
)

Visual Basic

Public Overridable Function GetValue ( 
	index1 As Index,
	index2 As Index,
	index3 As Index,
	index4 As Index
) As T

C++/CLI

public:
virtual T GetValue(
	Index index1, 
	Index index2, 
	Index index3, 
	Index index4
)

abstract GetValue : 
        index1 : Index * 
        index2 : Index * 
        index3 : Index * 
        index4 : Index -> 'T 
override GetValue : 
        index1 : Index * 
        index2 : Index * 
        index3 : Index * 
        index4 : Index -> 'T

Parameters

index1 Index: The position of the element in the first dimension.
index2 Index: The position of the element in the second dimension.
index3 Index: The position of the element in the third dimension.
index4 Index: The position of the element in the fourth dimension.

Return Value

T
The element with indices index1, index2, index3, and index4.

GetValue(Int32, Int32, Int32, Int32)

Gets the value at the specified position in a 4D tensor.

public virtual T GetValue(
	int index1,
	int index2,
	int index3,
	int index4
)

Visual Basic

Public Overridable Function GetValue ( 
	index1 As Integer,
	index2 As Integer,
	index3 As Integer,
	index4 As Integer
) As T

C++/CLI

public:
virtual T GetValue(
	int index1, 
	int index2, 
	int index3, 
	int index4
)

abstract GetValue : 
        index1 : int * 
        index2 : int * 
        index3 : int * 
        index4 : int -> 'T 
override GetValue : 
        index1 : int * 
        index2 : int * 
        index3 : int * 
        index4 : int -> 'T

Parameters

index1 Int32: The position of the element in the first dimension.
index2 Int32: The position of the element in the second dimension.
index3 Int32: The position of the element in the third dimension.
index4 Int32: The position of the element in the fourth dimension.

Return Value

T
The element with indices index1, index2, index3, and index4.

Tensor<T>.GetValue Method

Definition

Overload List

GetValue(Index)

Parameters

Return Value

GetValue(Index[])

Parameters

Return Value

Remarks

Exceptions

GetValue(Int32)

Parameters

Return Value

GetValue(Int32[])

Parameters

Return Value

Remarks

Exceptions

GetValue(ReadOnlySpan<Index>)

Parameters

Return Value

Remarks

Exceptions

GetValue(ReadOnlySpan<Int32>)

Parameters

Return Value

Remarks

Exceptions

GetValue(Index, Index)

Parameters

Return Value

GetValue(Int32, Int32)

Parameters

Return Value

GetValue(Index, Index, Index)

Parameters

Return Value

GetValue(Int32, Int32, Int32)

Parameters

Return Value

GetValue(Index, Index, Index, Index)

Parameters

Return Value

GetValue(Int32, Int32, Int32, Int32)

Parameters

Return Value

See Also

Reference