DescriptiveStatisticsHarmonicMeanOrDefault Method (IEnumerableNullableInt32, Double)

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

Copy

public static double HarmonicMeanOrDefault(
	this IEnumerable<Nullable<int>> data,
	double defaultValue
)

Parameters

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

Return Value

Type: Double
The harmonic mean.

Usage Note

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

Reference

DescriptiveStatistics Class

HarmonicMeanOrDefault Overload

FinMath.Statistics Namespace