org.conqat.lib.commons.math

Class StdDevAggregator

java.lang.Object

org.conqat.lib.commons.math.StdDevAggregator

All Implemented Interfaces:

IAggregator

public class StdDevAggregator
extends java.lang.Object
implements IAggregator

Calculates the standard deviation. This calculation is based on VarianceAggregator.

Constructor Summary

Constructors

Constructor and Description
StdDevAggregator(boolean sample) Constructor.

Method Summary

Modifier and Type	Method and Description
double	aggregate(java.util.Collection<? extends java.lang.Number> values) Aggregates by finding the average value
double	getNeutralElement() Returns Double.NaN.

Methods inherited from class java.lang.Object

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

Constructor Detail

StdDevAggregator

public StdDevAggregator(boolean sample)

Constructor.

Parameters:

sample - if true sample standard deviation is calculated, population standard deviation otherwise.

Method Detail

aggregate

public double aggregate(java.util.Collection<? extends java.lang.Number> values)

Aggregates by finding the average value

Specified by:

aggregate in interface IAggregator

Returns:

Double.NaN for empty input collection

getNeutralElement

public double getNeutralElement()

Returns Double.NaN.

Specified by:

getNeutralElement in interface IAggregator