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

A class that performs sampling from Student's T distribution. More...

#include <rv_samp.h>

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

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

Public Member Functions
	UnivStudTSampler ()=delete
	Default-construction is deleted.
	UnivStudTSampler (float_t dof)
	The user must supply the degrees of freedom parameter. 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::student_t_distribution< float_t >	m_t_gen
	makes t 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::UnivStudTSampler< float_t >

A class that performs sampling from Student's T distribution.

Author

taylor

Constructor & Destructor Documentation

UnivStudTSampler()

template<typename float_t >

pf::rvsamp::UnivStudTSampler< float_t >::UnivStudTSampler

(

float_t

dof

)

The user must supply the degrees of freedom parameter.

Parameters

dof	the degrees of freedom that are desired.

Member Function Documentation

sample()

template<typename float_t >

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