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

Public Member Functions

 InterpolatedDistro1DNP (const std::vector< GridAxis > &axes, bool interpolateVertically=false)
 
 InterpolatedDistro1DNP (const InterpolatedDistro1DNP &)
 
InterpolatedDistro1DNPoperator= (const InterpolatedDistro1DNP &)
 
virtual InterpolatedDistro1DNPclone () const
 
void interpolateVertically (bool b)
 
bool interpolatingVertically () const
 
void setGridDistro (const unsigned *cell, unsigned lenCell, AbsDistribution1D *distro, bool assumeDistroOwnership=true)
 
void setLinearDistro (unsigned long idx, AbsDistribution1D *distro, bool assumeDistroOwnership=true)
 
const AbsDistribution1DgetGridDistro (const unsigned *cell, unsigned lenCell) const
 
const AbsDistribution1DgetLinearDistro (unsigned long idx) const
 
void setGridCoords (const double *coords, unsigned lenCoords)
 
unsigned nAxes () const
 
unsigned long nDistros () const
 
ArrayShape gridShape () const
 
const GridAxisgetAxis (const unsigned i) 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 InterpolatedDistro1DNPread (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
 

Member Function Documentation

◆ cdf()

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

Cumulative distribution function

Implements npstat::AbsDistribution1D.

◆ classId()

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

Prototype needed for I/O

Implements npstat::AbsDistribution1D.

◆ clone()

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

"Virtual copy constructor"

Implements npstat::AbsDistribution1D.

◆ density()

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

Probability density

Implements npstat::AbsDistribution1D.

◆ exceedance()

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

1 - cdf, avoiding subtractive cancellation

Implements npstat::AbsDistribution1D.

◆ getAxis()

const GridAxis& npstat::InterpolatedDistro1DNP::getAxis ( const unsigned  i) const
inline

The grid axis for the given coordinate

◆ getGridDistro()

const AbsDistribution1D* npstat::InterpolatedDistro1DNP::getGridDistro ( const unsigned *  cell,
unsigned  lenCell 
) const

Lookup the distribution at the given grid cell. This method returns null pointer in case the distribution has not been set for that cell.

◆ gridShape()

ArrayShape npstat::InterpolatedDistro1DNP::gridShape ( ) const
inline

The shape of the rectangular grid of parameters

◆ isEqual()

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

Comparison for equality. To be implemented by derived classes.

Implements npstat::AbsDistribution1D.

◆ nAxes()

unsigned npstat::InterpolatedDistro1DNP::nAxes ( ) const
inline

Number of gris axes

◆ nDistros()

unsigned long npstat::InterpolatedDistro1DNP::nDistros ( ) const
inline

Number of gris points (and associated distributions)

◆ quantile()

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

The quantile function

Implements npstat::AbsDistribution1D.

◆ setGridCoords()

void npstat::InterpolatedDistro1DNP::setGridCoords ( const double *  coords,
unsigned  lenCoords 
)

This method must be called before calculating the density (it will perform various preparations related to distribution interpolation). The length of the "coords" array must be equal to the number of grid axes.

◆ setGridDistro()

void npstat::InterpolatedDistro1DNP::setGridDistro ( const unsigned *  cell,
unsigned  lenCell,
AbsDistribution1D distro,
bool  assumeDistroOwnership = true 
)

Set the distribution corresponding to the given parameter grid point. This class will assume the ownership of the "distro" pointer if "assumeDistroOwnership" parameter is "true" and will copy the distribution if it is "false".

◆ setLinearDistro()

void npstat::InterpolatedDistro1DNP::setLinearDistro ( unsigned long  idx,
AbsDistribution1D distro,
bool  assumeDistroOwnership = true 
)

Same as "setGridDistro" but using a linear index for the cell


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