org.jfree.data.statistics

Class MeanAndStandardDeviation

java.lang.Object

org.jfree.data.statistics.MeanAndStandardDeviation

All Implemented Interfaces:

Serializable

public class MeanAndStandardDeviation
extends Object
implements Serializable

A simple data structure that holds a mean value and a standard deviation value. This is used in the DefaultStatisticalCategoryDataset class.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MeanAndStandardDeviation(double mean, double standardDeviation) Creates a new mean and standard deviation record.
MeanAndStandardDeviation(Number mean, Number standardDeviation) Creates a new mean and standard deviation record.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj) Tests this instance for equality with an arbitrary object.
Number	getMean() Returns the mean.
double	getMeanValue() Returns the mean as a double primitive.
Number	getStandardDeviation() Returns the standard deviation.
double	getStandardDeviationValue() Returns the standard deviation as a double primitive.
String	toString() Returns a string representing this instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

MeanAndStandardDeviation

public MeanAndStandardDeviation(double mean,
                        double standardDeviation)

Creates a new mean and standard deviation record.

Parameters:

mean - the mean.

standardDeviation - the standard deviation.

MeanAndStandardDeviation

public MeanAndStandardDeviation(Number mean,
                        Number standardDeviation)

Creates a new mean and standard deviation record.

Parameters:

mean - the mean (null permitted).

standardDeviation - the standard deviation (null permitted.

Method Detail

getMean

public Number getMean()

Returns the mean.

Returns:

The mean.

getMeanValue

public double getMeanValue()

Returns the mean as a double primitive. If the underlying mean is null, this method will return Double.NaN.

Returns:

The mean.

Since:

1.0.7

See Also:

getMean()

getStandardDeviation

public Number getStandardDeviation()

Returns the standard deviation.

Returns:

The standard deviation.

getStandardDeviationValue

public double getStandardDeviationValue()

Returns the standard deviation as a double primitive. If the underlying standard deviation is null, this method will return Double.NaN.

Returns:

The standard deviation.

Since:

1.0.7

equals

public boolean equals(Object obj)

Tests this instance for equality with an arbitrary object.

Overrides:

equals in class Object

Parameters:

obj - the object (null permitted).

Returns:

A boolean.

toString

public String toString()

Returns a string representing this instance.

Overrides:

toString in class Object

Returns:

A string.

Since:

1.0.7