The gamma distribution Random Number Generator (RNG) that allows stream numbers to be set deterministically. More...
#include <random-variable-stream.h>
Public Member Functions | |
GammaRandomVariable () | |
Creates a gamma distribution RNG with the default values for alpha and beta. More... | |
double | GetAlpha (void) const |
Returns the alpha value for the gamma distribution returned by this RNG stream. More... | |
double | GetBeta (void) const |
Returns the beta value for the gamma distribution returned by this RNG stream. More... | |
uint32_t | GetInteger (uint32_t alpha, uint32_t beta) |
Returns a random unsigned integer from a gamma distribution with the specified alpha and beta. More... | |
virtual uint32_t | GetInteger (void) |
Returns a random unsigned integer from a gamma distribution with the current alpha and beta. More... | |
double | GetValue (double alpha, double beta) |
Returns a random double from a gamma distribution with the specified alpha and beta. More... | |
virtual double | GetValue (void) |
Returns a random double from a gamma distribution with the current alpha and beta. More... | |
![]() | |
RandomVariableStream () | |
virtual | ~RandomVariableStream () |
int64_t | GetStream (void) const |
Returns the stream number for this RNG stream. More... | |
bool | IsAntithetic (void) const |
Returns true if antithetic values should be generated. More... | |
void | SetAntithetic (bool isAntithetic) |
Specifies whether antithetic values should be generated. More... | |
void | SetStream (int64_t stream) |
Specifies the stream number for this RNG stream. More... | |
![]() | |
Object () | |
virtual | ~Object () |
void | AggregateObject (Ptr< Object > other) |
void | Dispose (void) |
Run the DoDispose methods of this object and all the objects aggregated to it. More... | |
AggregateIterator | GetAggregateIterator (void) const |
virtual TypeId | GetInstanceTypeId (void) const |
template<typename T > | |
Ptr< T > | GetObject (void) const |
template<typename T > | |
Ptr< T > | GetObject (TypeId tid) const |
void | Initialize (void) |
This method calls the virtual DoInitialize method on all the objects aggregated to this object. More... | |
![]() | |
SimpleRefCount () | |
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. More... | |
void | Ref (void) const |
Increment the reference count. More... | |
void | Unref (void) const |
Decrement the reference count. More... | |
![]() | |
virtual | ~ObjectBase () |
Virtual destructor. More... | |
void | GetAttribute (std::string name, AttributeValue &value) const |
bool | GetAttributeFailSafe (std::string name, AttributeValue &attribute) const |
void | SetAttribute (std::string name, const AttributeValue &value) |
bool | SetAttributeFailSafe (std::string name, const AttributeValue &value) |
bool | TraceConnect (std::string name, std::string context, const CallbackBase &cb) |
bool | TraceConnectWithoutContext (std::string name, const CallbackBase &cb) |
bool | TraceDisconnect (std::string name, std::string context, const CallbackBase &cb) |
bool | TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb) |
Static Public Member Functions | |
static TypeId | GetTypeId (void) |
![]() | |
static TypeId | GetTypeId (void) |
![]() | |
static TypeId | GetTypeId (void) |
Register this type. More... | |
![]() | |
static void | Cleanup (void) |
Noop. More... | |
![]() | |
static TypeId | GetTypeId (void) |
Get the type ID. More... | |
Private Member Functions | |
double | GetNormalValue (double mean, double variance, double bound) |
Returns a random double from a normal distribution with the specified mean, variance, and bound. More... | |
Private Attributes | |
double | m_alpha |
The alpha value for the gamma distribution returned by this RNG stream. More... | |
double | m_beta |
The beta value for the gamma distribution returned by this RNG stream. More... | |
double | m_next |
The algorithm produces two normal values at a time. More... | |
bool | m_nextValid |
True if the next normal value is valid. More... | |
Additional Inherited Members | |
![]() | |
RngStream * | Peek (void) const |
Returns a pointer to the underlying RNG stream. More... | |
![]() | |
Object (const Object &o) | |
virtual void | DoDispose (void) |
This method is called by Object::Dispose or by the object's destructor, whichever comes first. More... | |
virtual void | DoInitialize (void) |
This method is called only once by Object::Initialize. More... | |
virtual void | NotifyNewAggregate (void) |
This method is invoked whenever two sets of objects are aggregated together. More... | |
![]() | |
void | ConstructSelf (const AttributeConstructionList &attributes) |
virtual void | NotifyConstructionCompleted (void) |
This method is invoked once all member attributes have been initialized. More... | |
The gamma 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 gamma distribution. It also supports the generation of single random numbers from various gamma distributions.
The probability density function is defined over the interval [0, ) as:
where
and
Here is an example of how to use this class:
ns3::GammaRandomVariable is accessible through the following paths with Config::Set and Config::Connect:
No TraceSources are defined for this type.
Definition at line 1499 of file random-variable-stream.h.
ns3::GammaRandomVariable::GammaRandomVariable | ( | ) |
Creates a gamma distribution RNG with the default values for alpha and beta.
Definition at line 892 of file random-variable-stream.cc.
References NS_LOG_FUNCTION.
double ns3::GammaRandomVariable::GetAlpha | ( | void | ) | const |
Returns the alpha value for the gamma distribution returned by this RNG stream.
Definition at line 902 of file random-variable-stream.cc.
References m_alpha, and NS_LOG_FUNCTION.
double ns3::GammaRandomVariable::GetBeta | ( | void | ) | const |
Returns the beta value for the gamma distribution returned by this RNG stream.
Definition at line 908 of file random-variable-stream.cc.
References m_beta, and NS_LOG_FUNCTION.
uint32_t ns3::GammaRandomVariable::GetInteger | ( | uint32_t | alpha, |
uint32_t | beta | ||
) |
Returns a random unsigned integer from a gamma distribution with the specified alpha and beta.
alpha | Alpha value for the gamma distribution. |
beta | Beta value for the gamma distribution. |
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,
, uses (1-u), which is the distance
is from the 1.
Definition at line 983 of file random-variable-stream.cc.
References GetValue(), and NS_LOG_FUNCTION.
|
virtual |
Returns a random unsigned integer from a gamma distribution with the current alpha and beta.
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,
, uses (1-u), which is the distance
is from the 1.
Implements ns3::RandomVariableStream.
Definition at line 996 of file random-variable-stream.cc.
References GetValue(), m_alpha, m_beta, and NS_LOG_FUNCTION.
|
private |
Returns a random double from a normal distribution with the specified mean, variance, and bound.
mean | Mean value for the normal distribution. |
variance | Variance value for the normal distribution. |
bound | Bound on values returned. |
Note that antithetic values are being generated if m_isAntithetic is equal to true. If and
are uniform variables over [0,1], then the values that would be returned normally,
and
, are calculated as follows:
For the antithetic case, ) and
) are the distances that
and
would be from
. The antithetic values returned,
and
, are calculated as follows:
which now involves the distances and
are from 1.
Definition at line 1003 of file random-variable-stream.cc.
References ns3::RandomVariableStream::IsAntithetic(), m_next, m_nextValid, NS_LOG_FUNCTION, ns3::RandomVariableStream::Peek(), ns3::RngStream::RandU01(), and visualizer.higcontainer::w.
Referenced by GetValue().
|
static |
Definition at line 876 of file random-variable-stream.cc.
References m_alpha, m_beta, and ns3::TypeId::SetParent().
double ns3::GammaRandomVariable::GetValue | ( | double | alpha, |
double | beta | ||
) |
Returns a random double from a gamma distribution with the specified alpha and beta.
alpha | Alpha value for the gamma distribution. |
beta | Beta value for the gamma distribution. |
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,
, uses (1-u), which is the distance
is from the 1.
Definition at line 931 of file random-variable-stream.cc.
References GetNormalValue(), GetValue(), ns3::NormalRandomVariable::INFINITE_VALUE, ns3::RandomVariableStream::IsAntithetic(), NS_LOG_FUNCTION, ns3::RandomVariableStream::Peek(), ns3::RngStream::RandU01(), and sample-rng-plot::x.
Referenced by RandomVariableStreamGammaTestCase::ChiSquaredTest(), RandomVariableStreamGammaAntitheticTestCase::ChiSquaredTest(), RandomVariableStreamGammaTestCase::DoRun(), and RandomVariableStreamGammaAntitheticTestCase::DoRun().
|
virtual |
Returns a random double from a gamma distribution with the current alpha and beta.
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,
, uses (1-u), which is the distance
is from the 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 990 of file random-variable-stream.cc.
References m_alpha, m_beta, and NS_LOG_FUNCTION.
Referenced by GetInteger(), and GetValue().
|
private |
The alpha value for the gamma distribution returned by this RNG stream.
Definition at line 1623 of file random-variable-stream.h.
Referenced by GetAlpha(), GetInteger(), GetTypeId(), and GetValue().
|
private |
The beta value for the gamma distribution returned by this RNG stream.
Definition at line 1626 of file random-variable-stream.h.
Referenced by GetBeta(), GetInteger(), GetTypeId(), and GetValue().
|
private |
The algorithm produces two normal values at a time.
Definition at line 1632 of file random-variable-stream.h.
Referenced by GetNormalValue().
|
private |
True if the next normal value is valid.
Definition at line 1629 of file random-variable-stream.h.
Referenced by GetNormalValue().