The log-normal distribution Random Number Generator (RNG) that allows stream numbers to be set deterministically. More...
#include "random-variable-stream.h"
Public Member Functions | |
LogNormalRandomVariable () | |
Creates a log-normal distribution RNG with the default values for mu and sigma. More... | |
uint32_t | GetInteger () override |
Returns a random unsigned integer from a log-normal distribution with the current mu and sigma. More... | |
uint32_t | GetInteger (uint32_t mu, uint32_t sigma) |
Returns a random unsigned integer from a log-normal distribution with the specified mu and sigma. More... | |
double | GetMu () const |
Returns the mu value for the log-normal distribution returned by this RNG stream. More... | |
double | GetSigma () const |
Returns the sigma value for the log-normal distribution returned by this RNG stream. More... | |
double | GetValue () override |
Returns a random double from a log-normal distribution with the current mu and sigma. More... | |
double | GetValue (double mu, double sigma) |
Returns a random double from a log-normal distribution with the specified mu and sigma. More... | |
![]() | |
RandomVariableStream () | |
Default constructor. More... | |
RandomVariableStream (const RandomVariableStream &)=delete | |
~RandomVariableStream () override | |
Destructor. More... | |
virtual uint32_t | GetInteger ()=0 |
Get the next random value as an integer drawn from the distribution. More... | |
int64_t | GetStream () const |
Returns the stream number for the RngStream. More... | |
virtual double | GetValue ()=0 |
Get the next random value as a double drawn from the distribution. 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... | |
![]() | |
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... | |
![]() | |
SimpleRefCount () | |
Default constructor. More... | |
SimpleRefCount (const SimpleRefCount &o) | |
Copy constructor. More... | |
uint32_t | GetReferenceCount () const |
Get the reference count of the object. More... | |
SimpleRefCount & | operator= (const SimpleRefCount &o) |
Assignment operator. More... | |
void | Ref () const |
Increment the reference count. More... | |
void | Unref () const |
Decrement the reference count. More... | |
![]() | |
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 erros. More... | |
virtual TypeId | GetInstanceTypeId () const =0 |
Get the most derived TypeId for this Object. 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 TypeId | GetTypeId () |
Register this type. More... | |
![]() | |
static TypeId | GetTypeId () |
Register this type. More... | |
![]() | |
static TypeId | GetTypeId () |
Get the type ID. More... | |
Private Attributes | |
double | m_mu |
The mu value for the log-normal distribution returned by this RNG stream. More... | |
double | m_sigma |
The sigma value for the log-normal distribution returned by this RNG stream. More... | |
Additional Inherited Members | |
![]() | |
RngStream * | Peek () const |
Get the pointer to the underlying RngStream. More... | |
![]() | |
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... | |
![]() | |
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... | |
![]() | |
static TypeId | GetObjectIid () |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More... | |
The log-normal 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 log-normal distribution. It also supports the generation of single random numbers from various log-normal distributions.
LogNormalRandomVariable defines a random variable with a log-normal distribution. If one takes the natural logarithm of random variable following the log-normal distribution, the obtained values follow a normal distribution.
The probability density function is defined over the interval [0, ) as:
where
and
The and
parameters can be calculated instead if the mean and variance are known with the following equations:
, and,
Here is an example of how to use this class:
ns3::LogNormalRandomVariable is accessible through the following paths with Config::Set and Config::Connect:
No TraceSources are defined for this type.
Size of this type is 72 bytes (on a 64-bit architecture).
Definition at line 1288 of file random-variable-stream.h.
ns3::LogNormalRandomVariable::LogNormalRandomVariable | ( | ) |
Creates a log-normal distribution RNG with the default values for mu and sigma.
Definition at line 839 of file random-variable-stream.cc.
References NS_LOG_FUNCTION.
|
overridevirtual |
Returns a random unsigned integer from a log-normal distribution with the current mu and sigma.
Note that antithetic values are being generated if m_isAntithetic is equal to true. If and
are uniform variables over [0,1], then the value that would be returned normally,
, is calculated as follows:
For the antithetic case, ) and
) are the distances that
and
would be from
. The antithetic value returned,
, is calculated as follows:
which now involves the distances and
are from 1.
Implements ns3::RandomVariableStream.
Definition at line 938 of file random-variable-stream.cc.
References GetValue(), m_mu, m_sigma, and NS_LOG_FUNCTION.
Returns a random unsigned integer from a log-normal distribution with the specified mu and sigma.
[in] | mu | Mu value for the log-normal distribution. |
[in] | sigma | Sigma value for the log-normal distribution. |
Note that antithetic values are being generated if m_isAntithetic is equal to true. If and
are uniform variables over [0,1], then the value that would be returned normally,
, is calculated as follows:
For the antithetic case, ) and
) are the distances that
and
would be from
. The antithetic value returned,
, is calculated as follows:
which now involves the distances and
are from 1.
Definition at line 924 of file random-variable-stream.cc.
References GetValue(), and NS_LOG_FUNCTION.
double ns3::LogNormalRandomVariable::GetMu | ( | ) | const |
Returns the mu value for the log-normal distribution returned by this RNG stream.
Definition at line 847 of file random-variable-stream.cc.
References m_mu, and NS_LOG_FUNCTION.
double ns3::LogNormalRandomVariable::GetSigma | ( | ) | const |
Returns the sigma value for the log-normal distribution returned by this RNG stream.
Definition at line 854 of file random-variable-stream.cc.
References m_sigma, and NS_LOG_FUNCTION.
|
static |
Register this type.
Definition at line 817 of file random-variable-stream.cc.
References m_mu, m_sigma, ns3::MakeDoubleAccessor(), and ns3::TypeId::SetParent().
|
overridevirtual |
Returns a random double from a log-normal distribution with the current mu and sigma.
Note that antithetic values are being generated if m_isAntithetic is equal to true. If and
are uniform variables over [0,1], then the value that would be returned normally,
, is calculated as follows:
For the antithetic case, ) and
) are the distances that
and
would be from
. The antithetic value returned,
, is calculated as follows:
which now involves the distances and
are from 1.
Note that we have to re-implement this method here because the method is overloaded above for the two-argument variant and the c++ name resolution rules don't work well with overloads split between parent and child classes.
Implements ns3::RandomVariableStream.
Definition at line 931 of file random-variable-stream.cc.
References GetValue(), m_mu, m_sigma, and NS_LOG_FUNCTION.
Referenced by GetInteger(), and GetValue().
Returns a random double from a log-normal distribution with the specified mu and sigma.
[in] | mu | Mu value for the log-normal distribution. |
[in] | sigma | Sigma value for the log-normal distribution. |
Note that antithetic values are being generated if m_isAntithetic is equal to true. If and
are uniform variables over [0,1], then the value that would be returned normally,
, is calculated as follows:
For the antithetic case, ) and
) are the distances that
and
would be from
. The antithetic value returned,
, is calculated as follows:
which now involves the distances and
are from 1.
Definition at line 887 of file random-variable-stream.cc.
References ns3::RandomVariableStream::IsAntithetic(), ns3::normal, NS_LOG_FUNCTION, ns3::RandomVariableStream::Peek(), and ns3::RngStream::RandU01().
|
private |
The mu value for the log-normal distribution returned by this RNG stream.
Definition at line 1465 of file random-variable-stream.h.
Referenced by GetInteger(), GetMu(), GetTypeId(), and GetValue().
|
private |
The sigma value for the log-normal distribution returned by this RNG stream.
Definition at line 1468 of file random-variable-stream.h.
Referenced by GetInteger(), GetSigma(), GetTypeId(), and GetValue().