You are here: Start » Function Reference » Regression Analysis » Statistics_OfLoop

Statistics_OfLoop

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

Header:	AVL.h

Syntax

void avl::Statistics_OfLoop
(
	Statistics_OfLoopState& ioState,
	const float inValue,
	const int inBufferSize,
	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
)

void Statistics_OfLoop
(
	ref Statistics_OfLoopState ioState,
	float inValue,
	int inBufferSize,
	int inOutlierCount,
	bool inUseSampleFormula,
	out float? outMean,
	out float? outMedian,
	out float? outStandardDeviation,
	out float? outMinimum,
	out float? outMaximum,
	out float? outSpread,
	out float? outLinearTrend
)

Parameters

Name	Type	Range	Default	Description
ioState	Statistics_OfLoopState&			Object used to maintain state of the function.
inValue	const float			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
inUseSampleFormula	const bool			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
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)