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

public Interface UnivariateStatistic

extends Function
Known Direct Subinterfaces
org.apache.commons.math3.stat.descriptive.StorelessUnivariateStatistic
Known Direct Implementers
org.apache.commons.math3.stat.descriptive.AbstractUnivariateStatistic
Imports
org.apache.commons.math3.exception.MathIllegalArgumentException, org.apache.commons.math3.util.MathArrays

Base interface implemented by all statistics.

Method Summary

Modifier and TypeMethod and Description
public UnivariateStatistic

Returns:

a copy of the statistic
copy
()

Returns a copy of the statistic with the same internal state.

public double

Returns:

the value of the statistic applied to the input array
evaluate
(double[]
input array
values
)

Redeclares org.apache.commons.math3.util.MathArrays.Function.evaluate.

Returns the result of evaluating the statistic over the input array.

public double

Returns:

the value of the statistic applied to the included array entries
evaluate
(double[]
the input array
values
,
int
the index of the first element to include
begin
,
int
the number of elements to include
length
)

Redeclares org.apache.commons.math3.util.MathArrays.Function.evaluate.

Returns the result of evaluating the statistic over the specified entries in the input array.

Method Detail

copyback to summary
public UnivariateStatistic copy()

Returns a copy of the statistic with the same internal state.

Returns:UnivariateStatistic

a copy of the statistic

evaluateback to summary
public double evaluate(double[] values) throws MathIllegalArgumentException

Redeclares org.apache.commons.math3.util.MathArrays.Function.evaluate.

Returns the result of evaluating the statistic over the input array.

Parameters
values:double[]

input array

Returns:double

the value of the statistic applied to the input array

Exceptions
MathIllegalArgumentException:
if values is null
evaluateback to summary
public double evaluate(double[] values, int begin, int length) throws MathIllegalArgumentException

Redeclares org.apache.commons.math3.util.MathArrays.Function.evaluate.

Returns the result of evaluating the statistic over the specified entries in the input array.

Parameters
values:double[]

the input array

begin:int

the index of the first element to include

length:int

the number of elements to include

Returns:double

the value of the statistic applied to the included array entries

Exceptions
MathIllegalArgumentException:
if values is null or the indices are invalid