A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Member Functions | Protected Member Functions | Private Attributes | Friends | List of all members
ns3::RandomVariable Class Reference
Random Variable Distributions

The basic RNG for NS-3.Note: The underlying random number generation method used by NS-3 is the RngStream code by Pierre L'Ecuyer at the University of Montreal. More...

#include <random-variable.h>

+ Inheritance diagram for ns3::RandomVariable:

Public Member Functions

 RandomVariable (const RandomVariable &o)
 
uint32_t GetInteger (void) const
 Returns a random integer integer from the underlying distribution. More...
 
double GetValue (void) const
 Returns a random double from the underlying distribution. More...
 
RandomVariable & operator= (const RandomVariable &o)
 

Protected Member Functions

 RandomVariable (const RandomVariableBase &variable)
 
RandomVariableBase * Peek (void) const
 

Private Attributes

RandomVariableBase * m_variable
 

Friends

std::ostream & operator<< (std::ostream &os, const RandomVariable &var)
 
std::istream & operator>> (std::istream &os, RandomVariable &var)
 

Detailed Description

The basic RNG for NS-3.

Note: The underlying random number generation method used by NS-3 is the RngStream code by Pierre L'Ecuyer at the University of Montreal.

NS-3 has a rich set of random number generators. Class RandomVariable defines the base class functionalty required for all random number generators. By default, the underlying generator is seeded all the time with the same seed value and run number coming from the ns3::GlobalValue RngSeed and RngRun.

Definition at line 58 of file random-variable.h.

Member Function Documentation

uint32_t ns3::RandomVariable::GetInteger ( void  ) const

Returns a random integer integer from the underlying distribution.

Returns
Integer cast of RandomVariable::GetValue

Definition at line 145 of file random-variable.cc.

References NS_LOG_FUNCTION.

double ns3::RandomVariable::GetValue ( void  ) const

Returns a random double from the underlying distribution.

Returns
A floating point random value

Definition at line 138 of file random-variable.cc.

References NS_LOG_FUNCTION.

Referenced by BasicRandomNumberTestCase::DoRun(), ns3::UniformVariable::GetValue(), ns3::SequentialVariableImpl::GetValue(), ns3::GammaVariable::GetValue(), ns3::ErlangVariable::GetValue(), ns3::GammaVariableImpl::GetValue(), and ns3::ErlangVariableImpl::GetValue().

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