pf::rvsamp::UnivGammaSampler< float_t > Class Template Reference

A class that performs sampling from a univariate Gamma distribution. More...

#include <rv_samp.h>

Inheritance diagram for pf::rvsamp::UnivGammaSampler< float_t >:

Collaboration diagram for pf::rvsamp::UnivGammaSampler< float_t >:

Public Member Functions
	UnivGammaSampler ()=delete
	Default-constructor ...
	UnivGammaSampler (float_t alpha, float_t beta)
float_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::gamma_distribution< float_t >	m_gamma_gen
	makes gamma random variates
float_t	m_alpha
	mu
float_t	m_beta
	sigma

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

Detailed Description

template<typename float_t>
class pf::rvsamp::UnivGammaSampler< float_t >

A class that performs sampling from a univariate Gamma distribution.

Author

taylor

Constructor & Destructor Documentation

UnivGammaSampler()

template<typename float_t >

pf::rvsamp::UnivGammaSampler< float_t >::UnivGammaSampler	(	float_t	alpha,
		float_t	beta
	)

Parameters

alpha	a positive shape parameter.
beta	a positive scale parameter.

Member Function Documentation

sample()

template<typename float_t >

float_t pf::rvsamp::UnivGammaSampler< float_t >::sample

draws a random number.

Returns

a random sample of type float_t.

---

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

• include/pf/rv_samp.h