Click or drag to resize

DescriptiveStatistics.AbsoluteMaximumOrDefault Method (IEnumerable<Double> , Double, Boolean)

Returns the maximal absolute value in the given container.

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

Parameters

data
Type: System.Collections.Generic.IEnumerable<Double>
Reference to a container object.
defaultValue (Optional)
Type: System.Double
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: Double
The maximal value.

Usage Note

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