warptwin::NormalRandom< T > Class Template Reference

Class to generate random numbers according to normal distribution. More...

#include <NormalRandom.hpp>

Inheritance diagram for warptwin::NormalRandom< T >:

Public Member Functions
	NormalRandom (T set_mean, T set_std, unsigned int seed=0)
	Constructor for the normal random distribution.
	~NormalRandom ()
T	operator() ()

Public Attributes
clockwerk::DataIO< T >	mean = clockwerk::DataIO<T>(this, "mean")
	The mean of the random output. Can be get/set.
clockwerk::DataIO< T >	std = clockwerk::DataIO<T>(this, "std")
	The standard deviation of the random output. Can be get/set.

Protected Attributes
std::mt19937	_engine
std::normal_distribution< double >	_distribution

Detailed Description

template<typename T>
class warptwin::NormalRandom< T >

Class to generate random numbers according to normal distribution.

This function generates a random normal distribution draw according to the mt19937 engine and a std::normal_distribution. It produces random numbers according to the mean, std, and seed set in the constructor. Mean and std may be modified via standard setters mean and std.

Constructor & Destructor Documentation

NormalRandom()

template<typename T>

warptwin::NormalRandom< T >::NormalRandom	(	T	set_mean,
		T	set_std,
		unsigned int	seed = 0 )

Constructor for the normal random distribution.

Parameters

mean	The mean for the distribution
std	The standard deviation of the distribution
seed	Seed for the RNG – Defaults to zero

~NormalRandom()

template<typename T>

warptwin::NormalRandom< T >::~NormalRandom ( )

inline

Member Function Documentation

operator()()

template<typename T>

T warptwin::NormalRandom< T >::operator()

(

)

Member Data Documentation

_distribution

template<typename T>

std::normal_distribution<double> warptwin::NormalRandom< T >::_distribution

protected

_engine

template<typename T>

std::mt19937 warptwin::NormalRandom< T >::_engine

protected

mean

template<typename T>

clockwerk::DataIO<T> warptwin::NormalRandom< T >::mean = clockwerk::DataIO<T>(this, "mean")

The mean of the random output. Can be get/set.

std

template<typename T>

clockwerk::DataIO<T> warptwin::NormalRandom< T >::std = clockwerk::DataIO<T>(this, "std")

The standard deviation of the random output. Can be get/set.

---

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

• /Users/mickey/Documents/Projects/warptwin/cpp/src/simulation/NormalRandom.hpp