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

public static RetArray<long> argmax(
	this ConcreteArray<short, Array<short>, InArray<short>, OutArray<short>, RetArray<short>, Storage<short>> A,
	Nullable<int> axis = null,
	OutArray<short> values = null
)

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

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

returnValue = A.argmax(axis, values)

Parameters

A

Type: ILNumerics.Core.Arrays.ConcreteArray<Int16, Array<Int16>, InArray<Int16>, OutArray<Int16>, RetArray<Int16>, Storage<Int16>>
Array to compute the indices for. This is not altered.

axis (Optional)

Type: System.Nullable<Int32>
[Optional] The working dimension. Default: (null) finds the maximum of the whole array.

values (Optional)

Type: ILNumerics.OutArray<Int16>
[Optional] Returns the maximum values found from A also. Default: (null) maximum values are not returned.

Return Value

Usage Note

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

argmax(ConcreteArray<Int16, Array<Int16> , InArray<Int16> , OutArray<Int16> , RetArray<Int16> , Storage<Int16> > , Nullable<Int32> , OutArray<Int16> ) 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, nanargmax(ConcreteArray<Int16, Array<Int16>, InArray<Int16>, OutArray<Int16>, RetArray<Int16>, Storage<Int16>>, Nullable<Int32>, OutArray<Int16>), ignores NaN values and gives the maximum 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