ExtensionMethodsnanmax Method (ConcreteArrayDouble, ArrayDouble, InArrayDouble, OutArrayDouble, RetArrayDouble, StorageDouble, NullableInt32, OutArrayInt64)

public static RetArray<double> nanmax(
	this ConcreteArray<double, Array<double>, InArray<double>, OutArray<double>, RetArray<double>, Storage<double>> A,
	Nullable<int> axis = null,
	OutArray<long> indices = null
)

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

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

returnValue = A.nanmax(axis, indices)

Parameters

A

Type: ILNumerics.Core.ArraysConcreteArrayDouble, ArrayDouble, InArrayDouble, OutArrayDouble, RetArrayDouble, StorageDouble
Array to compute the maximum(s) for. This is not altered.

axis (Optional)

Type: SystemNullableInt32
[Optional] The working dimension. Default: (null) finds the maximum within the whole array.

indices (Optional)

Type: ILNumericsOutArrayInt64
[Optional] Also return the indices of the maximum values found from A. Default: (null) indices 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.

max(ConcreteArrayDouble, ArrayDouble, InArrayDouble, OutArrayDouble, RetArrayDouble, StorageDouble, NullableInt32, OutArrayInt64) 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, max(BaseArrayDouble, OutArrayInt64, Int32, Boolean), 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