LTI-Lib latest version v1.9 - last update 10 Apr 2010

lti::gammaDistribution Class Reference

Gamma distributed random number class. More...

#include <ltiGammaDist.h>

Inheritance diagram for lti::gammaDistribution:
Inheritance graph
[legend]
Collaboration diagram for lti::gammaDistribution:
Collaboration graph
[legend]

List of all members.

Classes

class  parameters
 parameters for the gamma distribution More...

Public Member Functions

 gammaDistribution ()
 gammaDistribution (const parameters &theParams)
 gammaDistribution (const int theOrder)
virtual ~gammaDistribution ()
const parametersgetParameters () const
virtual double draw () const
virtual functorclone () const
virtual const char * getTypeName () const

Detailed Description

Gamma distributed random number class.


Constructor & Destructor Documentation

lti::gammaDistribution::gammaDistribution (  )  [inline]

default constructor.

Referenced by clone().

lti::gammaDistribution::gammaDistribution ( const parameters theParams  ) 

constructor, sets the parameters

lti::gammaDistribution::gammaDistribution ( const int  theOrder  ) 

constructor, sets order theOrder

virtual lti::gammaDistribution::~gammaDistribution (  )  [inline, virtual]

destructor


Member Function Documentation

virtual functor* lti::gammaDistribution::clone (  )  const [inline, virtual]

returns a pointer to a clone of the functor.

Reimplemented from lti::continuousRandomDistribution.

References gammaDistribution().

virtual double lti::gammaDistribution::draw (  )  const [virtual]

gamma distribution.

Returns a deviate distributed as a gamma distribution of the given integer order, i.e. a waiting time to the (theOrder)th event in a Poisson process of unit mean.

Reimplemented from lti::continuousRandomDistribution.

const parameters& lti::gammaDistribution::getParameters (  )  const

returns the current parameters.

Reimplemented from lti::functor.

virtual const char* lti::gammaDistribution::getTypeName ( void   )  const [inline, virtual]

returns the name of this type

Reimplemented from lti::continuousRandomDistribution.


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

Generated on Sat Apr 10 15:28:20 2010 for LTI-Lib by Doxygen 1.6.1