DescriptiveStatisticsGeometricMeanOrDefault Method (Vector, Double, Boolean)
|
Returns the geometric mean of the container's values.
http://en.wikipedia.org/wiki/Average#Geometric_mean
Namespace:
FinMath.Statistics
Assembly:
FinMath (in FinMath.dll) Version: 2.4.7-0a995bd0ea1854c2c868ec3f8dae606c5777e170
Syntax public static double GeometricMeanOrDefault(
this Vector dataVector,
double defaultValue,
bool checkForAbnormals = false
)
Parameters
- dataVector
- Type: FinMath.LinearAlgebraVector
Reference to a container object. - defaultValue
- 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:
DoubleThe geometric mean.
Usage Note
In Visual Basic and C#, you can call this method as an instance method on any object of type
Vector. 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