Simpact Cyan
Population based event driven simulation using mNRM
Public Member Functions | List of all members
NormalDistribution Class Reference

This class allows you to return a random number from a normal distribution with parameters specified in the constructor. More...

#include <normaldistribution.h>

Inheritance diagram for NormalDistribution:
Inheritance graph
[legend]
Collaboration diagram for NormalDistribution:
Collaboration graph
[legend]

Public Member Functions

 NormalDistribution (double mu, double sigma, GslRandomNumberGenerator *pRng, double minValue=-std::numeric_limits< double >::infinity(), double maxValue=std::numeric_limits< double >::infinity())
 The constructor specifies parameters for a log-normal distribution. More...
 
double pickNumber () const
 Pick a number according to a specific distrubution, specified in a subclass of ProbabilityDistribution . More...
 

Detailed Description

This class allows you to return a random number from a normal distribution with parameters specified in the constructor.

The probability density is based on the following:

\[ \textrm{prob}(x) = \frac{1}{\sigma \sqrt{2 \pi} } \exp\left(-\frac{(x-\mu)^2}{2 \sigma^2}\right) \]

The range is restricted to the specified [min,max] range by using rejection sampling.

Constructor & Destructor Documentation

NormalDistribution::NormalDistribution ( double  mu,
double  sigma,
GslRandomNumberGenerator pRng,
double  minValue = -std::numeric_limits<double>::infinity(),
double  maxValue = std::numeric_limits<double>::infinity() 
)

The constructor specifies parameters for a log-normal distribution.

Member Function Documentation

double NormalDistribution::pickNumber ( ) const
virtual

Pick a number according to a specific distrubution, specified in a subclass of ProbabilityDistribution .

Implements ProbabilityDistribution.


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