Click or drag to resize

DescriptiveStatistics.AbsoluteMinimumIndexOrDefault Method (IEnumerable<Nullable<Single> > , Int32, Boolean)
Returns the index of the minimal absolute value in the given container.

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

Parameters

data
Type: System.Collections.Generic.IEnumerable<Nullable<Single>>
Reference to a container object.
defaultValue (Optional)
Type: System.Int32
The default value to return of calculation fail.
checkForAbnormals (Optional)
Type: System.Boolean
Check is array contains NaN values and properly process them.

Return Value

Type: Int32
The index of the minimal value.

Usage Note

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