ILNumerics Ultimate VS

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

ILNumerics Ultimate VS Documentation
ILNumerics - Technical Application Development
[numpy API] Computes maximum elements along the specified dimension of A, recognizing NaNs.

[ILNumerics numpy Module]

Namespace:  ILNumerics
Assembly:  ILNumerics.numpy (in ILNumerics.numpy.dll) Version: 5.5.0.0 (5.5.7514.3148)
Syntax

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

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

Type: RetArrayDouble

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type ConcreteArrayDouble, ArrayDouble, InArrayDouble, OutArrayDouble, RetArrayDouble, StorageDouble. 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.

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]

See Also

Reference

MathInternal.max(BaseArrayDouble, OutArrayInt64, Int32, Boolean)
ExtensionMethodsargmax(ConcreteArrayDouble, ArrayDouble, InArrayDouble, OutArrayDouble, RetArrayDouble, StorageDouble, NullableInt32, OutArrayDouble)
MathInternal.maxall(ConcreteArrayDouble, ArrayDouble, InArrayDouble, OutArrayDouble, RetArrayDouble, StorageDouble, OutArrayInt64, StorageOrders, Boolean)
MathInternal.minall(ConcreteArrayDouble, ArrayDouble, InArrayDouble, OutArrayDouble, RetArrayDouble, StorageDouble, OutArrayInt64, StorageOrders, Boolean)