Logo ROOT  
Reference Guide
 
Loading...
Searching...
No Matches
ROOT::Math::VavilovAccurateCdf Class Reference

Class describing the Vavilov cdf.

The probability density function of the Vavilov distribution is given by:

\[ p(\lambda; \kappa, \beta^2) = \frac{1}{2 \pi i}\int_{c-i\infty}^{c+i\infty} \phi(s) e^{\lambda s} ds\]

where \(\phi(s) = e^{C} e^{\psi(s)}\) with \( C = \kappa (1+\beta^2 \gamma )\) and

\[\psi(s) = s \ln \kappa + (s+\beta^2 \kappa) \cdot \left ( \int \limits_{0}^{1} \frac{1 - e^{\frac{-st}{\kappa}}}{t} \, dt - \gamma \right ) - \kappa \, e^{\frac{-s}{\kappa}}\]

. \( \gamma = 0.5772156649\dots\) is Euler's constant.

The parameters are:

  • 0: Norm: Normalization constant
  • 1: x0: Location parameter
  • 2: xi: Width parameter
  • 3: kappa: Parameter \(\kappa\) of the Vavilov distribution
  • 4: beta2: Parameter \(\beta^2\) of the Vavilov distribution

Benno List, June 2010

Definition at line 72 of file VavilovAccurateCdf.h.

Public Member Functions

 VavilovAccurateCdf ()
 Default constructor.
 
 VavilovAccurateCdf (const double *p)
 Constructor with parameter values.
 
 ~VavilovAccurateCdf () override
 Destructor.
 
IBaseFunctionOneDimClone () const override
 Return a clone of the object.
 
double DoEval (double x) const override
 Evaluate the function.
 
double DoEvalPar (double x, const double *p) const override
 Evaluate the function, using parameters p.
 
unsigned int NPar () const override
 Return the number of Parameters.
 
std::string ParameterName (unsigned int i) const override
 Return the name of the i-th parameter (starting from zero) Overwrite if want to avoid the default name ("Par_0, Par_1, ...")
 
const doubleParameters () const override
 Access the parameter values.
 
void SetParameters (const double *p) override
 Set the parameter values.
 
- Public Member Functions inherited from ROOT::Math::IParametricFunctionOneDim
double operator() (const double *x, const double *p) const
 multidim-like interface
 
double operator() (double x, const double *p) const
 Evaluate function at a point x and for given parameters p.
 
- Public Member Functions inherited from ROOT::Math::IBaseFunctionOneDim
 IBaseFunctionOneDim ()
 
virtual ~IBaseFunctionOneDim ()
 virtual destructor
 
double operator() (const double *x) const
 Evaluate the function at a point x[].
 
double operator() (double x) const
 Evaluate the function at a point x Use the a pure virtual private method DoEval which must be implemented by sub-classes.
 
- Public Member Functions inherited from ROOT::Math::IBaseParam
virtual ~IBaseParam ()
 Virtual Destructor (no operations)
 

Private Attributes

double fP [5]
 

Additional Inherited Members

- Public Types inherited from ROOT::Math::IParametricFunctionOneDim
typedef IBaseFunctionOneDim BaseFunc
 
- Public Types inherited from ROOT::Math::IBaseFunctionOneDim
typedef IBaseFunctionOneDim BaseFunc
 

#include <Math/VavilovAccurateCdf.h>

Inheritance diagram for ROOT::Math::VavilovAccurateCdf:
[legend]

Constructor & Destructor Documentation

◆ VavilovAccurateCdf() [1/2]

ROOT::Math::VavilovAccurateCdf::VavilovAccurateCdf ( )

Default constructor.

Definition at line 40 of file VavilovAccurateCdf.cxx.

◆ VavilovAccurateCdf() [2/2]

ROOT::Math::VavilovAccurateCdf::VavilovAccurateCdf ( const double p)

Constructor with parameter values.

Parameters
pvector of doubles containing the parameter values (Norm, x0, xi, kappa, beta2).

Definition at line 48 of file VavilovAccurateCdf.cxx.

◆ ~VavilovAccurateCdf()

ROOT::Math::VavilovAccurateCdf::~VavilovAccurateCdf ( )
override

Destructor.

Definition at line 61 of file VavilovAccurateCdf.cxx.

Member Function Documentation

◆ Clone()

IBaseFunctionOneDim * ROOT::Math::VavilovAccurateCdf::Clone ( ) const
overridevirtual

Return a clone of the object.

Implements ROOT::Math::IBaseFunctionOneDim.

Definition at line 101 of file VavilovAccurateCdf.cxx.

◆ DoEval()

double ROOT::Math::VavilovAccurateCdf::DoEval ( double  x) const
overridevirtual

Evaluate the function.

Parameters
xThe Landau parameter \(x = \lambda_L\)

Reimplemented from ROOT::Math::IParametricFunctionOneDim.

Definition at line 89 of file VavilovAccurateCdf.cxx.

◆ DoEvalPar()

double ROOT::Math::VavilovAccurateCdf::DoEvalPar ( double  x,
const double p 
) const
overridevirtual

Evaluate the function, using parameters p.

Parameters
xThe Landau parameter \(x = \lambda_L\)
pvector of doubles containing the parameter values (Norm, x0, xi, kappa, beta2).

Implements ROOT::Math::IParametricFunctionOneDim.

Definition at line 94 of file VavilovAccurateCdf.cxx.

◆ NPar()

unsigned int ROOT::Math::VavilovAccurateCdf::NPar ( ) const
overridevirtual

Return the number of Parameters.

Implements ROOT::Math::IBaseParam.

Definition at line 74 of file VavilovAccurateCdf.cxx.

◆ ParameterName()

std::string ROOT::Math::VavilovAccurateCdf::ParameterName ( unsigned int  i) const
overridevirtual

Return the name of the i-th parameter (starting from zero) Overwrite if want to avoid the default name ("Par_0, Par_1, ...")

Reimplemented from ROOT::Math::IBaseParam.

Definition at line 78 of file VavilovAccurateCdf.cxx.

◆ Parameters()

const double * ROOT::Math::VavilovAccurateCdf::Parameters ( ) const
overridevirtual

Access the parameter values.

Implements ROOT::Math::IBaseParam.

Definition at line 64 of file VavilovAccurateCdf.cxx.

◆ SetParameters()

void ROOT::Math::VavilovAccurateCdf::SetParameters ( const double p)
overridevirtual

Set the parameter values.

Parameters
pvector of doubles containing the parameter values (Norm, x0, xi, kappa, beta2).

Implements ROOT::Math::IBaseParam.

Definition at line 68 of file VavilovAccurateCdf.cxx.

Member Data Documentation

◆ fP

double ROOT::Math::VavilovAccurateCdf::fP[5]
private

Definition at line 136 of file VavilovAccurateCdf.h.

Libraries for ROOT::Math::VavilovAccurateCdf:

The documentation for this class was generated from the following files: