Skip to main content

Zymba Documentation

Statistic

object @Statistic() {
arithmeticMean(object $values, ?object $weights): number {}
average(object $values): number {}
averageDeviation(object $values, ?number $center): number {}
centralMoment(object $values, number $order, ?number $center): number {}
count(object $values): int {}
exponentialMovingAverage(object $values, ?number $exponent): number {}
geometricMean(object $values, ?object $weights): float {}
harmonicMean(object $values, ?object $weights): number {}
kurtosisPop(object $values): number {}
kurtosisSamp(object $values): number {}
linearMovingAverage(object $values): number {}
maximum(object $values): number {}
median(object $values): number {}
medianDeviation(object $values): number {}
midrange(object $values): number {}
minimum(object $values): number {}
mode(object $values): object {}
product(object $values): number {}
quadraticMean(object $values): float {}
range(object $values): number {}
rawMoment(object $values, number $order): number {}
skewnessPop(object $values): float {}
skewnessSamp(object $values): float {}
standardDeviationPop(object $values): float {}
standardDeviationSamp(object $values): float {}
standardScore(object $values): object {}
sum(object $values): number {}
variancePop(object $values): number {}
varianceSamp(object $values): number {}
}

Static statistical functions.

Functions

Calculates the arithmetic mean of a list of values.

@Statistic.arithmeticMean(object $values, ?object $weights): number
Parameters
NameTypeValueDefault
valuesobject[value, ...][]
weights?objectunweighted
Returns
TypeValue
number
null

Calculates the average of a list of values.

@Statistic.average(object $values): number
Parameters
NameTypeValueDefault
valuesobject[value, ...][]
Returns
TypeValue
number
null

Calculates the average absolute deviation of a list of values.

@Statistic.averageDeviation(object $values, ?number $center): number
Parameters
NameTypeValueDefault
valuesobject[value, ...][]
center?numberarithmetic mean of values
Returns
TypeValue
number
null

Calculates the central moment of a list of values.

@Statistic.centralMoment(object $values, number $order, ?number $center): number
Parameters
NameTypeValueDefault
valuesobject[value, ...][]
ordernumber2
center?numberarithmetic mean of values
Returns
TypeValue
number
null

Counts the total number of values.

@Statistic.count(object $values): int
Parameters
NameTypeValueDefault
valuesobject[value, ...][]
Returns
TypeValue
int

Calculates the exponential moving average of a list of values.

@Statistic.exponentialMovingAverage(object $values, ?number $exponent): number
Parameters
NameTypeValueDefault
valuesobject[value, ...][]
exponent?number(default: 2/(N+1))null
Returns
TypeValue
number
null

Calculates the geometric mean of a list of values.

@Statistic.geometricMean(object $values, ?object $weights): float
Parameters
NameTypeValueDefault
valuesobject[value, ...][]
weights?objectunweighted
Returns
TypeValue
float
null

Calculates the harmonic mean of a list of values.

@Statistic.harmonicMean(object $values, ?object $weights): number
Parameters
NameTypeValueDefault
valuesobject[value, ...][]
weights?objectunweighted
Returns
TypeValue
number
null
@Statistic.kurtosisPop(object $values): number
Parameters
NameTypeValueDefault
valuesobject[value, ...][]
Returns
TypeValue
number
null
@Statistic.kurtosisSamp(object $values): number
Parameters
NameTypeValueDefault
valuesobject[value, ...][]
Returns
TypeValue
number
null

Calculates the linear weighted moving average of a list of values.

@Statistic.linearMovingAverage(object $values): number
Parameters
NameTypeValueDefault
valuesobject[value, ...][]
Returns
TypeValue
number
null

Measures the maximum of a list of values.

@Statistic.maximum(object $values): number
Parameters
NameTypeValueDefault
valuesobject[value, ...][]
Returns
TypeValue
number
null

Measures the median of a list of values.

@Statistic.median(object $values): number
Parameters
NameTypeValueDefault
valuesobject[value, ...][]
Returns
TypeValue
number
null

Calculates the median absolute deviation of a list of values.

@Statistic.medianDeviation(object $values): number
Parameters
NameTypeValueDefault
valuesobject[value, ...][]
Returns
TypeValue
number
null

Measures the mid-range of a list of values.

@Statistic.midrange(object $values): number
Parameters
NameTypeValueDefault
valuesobject[value, ...][]
Returns
TypeValue
number
null

Measures the minimum of a list of values.

@Statistic.minimum(object $values): number
Parameters
NameTypeValueDefault
valuesobject[value, ...][]
Returns
TypeValue
number
null

Measures the mode of a list of values.

@Statistic.mode(object $values): object
Parameters
NameTypeValueDefault
valuesobject[value, ...][]
Returns
TypeValue
object[number, ...]

Calculates the product of a list of values.

@Statistic.product(object $values): number
Parameters
NameTypeValueDefault
valuesobject[value, ...][]
Returns
TypeValue
number
null

Calculates the quadratic mean of a list of values.

@Statistic.quadraticMean(object $values): float
Parameters
NameTypeValueDefault
valuesobject[value, ...][]
Returns
TypeValue
float
null

Measures the range of a list of values.

@Statistic.range(object $values): number
Parameters
NameTypeValueDefault
valuesobject[value, ...][]
Returns
TypeValue
number
null

Calculates the raw moment of a list of values.

@Statistic.rawMoment(object $values, number $order): number
Parameters
NameTypeValueDefault
valuesobject[value, ...][]
ordernumber2
Returns
TypeValue
number
null
@Statistic.skewnessPop(object $values): float
Parameters
NameTypeValueDefault
valuesobject[value, ...][]
Returns
TypeValue
float
null
@Statistic.skewnessSamp(object $values): float
Parameters
NameTypeValueDefault
valuesobject[value, ...][]
Returns
TypeValue
float
null

Calculates the population standard deviation of a list of values.

@Statistic.standardDeviationPop(object $values): float
Parameters
NameTypeValueDefault
valuesobject[value, ...][]
Returns
TypeValue
float
null

Calculates the sample standard deviation of a list of values.

@Statistic.standardDeviationSamp(object $values): float
Parameters
NameTypeValueDefault
valuesobject[value, ...][]
Returns
TypeValue
float
null

Calculates the standard scores for a list of values.

@Statistic.standardScore(object $values): object
Parameters
NameTypeValueDefault
valuesobject[value, ...][]
Returns
TypeValue
object[score, ...]

Sums up a list of values.

@Statistic.sum(object $values): number
Parameters
NameTypeValueDefault
valuesobject[value, ...][]
Returns
TypeValue
number
null

Calculates the population variance of a list of values.

@Statistic.variancePop(object $values): number
Parameters
NameTypeValueDefault
valuesobject[value, ...][]
Returns
TypeValue
number
null

Calculates the sample variance of a list of values.

@Statistic.varianceSamp(object $values): number
Parameters
NameTypeValueDefault
valuesobject[value, ...][]
Returns
TypeValue
number
null