Click or drag to resize

DescriptiveStatisticsMaximumIndexOrDefault Method (IEnumerableNullableSingle, Int32, Boolean)
Returns the index of the maximal value in the given container.

Namespace:  FinMath.Statistics
Assembly:  FinMath (in FinMath.dll) Version: 2.4.7-0a995bd0ea1854c2c868ec3f8dae606c5777e170
Syntax
C#
Copy
public static int MaximumIndexOrDefault(
	this IEnumerable<Nullable<float>> data,
	int defaultValue = 0,
	bool checkForAbnormals = false
)

Parameters

data
Type: System.Collections.GenericIEnumerableNullableSingle
Reference to a container object.
defaultValue (Optional)
Type: SystemInt32
The default value to return of calculation fail.
checkForAbnormals (Optional)
Type: SystemBoolean
Check is array contains NaN values and properly process them.

Return Value

Type: Int32
The index of the maximal value.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IEnumerableNullableSingle. 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).
See Also