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

ILNumerics Ultimate VS Documentation

ILNumerics - Technical Application Development

[numpy API] Computes the indices of maximum elements along the specified dimension of A, ignoring 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> nanargmax(
	this ConcreteArray<uint, Array<uint>, InArray<uint>, OutArray<uint>, RetArray<uint>, Storage<uint>> A,
	Nullable<int> axis = null,
	OutArray<uint> values = null
)

<ExtensionAttribute>
Public Shared Function nanargmax ( 
	A As ConcreteArray(Of UInteger, Array(Of UInteger), InArray(Of UInteger), OutArray(Of UInteger), RetArray(Of UInteger), Storage(Of UInteger)),
	Optional axis As Nullable(Of Integer) = Nothing,
	Optional values 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 Nullable(Of Integer)
Dim values As OutArray(Of UInteger)
Dim returnValue As RetArray(Of Long)

returnValue = A.nanargmax(axis, values)

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.Nullable<Int32>
[Optional] The working dimension. Default: (null) finds the maximum of the whole array.
values (Optional): Type: ILNumerics.OutArray<UInt32>
[Optional] Returns the maximum values found from A also. Default: (null) maximum 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

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

argmax(ConcreteArray<UInt32, Array<UInt32> , InArray<UInt32> , OutArray<UInt32> , RetArray<UInt32> , Storage<UInt32> > , Nullable<Int32> , OutArray<UInt32> ) 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<UInt32, Array<UInt32>, InArray<UInt32>, OutArray<UInt32>, RetArray<UInt32>, Storage<UInt32>>, Nullable<Int32>, OutArray<UInt32>), 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.

See max(BaseArray<UInt32> , OutArray<Int64> , Int32, Boolean) for details.

[ILNumerics numpy Module]

Reference

ExtensionMethods Class

nanargmax Overload

ILNumerics Namespace

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