ExtensionMethodsmax Method (ConcreteArrayInt32, ArrayInt32, InArrayInt32, OutArrayInt32, RetArrayInt32, StorageInt32, NullableInt32, OutArrayInt64)

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

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

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

returnValue = A.max(axis, indices)

Parameters

A

Type: ILNumerics.Core.ArraysConcreteArrayInt32, ArrayInt32, InArrayInt32, OutArrayInt32, RetArrayInt32, StorageInt32
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(ConcreteArrayInt32, ArrayInt32, InArrayInt32, OutArrayInt32, RetArrayInt32, StorageInt32, 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(BaseArrayInt32, 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