ILMathmaxall Method (ConcreteArraycomplex, Arraycomplex, InArraycomplex, OutArraycomplex, RetArraycomplex, Storagecomplex, OutArrayInt64, StorageOrders, Boolean)

public static RetArray<complex> maxall(
	ConcreteArray<complex, Array<complex>, InArray<complex>, OutArray<complex>, RetArray<complex>, Storage<complex>> A,
	OutArray<long> index = null,
	StorageOrders order = StorageOrders.ColumnMajor,
	bool ignoreNaN = true
)

Public Shared Function maxall ( 
	A As ConcreteArray(Of complex, Array(Of complex), InArray(Of complex), OutArray(Of complex), RetArray(Of complex), Storage(Of complex)),
	Optional index As OutArray(Of Long) = Nothing,
	Optional order As StorageOrders = StorageOrders.ColumnMajor,
	Optional ignoreNaN As Boolean = true
) As RetArray(Of complex)

Dim A As ConcreteArray(Of complex, Array(Of complex), InArray(Of complex), OutArray(Of complex), RetArray(Of complex), Storage(Of complex))
Dim index As OutArray(Of Long)
Dim order As StorageOrders
Dim ignoreNaN As Boolean
Dim returnValue As RetArray(Of complex)

returnValue = ILMath.maxall(A, index, 
	order, ignoreNaN)

Parameters

A

Type: ILNumerics.Core.ArraysConcreteArraycomplex, Arraycomplex, InArraycomplex, OutArraycomplex, RetArraycomplex, Storagecomplex
Array to compute the maximum for. This is not altered.

index (Optional)

Type: ILNumericsOutArrayInt64
[Optional] index of the maximum value. Default: (null) the index is not returned.

order (Optional)

Type: ILNumericsStorageOrders
[Optional] iteration order for the flattened sequential indices. Default: ColumnMajor.

ignoreNaN (Optional)

Type: SystemBoolean
[Optional] determins how NaN values are handled for floating point element types. Ignored for integer elements. Defaul: (true) ignores NaNs.

Return Value

See max(BaseArraycomplex, OutArrayInt64, Int32, Boolean) for getting the maximum values along a specific dimension.

The functions 'max','min','maxall','minall' give all similar results between the framework APIs (ILNumericsV4/Matlab(R) / numpy) but show individual behavior regarding the handling of floating point NaN values and iteration order. The value of 'true' for ignoreNaN corresponds to the behavior of ILNumerics version 4/ Matlab(R). Only if all elements in A are NaN the value of the result will also be NaN. This is the default.

The value of 'false' for ignoreNaN gives the numpy behavior: NaN values take precedence over non-NaN values. If one element in the set of values is NaN the result will also be NaN. This is the default behavior for such functions defined as [numpy API] extension methods on the array classes.

[ILNumerics Computing Engine]

Reference