Tensor.AbsoluteMaxIndex Method

Definition

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

Overload List

AbsoluteMaxIndex<T>(Tensor<T>, Index, Boolean, Tensor<Boolean>, Boolean, TensorElementOrder) Computes the index of the elements of a tensor with the largest absolute value along the specified axis.
AbsoluteMaxIndex<T>(Tensor<T>, Axes, Tensor<Int32>, Boolean, Tensor<Boolean>, Boolean, TensorElementOrder) Computes the index of the element with the largest absolute value of a tensor.

AbsoluteMaxIndex<T>(Tensor<T>, Index, Boolean, Tensor<Boolean>, Boolean, TensorElementOrder)

Computes the index of the elements of a tensor with the largest absolute value along the specified axis.
C# 
public static Tensor<int> AbsoluteMaxIndex<T>(
	this Tensor<T> operand,
	Index axis,
	bool keepDimensions = false,
	Tensor<bool>? mask = null,
	bool skipMissingValues = false,
	TensorElementOrder order = TensorElementOrder.Automatic
)

Parameters

operand  Tensor<T>
The tensor that contains the elements to reduce.
axis  Index
The axis along which to reduce the elements.
keepDimensions  Boolean  (Optional)
Optional. Specifies whether the reduced axis should be retained in the result. The default is false.
mask  Tensor<Boolean>  (Optional)
Optional. A condition that elements must satisfy to be included in the reduction.
skipMissingValues  Boolean  (Optional)
Optional. Specifies whether missing values should be excluded from the aggregation. The default is false.
order  TensorElementOrder  (Optional)
Optional. Specifies the element order of the result. By default, elements are stored in the order of operand.

Type Parameters

T
The type of the elements of the tensor.

Return Value

Tensor<Int32>
A tensor containing the index of the largest element of operand that satisfies mask along axis.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type Tensor<T>. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

AbsoluteMaxIndex<T>(Tensor<T>, Axes, Tensor<Int32>, Boolean, Tensor<Boolean>, Boolean, TensorElementOrder)

Computes the index of the element with the largest absolute value of a tensor.
C# 
public static Tensor<int> AbsoluteMaxIndex<T>(
	Tensor<T> value,
	Axes axis,
	Tensor<int>? result = null,
	bool keepDimensions = false,
	Tensor<bool>? mask = null,
	bool skipMissingValues = false,
	TensorElementOrder order = TensorElementOrder.Automatic
)

Parameters

value  Tensor<T>
A tensor.
axis  Axes
The axis along which the index of the element with the largest absolute value is computed.
result  Tensor<Int32>  (Optional)
Optional. The tensor that is to hold the result. May be null.
keepDimensions  Boolean  (Optional)
Optional. Specifies whether the reduced axis should be retained in the result. The default is false.
mask  Tensor<Boolean>  (Optional)
Optional. A boolean tensor that specifies for which elements should be included in the operation. If null (the default), the operation is applied everywhere.
skipMissingValues  Boolean  (Optional)
Optional. Specifies whether missing values should be excluded from the aggregation. The default is false.
order  TensorElementOrder  (Optional)
Optional. If result is null, the desired ordering in memory of the result.

Type Parameters

T
The type of the elements of the tensor.

Return Value

Tensor<Int32>
A tensor containing the index of the element with the largest absolute value of value that satisfy mask along the specified axis.

Exceptions

ArgumentNullException

value is null.

See Also