gov.sandia.cognition.math

Class NumberAverager

java.lang.Object

gov.sandia.cognition.util.AbstractCloneableSerializable

gov.sandia.cognition.math.NumberAverager

All Implemented Interfaces:

CloneableSerializable, Summarizer<java.lang.Number,java.lang.Double>, java.io.Serializable, java.lang.Cloneable

@CodeReview(reviewer="Kevin R. Dixon",
            date="2008-02-26",
            changesNeeded=false,
            comments={"Made some of the javadoc more descriptive","Otherwise, looks good."})
public class NumberAverager
extends AbstractCloneableSerializable
implements Summarizer<java.lang.Number,java.lang.Double>

Returns an average (arithmetic mean) of a collection of Numbers

Since:

2.0

Author:

Kevin R. Dixon

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static NumberAverager	INSTANCE Instance of NumberAverager, since it has no state.

Constructor Summary

Constructors

Constructor and Description
NumberAverager() Creates a new instance of NumberAverager

Method Summary

Modifier and Type	Method and Description
java.lang.Double	summarize(java.util.Collection<? extends java.lang.Number> data) Returns the average (arithmetic mean) of a Collection of Numbers, or null if the collection of Numbers are null

Methods inherited from class gov.sandia.cognition.util.AbstractCloneableSerializable

clone

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final NumberAverager INSTANCE

Instance of NumberAverager, since it has no state.

Constructor Detail

NumberAverager

public NumberAverager()

Creates a new instance of NumberAverager

Method Detail

summarize

public java.lang.Double summarize(java.util.Collection<? extends java.lang.Number> data)

Returns the average (arithmetic mean) of a Collection of Numbers, or null if the collection of Numbers are null

Specified by:

summarize in interface Summarizer<java.lang.Number,java.lang.Double>

Parameters:

data - Collection of Number to compute the average of

Returns:

Average (arithmetic mean) of the data, null if no Numbers are given