You are here: Start » Function Reference » Statistics » Statistics_OfArray

Statistics_OfArray

Computes basic statistical information out of an array of real numbers. The array must be not empty.

Syntax

void avl::Statistics_OfArray
(
	const atl::Array<float>& inValues,
	const int inOutlierCount,
	const bool inUseSampleFormula,
	atl::Optional<float&> outMean = atl::NIL,
	atl::Optional<float&> outMedian = atl::NIL,
	atl::Optional<float&> outStandardDeviation = atl::NIL,
	atl::Optional<float&> outMinimum = atl::NIL,
	atl::Optional<float&> outMaximum = atl::NIL,
	atl::Optional<float&> outSpread = atl::NIL,
	atl::Optional<float&> outLinearTrend = atl::NIL
)

Parameters

	Name	Type	Range	Default	Description
	inValues	const Array<float>&			Values used to compute statistical informations
	inOutlierCount	const int	0 - +	0	Defines how many outliers should be removed from the input values
	inUseSampleFormula	const bool		False	Defines, whether to use population, or sample formulas.
	outMean	Optional<float&>		NIL	Mean of the input values
	outMedian	Optional<float&>		NIL	Median of the input values
	outStandardDeviation	Optional<float&>		NIL	Standard deviation of the input values, treated as population
	outMinimum	Optional<float&>		NIL	Minimum of the input values
	outMaximum	Optional<float&>		NIL	Maximum of the input values
	outSpread	Optional<float&>		NIL	Difference between maximum and minimum of the input values
	outLinearTrend	Optional<float&>		NIL	First parameter of the linear regression function (multiplier)

Errors