GeometricMeanCalculator (OpenGamma Strata Math API)

java.lang.Object
- com.opengamma.strata.math.impl.statistics.descriptive.GeometricMeanCalculator

All Implemented Interfaces:

Function<double[],Double>
```
public class GeometricMeanCalculator
extends Object
implements Function<double[],Double>
```
Calculates the geometric mean of a series of data.
The geometric mean $\mu$ of a series of elements $x_1, x_2, \dots, x_n$ is given by: $$ \begin{align*} \mu = \left({\prod\limits_{i=1}^n x_i}\right)^{\frac{1}{n}} \end{align*} $$

- Constructor Summary
  
  Constructors
  Constructor and Description
  
  GeometricMeanCalculator()
- Method Summary
  
  All Methods Instance Methods Concrete Methods
  Modifier and Type Method and Description
  
  Double apply(double[] x)
  - Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  - Methods inherited from interface java.util.function.Function
    andThen, compose, identity

Constructors
Constructor and Description
`GeometricMeanCalculator()`

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Double`	`apply(double[] x)`

- Constructor Detail
  - GeometricMeanCalculator
```
public GeometricMeanCalculator()
```
- Method Detail
  - apply
```
public Double apply(double[] x)
```
    Specified by:
    
    apply in interface Function<double[],Double>
    
    Parameters:
    
    x - The array of data, not null or empty
    
    Returns:
    
    The geometric mean

Copyright 2009-Present by OpenGamma Inc. and individual contributors
Apache v2 licensed
Additional documentation can be found at strata.opengamma.io.

Class GeometricMeanCalculator

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.function.Function

Constructor Detail

GeometricMeanCalculator

Method Detail

apply