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

A class that performs sampling from a continuous uniform distribution. More...

#include <rv_samp.h>

Inheritance diagram for pf::rvsamp::UniformSampler< float_t >:
Collaboration diagram for pf::rvsamp::UniformSampler< float_t >:

Public Member Functions

 UniformSampler ()
 The default constructor. Gives a lower bound of 0 and upper bound of 1.
 
 UniformSampler (float_t lower, float_t upper)
 The constructor. More...
 
float_t sample ()
 Draws a sample. 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::uniform_real_distribution< float_t > m_unif_gen
 makes uniform random variates
 

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

A class that performs sampling from a continuous uniform distribution.

Author
taylor

Constructor & Destructor Documentation

◆ UniformSampler()

template<typename float_t >
pf::rvsamp::UniformSampler< float_t >::UniformSampler ( float_t  lower,
float_t  upper 
)

The constructor.

Parameters
lowerthe lower bound of the PRNG.
upperthe upper bound of the PRNG.

Member Function Documentation

◆ sample()

template<typename float_t >
float_t pf::rvsamp::UniformSampler< float_t >::sample

Draws a sample.

Returns
a sample of type float_t.

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