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

Statistics_OfLoop

Header:	FIL.h
Namespace:	fil
Module:	FoundationBasic

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

Syntax

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

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.