Stats.GeometricMean Method

Definition

Namespace: Numerics.NET.Statistics
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 9.0.4

Overload List

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

GeometricMean(Double[])

Returns the geometric mean of the elements of an array.

public static double GeometricMean(
	double[] values
)

Visual Basic

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

C++/CLI

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

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

Parameters

values Double[]: A Double array.

Return Value

Double
The geometric mean of the elements of values.

Exceptions

ArgumentNullException

values is null.

GeometricMean(Int32[])

Returns the geometric mean of the elements of an array.

public static double GeometricMean(
	int[] values
)

Visual Basic

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

C++/CLI

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

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

Parameters

values Int32[]: An Int32 array.

Return Value

Double
The geometric mean of the elements of values.

Remarks

The geometric mean is a Double value.

Exceptions

ArgumentNullException	values is null.
InvalidOperationException	One or more of the values values is negative.

GeometricMean(Vector<Double>)

Returns the geometric mean of the elements of a vector.

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

Visual Basic

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

C++/CLI

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

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

Parameters

values Vector<Double>: A vector.

Return Value

Double
The geometric 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).

Exceptions

ArgumentNullException	values is null.
InvalidOperationException	One or more of the values values is negative.

GeometricMean<T>(Vector<T>)

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

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

Visual Basic

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

C++/CLI

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

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

Parameters

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

Type Parameters

T

Return Value

Double
The geometric mean of the elements of values.

Exceptions

ArgumentNullException	values is null.
InvalidOperationException	One or more of the values values is negative.

Stats.GeometricMean Method

Definition

Overload List

GeometricMean(Double[])

Parameters

Return Value

Exceptions

GeometricMean(Int32[])

Parameters

Return Value

Remarks

Exceptions

GeometricMean(Vector<Double>)

Parameters

Return Value

Usage Note

Exceptions

GeometricMean<T>(Vector<T>)

Parameters

Type Parameters

Return Value

Exceptions

See Also

Reference