ExtensionMethods.argsort Method (ConcreteArray<UInt32, Array<UInt32>, InArray<UInt32>, OutArray<UInt32>, RetArray<UInt32>, Storage<UInt32>>, Int32, Boolean, OutArray<UInt32>)

ILNumerics Ultimate VS Documentation

ILNumerics - Technical Application Development

[numpy API] Computes the indices for elements of sorted A.

[ILNumerics numpy Module]

Namespace: ILNumerics
Assembly: ILNumerics.numpy (in ILNumerics.numpy.dll) Version: 5.5.0.0 (5.5.7503.3146)

Syntax

public static RetArray<long> argsort(
	this ConcreteArray<uint, Array<uint>, InArray<uint>, OutArray<uint>, RetArray<uint>, Storage<uint>> A,
	int axis = -1,
	bool descending = false,
	OutArray<uint> sorted = null
)

<ExtensionAttribute>
Public Shared Function argsort ( 
	A As ConcreteArray(Of UInteger, Array(Of UInteger), InArray(Of UInteger), OutArray(Of UInteger), RetArray(Of UInteger), Storage(Of UInteger)),
	Optional axis As Integer = -1,
	Optional descending As Boolean = false,
	Optional sorted As OutArray(Of UInteger) = Nothing
) As RetArray(Of Long)

Dim A As ConcreteArray(Of UInteger, Array(Of UInteger), InArray(Of UInteger), OutArray(Of UInteger), RetArray(Of UInteger), Storage(Of UInteger))
Dim axis As Integer
Dim descending As Boolean
Dim sorted As OutArray(Of UInteger)
Dim returnValue As RetArray(Of Long)

returnValue = A.argsort(axis, descending, 
	sorted)

Parameters

A: Type: ILNumerics.Core.Arrays.ConcreteArray<UInt32, Array<UInt32>, InArray<UInt32>, OutArray<UInt32>, RetArray<UInt32>, Storage<UInt32>>
Array to compute the indices for. This is not altered.
axis (Optional): Type: System.Int32
[Optional] The working dimension. Default: (-1) sorts the last dimension.
descending (Optional): Type: System.Boolean
[Optional] Sort in descending order. Default: (false) sort in ascending order.
sorted (Optional): Type: ILNumerics.OutArray<UInt32>
[Optional] Returns the sorted values of A also. Default: (null) sorted values are not returned.

Return Value

Type: RetArray<Int64>

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type ConcreteArray<UInt32, Array<UInt32>, InArray<UInt32>, OutArray<UInt32>, RetArray<UInt32>, Storage<UInt32>>. 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).

Remarks

The sort is performed in parallel, using the quicksort algorithm.

See sort(BaseArray<UInt32> , Int32, Boolean) for details.

This function internally creates a copy of A. Therefore, the sorted values can be returned without significant overhead.

[ILNumerics numpy Module]

Reference

ExtensionMethods Class

argsort Overload

ILNumerics Namespace

MathInternal.sort(BaseArray<UInt32>, Int32, Boolean)

MathInternal.sort(BaseArray<UInt32>, OutArray<Int64>, Int32, Boolean)