npstat is hosted by Hepforge, IPPP Durham
NPStat  5.10.0

#include <DistributionsND.hh>

Inheritance diagram for npstat::RadialProfileND:
npstat::AbsScalableDistributionND npstat::AbsDistributionND

Public Member Functions

template<typename Real >
 RadialProfileND (const double *location, const double *scale, unsigned dim, const Real *data, unsigned dataLen, unsigned interpolationDegree)
 
virtual RadialProfileNDclone () const
 
bool mappedByQuantiles () const
 
unsigned interpolationDegree () const
 
unsigned profileLength () const
 
const double * profileData () const
 
virtual gs::ClassId classId () const
 
virtual bool write (std::ostream &of) const
 
- Public Member Functions inherited from npstat::AbsScalableDistributionND
 AbsScalableDistributionND (const double *location, const double *scale, unsigned dim)
 
double location (unsigned i) const
 
double scale (unsigned i) const
 
void setLocation (unsigned i, double v)
 
void setScale (unsigned i, double v)
 
double density (const double *x, unsigned dim) const
 
void unitMap (const double *rnd, unsigned dim, double *x) const
 
- Public Member Functions inherited from npstat::AbsDistributionND
 AbsDistributionND (const unsigned dim)
 
 AbsDistributionND (const AbsDistributionND &r)
 
AbsDistributionNDoperator= (const AbsDistributionND &r)
 
bool operator== (const AbsDistributionND &r) const
 
bool operator!= (const AbsDistributionND &r) const
 
unsigned dim () const
 
virtual unsigned random (AbsRandomGenerator &g, double *x, unsigned lenX) const
 

Static Public Member Functions

static const char * classname ()
 
static unsigned version ()
 
static RadialProfileNDread (const gs::ClassId &id, std::istream &in)
 
- Static Public Member Functions inherited from npstat::AbsScalableDistributionND
static bool read (std::istream &is, unsigned *dim, std::vector< double > *locations, std::vector< double > *scales)
 
- Static Public Member Functions inherited from npstat::AbsDistributionND
static const char * classname ()
 
static unsigned version ()
 
static AbsDistributionNDread (const gs::ClassId &id, std::istream &)
 

Protected Member Functions

virtual bool isEqual (const AbsDistributionND &) const
 

Additional Inherited Members

- Protected Attributes inherited from npstat::AbsDistributionND
const unsigned dim_
 

Detailed Description

Distribution defined by the interpolation table of its radial profile

Constructor & Destructor Documentation

◆ RadialProfileND()

template<typename Real >
npstat::RadialProfileND::RadialProfileND ( const double *  location,
const double *  scale,
unsigned  dim,
const Real *  data,
unsigned  dataLen,
unsigned  interpolationDegree 
)

"location", "scale", and "dim" are the usual multivariate density parameters which define the distribution location, scale in each dimension, and the number of dimensions.

The "data" array gives density values, (d Prob)/(dx_1 ... dx_n), at equidistant radial intervals. data[0] is density at r = 0.0, and data[dataLen-1] is density at r = 1.0. If "dataLen" is less than 2, uniform distribution will be created. The total probability content will be automatically normalized to 1, so the "data" values do not have to be normalized by the user. Internally, the profile is kept in double precision.

"interpolationDegree" is the order of the radial profile interpolation polynomial. It must be less than 4 and less than "dataLen".

Member Function Documentation

◆ classId()

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

Method related to "geners" I/O

Implements npstat::AbsScalableDistributionND.

◆ clone()

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

"Virtual copy constructor"

Implements npstat::AbsScalableDistributionND.

◆ isEqual()

virtual bool npstat::RadialProfileND::isEqual ( const AbsDistributionND ) const
protectedvirtual

Derived classes should override the following method as long as they have at least one additional data member. Don't forget to call "isEqual" of the base class inside the derived class.

Reimplemented from npstat::AbsScalableDistributionND.

◆ mappedByQuantiles()

bool npstat::RadialProfileND::mappedByQuantiles ( ) const
inlinevirtual

Is the mappling from the unit cube to the support region performed by the conditional quantile functions?

Implements npstat::AbsScalableDistributionND.


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