org.perfcake.reporting.reporter.accumulator.weighted

Class WeightedMeanAccumulator

java.lang.Object

org.perfcake.reporting.reporter.accumulator.weighted.WeightedMeanAccumulator

All Implemented Interfaces:

Accumulator<WeightedValue<Double>>

public class WeightedMeanAccumulator
extends Object
implements Accumulator<WeightedValue<Double>>

Accumulates weighted mean. For values x1, x2, x3... and their respective weights w1, w2, w3... the result is (x1 * w1 + x2 * w2 + x3 * w3 + ...) / (w1 + w2 + w3 + ...).

Author:

Martin Večeřa

Constructor Summary

Constructors

Constructor and Description
WeightedMeanAccumulator()

Method Summary

Modifier and Type	Method and Description
void	add(WeightedValue<Double> value) Adds a value to the accumulator.
WeightedValue<Double>	getResult() Returns the weighted mean of all accumulated values.
void	reset() Resets the accumulator to its default state, please note that this results to the accumulated value of Double.NaN as there is nothing accumulated and no mean can be computed.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WeightedMeanAccumulator

public WeightedMeanAccumulator()

Method Detail

add

public void add(WeightedValue<Double> value)

Description copied from interface: Accumulator

Adds a value to the accumulator. This value is accumulated with the previously reported values.

Specified by:

add in interface Accumulator<WeightedValue<Double>>

Parameters:

value - The value to be accumulated.

getResult

public WeightedValue<Double> getResult()

Returns the weighted mean of all accumulated values. When there are no accumulated values, the result is Double.NaN. The weight of the result is always 1.

Specified by:

getResult in interface Accumulator<WeightedValue<Double>>

Returns:

The weighted mean of all accumulated values.

reset

public void reset()

Resets the accumulator to its default state, please note that this results to the accumulated value of Double.NaN as there is nothing accumulated and no mean can be computed.

Specified by:

reset in interface Accumulator<WeightedValue<Double>>