npstat::AbsDistributionND Class Reference

#include <AbsDistributionND.hh>

Inheritance diagram for npstat::AbsDistributionND:

Public Member Functions
	AbsDistributionND (const unsigned dim)
	AbsDistributionND (const AbsDistributionND &r)
AbsDistributionND &	operator= (const AbsDistributionND &r)
virtual AbsDistributionND *	clone () const =0
bool	operator== (const AbsDistributionND &r) const
bool	operator!= (const AbsDistributionND &r) const
unsigned	dim () const
virtual double	density (const double *x, unsigned dim) const =0
virtual void	unitMap (const double *rnd, unsigned bufLen, double *x) const =0
virtual bool	mappedByQuantiles () const =0
virtual unsigned	random (AbsRandomGenerator &g, double *x, unsigned lenX) const
virtual gs::ClassId	classId () const =0
virtual bool	write (std::ostream &) const

Static Public Member Functions
static const char *	classname ()
static unsigned	version ()
static AbsDistributionND *	read (const gs::ClassId &id, std::istream &)

Protected Member Functions
virtual bool	isEqual (const AbsDistributionND &) const =0

Protected Attributes
const unsigned	dim_

Detailed Description

All classes derived from this base should have copy constructors

Member Function Documentation

classId()

virtual gs::ClassId npstat::AbsDistributionND::classId ( ) const

pure virtual

Prototype needed for I/O

Implemented in npstat::AbsScalableDistributionND, npstat::UnitMapInterpolationND, npstat::ScalableGaussND, npstat::GridInterpolatedDistribution, npstat::EllipticalPearsonTypeII, npstat::EllipticalPearsonTypeVII, npstat::EllipticalKotz, npstat::EllipticalNormal, npstat::EllipticalDistribution, npstat::LinTransformedDistroND, npstat::BinnedDensityND, npstat::RadialProfileND, npstat::ProductSymmetricBetaND, npstat::ScalableHuberND, npstat::ScalableSymmetricBetaND, npstat::UniformND, npstat::GaussND, npstat::ProductDistributionND, npstat::DistributionMixND, npstat::TCopula, npstat::FGMCopula, npstat::GaussianCopula, npstat::CopulaInterpolationND, and npstat::CompositeDistributionND.

clone()

virtual AbsDistributionND* npstat::AbsDistributionND::clone ( ) const

pure virtual

"Virtual copy constructor"

Implemented in npstat::HomogeneousProductDistroND< SymmetricBeta1D >, npstat::AbsInterpolationAlgoND, npstat::HomogeneousProductDistroND< Distro1D >, npstat::AbsScalableDistributionND, npstat::UnitMapInterpolationND, npstat::ScalableGaussND, npstat::GridInterpolatedDistribution, npstat::EllipticalDistribution, npstat::LinTransformedDistroND, npstat::BinnedDensityND, npstat::RadialProfileND, npstat::ProductSymmetricBetaND, npstat::ScalableHuberND, npstat::ScalableSymmetricBetaND, npstat::UniformND, npstat::GaussND, npstat::ProductDistributionND, npstat::DistributionMixND, npstat::TCopula, npstat::FGMCopula, npstat::GaussianCopula, npstat::CopulaInterpolationND, and npstat::CompositeDistributionND.

density()

virtual double npstat::AbsDistributionND::density ( const double *  x, unsigned  dim  ) const

pure virtual

Probability density

Implemented in npstat::UnitMapInterpolationND, npstat::GridInterpolatedDistribution, npstat::EllipticalDistribution, npstat::LinTransformedDistroND, npstat::GaussND, npstat::ProductDistributionND, npstat::DistributionMixND, npstat::TCopula, npstat::FGMCopula, npstat::GaussianCopula, npstat::CopulaInterpolationND, npstat::CompositeDistributionND, npstat::HomogeneousProductDistroND< Distro1D >, npstat::HomogeneousProductDistroND< SymmetricBeta1D >, npstat::AbsScalableDistributionND, and npstat::EllipticalKotz.

dim()

unsigned npstat::AbsDistributionND::dim ( ) const

inline

Dimensionality of the density

mappedByQuantiles()

virtual bool npstat::AbsDistributionND::mappedByQuantiles ( ) const

pure virtual

The following method should return "true" in case the "unitMap" method is implemented by a sequence of conditional quantile functions. Distributions with such maps permit quantile-based interpolation procedures.

Implemented in npstat::AbsScalableDistributionND, npstat::UnitMapInterpolationND, npstat::ScalableGaussND, npstat::GridInterpolatedDistribution, npstat::EllipticalDistribution, npstat::LinTransformedDistroND, npstat::BinnedDensityND, npstat::RadialProfileND, npstat::ScalableHuberND, npstat::ScalableSymmetricBetaND, npstat::UniformND, npstat::GaussND, npstat::ProductDistributionND, npstat::DistributionMixND, npstat::TCopula, npstat::FGMCopula, npstat::GaussianCopula, npstat::CopulaInterpolationND, npstat::CompositeDistributionND, npstat::HomogeneousProductDistroND< Distro1D >, and npstat::HomogeneousProductDistroND< SymmetricBeta1D >.

operator!=()

bool npstat::AbsDistributionND::operator!= ( const AbsDistributionND &  r ) const

inline

Logical negation of operator==

operator==()

bool npstat::AbsDistributionND::operator==

(

const AbsDistributionND &

r

)

const

The comparison operator is needed mostly in order to support I/O testing. Because of this, do not expect it to work well for classes which do not implement the "isEqual" method. Moreover, derived classes should not implement "operator==", provide only "isEqual" if needed.

random()

virtual unsigned npstat::AbsDistributionND::random ( AbsRandomGenerator &  g, double *  x, unsigned  lenX  ) const

virtual

Random number generator according to the given distribution. Should return the number of random points used up from the generator. Length of the provided buffer "x" should be equal to the function dimensionality.

Reimplemented in npstat::EllipticalDistribution, and npstat::DistributionMixND.

unitMap()

virtual void npstat::AbsDistributionND::unitMap ( const double *  rnd, unsigned  bufLen, double *  x  ) const

pure virtual

Mapping from the unit hypercube into the density support region. Note that "bufLen" does not have to be equal to the dimensionality of the function. There may be an efficient way to generate just the leading dimensions in case "bufLen" is smaller than the dimensionality.

Implemented in npstat::GridInterpolatedDistribution, npstat::UnitMapInterpolationND, npstat::CopulaInterpolationND, npstat::CompositeDistributionND, npstat::AbsScalableDistributionND, npstat::EllipticalDistribution, npstat::LinTransformedDistroND, npstat::GaussND, npstat::ProductDistributionND, npstat::DistributionMixND, npstat::TCopula, npstat::FGMCopula, npstat::GaussianCopula, npstat::HomogeneousProductDistroND< Distro1D >, and npstat::HomogeneousProductDistroND< SymmetricBeta1D >.

---

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

• stat/AbsDistributionND.hh