A class that performs sampling from a Poisson distribution. More...

#include <rv_samp.h>

Inheritance diagram for pf::rvsamp::PoissonSampler< float_t, int_t >:

Collaboration diagram for pf::rvsamp::PoissonSampler< float_t, int_t >:

Public Member Functions
	PoissonSampler ()
	Default-constructor sets up for Poisson random variate generation with lambda = 1.

	PoissonSampler (float_t lambda)
	Constructs Poisson sampler with user-specified lambda. More...

void	setLambda (float_t lambda)
	sets the parameter lambda. More...

int_t	sample ()
	Draws a random number. More...

Public Member Functions inherited from pf::rvsamp::rvsamp_base
	rvsamp_base ()
	The default constructor. This is the only option available. Sets the seed with the clock.

Private Attributes
std::poisson_distribution< int_t >	m_p_gen
	makes normal random variates

Additional Inherited Members
Protected Attributes inherited from pf::rvsamp::rvsamp_base
std::mt19937	m_rng
	prng

Detailed Description

A class that performs sampling from a Poisson distribution.

Constructor & Destructor Documentation

template<typename float_t , typename int_t >

pf::rvsamp::PoissonSampler< float_t, int_t >::PoissonSampler ( float_t lambda )

Constructs Poisson sampler with user-specified lambda.

Parameters

lambda a float_t for the average/variance.

template<typename float_t , typename int_t >

int_t pf::rvsamp::PoissonSampler< float_t, int_t >::sample

Draws a random number.

template<typename float_t , typename int_t >

void pf::rvsamp::PoissonSampler< float_t, int_t >::setLambda ( float_t lambda )

sets the parameter lambda.

Parameters

lambda (the average and the variance).

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