Back to Aurora Vision Library website

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

Statistics_OfArray


Header: AVL.h
Namespace: avl
Module: FoundationBasic

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

Syntax

C++
C#
 
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
Input value inValues const Array<float>& Values used to compute statistical informations
Input value inOutlierCount const int 0 - + 0 Defines how many outliers should be removed from the input values
Input value inUseSampleFormula const bool False Defines, whether to use population, or sample formulas.
Output value outMean Optional<float&> NIL Mean of the input values
Output value outMedian Optional<float&> NIL Median of the input values
Output value outStandardDeviation Optional<float&> NIL Standard deviation of the input values, treated as population
Output value outMinimum Optional<float&> NIL Minimum of the input values
Output value outMaximum Optional<float&> NIL Maximum of the input values
Output value outSpread Optional<float&> NIL Difference between maximum and minimum of the input values
Output value 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 atl::NIL to these parameters: outMean, outMedian, outStandardDeviation, outMinimum, outMaximum, outSpread, outLinearTrend.

Read more about Optional Outputs.

Errors

List of possible exceptions:

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