gslmm::poisson Class Reference
[Distributions]

#include <gslmm/random/poisson.hh>

Inheritance diagram for gslmm::poisson:

Inheritance graph
[legend]
Collaboration diagram for gslmm::poisson:

Collaboration graph
[legend]
List of all members.

Detailed Description

Poisson distribution interface class.

The Poisson PDF is

\[ p(k) = {\mu^k \over k!} \exp(-\mu) \]

for $ k \geq 0$

Examples:

random/distribution-test.cc.


Public Member Functions

 poisson (double mu, generator &r)
virtual ~poisson ()
virtual return_type sample ()
virtual double pdf (const return_type &x)

Protected Types

typedef distribution< size_t > base_type

Protected Attributes

double _mu


Member Typedef Documentation

typedef distribution<size_t> gslmm::poisson::base_type [protected]
 

The base type.


Constructor & Destructor Documentation

gslmm::poisson::poisson double  mu,
generator r
[inline]
 

Constructor.

Parameters:
mu The mean of the distribution
r The random number generator

virtual gslmm::poisson::~poisson  )  [inline, virtual]
 

Destructor.


Member Function Documentation

virtual double gslmm::poisson::pdf const return_type x  )  [inline, virtual]
 

See also:
gslmm::distribution<Return,Arg>::pdf

virtual return_type gslmm::poisson::sample  )  [inline, virtual]
 

Sample the distribution.

Returns:
The sample.

Implements gslmm::distribution< size_t >.


Member Data Documentation

double gslmm::poisson::_mu [protected]
 

The mean ($\mu$) of the distribution.


The documentation for this class was generated from the following file:
Top of page Last update Tue May 9 10:11:33 2006
Christian Holm
Created by DoxyGen 1.4.6