org.djutils.means

Class HarmonicMean<V extends Number,W extends Number>

java.lang.Object

org.djutils.means.AbstractMean<HarmonicMean<V,W>,V,W>

org.djutils.means.HarmonicMean<V,W>

Type Parameters:

V - value type

W - weight type

public class HarmonicMean<V extends Number,W extends Number>
extends AbstractMean<HarmonicMean<V,W>,V,W>

Compute the harmonic (weighted) mean of a set of values.

Copyright (c) 2013-2019 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.

Version:

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

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

Constructor Summary

Constructors

Constructor and Description
HarmonicMean()

Method Summary

Modifier and Type	Method and Description
HarmonicMean<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

HarmonicMean

public HarmonicMean()

Method Detail

getMean

public final double getMean()

Returns the weighted mean of accumulated data.

Specified by:

getMean in class AbstractMean<HarmonicMean<V extends Number,W extends Number>,V extends Number,W extends Number>

Returns:

double; weighted mean of accumulated data

addImpl

public final HarmonicMean<V,W> addImpl(V value,
                                       Number weight)

Adds a value with weight.

Specified by:

addImpl in class AbstractMean<HarmonicMean<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