Click or drag to resize

DescriptiveStatisticsArithmeticMeanOrDefault Method (IEnumerableNullableDouble, Double, Boolean)
Returns the arithmetic mean of the container's values. http://en.wikipedia.org/wiki/Average#Arithmetic_mean

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

Parameters

data
Type: System.Collections.GenericIEnumerableNullableDouble
Reference to a container object.
defaultValue (Optional)
Type: SystemDouble
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: Double
The arithmetic mean.

Usage Note

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