Probabilities::GenParetoCDF Function

double GenParetoCDF(double x, double k, double Mu, double sigma);

Generalized Pareto (GPD) cumulative distribution function (CDF).

#NameTypeDescription
1xdoubleDistribution domain, real value; if k >= 0 valid on (Mu, +Inf), if k < 0 valid when 0 <= (x-Mu)/sigma <= -1/k.
2kdoubleDistribution shape parameter, real value.
3MudoubleDistribution location parameter, real value.
4sigmadoubleDistribution scale parameter, positive real value (sigma>0).

Returns: the Generalized Pareto CDF for value x using shape k, location Mu and positive scale sigma. Returns NaN if sigma<=0, if (x-Mu)/sigma<0, or (for k<0) if 1+k(x-Mu)/sigma<=0.

Remarks:

With z=(x-mu)/sigma the Generalized Pareto CDF is

CDF(x | k,mu,sigma) = { 1-(1+k z)^(-1/k),  if k != 0
                      { [1.2ex] 1-exp[-z],  if k=0   ,   z=(x-mu)/sigma .

This shape convention matches scipy.stats genpareto with c=k. It is monotone non-decreasing. Returns NaN for sigma<=0, for z<0, or when 1+k z <= 0 for k < 0.

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