TensorBackEnd.Sort Method

Definition

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

Overload List

Sort<T>(Tensor<T>, IComparer<T>, Index, Tensor<T>, Tensor<Boolean>, TensorElementOrder)	Sorts the elements of a tensor.
Sort<T>(Tensor<T>, Index, Tensor<T>, Tensor<Boolean>, Boolean, TensorElementOrder)	Sorts the elements of a tensor.

Sort<T>(Tensor<T>, IComparer<T>, Index, Tensor<T>, Tensor<Boolean>, TensorElementOrder)

Sorts the elements of a tensor.

public abstract Tensor<T> Sort<T>(
	Tensor<T> tensor,
	IComparer<T> comparer,
	Index axis,
	Tensor<T>? result = null,
	Tensor<bool>? mask = null,
	TensorElementOrder order = TensorElementOrder.Automatic
)

Visual Basic

Public MustOverride Function Sort(Of T) ( 
	tensor As Tensor(Of T),
	comparer As IComparer(Of T),
	axis As Index,
	Optional result As Tensor(Of T) = Nothing,
	Optional mask As Tensor(Of Boolean) = Nothing,
	Optional order As TensorElementOrder = TensorElementOrder.Automatic
) As Tensor(Of T)

C++/CLI

public:
generic<typename T>
virtual Tensor<T>^ Sort(
	Tensor<T>^ tensor, 
	IComparer<T>^ comparer, 
	Index axis, 
	Tensor<T>^ result = nullptr, 
	Tensor<bool>^ mask = nullptr, 
	TensorElementOrder order = TensorElementOrder::Automatic
) abstract

abstract Sort : 
        tensor : Tensor<'T> * 
        comparer : IComparer<'T> * 
        axis : Index * 
        ?result : Tensor<'T> * 
        ?mask : Tensor<bool> * 
        ?order : TensorElementOrder 
(* Defaults:
        let _result = defaultArg result null
        let _mask = defaultArg mask null
        let _order = defaultArg order TensorElementOrder.Automatic
*)
-> Tensor<'T>

Parameters

tensor Tensor<T>: A tensor.
comparer IComparer<T>: The IComparer<T> implementation to use when comparing elements, or null to use Comparer.
axis Index: The axis along which the transformation is computed.
result Tensor<T> (Optional): Optional. The tensor that is to hold the result. May be null.
mask Tensor<Boolean> (Optional): Optional. A boolean tensor that specifies for which elements the operation should be performed. If null (the default), the operation is applied everywhere.
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<T>
A tensor of the same shape as tensor whose elements are equal to the sorted of the corresponding elements of tensor.

Exceptions

ArgumentNullException

tensor is null.

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

Sorts the elements of a tensor.

public virtual Tensor<T> Sort<T>(
	Tensor<T> value,
	Index axis,
	Tensor<T>? result = null,
	Tensor<bool>? mask = null,
	bool skipMissingValues = false,
	TensorElementOrder order = TensorElementOrder.Automatic
)

Visual Basic

Public Overridable Function Sort(Of T) ( 
	value As Tensor(Of T),
	axis As Index,
	Optional result As Tensor(Of T) = Nothing,
	Optional mask As Tensor(Of Boolean) = Nothing,
	Optional skipMissingValues As Boolean = false,
	Optional order As TensorElementOrder = TensorElementOrder.Automatic
) As Tensor(Of T)

C++/CLI

public:
generic<typename T>
virtual Tensor<T>^ Sort(
	Tensor<T>^ value, 
	Index axis, 
	Tensor<T>^ result = nullptr, 
	Tensor<bool>^ mask = nullptr, 
	bool skipMissingValues = false, 
	TensorElementOrder order = TensorElementOrder::Automatic
)

abstract Sort : 
        value : Tensor<'T> * 
        axis : Index * 
        ?result : Tensor<'T> * 
        ?mask : Tensor<bool> * 
        ?skipMissingValues : bool * 
        ?order : TensorElementOrder 
(* Defaults:
        let _result = defaultArg result null
        let _mask = defaultArg mask null
        let _skipMissingValues = defaultArg skipMissingValues false
        let _order = defaultArg order TensorElementOrder.Automatic
*)
-> Tensor<'T> 
override Sort : 
        value : Tensor<'T> * 
        axis : Index * 
        ?result : Tensor<'T> * 
        ?mask : Tensor<bool> * 
        ?skipMissingValues : bool * 
        ?order : TensorElementOrder 
(* Defaults:
        let _result = defaultArg result null
        let _mask = defaultArg mask null
        let _skipMissingValues = defaultArg skipMissingValues false
        let _order = defaultArg order TensorElementOrder.Automatic
*)
-> Tensor<'T>

Parameters

value Tensor<T>: A tensor.
axis Index: The axis along which the transformation is computed.
result Tensor<T> (Optional): Optional. The tensor that is to hold the result. May be null.
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 operation. 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<T>
A tensor of the same shape as value whose elements are equal to the sorted of the corresponding elements of value.

Exceptions

ArgumentNullException

value is null.

TensorBackEnd.Sort Method

Definition

Overload List

Sort<T>(Tensor<T>, IComparer<T>, Index, Tensor<T>, Tensor<Boolean>, TensorElementOrder)

Parameters

Type Parameters

Return Value

Exceptions

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

Parameters

Type Parameters

Return Value

Exceptions

See Also

Reference