Top Description Fields Constructors Methods
org.apache.commons.math3.stat.descriptive

public Class StatisticalSummaryValues

extends Object
implements Serializable, StatisticalSummary
Class Inheritance
All Implemented Interfaces
org.apache.commons.math3.stat.descriptive.StatisticalSummary, java.io.Serializable
Imports
java.io.Serializable, org.apache.commons.math3.util.FastMath, .MathUtils, .Precision
Value object representing the results of a univariate statistical summary.

Field Summary

Modifier and TypeField and Description
private final double
max

The maximum value

private final double
mean

The sample mean

private final double
min

The minimum value

private final long
n

The number of observations in the sample

private static final long
serialVersionUID

Serialization id

private final double
sum

The sum of the sample values

private final double
variance

The sample variance

Constructor Summary

AccessConstructor and Description
public
StatisticalSummaryValues(double
the sample mean
mean, double
the sample variance
variance, long
the number of observations in the sample
n, double
the maximum value
max, double
the minimum value
min, double
the sum of the values
sum)

Constructor

Method Summary

Modifier and TypeMethod and Description
public boolean

Returns:

true if object equals this
equals(Object
the object to test equality against.
object)

Overrides java.lang.Object.equals.

Returns true iff object is a StatisticalSummaryValues instance and all statistics have the same values as this.

public double

Returns:

Returns the max.
getMax()

Implements org.apache.commons.math3.stat.descriptive.StatisticalSummary.getMax.

Returns the maximum of the available values

public double

Returns:

Returns the mean.
getMean()

Implements org.apache.commons.math3.stat.descriptive.StatisticalSummary.getMean.

Returns the arithmetic mean of the available values

public double

Returns:

Returns the min.
getMin()

Implements org.apache.commons.math3.stat.descriptive.StatisticalSummary.getMin.

Returns the minimum of the available values

public long

Returns:

Returns the number of values.
getN()

Implements org.apache.commons.math3.stat.descriptive.StatisticalSummary.getN.

Returns the number of available values

public double

Returns:

Returns the standard deviation
getStandardDeviation()

Implements org.apache.commons.math3.stat.descriptive.StatisticalSummary.getStandardDeviation.

Returns the standard deviation of the available values.

public double

Returns:

Returns the sum.
getSum()

Implements org.apache.commons.math3.stat.descriptive.StatisticalSummary.getSum.

Returns the sum of the values that have been added to Univariate.

public double

Returns:

Returns the variance.
getVariance()

Implements org.apache.commons.math3.stat.descriptive.StatisticalSummary.getVariance.

Returns the variance of the available values.

public int

Returns:

hash code
hashCode()

Overrides java.lang.Object.hashCode.

Returns hash code based on values of statistics

public String

Returns:

String with line feeds displaying statistics
toString()

Overrides java.lang.Object.toString.

Generates a text report displaying values of statistics.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

maxback to summary
private final double max

The maximum value

meanback to summary
private final double mean

The sample mean

minback to summary
private final double min

The minimum value

nback to summary
private final long n

The number of observations in the sample

serialVersionUIDback to summary
private static final long serialVersionUID

Serialization id

sumback to summary
private final double sum

The sum of the sample values

varianceback to summary
private final double variance

The sample variance

Constructor Detail

StatisticalSummaryValuesback to summary
public StatisticalSummaryValues(double mean, double variance, long n, double max, double min, double sum)

Constructor

Parameters
mean:double

the sample mean

variance:double

the sample variance

n:long

the number of observations in the sample

max:double

the maximum value

min:double

the minimum value

sum:double

the sum of the values

Method Detail

equalsback to summary
public boolean equals(Object object)

Overrides java.lang.Object.equals.

Returns true iff object is a StatisticalSummaryValues instance and all statistics have the same values as this.

Parameters
object:Object

the object to test equality against.

Returns:boolean

true if object equals this

Annotations
@Override
getMaxback to summary
public double getMax()

Implements org.apache.commons.math3.stat.descriptive.StatisticalSummary.getMax.

Doc from org.apache.commons.math3.stat.descriptive.StatisticalSummary.getMax.

Returns the maximum of the available values

Returns:double

Returns the max.

getMeanback to summary
public double getMean()

Implements org.apache.commons.math3.stat.descriptive.StatisticalSummary.getMean.

Doc from org.apache.commons.math3.stat.descriptive.StatisticalSummary.getMean.

Returns the arithmetic mean of the available values

Returns:double

Returns the mean.

getMinback to summary
public double getMin()

Implements org.apache.commons.math3.stat.descriptive.StatisticalSummary.getMin.

Doc from org.apache.commons.math3.stat.descriptive.StatisticalSummary.getMin.

Returns the minimum of the available values

Returns:double

Returns the min.

getNback to summary
public long getN()

Implements org.apache.commons.math3.stat.descriptive.StatisticalSummary.getN.

Doc from org.apache.commons.math3.stat.descriptive.StatisticalSummary.getN.

Returns the number of available values

Returns:long

Returns the number of values.

getStandardDeviationback to summary
public double getStandardDeviation()

Implements org.apache.commons.math3.stat.descriptive.StatisticalSummary.getStandardDeviation.

Doc from org.apache.commons.math3.stat.descriptive.StatisticalSummary.getStandardDeviation.

Returns the standard deviation of the available values.

Returns:double

Returns the standard deviation

getSumback to summary
public double getSum()

Implements org.apache.commons.math3.stat.descriptive.StatisticalSummary.getSum.

Doc from org.apache.commons.math3.stat.descriptive.StatisticalSummary.getSum.

Returns the sum of the values that have been added to Univariate.

Returns:double

Returns the sum.

getVarianceback to summary
public double getVariance()

Implements org.apache.commons.math3.stat.descriptive.StatisticalSummary.getVariance.

Doc from org.apache.commons.math3.stat.descriptive.StatisticalSummary.getVariance.

Returns the variance of the available values.

Returns:double

Returns the variance.

hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Returns hash code based on values of statistics

Returns:int

hash code

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Generates a text report displaying values of statistics. Each statistic is displayed on a separate line.

Returns:String

String with line feeds displaying statistics

Annotations
@Override