|
A Discrete-Event Network Simulator
|
API |
|
|
A Discrete-Event Network Simulator
|
API |
The log-normal distribution Random Number Generator (RNG) that allows stream numbers to be set deterministically. More...
#include "random-variable-stream.h"
Inheritance diagram for ns3::LogNormalRandomVariable: Collaboration diagram for ns3::LogNormalRandomVariable:Public Member Functions | |
| LogNormalRandomVariable () | |
| Creates a log-normal distribution RNG with the default values for mu and sigma. More... | |
| virtual uint32_t | GetInteger () |
| Get the next random value drawn from the distribution. More... | |
| uint32_t | GetInteger (uint32_t mu, uint32_t sigma) |
| Get the next random value drawn from the distribution. 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 |
| Get the next random value drawn from the distribution. More... | |
| double | GetValue (double mu, double sigma) |
| Get the next random value drawn from the distribution. 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... | |
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 | |
| 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... | |
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. If one takes the natural logarithm of a random variable following the log-normal distribution, the obtained values follow a normal distribution.
The probability density function is defined using two parameters Mu = 
and Sigma = 
as:
![\[ P(x; \mu, \sigma) dx = \frac{1}{x\sqrt{2\pi\sigma^2}} e^{-\frac{(ln(x) - \mu)^2}{2\sigma^2}} dx, \\ \quad x \in [0, +\infty) \]](../../form_64.png)
The distribution has mean value
![\[ \langle x | P(x; \mu, \sigma) \rangle = e^{\mu+\frac{\sigma^2}{2}} \]](../../form_65.png)
and variance
![\[ var(x) = (e^{\sigma^2}-1)e^{2\mu+\sigma^2} \]](../../form_66.png)
Note these are the mean and variance of the log-normal distribution, not the Mu or Sigma configuration variables.
If the desired mean and variance are known the and parameters can be calculated instead with the following equations:
![\[ \mu = ln(\langle x \rangle) - \\ \frac{1}{2}ln\left(1+\frac{var(x)}{{\langle x \rangle}^2}\right) \]](../../form_67.png)
and
![\[ \sigma^2 = ln\left(1+\frac{var(x)}{{\langle x \rangle}^2}\right) \]](../../form_68.png)
If 
, 
are uniform variables over [0,1] then the log-normal RNG value, 
is generated as follows:
Here is an example of how to use this class:
If an instance of this RNG is configured to return antithetic values, the actual value returned, 
, is generated as follows:
which now involves the distances and are from 1.
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 1130 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 804 of file random-variable-stream.cc.
References NS_LOG_FUNCTION.
|
virtual |
Get the next random value drawn from the distribution.
Reimplemented from ns3::RandomVariableStream.
Definition at line 153 of file random-variable-stream.cc.
| uint32_t ns3::LogNormalRandomVariable::GetInteger | ( | uint32_t | mu, |
| uint32_t | sigma | ||
| ) |
Get the next random value drawn from the distribution.
| [in] | mu | Mu value for the log-normal distribution. |
| [in] | sigma | Sigma value for the log-normal distribution. |
Definition at line 889 of file random-variable-stream.cc.
References GetValue(), NS_LOG_FUNCTION, and two-ray-to-three-gpp-ch-calibration::sigma.
Here is the call graph for this function:| double ns3::LogNormalRandomVariable::GetMu | ( | ) | const |
Returns the mu value for the log-normal distribution returned by this RNG stream.
Definition at line 812 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 819 of file random-variable-stream.cc.
References m_sigma, and NS_LOG_FUNCTION.
|
static |
Register this type.
Definition at line 782 of file random-variable-stream.cc.
References m_mu, m_sigma, ns3::MakeDoubleAccessor(), and ns3::TypeId::SetParent().
Here is the call graph for this function:
|
overridevirtual |
Get the next random value drawn from the distribution.
Implements ns3::RandomVariableStream.
Definition at line 896 of file random-variable-stream.cc.
References m_mu, m_sigma, and NS_LOG_FUNCTION.
Referenced by GetInteger().
Here is the caller graph for this function:| double ns3::LogNormalRandomVariable::GetValue | ( | double | mu, |
| double | sigma | ||
| ) |
Get the next random value drawn from the distribution.
| [in] | mu | Mu value for the log-normal distribution. |
| [in] | sigma | Sigma value for the log-normal distribution. |
Definition at line 852 of file random-variable-stream.cc.
References ns3::RandomVariableStream::IsAntithetic(), ns3::normal, NS_LOG_FUNCTION, ns3::RandomVariableStream::Peek(), ns3::RngStream::RandU01(), two-ray-to-three-gpp-ch-calibration::sigma, and two-ray-to-three-gpp-ch-calibration::x.
Here is the call graph for this function:
|
private |
The mu value for the log-normal distribution returned by this RNG stream.
Definition at line 1173 of file random-variable-stream.h.
Referenced by GetMu(), GetTypeId(), and GetValue().
|
private |
The sigma value for the log-normal distribution returned by this RNG stream.
Definition at line 1176 of file random-variable-stream.h.
Referenced by GetSigma(), GetTypeId(), and GetValue().
1.9.1 
