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

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

#include <rv_samp.h>

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

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

Public Member Functions
	BetaSampler ()=delete
	Default-constructor sets up for Beta(1,1) random variate generation.
	BetaSampler (float_t alpha, float_t beta)
	The user must supply both alpha and beta. More...
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_first_gamma_gen
	makes gamma random variates
std::gamma_distribution< float_t >	m_second_gamma_gen
	makes other gamma random variates
float_t	m_alpha
	the first shape parameter
float_t	m_beta
	the second shape parameter

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::BetaSampler< float_t >

A class that performs sampling from a Beta distribution.

Author

taylor

Constructor & Destructor Documentation

BetaSampler()

template<typename float_t >

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

The user must supply both alpha and beta.

Parameters

alpha	shape 1 parameter (> 0)
beta	shape 2 parameter (> 0)

Member Function Documentation

sample()

template<typename float_t >

float_t pf::rvsamp::BetaSampler< 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