npstat::ShiftableDiscreteDistribution1D Class Reference

#include <AbsDiscreteDistribution1D.hh>

Inheritance diagram for npstat::ShiftableDiscreteDistribution1D:

Public Member Functions
	ShiftableDiscreteDistribution1D (const long location)
long	location () const
void	setLocation (const long v)
double	probability (const long x) const
double	cdf (const double x) const
double	exceedance (const double x) const
long	quantile (const double x) const
virtual ShiftableDiscreteDistribution1D *	clone () const =0
virtual gs::ClassId	classId () const =0
Public Member Functions inherited from npstat::AbsDiscreteDistribution1D
bool	operator== (const AbsDiscreteDistribution1D &r) const
bool	operator!= (const AbsDiscreteDistribution1D &r) const
virtual unsigned	random (AbsRandomGenerator &g, long *generatedRandom) const
virtual bool	write (std::ostream &) const

Protected Member Functions
virtual bool	isEqual (const AbsDiscreteDistribution1D &other) const

Additional Inherited Members
Static Public Member Functions inherited from npstat::AbsDiscreteDistribution1D
static const char *	classname ()
static unsigned	version ()
static AbsDiscreteDistribution1D *	read (const gs::ClassId &id, std::istream &is)

Detailed Description

This base class is used to model discrete distributions which have "trivial" behavior w.r.t. location parameter. That is, if the distribution density is g(x), the density with location parameter "mu" is g(x - mu).

Member Function Documentation

cdf()

double npstat::ShiftableDiscreteDistribution1D::cdf ( const double  x ) const

inlinevirtual

Cumulative distribution function

Implements npstat::AbsDiscreteDistribution1D.

classId()

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

pure virtual

Method related to "geners" I/O

Implements npstat::AbsDiscreteDistribution1D.

Implemented in npstat::DiscreteTabulated1D.

clone()

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

pure virtual

"Virtual copy constructor"

Implements npstat::AbsDiscreteDistribution1D.

Implemented in npstat::DiscreteTabulated1D.

exceedance()

double npstat::ShiftableDiscreteDistribution1D::exceedance ( const double  x ) const

inlinevirtual

1 - cdf, implementations should avoid subtractive cancellation

Implements npstat::AbsDiscreteDistribution1D.

isEqual()

virtual bool npstat::ShiftableDiscreteDistribution1D::isEqual ( const AbsDiscreteDistribution1D &  other ) const

inlineprotectedvirtual

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 classes.

Implements npstat::AbsDiscreteDistribution1D.

Reimplemented in npstat::DiscreteTabulated1D.

location()

long npstat::ShiftableDiscreteDistribution1D::location ( ) const

inline

Get the location parameter

probability()

double npstat::ShiftableDiscreteDistribution1D::probability ( const long  x ) const

inlinevirtual

Method overriden from the AbsDiscreteDistribution1D base class

Implements npstat::AbsDiscreteDistribution1D.

quantile()

long npstat::ShiftableDiscreteDistribution1D::quantile ( const double  x ) const

inlinevirtual

The quantile function

Implements npstat::AbsDiscreteDistribution1D.

setLocation()

void npstat::ShiftableDiscreteDistribution1D::setLocation ( const long  v )

inline

Set the location parameter

---

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

• stat/AbsDiscreteDistribution1D.hh