viennashe::math::poisson_distribution< RealT, ResultT > Class Template Reference

A poisson (exponential) distribution of random numbers. More...

#include <random.hpp>

Public Member Functions
	poisson_distribution (RealT const &mean_value)
RealT	mean () const
template<typename RandGeneratorType >
ResultT	operator() (RandGeneratorType &gen)
	Returns a poisson distributed random number. More...

Detailed Description

template<typename RealT = double, typename ResultT = int>
class viennashe::math::poisson_distribution< RealT, ResultT >

A poisson (exponential) distribution of random numbers.

Definition at line 182 of file random.hpp.

Constructor & Destructor Documentation

poisson_distribution()

template<typename RealT = double, typename ResultT = int>

viennashe::math::poisson_distribution< RealT, ResultT >::poisson_distribution ( RealT const &  mean_value )

inline

Definition at line 189 of file random.hpp.

Member Function Documentation

mean()

template<typename RealT = double, typename ResultT = int>

RealT viennashe::math::poisson_distribution< RealT, ResultT >::mean ( ) const

inline

Definition at line 195 of file random.hpp.

operator()()

template<typename RealT = double, typename ResultT = int>

template<typename RandGeneratorType >

ResultT viennashe::math::poisson_distribution< RealT, ResultT >::operator() ( RandGeneratorType &  gen )

inline

Returns a poisson distributed random number.

Parameters

gen	A random number generator implementing the concept of rand_generator_base

Returns

Poisson distributed random number

Definition at line 203 of file random.hpp.

---

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

• viennashe/math/random.hpp