ExtensionMethods.argmin Method (ConcreteArray<Byte, Array<Byte>, InArray<Byte>, OutArray<Byte>, RetArray<Byte>, Storage<Byte>>, Nullable<Int32>, OutArray<Byte>)

ILNumerics Ultimate VS Documentation

ILNumerics - Technical Application Development

[numpy API] Computes indices of minimum elements along the specified dimension of A, recognizing NaNs.

[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> argmin(
	this ConcreteArray<byte, Array<byte>, InArray<byte>, OutArray<byte>, RetArray<byte>, Storage<byte>> A,
	Nullable<int> axis = null,
	OutArray<byte> values = null
)

<ExtensionAttribute>
Public Shared Function argmin ( 
	A As ConcreteArray(Of Byte, Array(Of Byte), InArray(Of Byte), OutArray(Of Byte), RetArray(Of Byte), Storage(Of Byte)),
	Optional axis As Nullable(Of Integer) = Nothing,
	Optional values As OutArray(Of Byte) = Nothing
) As RetArray(Of Long)

Dim A As ConcreteArray(Of Byte, Array(Of Byte), InArray(Of Byte), OutArray(Of Byte), RetArray(Of Byte), Storage(Of Byte))
Dim axis As Nullable(Of Integer)
Dim values As OutArray(Of Byte)
Dim returnValue As RetArray(Of Long)

returnValue = A.argmin(axis, values)

Parameters

A: Type: ILNumerics.Core.Arrays.ConcreteArray<Byte, Array<Byte>, InArray<Byte>, OutArray<Byte>, RetArray<Byte>, Storage<Byte>>
Array to compute the indices for. This is not altered.
axis (Optional): Type: System.Nullable<Int32>
[Optional] The working dimension. Default: (null) finds the minimum of the whole array.
values (Optional): Type: ILNumerics.OutArray<Byte>
[Optional] Returns the minimum values found from A also. Default: (null) minimum 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<Byte, Array<Byte>, InArray<Byte>, OutArray<Byte>, RetArray<Byte>, Storage<Byte>>. 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

Negative dimension specifier 'axis' will be shifted into the range of valid dimension indices. -1 corresponds to the last dimension.

argmin(ConcreteArray<Byte, Array<Byte> , InArray<Byte> , OutArray<Byte> , RetArray<Byte> , Storage<Byte> > , Nullable<Int32> , OutArray<Byte> ) prioritizes NaN values over non-NaN values. I.e.: if any of the elements is NaN the respective result value will be NaN also. Conversely, nanargmin(ConcreteArray<Byte, Array<Byte>, InArray<Byte>, OutArray<Byte>, RetArray<Byte>, Storage<Byte>>, Nullable<Int32>, OutArray<Byte>), ignores NaN values and gives the minimum among the non-NaN values, if possible. This corresponds to the behavior of ILNumerics version 4, Matlab(R) a.s.f.

[ILNumerics numpy Module]

Reference

ExtensionMethods Class

argmin Overload

ILNumerics Namespace

MathInternal.min(BaseArray<Byte>, OutArray<Int64>, Int32, Boolean)

MathInternal.minall(ConcreteArray<Byte, Array<Byte>, InArray<Byte>, OutArray<Byte>, RetArray<Byte>, Storage<Byte>>, OutArray<Int64>, StorageOrders, Boolean)

ExtensionMethods.nanargmin(ConcreteArray<Byte, Array<Byte>, InArray<Byte>, OutArray<Byte>, RetArray<Byte>, Storage<Byte>>, Nullable<Int32>, OutArray<Byte>)

ExtensionMethods.argmin(ConcreteArray<Byte, Array<Byte>, InArray<Byte>, OutArray<Byte>, RetArray<Byte>, Storage<Byte>>, Nullable<Int32>, OutArray<Byte>)