ROOT::Math::VavilovAccuratePdf Class Reference

Class describing the Vavilov pdf.

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

$$p(\lambda ;\kappa ,{\beta }^2)=\frac{1}{2\pi i}{\int }_{c-i\mathrm{\infty }}^{c+i\mathrm{\infty }}\varphi (s)e^{\lambda s}ds$$

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

$$\psi (s)=s\ln \kappa +(s+{\beta }^2\kappa )\cdot (\underset{0}{\overset{1}{\int }}\frac{1-e^{\frac{-st}{\kappa }}}{t}dt-\gamma )-\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 VavilovAccuratePdf.h.

Public Member Functions
	VavilovAccuratePdf ()
	Default constructor.
	VavilovAccuratePdf (const double *p)
	Constructor with parameter values.
	~VavilovAccuratePdf () override
	Destructor.
IBaseFunctionOneDim *	Clone () 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)
const double *	Parameters () 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
virtual	~IBaseFunctionOneDim ()=default
virtual bool	HasGradient () const
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.
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/VavilovAccuratePdf.h>

Inheritance diagram for ROOT::Math::VavilovAccuratePdf:

Constructor & Destructor Documentation

VavilovAccuratePdf() [1/2]

ROOT::Math::VavilovAccuratePdf::VavilovAccuratePdf

(

)

Default constructor.

Definition at line 40 of file VavilovAccuratePdf.cxx.

VavilovAccuratePdf() [2/2]

ROOT::Math::VavilovAccuratePdf::VavilovAccuratePdf

(

const double *

p

)

Constructor with parameter values.

Parameters

p	vector of doubles containing the parameter values (Norm, x0, xi, kappa, beta2).

Definition at line 48 of file VavilovAccuratePdf.cxx.

~VavilovAccuratePdf()

ROOT::Math::VavilovAccuratePdf::~VavilovAccuratePdf ( )

override

Destructor.

Definition at line 61 of file VavilovAccuratePdf.cxx.

Member Function Documentation

Clone()

IBaseFunctionOneDim * ROOT::Math::VavilovAccuratePdf::Clone ( ) const

overridevirtual

Return a clone of the object.

Implements ROOT::Math::IBaseFunctionOneDim.

Definition at line 101 of file VavilovAccuratePdf.cxx.

DoEval()

double ROOT::Math::VavilovAccuratePdf::DoEval ( double x ) const

overridevirtual

Evaluate the function.

Parameters

x	The Landau parameter $x={\lambda }_L$

Reimplemented from ROOT::Math::IParametricFunctionOneDim.

Definition at line 89 of file VavilovAccuratePdf.cxx.

DoEvalPar()

double ROOT::Math::VavilovAccuratePdf::DoEvalPar ( double x, const double * p ) const

overridevirtual

Evaluate the function, using parameters p.

Parameters

x	The Landau parameter $x={\lambda }_L$
p	vector of doubles containing the parameter values (Norm, x0, xi, kappa, beta2).

Implements ROOT::Math::IParametricFunctionOneDim.

Definition at line 94 of file VavilovAccuratePdf.cxx.

NPar()

unsigned int ROOT::Math::VavilovAccuratePdf::NPar ( ) const

overridevirtual

Return the number of Parameters.

Implements ROOT::Math::IBaseParam.

Definition at line 74 of file VavilovAccuratePdf.cxx.

ParameterName()

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

overridevirtual

Return the name of the i-th parameter (starting from zero)

Reimplemented from ROOT::Math::IBaseParam.

Definition at line 78 of file VavilovAccuratePdf.cxx.

Parameters()

const double * ROOT::Math::VavilovAccuratePdf::Parameters ( ) const

overridevirtual

Access the parameter values.

Implements ROOT::Math::IBaseParam.

Definition at line 64 of file VavilovAccuratePdf.cxx.

SetParameters()

void ROOT::Math::VavilovAccuratePdf::SetParameters ( const double * p )

overridevirtual

Set the parameter values.

Parameters

p	vector of doubles containing the parameter values (Norm, x0, xi, kappa, beta2).

Implements ROOT::Math::IBaseParam.

Definition at line 68 of file VavilovAccuratePdf.cxx.

Member Data Documentation

fP

double ROOT::Math::VavilovAccuratePdf::fP[5]

private

Definition at line 135 of file VavilovAccuratePdf.h.

Libraries for ROOT::Math::VavilovAccuratePdf:

---

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

• math/mathmore/inc/Math/VavilovAccuratePdf.h
• math/mathmore/src/VavilovAccuratePdf.cxx