GeometricMean (DJUTILS - Delft Java Utilities 1.06.25 API)

java.lang.Object
- org.djutils.means.AbstractMean<GeometricMean<V,W>,V,W>
- - org.djutils.means.GeometricMean<V,W>

Type Parameters:

V - value type

W - weight type
```
public class GeometricMean<V extends Number,W extends Number>
extends AbstractMean<GeometricMean<V,W>,V,W>
```
Compute the geometric (weighted) mean of a set of values. Geometric mean can not handle negative or zero values.
Copyright (c) 2013-2016 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See DJUTILS License.

Version:

$Revision$, $LastChangedDate$, by $Author$, initial version Oct 26, 2018

Author:

Alexander Verbraeck, Peter Knoppers

Constructor Summary

Constructors
Constructor Description

GeometricMean()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`GeometricMean<V,W>`	`addImpl(V value, Number weight)`	Adds a value with weight.
`double`	`getMean()`	Returns the weighted mean of accumulated data.
`String`	`toString()`

Methods inherited from class org.djutils.means.AbstractMean
add, add, add, add, add, add, add, add, add, getSum, getSumOfWeights, increment

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - GeometricMean
```
public GeometricMean()
```
- Method Detail
  - getMean
```
public final double getMean()
```
    Returns the weighted mean of accumulated data.
    
    Specified by:
    
    getMean in class AbstractMean<GeometricMean<V extends Number,W extends Number>,V extends Number,W extends Number>
    
    Returns:
    
    double; weighted mean of accumulated data
  - addImpl
```
public final GeometricMean<V,W> addImpl(V value,
                                              Number weight)
```
    Adds a value with weight.
    
    Specified by:
    
    addImpl in class AbstractMean<GeometricMean<V extends Number,W extends Number>,V extends Number,W extends Number>
    
    Parameters:
    
    value - V; the value
    
    weight - Number; the weight
    
    Returns:
    
    this AbstractMean<MT, V, W>; for method chaining
  - toString
```
public final String toString()
```
    Overrides:
    
    toString in class Object