Class StatisticalSummaryValues
- java.lang.Object
-
- org.apache.commons.math3.stat.descriptive.StatisticalSummaryValues
-
- All Implemented Interfaces:
java.io.Serializable
,StatisticalSummary
public class StatisticalSummaryValues extends java.lang.Object implements java.io.Serializable, StatisticalSummary
Value object representing the results of a univariate statistical summary.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description private double
max
The maximum valueprivate double
mean
The sample meanprivate double
min
The minimum valueprivate long
n
The number of observations in the sampleprivate static long
serialVersionUID
Serialization idprivate double
sum
The sum of the sample valuesprivate double
variance
The sample variance
-
Constructor Summary
Constructors Constructor Description StatisticalSummaryValues(double mean, double variance, long n, double max, double min, double sum)
Constructor
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object object)
Returns true iffobject
is aStatisticalSummaryValues
instance and all statistics have the same values as this.double
getMax()
Returns the maximum of the available valuesdouble
getMean()
Returns the arithmetic mean of the available valuesdouble
getMin()
Returns the minimum of the available valueslong
getN()
Returns the number of available valuesdouble
getStandardDeviation()
Returns the standard deviation of the available values.double
getSum()
Returns the sum of the values that have been added to Univariate.double
getVariance()
Returns the variance of the available values.int
hashCode()
Returns hash code based on values of statisticsjava.lang.String
toString()
Generates a text report displaying values of statistics.
-
-
-
Field Detail
-
serialVersionUID
private static final long serialVersionUID
Serialization id- See Also:
- Constant Field Values
-
mean
private final double mean
The sample mean
-
variance
private final double variance
The sample variance
-
n
private final long n
The number of observations in the sample
-
max
private final double max
The maximum value
-
min
private final double min
The minimum value
-
sum
private final double sum
The sum of the sample values
-
-
Constructor Detail
-
StatisticalSummaryValues
public StatisticalSummaryValues(double mean, double variance, long n, double max, double min, double sum)
Constructor- Parameters:
mean
- the sample meanvariance
- the sample variancen
- the number of observations in the samplemax
- the maximum valuemin
- the minimum valuesum
- the sum of the values
-
-
Method Detail
-
getMax
public double getMax()
Description copied from interface:StatisticalSummary
Returns the maximum of the available values- Specified by:
getMax
in interfaceStatisticalSummary
- Returns:
- Returns the max.
-
getMean
public double getMean()
Description copied from interface:StatisticalSummary
Returns the arithmetic mean of the available values- Specified by:
getMean
in interfaceStatisticalSummary
- Returns:
- Returns the mean.
-
getMin
public double getMin()
Description copied from interface:StatisticalSummary
Returns the minimum of the available values- Specified by:
getMin
in interfaceStatisticalSummary
- Returns:
- Returns the min.
-
getN
public long getN()
Description copied from interface:StatisticalSummary
Returns the number of available values- Specified by:
getN
in interfaceStatisticalSummary
- Returns:
- Returns the number of values.
-
getSum
public double getSum()
Description copied from interface:StatisticalSummary
Returns the sum of the values that have been added to Univariate.- Specified by:
getSum
in interfaceStatisticalSummary
- Returns:
- Returns the sum.
-
getStandardDeviation
public double getStandardDeviation()
Description copied from interface:StatisticalSummary
Returns the standard deviation of the available values.- Specified by:
getStandardDeviation
in interfaceStatisticalSummary
- Returns:
- Returns the standard deviation
-
getVariance
public double getVariance()
Description copied from interface:StatisticalSummary
Returns the variance of the available values.- Specified by:
getVariance
in interfaceStatisticalSummary
- Returns:
- Returns the variance.
-
equals
public boolean equals(java.lang.Object object)
Returns true iffobject
is aStatisticalSummaryValues
instance and all statistics have the same values as this.- Overrides:
equals
in classjava.lang.Object
- Parameters:
object
- the object to test equality against.- Returns:
- true if object equals this
-
hashCode
public int hashCode()
Returns hash code based on values of statistics- Overrides:
hashCode
in classjava.lang.Object
- Returns:
- hash code
-
toString
public java.lang.String toString()
Generates a text report displaying values of statistics. Each statistic is displayed on a separate line.- Overrides:
toString
in classjava.lang.Object
- Returns:
- String with line feeds displaying statistics
-
-