ns-3
ns3::ExponentialVariable Class Reference

Exponentially Distributed random varThis class supports the creation of objects that return random numbers from a fixed exponential distribution. It also supports the generation of single random numbers from various exponential distributions. More...

#include <random-variable.h>

Inheritance diagram for ns3::ExponentialVariable:
Collaboration diagram for ns3::ExponentialVariable:

List of all members.

Public Member Functions

 ExponentialVariable ()
 ExponentialVariable (double m)
 Constructs an exponential random variable with a specified mean.
 ExponentialVariable (double m, double b)
 Constructs an exponential random variable with specified mean and upper limit.

Detailed Description

Exponentially Distributed random var

This class supports the creation of objects that return random numbers from a fixed exponential distribution. It also supports the generation of single random numbers from various exponential distributions.

The probability density function of an exponential variable is defined over the interval [0, +inf) as: $ \alpha e^{-\alpha x} $ where $ \alpha = \frac{1}{mean} $

The bounded version is defined over the interval [0,b] as: $ \alpha e^{-\alpha x} \quad x \in [0,b] $. Note that in this case the true mean is $ 1/\alpha - b/(e^{\alpha \, b}-1) $

 ExponentialVariable x(3.14);
 x.GetValue ();  //will always return with mean 3.14

Constructor & Destructor Documentation

Constructs an exponential random variable with a mean value of 1.0.

Constructs an exponential random variable with a specified mean.

Parameters:
mMean value for the random variable
ns3::ExponentialVariable::ExponentialVariable ( double  m,
double  b 
)

Constructs an exponential random variable with specified mean and upper limit.

Since exponential distributions can theoretically return unbounded values, it is sometimes useful to specify a fixed upper limit. Note however when the upper limit is specified, the true mean of the distribution is slightly smaller than the mean value specified: $ m - b/(e^{b/m}-1) $.

Parameters:
mMean value of the random variable
bUpper bound on returned values

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