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

LinearRegression_M

This is Filter Equivalent. This function may be present in generated code, but should not be used in hand-written code.

Computes linear regression of given point set using selected M-estimator for outlier suppression.

Syntax

void avl::LinearRegression_M
(
	const atl::Array<atl::real>& inYValues,
	const atl::Optional<atl::Array<atl::real> >& inXValues,
	avl::MEstimator::Type inOutlierSuppression,
	atl::real inClippingFactor,
	int inIterationCount,
	atl::Optional<const avl::LinearFunction&> inInitialLinearFunction,
	avl::LinearFunction& outLinearFunction,
	atl::Array<atl::real>& outEstimatedValues,
	atl::Array<atl::real>& outResiduals
)

Parameters

	Name	Type	Range	Default	Description
	inYValues	const Array<real>&			Sequence of ordinates
	inXValues	const Optional<Array<real> >&		NIL	Sequence of abscissae, or {0, 1, 2, ...} by default
	inOutlierSuppression	MEstimator::Type
	inClippingFactor	real	0.675 - 6.0	2.5f	Multitude of standard deviation within which points are considered inliers
	inIterationCount	int	0 -	5	Number of iterations of outlier suppressing algorithm
	inInitialLinearFunction	Optional<const LinearFunction&>		NIL	Initial approximation of the output linear function (if available)
	outLinearFunction	LinearFunction&			Linear function approximating the given point set
	outEstimatedValues	Array<real>&			The result of application of the computed function to the X values
	outResiduals	Array<real>&			Difference between an input Y value and the corresponding estimated value

Errors