Click or drag to resize

DescriptiveStatisticsHarmonicMeanOrDefault Method (IEnumerableNullableDecimal, Decimal)

Returns the harmonic mean of the container's values. http://en.wikipedia.org/wiki/Average#Harmonic_mean

Namespace:  FinMath.Statistics
Assembly:  FinMath (in FinMath.dll) Version: 2.4.7-0a995bd0ea1854c2c868ec3f8dae606c5777e170
Syntax
C#
public static decimal HarmonicMeanOrDefault(
	this IEnumerable<Nullable<decimal>> data,
	decimal defaultValue
)

Parameters

data
Type: System.Collections.GenericIEnumerableNullableDecimal
Reference to a container object.
defaultValue
Type: SystemDecimal
The default value to return of calculation fail.

Return Value

Type: Decimal
The harmonic mean.

Usage Note

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