ExtensionMethodsargsort Method (ConcreteArrayUInt64, ArrayUInt64, InArrayUInt64, OutArrayUInt64, RetArrayUInt64, StorageUInt64, Int32, Boolean, OutArrayUInt64)

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<ulong, Array<ulong>, InArray<ulong>, OutArray<ulong>, RetArray<ulong>, Storage<ulong>> A,
	int axis = -1,
	bool descending = false,
	OutArray<ulong> sorted = null
)

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

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

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

Parameters

A: Type: ILNumerics.Core.ArraysConcreteArrayUInt64, ArrayUInt64, InArrayUInt64, OutArrayUInt64, RetArrayUInt64, StorageUInt64
Array to compute the indices for. This is not altered.
axis (Optional): Type: SystemInt32
[Optional] The working dimension. Default: (-1) sorts the last dimension.
descending (Optional): Type: SystemBoolean
[Optional] Sort in descending order. Default: (false) sort in ascending order.
sorted (Optional): Type: ILNumericsOutArrayUInt64
[Optional] Returns the sorted values of A also. Default: (null) sorted values are not returned.

Return Value

Type: RetArrayInt64

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type ConcreteArrayUInt64, ArrayUInt64, InArrayUInt64, OutArrayUInt64, RetArrayUInt64, StorageUInt64. 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(BaseArrayUInt64, 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(BaseArrayUInt64, Int32, Boolean)

MathInternal.sort(BaseArrayUInt64, OutArrayInt64, Int32, Boolean)