Stats.HarmonicMean Method

Definition

Namespace: Extreme.Statistics
Assembly: Extreme.Numerics (in Extreme.Numerics.dll) Version: 8.1.23

Overload List

HarmonicMean(Double[])	Returns the harmonic mean of the elements of an array.
HarmonicMean(Int32[])	Returns the harmonic mean of the elements of an array.
HarmonicMean(Vector<Double>)	Returns the harmonic mean of the elements of a vector.
HarmonicMean<T>(Vector<T>)	Returns the harmonic mean of the elements of a numerical variable.

HarmonicMean(Double[])

Returns the harmonic mean of the elements of an array.

public static double HarmonicMean(
	double[] values
)

Visual Basic

Public Shared Function HarmonicMean ( 
	values As Double()
) As Double

C++/CLI

public:
static double HarmonicMean(
	array<double>^ values
)

static member HarmonicMean : 
        values : float[] -> float

Parameters

values Double[]: A Double array.

Return Value

Double
The harmonic mean of the elements of values.

Remarks

The harmonic mean is the reciprocal of the arithmetic mean of the reciprocals of the values values.

Exceptions

ArgumentNullException

values is null.

HarmonicMean(Int32[])

Returns the harmonic mean of the elements of an array.

public static double HarmonicMean(
	int[] values
)

Visual Basic

Public Shared Function HarmonicMean ( 
	values As Integer()
) As Double

C++/CLI

public:
static double HarmonicMean(
	array<int>^ values
)

static member HarmonicMean : 
        values : int[] -> float

Parameters

values Int32[]: An Int32 array.

Return Value

Double
The harmonic mean of the elements of values.

Remarks

The harmonic mean is the reciprocal of the arithmetic mean of the reciprocals of the values values.

The harmonic mean is a Double value.

Exceptions

ArgumentNullException

values is null.

HarmonicMean(Vector<Double>)

Returns the harmonic mean of the elements of a vector.

public static double HarmonicMean(
	this Vector<double> values
)

Visual Basic

<ExtensionAttribute>
Public Shared Function HarmonicMean ( 
	values As Vector(Of Double)
) As Double

C++/CLI

public:
[ExtensionAttribute]
static double HarmonicMean(
	Vector<double>^ values
)

[<ExtensionAttribute>]
static member HarmonicMean : 
        values : Vector<float> -> float

Parameters

values Vector<Double>: A vector.

Return Value

Double
The harmonic mean of the elements of values.

Usage Note

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

Remarks

The harmonic mean is the reciprocal of the arithmetic mean of the reciprocals of the values values.

Exceptions

ArgumentNullException

values is null.

HarmonicMean<T>(Vector<T>)

Returns the harmonic mean of the elements of a numerical variable.

public static double HarmonicMean<T>(
	Vector<T> values
)

Visual Basic

Public Shared Function HarmonicMean(Of T) ( 
	values As Vector(Of T)
) As Double

C++/CLI

public:
generic<typename T>
static double HarmonicMean(
	Vector<T>^ values
)

static member HarmonicMean : 
        values : Vector<'T> -> float

Parameters

values Vector<T>: A Vector<T>.

Type Parameters

T

Return Value

Double
The harmonic mean of the elements of values.

Remarks

The harmonic mean is the reciprocal of the arithmetic mean of the reciprocals of the values values.

Exceptions

ArgumentNullException

values is null.

Stats.HarmonicMean Method

Definition

Overload List

HarmonicMean(Double[])

Parameters

Return Value

Remarks

Exceptions

HarmonicMean(Int32[])

Parameters

Return Value

Remarks

Exceptions

HarmonicMean(Vector<Double>)

Parameters

Return Value

Usage Note

Remarks

Exceptions

HarmonicMean<T>(Vector<T>)

Parameters

Type Parameters

Return Value

Remarks

Exceptions

See Also

Reference