You are here: Start » Function Reference » Data Classification » Regression Analysis » Statistics_OfArray

Statistics_OfArray

Header:	FIL.h
Namespace:	fil
Module:	FoundationBasic

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

Syntax

void fil::Statistics_OfArray
(
	const ftl::Array<float>& inValues,
	const int inOutlierCount,
	const bool inUseSampleFormula,
	ftl::Optional<float&> outMean = ftl::NIL,
	ftl::Optional<float&> outMedian = ftl::NIL,
	ftl::Optional<float&> outStandardDeviation = ftl::NIL,
	ftl::Optional<float&> outMinimum = ftl::NIL,
	ftl::Optional<float&> outMaximum = ftl::NIL,
	ftl::Optional<float&> outSpread = ftl::NIL,
	ftl::Optional<float&> outLinearTrend = ftl::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)

Optional Outputs

The computation of following outputs can be switched off by passing value ftl::NIL to these parameters: outMean, outMedian, outStandardDeviation, outMinimum, outMaximum, outSpread, outLinearTrend.

Errors

List of possible exceptions:

Error type	Description
DomainError	No data available on input in Statistics_OfArray.