Probabilities::CauchyCDF Function

Overload List

#SignatureDescription
1double CauchyCDF(double x, double m, double b);Cauchy cumulative distribution function (CDF).
2void CauchyCDF(TDenseMtxVec *X, double m, double b, TDenseMtxVec *Res);Cauchy CDF (vectorized).

Overload 1: double CauchyCDF(double x, double m, double b);

Cauchy cumulative distribution function (CDF).

#NameTypeDescription
1xdoubleFunction domain, real value.
2mdoubleLocation parameter, real value.
3bdoubleShape (scale) parameter, real positive value.

Returns: the Cauchy cumulative distribution function (CDF). Parameter b must be positive, otherwise the result is NAN.

Remarks:

The Cauchy cumulative distribution function is

CDF(x| m,b)=1/2+1/piarctan((x-m)/b)

Domain: x is any real value, m any real value, scale b > 0. The result lies in the open interval (0,1) and increases monotonically. For b <= 0 the result is NAN.

See Also: Probabilities::CauchyPDF, Probabilities::CauchyCDFInv
Declared in Dew::Math::Units::Probabilities · Dew.Math/Units.Probabilities.h · Cross-compiler

Overload 2: void CauchyCDF(TDenseMtxVec *X, double m, double b, TDenseMtxVec *Res);

Cauchy CDF (vectorized).

#NameTypeDescription
1XTDenseMtxVec *Defines distribution domain, real vector or matrix.
2mdoubleLocation parameter, real value.
3bdoubleShape parameter, real positive value.
4ResTDenseMtxVec *After calculation stores the CDF calculated from X, m and b. Length and Complex properties of Res are adjusted automatically to match Length and Complex properties of X.
Declared in Dew::Math::Units::Probabilities · Dew.Math/Units.Probabilities.h · Cross-compiler