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

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

#include <lognormaldistribution.h>

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

Public Member Functions

 LogNormalDistribution (double zeta, double sigma, GslRandomNumberGenerator *pRng)
 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 log-normal distribution with parameters specified in the constructor.

The probability density is the following:

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

Constructor & Destructor Documentation

LogNormalDistribution::LogNormalDistribution ( double  zeta,
double  sigma,
GslRandomNumberGenerator pRng 
)
inline

The constructor specifies parameters for a log-normal distribution.

Member Function Documentation

double LogNormalDistribution::pickNumber ( ) const
inlinevirtual

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 file: