npstat is hosted by Hepforge, IPPP Durham
NPStat  5.10.0
Inheritance diagram for npstat::InterpolatedDistro1D1P:
npstat::AbsDistribution1D

Public Member Functions

 InterpolatedDistro1D1P (const GridAxis &axis, const std::vector< CPP11_shared_ptr< const AbsDistribution1D > > &distros, double initialParameterValue=0.0, bool interpolateVertically=false)
 
 InterpolatedDistro1D1P (const GridAxis &axis, bool interpolateVertically=false)
 
 InterpolatedDistro1D1P (const InterpolatedDistro1D1P &)
 
InterpolatedDistro1D1Poperator= (const InterpolatedDistro1D1P &)
 
void setGridDistro (unsigned cell, const AbsDistribution1D &distro)
 
void setParameter (double value)
 
double getParameter () const
 
const GridAxisgetAxis () const
 
unsigned nDistros () const
 
void interpolateVertically (bool b)
 
bool interpolatingVertically () const
 
virtual InterpolatedDistro1D1Pclone () const
 
double density (const double x) const
 
double cdf (const double x) const
 
double exceedance (const double x) const
 
double quantile (const double x) const
 
virtual gs::ClassId classId () const
 
virtual bool write (std::ostream &) const
 
- Public Member Functions inherited from npstat::AbsDistribution1D
bool operator== (const AbsDistribution1D &r) const
 
bool operator!= (const AbsDistribution1D &r) const
 
virtual unsigned random (AbsRandomGenerator &g, double *generatedRandom) const
 
long double empiricalMoment (long double center, unsigned order, unsigned nIntegrationPoints=1024U, bool useFejerQuadrature=false) const
 
template<class Functor >
double expectation (const Functor &fcn, unsigned nIntegrationPoints=1024U, bool useFejerQuadrature=false) const
 

Static Public Member Functions

static const char * classname ()
 
static unsigned version ()
 
static InterpolatedDistro1D1Pread (const gs::ClassId &id, std::istream &in)
 
- Static Public Member Functions inherited from npstat::AbsDistribution1D
static const char * classname ()
 
static unsigned version ()
 
static AbsDistribution1Dread (const gs::ClassId &id, std::istream &)
 

Protected Member Functions

virtual bool isEqual (const AbsDistribution1D &) const
 

Constructor & Destructor Documentation

◆ InterpolatedDistro1D1P() [1/2]

npstat::InterpolatedDistro1D1P::InterpolatedDistro1D1P ( const GridAxis axis,
const std::vector< CPP11_shared_ptr< const AbsDistribution1D > > &  distros,
double  initialParameterValue = 0.0,
bool  interpolateVertically = false 
)

This constructor builds an object which is ready to use. The "distros" argument must provide one distribution for each grid cell.

◆ InterpolatedDistro1D1P() [2/2]

npstat::InterpolatedDistro1D1P::InterpolatedDistro1D1P ( const GridAxis axis,
bool  interpolateVertically = false 
)
explicit

If this constructor is used, the object must be built incrementally, using "setGridDistro" calls, one call for each grid cell. After all distributions have been set, provide the parameter value with "setParameter". Only then one can call methods "density", etc.

Member Function Documentation

◆ cdf()

double npstat::InterpolatedDistro1D1P::cdf ( const double  x) const
inlinevirtual

Cumulative distribution function

Implements npstat::AbsDistribution1D.

◆ classId()

virtual gs::ClassId npstat::InterpolatedDistro1D1P::classId ( ) const
inlinevirtual

Prototype needed for I/O

Implements npstat::AbsDistribution1D.

◆ clone()

virtual InterpolatedDistro1D1P* npstat::InterpolatedDistro1D1P::clone ( ) const
inlinevirtual

"Virtual copy constructor"

Implements npstat::AbsDistribution1D.

◆ density()

double npstat::InterpolatedDistro1D1P::density ( const double  x) const
inlinevirtual

Probability density

Implements npstat::AbsDistribution1D.

◆ exceedance()

double npstat::InterpolatedDistro1D1P::exceedance ( const double  x) const
inlinevirtual

1 - cdf, known as "survival function" or "exceedance". Implementations should avoid subtractive cancellation.

Implements npstat::AbsDistribution1D.

◆ getParameter()

double npstat::InterpolatedDistro1D1P::getParameter ( ) const
inline

Get the value of the parameter

◆ isEqual()

virtual bool npstat::InterpolatedDistro1D1P::isEqual ( const AbsDistribution1D ) const
protectedvirtual

Comparison for equality. To be implemented by derived classes.

Implements npstat::AbsDistribution1D.

◆ quantile()

double npstat::InterpolatedDistro1D1P::quantile ( const double  x) const
inlinevirtual

The quantile function (inverse cdf)

Implements npstat::AbsDistribution1D.

◆ setGridDistro()

void npstat::InterpolatedDistro1D1P::setGridDistro ( unsigned  cell,
const AbsDistribution1D distro 
)

Set the distribution corresponding to the given grid point

◆ setParameter()

void npstat::InterpolatedDistro1D1P::setParameter ( double  value)

Set the value of the parameter


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