The normal (Gaussian) distribution Random Number Generator (RNG) that allows stream numbers to be set deterministically. More...

#include "random-variable-stream.h"

Inheritance diagram for ns3::NormalRandomVariable:

Collaboration diagram for ns3::NormalRandomVariable:

Public Member Functions
	NormalRandomVariable ()
	Creates a normal distribution RNG with the default values for the mean, variance, and bound. More...

double	GetBound () const
	Returns the bound on values that can be returned by this RNG stream. More...

virtual uint32_t	GetInteger ()
	Get the next random value drawn from the distribution. More...

uint32_t	GetInteger (uint32_t mean, uint32_t variance, uint32_t bound)
	Get the next random value drawn from the distribution. More...

double	GetMean () const
	Returns the mean value for the normal distribution returned by this RNG stream. More...

double	GetValue () override
	Get the next random value drawn from the distribution. More...

double	GetValue (double mean, double variance, double bound=NormalRandomVariable::INFINITE_VALUE)
	Get the next random value drawn from the distribution. More...

double	GetVariance () const
	Returns the variance value for the normal distribution returned by this RNG stream. More...

Public Member Functions inherited from ns3::RandomVariableStream
	RandomVariableStream ()
	Default constructor. More...

	RandomVariableStream (const RandomVariableStream &)=delete

	~RandomVariableStream () override
	Destructor. More...

int64_t	GetStream () const
	Returns the stream number for the RngStream. More...

bool	IsAntithetic () const
	Check if antithetic values will be generated. More...

RandomVariableStream &	operator= (const RandomVariableStream &)=delete

void	SetAntithetic (bool isAntithetic)
	Specify whether antithetic values should be generated. More...

void	SetStream (int64_t stream)
	Specifies the stream number for the RngStream. More...

Public Member Functions inherited from ns3::Object
	Object ()
	Constructor. More...

	~Object () override
	Destructor. More...

void	AggregateObject (Ptr< Object > other)
	Aggregate two Objects together. More...

void	Dispose ()
	Dispose of this Object. More...

AggregateIterator	GetAggregateIterator () const
	Get an iterator to the Objects aggregated to this one. More...

TypeId	GetInstanceTypeId () const override
	Get the most derived TypeId for this Object. More...

template<typename T >
Ptr< T >	GetObject () const
	Get a pointer to the requested aggregated Object. More...

template<>
Ptr< Object >	GetObject () const
	Specialization of () for objects of type ns3::Object. More...

template<typename T >
Ptr< T >	GetObject (TypeId tid) const
	Get a pointer to the requested aggregated Object by TypeId. More...

template<>
Ptr< Object >	GetObject (TypeId tid) const
	Specialization of (TypeId tid) for objects of type ns3::Object. More...

void	Initialize ()
	Invoke DoInitialize on all Objects aggregated to this one. More...

bool	IsInitialized () const
	Check if the object has been initialized. More...

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	Default constructor. More...

	SimpleRefCount (const SimpleRefCount &o[[maybe_unused]])
	Copy constructor. More...

uint32_t	GetReferenceCount () const
	Get the reference count of the object. More...

SimpleRefCount &	operator= (const SimpleRefCount &o[[maybe_unused]])
	Assignment operator. More...

void	Ref () const
	Increment the reference count. More...

void	Unref () const
	Decrement the reference count. More...

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor. More...

void	GetAttribute (std::string name, AttributeValue &value) const
	Get the value of an attribute, raising fatal errors if unsuccessful. More...

bool	GetAttributeFailSafe (std::string name, AttributeValue &value) const
	Get the value of an attribute without raising errors. More...

void	SetAttribute (std::string name, const AttributeValue &value)
	Set a single attribute, raising fatal errors if unsuccessful. More...

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
	Set a single attribute without raising errors. More...

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
	Connect a TraceSource to a Callback with a context. More...

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
	Connect a TraceSource to a Callback without a context. More...

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected with a context. More...

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected without a context. More...

Static Public Member Functions
static TypeId	GetTypeId ()
	Register this type. More...

Static Public Member Functions inherited from ns3::RandomVariableStream
static TypeId	GetTypeId ()
	Register this type. More...

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId ()
	Register this type. More...

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId ()
	Get the type ID. More...

Static Public Attributes
static const double	INFINITE_VALUE = 1e307
	Large constant to bound the range. More...

Private Attributes
double	m_bound
	The bound on values that can be returned by this RNG stream. More...

double	m_mean
	The mean value for the normal distribution returned by this RNG stream. More...

bool	m_nextValid
	True if the next value is valid. More...

double	m_v2
	The algorithm produces two values at a time. More...

double	m_variance
	The variance value for the normal distribution returned by this RNG stream. More...

double	m_y
	The algorithm produces two values at a time. More...

Additional Inherited Members
Protected Member Functions inherited from ns3::RandomVariableStream
RngStream *	Peek () const
	Get the pointer to the underlying RngStream. More...

Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
	Copy an Object. More...

virtual void	DoDispose ()
	Destructor implementation. More...

virtual void	DoInitialize ()
	Initialize() implementation. More...

virtual void	NotifyNewAggregate ()
	Notify all Objects aggregated to this one of a new Object being aggregated. More...

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
	Complete construction of ObjectBase; invoked by derived classes. More...

virtual void	NotifyConstructionCompleted ()
	Notifier called once the ObjectBase is fully constructed. More...

Related Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More...

Detailed Description

The normal (Gaussian) distribution Random Number Generator (RNG) that allows stream numbers to be set deterministically.

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

The probability density function is:

$P(x; \mu, \sigma) dx = \frac{1}{\sqrt{2\pi\sigma^2}} e^{-\frac{(x-\mu)^2}{2\sigma^2}} dx, \\ \quad x \in (-\infty, +\infty)$

where the Mean is given by $\mu$ and the Variance is $\sigma^2$

If , are uniform variables over [0,1] then the Gaussian RNG values, and , are calculated as follows:

$\begin{eqnarray*} v_1 & = & 2 u_1 - 1 \\ v_2 & = & 2 u_2 - 1 \\ r^2 & = & v_1^2 + v_2^2 \\ y & = & \sqrt{\frac{-2 \log(r^2)}{r^2}} \\ x_1 & = & \mu + v_1 y \sqrt{\sigma^2} \\ x_2 & = & \mu + v_2 y \sqrt{\sigma^2} . \end{eqnarray*}$

Note this algorithm consumes two uniform random values and produces two normally distributed values. The implementation used here caches and to generate on the next call.

Bounded Distribution

Since normal distributions can theoretically return unbounded values, it is sometimes useful to specify a fixed bound. The NormalRandomVariable is bounded symmetrically about the mean by the Bound parameter, , i.e. its values are confined to the interval $[\mu - b, \mu + b]$ . This preserves the mean but decreases the variance.

Example

Here is an example of how to use this class:

double mean = 5.0;
double variance = 2.0;
 
Ptr<NormalRandomVariable> x = CreateObject<NormalRandomVariable> ();
x->SetAttribute ("Mean", DoubleValue (mean));
x->SetAttribute ("Variance", DoubleValue (variance));
 
// The expected value for the mean of the values returned by a
// normally distributed random variable is equal to mean.
double value = x->GetValue ();

Antithetic Values.

If an instance of this RNG is configured to return antithetic values, the actual values returned, $x_1^{\prime}$ and $x_2^{\prime}$ , are calculated as follows:

$\begin{eqnarray*} v_1^{\prime} & = & 2 (1 - u_1) - 1 \\ v_2^{\prime} & = & 2 (1 - u_2) - 1 \\ r^{\prime 2} & = & v_1^{\prime 2} + v_2^{\prime 2} \\ y^{\prime} & = & \sqrt{\frac{-2 \log(r^{\prime 2})}{r^{\prime 2}}} \\ x_1^{\prime} & = & \mu + v_1^{\prime} y^{\prime} \sqrt{\sigma^2} \\ x_2^{\prime} & = & \mu + v_2^{\prime} y^{\prime} \sqrt{\sigma^2} , \end{eqnarray*}$

which now involves the distances and are from 1.

Definition at line 969 of file random-variable-stream.h.

Constructor & Destructor Documentation

◆ NormalRandomVariable()

ns3::NormalRandomVariable::NormalRandomVariable ( )

Creates a normal distribution RNG with the default values for the mean, variance, and bound.

Definition at line 685 of file random-variable-stream.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ GetBound()

double ns3::NormalRandomVariable::GetBound ( ) const

Returns the bound on values that can be returned by this RNG stream.

Returns: The bound on values that can be returned by this RNG stream.

Definition at line 708 of file random-variable-stream.cc.

References m_bound, and NS_LOG_FUNCTION.

◆ GetInteger() [1/2]

uint32_t ns3::RandomVariableStream::GetInteger

virtual

Get the next random value drawn from the distribution.

Returns: A random value.

Reimplemented from ns3::RandomVariableStream.

Definition at line 155 of file random-variable-stream.cc.

◆ GetInteger() [2/2]

uint32_t ns3::NormalRandomVariable::GetInteger	(	uint32_t	mean,
		uint32_t	variance,
		uint32_t	bound
	)

Get the next random value drawn from the distribution.

Returns: A random value.

Parameters

[in]	mean	Mean value for the normal distribution.
[in]	variance	Variance value for the normal distribution.
[in]	bound	Bound on values returned.

Definition at line 766 of file random-variable-stream.cc.

References GetValue(), and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ GetMean()

double ns3::NormalRandomVariable::GetMean ( ) const

Returns the mean value for the normal distribution returned by this RNG stream.

Returns: The mean value for the normal distribution returned by this RNG stream.

Definition at line 694 of file random-variable-stream.cc.

References m_mean, and NS_LOG_FUNCTION.

◆ GetTypeId()

TypeId ns3::NormalRandomVariable::GetTypeId ( void )

static

Register this type.

Returns: The object TypeId.

Definition at line 659 of file random-variable-stream.cc.

References INFINITE_VALUE, m_bound, m_mean, m_variance, ns3::MakeDoubleAccessor(), and ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ GetValue() [1/2]

double ns3::NormalRandomVariable::GetValue ( )

overridevirtual

Get the next random value drawn from the distribution.

Returns: A random value.

Implements ns3::RandomVariableStream.

Definition at line 773 of file random-variable-stream.cc.

References m_bound, m_mean, m_variance, and NS_LOG_FUNCTION.

Referenced by GetInteger().

Here is the caller graph for this function:

◆ GetValue() [2/2]

double ns3::NormalRandomVariable::GetValue	(	double	mean,
		double	variance,
		double	bound = `NormalRandomVariable::INFINITE_VALUE`
	)

Get the next random value drawn from the distribution.

Returns: A random value.

Parameters

[in]	mean	Mean value for the normal distribution.
[in]	variance	Variance value for the normal distribution.
[in]	bound	Bound on values returned.

Definition at line 715 of file random-variable-stream.cc.

References ns3::RandomVariableStream::IsAntithetic(), m_nextValid, m_v2, m_y, NS_LOG_FUNCTION, ns3::RandomVariableStream::Peek(), and ns3::RngStream::RandU01().

Here is the call graph for this function:

◆ GetVariance()

double ns3::NormalRandomVariable::GetVariance ( ) const

Returns the variance value for the normal distribution returned by this RNG stream.

Returns: The variance value for the normal distribution returned by this RNG stream.

Definition at line 701 of file random-variable-stream.cc.

References m_variance, and NS_LOG_FUNCTION.

Member Data Documentation

◆ INFINITE_VALUE

const double ns3::NormalRandomVariable::INFINITE_VALUE = 1e307

static

Large constant to bound the range.

Definition at line 973 of file random-variable-stream.h.

Referenced by GetTypeId(), and ns3::GammaRandomVariable::GetValue().

◆ m_bound

double ns3::NormalRandomVariable::m_bound

private

The bound on values that can be returned by this RNG stream.

Definition at line 1030 of file random-variable-stream.h.

Referenced by GetBound(), GetTypeId(), and GetValue().

◆ m_mean

double ns3::NormalRandomVariable::m_mean

private

The mean value for the normal distribution returned by this RNG stream.

Definition at line 1024 of file random-variable-stream.h.

Referenced by GetMean(), GetTypeId(), and GetValue().

◆ m_nextValid

bool ns3::NormalRandomVariable::m_nextValid

private

True if the next value is valid.

Definition at line 1033 of file random-variable-stream.h.

Referenced by GetValue().

◆ m_v2

double ns3::NormalRandomVariable::m_v2

private

The algorithm produces two values at a time.

Cache parameters for possible reuse.

Definition at line 1036 of file random-variable-stream.h.

Referenced by GetValue().

◆ m_variance

double ns3::NormalRandomVariable::m_variance

private

The variance value for the normal distribution returned by this RNG stream.

Definition at line 1027 of file random-variable-stream.h.

Referenced by GetTypeId(), GetValue(), and GetVariance().

◆ m_y

double ns3::NormalRandomVariable::m_y

private

The algorithm produces two values at a time.

Cache parameters for possible reuse.

Definition at line 1038 of file random-variable-stream.h.

Referenced by GetValue().

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

src/core/model/random-variable-stream.h
src/core/model/random-variable-stream.cc

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ NormalRandomVariable()

Member Function Documentation

◆ GetBound()

◆ GetInteger() [1/2]

◆ GetInteger() [2/2]

◆ GetMean()

◆ GetTypeId()

◆ GetValue() [1/2]

◆ GetValue() [2/2]

◆ GetVariance()

Member Data Documentation

◆ INFINITE_VALUE

◆ m_bound

◆ m_mean

◆ m_nextValid

◆ m_v2

◆ m_variance

◆ m_y