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

Statistics_OfLoop

Computes basic statistical information out of real numbers appearing in consecutive iterations.

Syntax

void avl::Statistics_OfLoop
(
	Statistics_OfLoopState& ioState,
	const atl::real inValue,
	const int inBufferSize,
	const int inOutlierCount,
	atl::Optional<atl::real&> outMean = atl::NIL,
	atl::Optional<atl::real&> outMedian = atl::NIL,
	atl::Optional<atl::real&> outStandardDeviation = atl::NIL,
	atl::Optional<atl::real&> outMinimum = atl::NIL,
	atl::Optional<atl::real&> outMaximum = atl::NIL,
	atl::Optional<atl::real&> outSpread = atl::NIL,
	atl::Optional<atl::real&> outLinearTrend = atl::NIL
)

Parameters

	Name	Type	Range	Default	Description
	ioState	Statistics_OfLoopState&			Object used to maintain state of the function.
	inValue	const real			Value used to compute statistical informations
	inBufferSize	const int	1 - +	10	Defines how many numbers are taken into account
	inOutlierCount	const int	0 - +	0	Defines how many outliers should be removed from the input values
	outMean	Optional<real&>		NIL	Mean of the input values
	outMedian	Optional<real&>		NIL	Median of the input values
	outStandardDeviation	Optional<real&>		NIL	Standard deviation of the input values
	outMinimum	Optional<real&>		NIL	Minimum of the input values
	outMaximum	Optional<real&>		NIL	Maximum of the input values
	outSpread	Optional<real&>		NIL	Difference between maximum and minimum of the input values
	outLinearTrend	Optional<real&>		NIL	First parameter of the linear regression function (multiplier)