|
A Discrete-Event Network Simulator
|
API |
|
|
A Discrete-Event Network Simulator
|
API |
The Largest Extreme Value distribution Random Number Generator (RNG). More...
#include "random-variable-stream.h"
Inheritance diagram for ns3::LargestExtremeValueRandomVariable: Collaboration diagram for ns3::LargestExtremeValueRandomVariable:Public Member Functions | |
| LargestExtremeValueRandomVariable () | |
| Creates a Largest Extreme Value distribution RNG with the default values for the location and the scale. | |
| virtual uint32_t | GetInteger () |
| Get the next random value drawn from the distribution. | |
| uint32_t | GetInteger (uint32_t location, uint32_t scale) |
| Get the next random value drawn from the distribution. | |
| double | GetLocation () const |
| Get the configured location value of this RNG. | |
| double | GetMean () const |
| Returns the mean value for the Largest Extreme Value distribution returned by this RNG stream. | |
| double | GetScale () const |
| Get the configured scale value of this RNG. | |
| double | GetValue () override |
| Get the next random value drawn from the distribution. | |
| double | GetValue (double location, double scale) |
| Get the next random value drawn from the distribution. | |
| double | GetVariance () const |
| Returns the variance value for the Largest Extreme Value distribution returned by this RNG stream. | |
| Public Member Functions inherited from ns3::RandomVariableStream | |
| RandomVariableStream () | |
| Default constructor. | |
| RandomVariableStream (const RandomVariableStream &)=delete | |
| ~RandomVariableStream () override | |
| Destructor. | |
| int64_t | GetStream () const |
| Returns the stream number for the RngStream. | |
| bool | IsAntithetic () const |
| Check if antithetic values will be generated. | |
| RandomVariableStream & | operator= (const RandomVariableStream &)=delete |
| void | SetAntithetic (bool isAntithetic) |
| Specify whether antithetic values should be generated. | |
| void | SetStream (int64_t stream) |
| Specifies the stream number for the RngStream. | |
| Public Member Functions inherited from ns3::Object | |
| Object () | |
| Constructor. | |
| ~Object () override | |
| Destructor. | |
| void | AggregateObject (Ptr< Object > other) |
| Aggregate two Objects together. | |
| void | Dispose () |
| Dispose of this Object. | |
| AggregateIterator | GetAggregateIterator () const |
| Get an iterator to the Objects aggregated to this one. | |
| TypeId | GetInstanceTypeId () const final |
| Get the most derived TypeId for this Object. | |
| template<typename T> | |
| Ptr< T > | GetObject () const |
| Get a pointer to the requested aggregated Object. | |
| template<> | |
| Ptr< Object > | GetObject () const |
| Specialization of () for objects of type ns3::Object. | |
| template<typename T> | |
| Ptr< T > | GetObject (TypeId tid) const |
| Get a pointer to the requested aggregated Object by TypeId. | |
| template<> | |
| Ptr< Object > | GetObject (TypeId tid) const |
| Specialization of (TypeId tid) for objects of type ns3::Object. | |
| void | Initialize () |
| Invoke DoInitialize on all Objects aggregated to this one. | |
| bool | IsInitialized () const |
| Check if the object has been initialized. | |
| void | UnidirectionalAggregateObject (Ptr< Object > other) |
| Aggregate an Object to another Object. | |
| Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter > | |
| SimpleRefCount () | |
| Default constructor. | |
| SimpleRefCount (const SimpleRefCount &o) | |
| Copy constructor. | |
| uint32_t | GetReferenceCount () const |
| Get the reference count of the object. | |
| SimpleRefCount & | operator= (const SimpleRefCount &o) |
| Assignment operator. | |
| void | Ref () const |
| Increment the reference count. | |
| void | Unref () const |
| Decrement the reference count. | |
| Public Member Functions inherited from ns3::ObjectBase | |
| virtual | ~ObjectBase () |
| Virtual destructor. | |
| void | GetAttribute (std::string name, AttributeValue &value, bool permissive=false) const |
| Get the value of an attribute, raising fatal errors if unsuccessful. | |
| bool | GetAttributeFailSafe (std::string name, AttributeValue &value) const |
| Get the value of an attribute without raising errors. | |
| void | SetAttribute (std::string name, const AttributeValue &value) |
| Set a single attribute, raising fatal errors if unsuccessful. | |
| bool | SetAttributeFailSafe (std::string name, const AttributeValue &value) |
| Set a single attribute without raising errors. | |
| bool | TraceConnect (std::string name, std::string context, const CallbackBase &cb) |
| Connect a TraceSource to a Callback with a context. | |
| bool | TraceConnectWithoutContext (std::string name, const CallbackBase &cb) |
| Connect a TraceSource to a Callback without a context. | |
| bool | TraceDisconnect (std::string name, std::string context, const CallbackBase &cb) |
| Disconnect from a TraceSource a Callback previously connected with a context. | |
| bool | TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb) |
| Disconnect from a TraceSource a Callback previously connected without a context. | |
Static Public Member Functions | |
| static double | GetMean (double location, double scale) |
| Returns the mean value for the Largest Extreme Value distribution returned by this RNG stream. | |
| static TypeId | GetTypeId () |
| Register this type. | |
| static double | GetVariance (double scale) |
| Returns the variance value for the Largest Extreme Value distribution returned by this RNG stream. | |
| Static Public Member Functions inherited from ns3::RandomVariableStream | |
| static TypeId | GetTypeId () |
| Register this type. | |
| Static Public Member Functions inherited from ns3::Object | |
| static TypeId | GetTypeId () |
| Register this type. | |
| Static Public Member Functions inherited from ns3::ObjectBase | |
| static TypeId | GetTypeId () |
| Get the type ID. | |
Private Attributes | |
| double | m_location |
| The location value of the Largest Extreme Value distribution. | |
| double | m_scale |
| The scale value of the Largest Extreme Value distribution. | |
Additional Inherited Members | |
| Protected Member Functions inherited from ns3::RandomVariableStream | |
| RngStream * | Peek () const |
| Get the pointer to the underlying RngStream. | |
| Protected Member Functions inherited from ns3::Object | |
| Object (const Object &o) | |
| Copy an Object. | |
| virtual void | DoDispose () |
| Destructor implementation. | |
| virtual void | DoInitialize () |
| Initialize() implementation. | |
| virtual void | NotifyNewAggregate () |
| Notify all Objects aggregated to this one of a new Object being aggregated. | |
| Protected Member Functions inherited from ns3::ObjectBase | |
| void | ConstructSelf (const AttributeConstructionList &attributes) |
| Complete construction of ObjectBase; invoked by derived classes. | |
| virtual void | NotifyConstructionCompleted () |
| Notifier called once the ObjectBase is fully constructed. | |
| Related Symbols inherited from ns3::ObjectBase | |
| static TypeId | GetObjectIid () |
| Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. | |
The Largest Extreme Value distribution Random Number Generator (RNG).
This class supports the creation of objects that return random numbers from a fixed Largest Extreme Value distribution. This corresponds to the type-I Generalized Extreme Value distribution, also known as Gumbel distribution (https://en.wikipedia.org/wiki/Gumbel_distribution).
The probability density function of a Largest Extreme Value variable is defined as:
![\[ P(x; \mu, \beta) dx = \frac{1}{\beta} e^{-(z+ e^{-z})} dx, \quad z = \frac{x - \mu}{\beta}
\]](../../form_145_dark.png)
where 
Location configurable attribute and 
Scale configurable attribute.
The Largest Extreme Value RNG value 
![\[ x = \mu - \beta \log(-\log(u))
\]](../../form_146_dark.png)
where 
The mean of the distribution is:
![\[ E = \mu + y \beta
\]](../../form_147_dark.png)
where 
The variance of the distribution is
![\[ \sigma^2 = 6 \pi^2 \beta^2
\]](../../form_148_dark.png)
ns3::LargestExtremeValueRandomVariable is accessible through the following paths with Config::Set and Config::Connect:
No TraceSources are defined for this type
Group: Core
Size of this type is 96 bytes (on a 64-bit architecture).
Definition at line 2443 of file random-variable-stream.h.
| ns3::LargestExtremeValueRandomVariable::LargestExtremeValueRandomVariable | ( | ) |
Creates a Largest Extreme Value distribution RNG with the default values for the location and the scale.
Definition at line 1990 of file random-variable-stream.cc.
References NS_LOG_FUNCTION.
Referenced by GetTypeId().
Here is the caller graph for this function:
|
virtual |
Get the next random value drawn from the distribution.
Reimplemented from ns3::RandomVariableStream.
Definition at line 145 of file random-variable-stream.cc.
Get the next random value drawn from the distribution.
| [in] | location | location value of the Largest Extreme Value distribution. |
| [in] | scale | scale value of the Largest Extreme Value distribution. |
Definition at line 2028 of file random-variable-stream.cc.
References GetValue(), and NS_LOG_FUNCTION.
Here is the call graph for this function:| double ns3::LargestExtremeValueRandomVariable::GetLocation | ( | ) | const |
Get the configured location value of this RNG.
Definition at line 1996 of file random-variable-stream.cc.
References m_location.
| double ns3::LargestExtremeValueRandomVariable::GetMean | ( | ) | const |
Returns the mean value for the Largest Extreme Value distribution returned by this RNG stream.
Definition at line 2049 of file random-variable-stream.cc.
References GetMean(), m_location, and m_scale.
Referenced by ns3::test::RandomVariable::LargestExtremeValueTestCase::DoRun(), and GetMean().
Here is the call graph for this function: Here is the caller graph for this function:Returns the mean value for the Largest Extreme Value distribution returned by this RNG stream.
| [in] | location | location value of the Largest Extreme Value distribution. |
| [in] | scale | scale value of the Largest Extreme Value distribution. |
Definition at line 2042 of file random-variable-stream.cc.
References NS_LOG_FUNCTION.
| double ns3::LargestExtremeValueRandomVariable::GetScale | ( | ) | const |
Get the configured scale value of this RNG.
Definition at line 2002 of file random-variable-stream.cc.
References m_scale.
|
static |
Register this type.
Definition at line 1968 of file random-variable-stream.cc.
References LargestExtremeValueRandomVariable(), ns3::RandomVariableStream::RandomVariableStream(), m_location, m_scale, ns3::MakeDoubleAccessor(), ns3::MakeDoubleChecker(), 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 2035 of file random-variable-stream.cc.
References GetValue(), m_location, m_scale, and NS_LOG_FUNCTION.
Referenced by GetInteger(), and GetValue().
Here is the call graph for this function: Here is the caller graph for this function:Get the next random value drawn from the distribution.
| [in] | location | location value of the Largest Extreme Value distribution. |
| [in] | scale | scale value of the Largest Extreme Value distribution. |
Definition at line 2008 of file random-variable-stream.cc.
References ns3::RandomVariableStream::IsAntithetic(), NS_ABORT_MSG_IF, NS_LOG_FUNCTION, ns3::RandomVariableStream::Peek(), and ns3::RngStream::RandU01().
Here is the call graph for this function:| double ns3::LargestExtremeValueRandomVariable::GetVariance | ( | ) | const |
Returns the variance value for the Largest Extreme Value distribution returned by this RNG stream.
Definition at line 2062 of file random-variable-stream.cc.
References GetVariance(), and m_scale.
Referenced by ns3::test::RandomVariable::LargestExtremeValueTestCase::DoRun(), and GetVariance().
Here is the call graph for this function: Here is the caller graph for this function:Returns the variance value for the Largest Extreme Value distribution returned by this RNG stream.
| [in] | scale | scale value of the Largest Extreme Value distribution. |
Definition at line 2055 of file random-variable-stream.cc.
References NS_LOG_FUNCTION.
|
private |
The location value of the Largest Extreme Value distribution.
Definition at line 2517 of file random-variable-stream.h.
Referenced by GetLocation(), GetMean(), GetTypeId(), and GetValue().
|
private |
The scale value of the Largest Extreme Value distribution.
Definition at line 2520 of file random-variable-stream.h.
Referenced by GetMean(), GetScale(), GetTypeId(), GetValue(), and GetVariance().
1.13.2