The Weibull distribution Random Number Generator (RNG) that allows stream numbers to be set deterministically. More...
#include "random-variable-stream.h"
Public Member Functions | |
WeibullRandomVariable () | |
Creates a Weibull distribution RNG with the default values for the scale, shape, and upper bound. More... | |
double | GetBound (void) const |
Returns the upper bound on values that can be returned by this RNG stream. More... | |
uint32_t | GetInteger (uint32_t scale, uint32_t shape, uint32_t bound) |
Returns a random unsigned integer from a Weibull distribution with the specified scale, shape, and upper bound. More... | |
virtual uint32_t | GetInteger (void) |
Returns a random unsigned integer from a Weibull distribution with the current scale, shape, and upper bound. More... | |
double | GetScale (void) const |
Returns the scale parameter for the Weibull distribution returned by this RNG stream. More... | |
double | GetShape (void) const |
Returns the shape parameter for the Weibull distribution returned by this RNG stream. More... | |
double | GetValue (double scale, double shape, double bound) |
Returns a random double from a Weibull distribution with the specified scale, shape, and upper bound. More... | |
virtual double | GetValue (void) |
Returns a random double from a Weibull distribution with the current scale, shape, and upper bound. More... | |
Public Member Functions inherited from ns3::RandomVariableStream | |
RandomVariableStream () | |
Default constructor. More... | |
virtual | ~RandomVariableStream () |
Destructor. More... | |
int64_t | GetStream (void) const |
Returns the stream number for the RngStream. More... | |
bool | IsAntithetic (void) const |
Check if antithetic values will be generated. More... | |
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... | |
virtual | ~Object () |
Destructor. More... | |
void | AggregateObject (Ptr< Object > other) |
Aggregate two Objects together. More... | |
void | Dispose (void) |
Dispose of this Object. More... | |
AggregateIterator | GetAggregateIterator (void) const |
Get an iterator to the Objects aggregated to this one. More... | |
virtual TypeId | GetInstanceTypeId (void) const |
Get the most derived TypeId for this Object. More... | |
template<typename T > | |
Ptr< T > | GetObject (void) const |
Get a pointer to the requested aggregated Object. More... | |
template<typename T > | |
Ptr< T > | GetObject (TypeId tid) const |
Get a pointer to the requested aggregated Object by TypeId. More... | |
void | Initialize (void) |
Invoke DoInitialize on all Objects aggregated to this one. More... | |
bool | IsInitialized (void) 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) | |
Copy constructor. More... | |
uint32_t | GetReferenceCount (void) const |
Get the reference count of the object. More... | |
SimpleRefCount & | operator= (const SimpleRefCount &o) |
Assignment operator. More... | |
void | Ref (void) const |
Increment the reference count. More... | |
void | Unref (void) 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 erros. 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 (void) |
Register this type. More... | |
Static Public Member Functions inherited from ns3::RandomVariableStream | |
static TypeId | GetTypeId (void) |
Register this type. More... | |
Static Public Member Functions inherited from ns3::Object | |
static TypeId | GetTypeId (void) |
Register this type. More... | |
Static Public Member Functions inherited from ns3::ObjectBase | |
static TypeId | GetTypeId (void) |
Get the type ID. More... | |
Private Attributes | |
double | m_bound |
The upper bound on values that can be returned by this RNG stream. More... | |
double | m_scale |
The scale parameter for the Weibull distribution returned by this RNG stream. More... | |
double | m_shape |
The shape parameter for the Weibull distribution returned by this RNG stream. More... | |
Additional Inherited Members | |
Protected Member Functions inherited from ns3::RandomVariableStream | |
RngStream * | Peek (void) 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 (void) |
Destructor implementation. More... | |
virtual void | DoInitialize (void) |
Initialize() implementation. More... | |
virtual void | NotifyNewAggregate (void) |
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 (void) |
Notifier called once the ObjectBase is fully constructed. More... | |
Related Functions inherited from ns3::ObjectBase | |
static TypeId | GetObjectIid (void) |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More... | |
The Weibull 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 Weibull distribution. It also supports the generation of single random numbers from various Weibull distributions.
The probability density function is defined over the interval [0, ] as: where is the shape parameter and is the scale parameter. The specified mean is related to the scale and shape parameters by the following relation: where is the Gamma function.
Since Weibull distributions can theoretically return unbounded values, it is sometimes useful to specify a fixed upper limit. Note however when the upper limit is specified, the true mean of the distribution is slightly smaller than the mean value specified.
Here is an example of how to use this class:
ns3::WeibullRandomVariable is accessible through the following paths with Config::Set and Config::Connect:
No TraceSources are defined for this type.
Size of this type is 80 bytes (on a 64-bit architecture).
Definition at line 864 of file random-variable-stream.h.
ns3::WeibullRandomVariable::WeibullRandomVariable | ( | ) |
Creates a Weibull distribution RNG with the default values for the scale, shape, and upper bound.
Definition at line 592 of file random-variable-stream.cc.
References NS_LOG_FUNCTION.
double ns3::WeibullRandomVariable::GetBound | ( | void | ) | const |
Returns the upper bound on values that can be returned by this RNG stream.
Definition at line 612 of file random-variable-stream.cc.
References m_bound, and NS_LOG_FUNCTION.
uint32_t ns3::WeibullRandomVariable::GetInteger | ( | uint32_t | scale, |
uint32_t | shape, | ||
uint32_t | bound | ||
) |
Returns a random unsigned integer from a Weibull distribution with the specified scale, shape, and upper bound.
[in] | scale | Scale parameter for the Weibull distribution. |
[in] | shape | Shape parameter for the Weibull distribution. |
[in] | bound | Upper bound on values returned. |
Note that antithetic values are being generated if m_isAntithetic is equal to true. If is a uniform variable over [0,1] and
is a value that would be returned normally, then ) is the distance that would be from . The value returned in the antithetic case, , is calculated as
which now involves the log of the distance is from 1.
Definition at line 643 of file random-variable-stream.cc.
References GetValue(), and NS_LOG_FUNCTION.
|
virtual |
Returns a random unsigned integer from a Weibull distribution with the current scale, shape, and upper bound.
Note that antithetic values are being generated if m_isAntithetic is equal to true. If is a uniform variable over [0,1] and
is a value that would be returned normally, then ) is the distance that would be from . The value returned in the antithetic case, , is calculated as
which now involves the log of the distance is from 1.
Implements ns3::RandomVariableStream.
Definition at line 656 of file random-variable-stream.cc.
References GetValue(), m_bound, m_scale, m_shape, and NS_LOG_FUNCTION.
double ns3::WeibullRandomVariable::GetScale | ( | void | ) | const |
Returns the scale parameter for the Weibull distribution returned by this RNG stream.
Definition at line 600 of file random-variable-stream.cc.
References m_scale, and NS_LOG_FUNCTION.
double ns3::WeibullRandomVariable::GetShape | ( | void | ) | const |
Returns the shape parameter for the Weibull distribution returned by this RNG stream.
Definition at line 606 of file random-variable-stream.cc.
References m_shape, and NS_LOG_FUNCTION.
|
static |
Register this type.
Definition at line 571 of file random-variable-stream.cc.
References m_bound, m_scale, m_shape, ns3::MakeDoubleAccessor(), and ns3::TypeId::SetParent().
double ns3::WeibullRandomVariable::GetValue | ( | double | scale, |
double | shape, | ||
double | bound | ||
) |
Returns a random double from a Weibull distribution with the specified scale, shape, and upper bound.
[in] | scale | Scale parameter for the Weibull distribution. |
[in] | shape | Shape parameter for the Weibull distribution. |
[in] | bound | Upper bound on values returned. |
Note that antithetic values are being generated if m_isAntithetic is equal to true. If is a uniform variable over [0,1] and
is a value that would be returned normally, then ) is the distance that would be from . The value returned in the antithetic case, , is calculated as
which now involves the log of the distance is from 1.
Definition at line 619 of file random-variable-stream.cc.
References ns3::RandomVariableStream::IsAntithetic(), NS_LOG_FUNCTION, ns3::RandomVariableStream::Peek(), and ns3::RngStream::RandU01().
Referenced by RandomVariableStreamWeibullTestCase::ChiSquaredTest(), and RandomVariableStreamWeibullAntitheticTestCase::ChiSquaredTest().
|
virtual |
Returns a random double from a Weibull distribution with the current scale, shape, and upper bound.
Note that antithetic values are being generated if m_isAntithetic is equal to true. If is a uniform variable over [0,1] and
is a value that would be returned normally, then ) is the distance that would be from . The value returned in the antithetic case, , is calculated as
which now involves the log of the distance is from 1.
Note that we have to re-implement this method here because the method is overloaded above for the three-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 650 of file random-variable-stream.cc.
References m_bound, m_scale, m_shape, and NS_LOG_FUNCTION.
Referenced by GetInteger().
|
private |
The upper bound on values that can be returned by this RNG stream.
Definition at line 1012 of file random-variable-stream.h.
Referenced by GetBound(), GetInteger(), GetTypeId(), and GetValue().
|
private |
The scale parameter for the Weibull distribution returned by this RNG stream.
Definition at line 1006 of file random-variable-stream.h.
Referenced by GetInteger(), GetScale(), GetTypeId(), and GetValue().
|
private |
The shape parameter for the Weibull distribution returned by this RNG stream.
Definition at line 1009 of file random-variable-stream.h.
Referenced by GetInteger(), GetShape(), GetTypeId(), and GetValue().