A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
ns3::GammaRandomVariable Class Reference

The gamma distribution Random Number Generator (RNG) that allows stream numbers to be set deterministically. More...

#include "random-variable-stream.h"

+ Inheritance diagram for ns3::GammaRandomVariable:
+ Collaboration diagram for ns3::GammaRandomVariable:

Public Member Functions

 GammaRandomVariable ()
 Creates a gamma distribution RNG with the default values for alpha and beta.
 
double GetAlpha () const
 Returns the alpha value for the gamma distribution returned by this RNG stream.
 
double GetBeta () const
 Returns the beta value for the gamma distribution returned by this RNG stream.
 
virtual uint32_t GetInteger ()
 Get the next random value drawn from the distribution.
 
uint32_t GetInteger (uint32_t alpha, uint32_t beta)
 Get the next random value drawn from the distribution.
 
double GetValue () override
 Get the next random value drawn from the distribution.
 
double GetValue (double alpha, double beta)
 Get the next random value drawn from the distribution.
 
- Public Member Functions inherited from ns3::RandomVariableStream
 RandomVariableStream ()
 Default constructor.
 
 RandomVariableStream (const RandomVariableStream &)=delete
 
 ~RandomVariableStream () override
 Destructor.
 
virtual uint32_t GetInteger ()
 Get the next random value drawn from the distribution.
 
int64_t GetStream () const
 Returns the stream number for the RngStream.
 
virtual double GetValue ()=0
 Get the next random value drawn from the distribution.
 
bool IsAntithetic () const
 Check if antithetic values will be generated.
 
RandomVariableStreamoperator= (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 override
 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< ObjectGetObject () 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< ObjectGetObject (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.
 
SimpleRefCountoperator= (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) 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.
 
virtual TypeId GetInstanceTypeId () const =0
 Get the most derived TypeId for this Object.
 
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 TypeId GetTypeId ()
 Register this type.
 
- 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 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.
 

Private Attributes

double m_alpha
 The alpha value for the gamma distribution returned by this RNG stream.
 
double m_beta
 The beta value for the gamma distribution returned by this RNG stream.
 
bool m_nextValid
 True if the next normal value is valid.
 
double m_v2
 The algorithm produces two values at a time.
 
double m_y
 The algorithm produces two values at a time.
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::RandomVariableStream
RngStreamPeek () 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.
 

Detailed Description

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 distribution is defined in terms two parameters, Alpha = $\alpha > 0$ and Beta = $ \beta > 0$. (Note the Wikipedia entry for the Gamma Distribution uses either the parameters $k, \theta$ or $\alpha, \beta$. The parameters used here $(\alpha, \beta)_{\mbox{ns-3}}$ correspond to $(\alpha, \frac{1}{\beta})_{\mbox{Wikipedia}}$.)

The probability density function is:

\[
     P(x; \alpha, \beta) dx = x^{\alpha-1} \\
         \frac{e^{-\frac{x}{\beta}}}{\beta^\alpha \Gamma(\alpha)} dx, \\
         \quad x \in [0, +\infty)
  \]

where the mean is $ \mu = \alpha\beta $ and the variance is $ \sigma^2 = \alpha \beta^2$.

While gamma RNG values can be generated by an algorithm similar to normal RNGs, the implementation used here is based on the paper G. Marsaglia and W. W. Tsang, A simple method for generating Gamma variables, ACM Transactions on Mathematical Software, Vol. 26, No. 3, Sept. 2000.

Example

Here is an example of how to use this class:

double alpha = 5.0;
double beta = 2.0;
Ptr<GammaRandomVariable> x = CreateObject<GammaRandomVariable> ();
x->SetAttribute ("Alpha", DoubleValue (alpha));
x->SetAttribute ("Beta", DoubleValue (beta));
double value = x->GetValue ();
This class can be used to hold variables of floating point type such as 'double' or 'float'.
Definition: double.h:42
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:77
Antithetic Values.

If an instance of this RNG is configured to return antithetic values, the actual value returned, $x'$, is generated using the prescription in the Marsaglia, et al. paper cited above.

Config Paths

ns3::GammaRandomVariable is accessible through the following paths with Config::Set and Config::Connect:

  • "/NodeList/[i]/DeviceList/[i]/$ns3::SimpleNetDevice/ReceiveErrorModel/$ns3::RateErrorModel/RanVar/$ns3::GammaRandomVariable"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::SimpleNetDevice/ReceiveErrorModel/$ns3::BurstErrorModel/BurstStart/$ns3::GammaRandomVariable"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::SimpleNetDevice/ReceiveErrorModel/$ns3::BurstErrorModel/BurstSize/$ns3::GammaRandomVariable"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Channel/$ns3::SpectrumChannel/PropagationLossModel/$ns3::RandomPropagationLossModel/Variable/$ns3::GammaRandomVariable"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Channel/$ns3::SpectrumChannel/PropagationLossModel/$ns3::NakagamiPropagationLossModel/GammaRv"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Channel/$ns3::YansWifiChannel/PropagationLossModel/$ns3::RandomPropagationLossModel/Variable/$ns3::GammaRandomVariable"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Channel/$ns3::YansWifiChannel/PropagationLossModel/$ns3::NakagamiPropagationLossModel/GammaRv"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Channel/$ns3::YansWifiChannel/PropagationDelayModel/$ns3::RandomPropagationDelayModel/Variable/$ns3::GammaRandomVariable"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Phy/Channel/$ns3::SpectrumChannel/PropagationLossModel/$ns3::RandomPropagationLossModel/Variable/$ns3::GammaRandomVariable"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Phy/Channel/$ns3::SpectrumChannel/PropagationLossModel/$ns3::NakagamiPropagationLossModel/GammaRv"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Phy/Channel/$ns3::YansWifiChannel/PropagationLossModel/$ns3::RandomPropagationLossModel/Variable/$ns3::GammaRandomVariable"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Phy/Channel/$ns3::YansWifiChannel/PropagationLossModel/$ns3::NakagamiPropagationLossModel/GammaRv"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Phy/Channel/$ns3::YansWifiChannel/PropagationDelayModel/$ns3::RandomPropagationDelayModel/Variable/$ns3::GammaRandomVariable"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Phy/PostReceptionErrorModel/$ns3::RateErrorModel/RanVar/$ns3::GammaRandomVariable"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Phy/PostReceptionErrorModel/$ns3::BurstErrorModel/BurstStart/$ns3::GammaRandomVariable"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Phy/PostReceptionErrorModel/$ns3::BurstErrorModel/BurstSize/$ns3::GammaRandomVariable"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Phys/[i]/Channel/$ns3::SpectrumChannel/PropagationLossModel/$ns3::RandomPropagationLossModel/Variable/$ns3::GammaRandomVariable"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Phys/[i]/Channel/$ns3::SpectrumChannel/PropagationLossModel/$ns3::NakagamiPropagationLossModel/GammaRv"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Phys/[i]/Channel/$ns3::YansWifiChannel/PropagationLossModel/$ns3::RandomPropagationLossModel/Variable/$ns3::GammaRandomVariable"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Phys/[i]/Channel/$ns3::YansWifiChannel/PropagationLossModel/$ns3::NakagamiPropagationLossModel/GammaRv"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Phys/[i]/Channel/$ns3::YansWifiChannel/PropagationDelayModel/$ns3::RandomPropagationDelayModel/Variable/$ns3::GammaRandomVariable"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Phys/[i]/PostReceptionErrorModel/$ns3::RateErrorModel/RanVar/$ns3::GammaRandomVariable"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Phys/[i]/PostReceptionErrorModel/$ns3::BurstErrorModel/BurstStart/$ns3::GammaRandomVariable"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Phys/[i]/PostReceptionErrorModel/$ns3::BurstErrorModel/BurstSize/$ns3::GammaRandomVariable"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Mac/$ns3::StaWifiMac/ProbeDelay/$ns3::GammaRandomVariable"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::MeshPointDevice/ForwardingDelay/$ns3::GammaRandomVariable"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::PointToPointNetDevice/ReceiveErrorModel/$ns3::RateErrorModel/RanVar/$ns3::GammaRandomVariable"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::PointToPointNetDevice/ReceiveErrorModel/$ns3::BurstErrorModel/BurstStart/$ns3::GammaRandomVariable"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::PointToPointNetDevice/ReceiveErrorModel/$ns3::BurstErrorModel/BurstSize/$ns3::GammaRandomVariable"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::CsmaNetDevice/ReceiveErrorModel/$ns3::RateErrorModel/RanVar/$ns3::GammaRandomVariable"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::CsmaNetDevice/ReceiveErrorModel/$ns3::BurstErrorModel/BurstStart/$ns3::GammaRandomVariable"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::CsmaNetDevice/ReceiveErrorModel/$ns3::BurstErrorModel/BurstSize/$ns3::GammaRandomVariable"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::LrWpanNetDevice/Channel/PropagationLossModel/$ns3::RandomPropagationLossModel/Variable/$ns3::GammaRandomVariable"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::LrWpanNetDevice/Channel/PropagationLossModel/$ns3::NakagamiPropagationLossModel/GammaRv"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::LrWpanNetDevice/Phy/PostReceptionErrorModel/$ns3::RateErrorModel/RanVar/$ns3::GammaRandomVariable"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::LrWpanNetDevice/Phy/PostReceptionErrorModel/$ns3::BurstErrorModel/BurstStart/$ns3::GammaRandomVariable"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::LrWpanNetDevice/Phy/PostReceptionErrorModel/$ns3::BurstErrorModel/BurstSize/$ns3::GammaRandomVariable"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::SixLowPanNetDevice/MeshUnderJitter/$ns3::GammaRandomVariable"
  • "/NodeList/[i]/ApplicationList/[i]/$ns3::DhcpClient/Transactions/$ns3::GammaRandomVariable"
  • "/NodeList/[i]/ApplicationList/[i]/$ns3::OnOffApplication/OnTime/$ns3::GammaRandomVariable"
  • "/NodeList/[i]/ApplicationList/[i]/$ns3::OnOffApplication/OffTime/$ns3::GammaRandomVariable"
  • "/NodeList/[i]/$ns3::MobilityModel/$ns3::GaussMarkovMobilityModel/MeanVelocity/$ns3::GammaRandomVariable"
  • "/NodeList/[i]/$ns3::MobilityModel/$ns3::GaussMarkovMobilityModel/MeanDirection/$ns3::GammaRandomVariable"
  • "/NodeList/[i]/$ns3::MobilityModel/$ns3::GaussMarkovMobilityModel/MeanPitch/$ns3::GammaRandomVariable"
  • "/NodeList/[i]/$ns3::MobilityModel/$ns3::RandomDirection2dMobilityModel/Speed/$ns3::GammaRandomVariable"
  • "/NodeList/[i]/$ns3::MobilityModel/$ns3::RandomDirection2dMobilityModel/Pause/$ns3::GammaRandomVariable"
  • "/NodeList/[i]/$ns3::MobilityModel/$ns3::RandomWalk2dMobilityModel/Direction/$ns3::GammaRandomVariable"
  • "/NodeList/[i]/$ns3::MobilityModel/$ns3::RandomWalk2dMobilityModel/Speed/$ns3::GammaRandomVariable"
  • "/NodeList/[i]/$ns3::MobilityModel/$ns3::RandomWaypointMobilityModel/Speed/$ns3::GammaRandomVariable"
  • "/NodeList/[i]/$ns3::MobilityModel/$ns3::RandomWaypointMobilityModel/Pause/$ns3::GammaRandomVariable"
  • "/NodeList/[i]/$ns3::MobilityModel/$ns3::RandomWaypointMobilityModel/PositionAllocator/$ns3::RandomRectanglePositionAllocator/X/$ns3::GammaRandomVariable"
  • "/NodeList/[i]/$ns3::MobilityModel/$ns3::RandomWaypointMobilityModel/PositionAllocator/$ns3::RandomRectanglePositionAllocator/Y/$ns3::GammaRandomVariable"
  • "/NodeList/[i]/$ns3::MobilityModel/$ns3::RandomWaypointMobilityModel/PositionAllocator/$ns3::RandomBoxPositionAllocator/X/$ns3::GammaRandomVariable"
  • "/NodeList/[i]/$ns3::MobilityModel/$ns3::RandomWaypointMobilityModel/PositionAllocator/$ns3::RandomBoxPositionAllocator/Y/$ns3::GammaRandomVariable"
  • "/NodeList/[i]/$ns3::MobilityModel/$ns3::RandomWaypointMobilityModel/PositionAllocator/$ns3::RandomBoxPositionAllocator/Z/$ns3::GammaRandomVariable"
  • "/NodeList/[i]/$ns3::MobilityModel/$ns3::RandomWaypointMobilityModel/PositionAllocator/$ns3::RandomDiscPositionAllocator/Theta/$ns3::GammaRandomVariable"
  • "/NodeList/[i]/$ns3::MobilityModel/$ns3::RandomWaypointMobilityModel/PositionAllocator/$ns3::RandomDiscPositionAllocator/Rho/$ns3::GammaRandomVariable"
  • "/NodeList/[i]/$ns3::MobilityModel/$ns3::RandomWaypointMobilityModel/PositionAllocator/$ns3::OutdoorPositionAllocator/X/$ns3::GammaRandomVariable"
  • "/NodeList/[i]/$ns3::MobilityModel/$ns3::RandomWaypointMobilityModel/PositionAllocator/$ns3::OutdoorPositionAllocator/Y/$ns3::GammaRandomVariable"
  • "/NodeList/[i]/$ns3::MobilityModel/$ns3::RandomWaypointMobilityModel/PositionAllocator/$ns3::OutdoorPositionAllocator/Z/$ns3::GammaRandomVariable"
  • "/NodeList/[i]/$ns3::MobilityModel/$ns3::RandomWalk2dOutdoorMobilityModel/Direction/$ns3::GammaRandomVariable"
  • "/NodeList/[i]/$ns3::MobilityModel/$ns3::RandomWalk2dOutdoorMobilityModel/Speed/$ns3::GammaRandomVariable"
  • "/NodeList/[i]/$ns3::ArpL3Protocol/RequestJitter/$ns3::GammaRandomVariable"
  • "/NodeList/[i]/$ns3::Icmpv6L4Protocol/SolicitationJitter/$ns3::GammaRandomVariable"
  • "/NodeList/[i]/$ns3::Icmpv6L4Protocol/RsRetransmissionJitter/$ns3::GammaRandomVariable"
  • "/ChannelList/[i]/$ns3::SpectrumChannel/PropagationLossModel/$ns3::RandomPropagationLossModel/Variable/$ns3::GammaRandomVariable"
  • "/ChannelList/[i]/$ns3::SpectrumChannel/PropagationLossModel/$ns3::NakagamiPropagationLossModel/GammaRv"
  • "/ChannelList/[i]/$ns3::YansWifiChannel/PropagationLossModel/$ns3::RandomPropagationLossModel/Variable/$ns3::GammaRandomVariable"
  • "/ChannelList/[i]/$ns3::YansWifiChannel/PropagationLossModel/$ns3::NakagamiPropagationLossModel/GammaRv"
  • "/ChannelList/[i]/$ns3::YansWifiChannel/PropagationDelayModel/$ns3::RandomPropagationDelayModel/Variable/$ns3::GammaRandomVariable"

Attributes

  • Alpha: The alpha value for the gamma distribution returned by this RNG stream.
    • Set with class: ns3::DoubleValue
    • Underlying type: double -1.79769e+308:1.79769e+308
    • Initial value: 1
    • Flags: constructwriteread
  • Beta: The beta value for the gamma distribution returned by this RNG stream.
    • Set with class: ns3::DoubleValue
    • Underlying type: double -1.79769e+308:1.79769e+308
    • Initial value: 1
    • Flags: constructwriteread

Attributes defined in parent class ns3::RandomVariableStream

  • Antithetic: Set this RNG stream to generate antithetic values
    • Set with class: ns3::BooleanValue
    • Underlying type: bool
    • Initial value: false
    • Flags: constructwriteread
  • Stream: The stream number for this RNG stream. -1 means "allocate a stream automatically". Note that if -1 is set, Get will return -1 so that it is not possible to know which value was automatically allocated.
    • Set with class: ns3::IntegerValue
    • Underlying type: int64_t -9223372036854775808:9223372036854775807
    • Initial value: -1
    • Flags: constructwriteread

No TraceSources are defined for this type.
Size of this type is 120 bytes (on a 64-bit architecture).

Definition at line 1245 of file random-variable-stream.h.

Constructor & Destructor Documentation

◆ GammaRandomVariable()

ns3::GammaRandomVariable::GammaRandomVariable ( )

Creates a gamma distribution RNG with the default values for alpha and beta.

Definition at line 937 of file random-variable-stream.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ GetAlpha()

double ns3::GammaRandomVariable::GetAlpha ( ) const

Returns the alpha value for the gamma distribution returned by this RNG stream.

Returns
The alpha value for the gamma distribution returned by this RNG stream.

Definition at line 946 of file random-variable-stream.cc.

References m_alpha, and NS_LOG_FUNCTION.

◆ GetBeta()

double ns3::GammaRandomVariable::GetBeta ( ) const

Returns the beta value for the gamma distribution returned by this RNG stream.

Returns
The beta value for the gamma distribution returned by this RNG stream.

Definition at line 953 of file random-variable-stream.cc.

References m_beta, and NS_LOG_FUNCTION.

◆ GetInteger() [1/2]

uint32_t ns3::RandomVariableStream::GetInteger ( )
virtual

Get the next random value drawn from the distribution.

Returns
A random value.

Reimplemented from ns3::RandomVariableStream.

Definition at line 155 of file random-variable-stream.cc.

◆ GetInteger() [2/2]

uint32_t ns3::GammaRandomVariable::GetInteger ( uint32_t  alpha,
uint32_t  beta 
)

Get the next random value drawn from the distribution.

Returns
A random value.
Parameters
[in]alphaAlpha value for the gamma distribution.
[in]betaBeta value for the gamma distribution.

◆ GetNormalValue()

double ns3::GammaRandomVariable::GetNormalValue ( double  mean,
double  variance,
double  bound 
)
private

Returns a random double from a normal distribution with the specified mean, variance, and bound.

Parameters
[in]meanMean value for the normal distribution.
[in]varianceVariance value for the normal distribution.
[in]boundBound on values returned.
Returns
A floating point random value.

Definition at line 1036 of file random-variable-stream.cc.

References ns3::RandomVariableStream::IsAntithetic(), m_nextValid, m_v2, m_y, NS_LOG_FUNCTION, ns3::RandomVariableStream::Peek(), and ns3::RngStream::RandU01().

Referenced by GetValue().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::GammaRandomVariable::GetTypeId ( )
static

Register this type.

Returns
The object TypeId.

Definition at line 917 of file random-variable-stream.cc.

References m_alpha, m_beta, ns3::MakeDoubleAccessor(), and ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ GetValue() [1/2]

double ns3::GammaRandomVariable::GetValue ( )
overridevirtual

Get the next random value drawn from the distribution.

Returns
A random value.

Implements ns3::RandomVariableStream.

Definition at line 1029 of file random-variable-stream.cc.

References GetValue(), m_alpha, m_beta, and NS_LOG_FUNCTION.

Referenced by GetValue().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ GetValue() [2/2]

double ns3::GammaRandomVariable::GetValue ( double  alpha,
double  beta 
)

Get the next random value drawn from the distribution.

Returns
A random value.
Parameters
[in]alphaAlpha value for the gamma distribution.
[in]betaBeta value for the gamma distribution.

Definition at line 976 of file random-variable-stream.cc.

References GetNormalValue(), GetValue(), ns3::NormalRandomVariable::INFINITE_VALUE, ns3::RandomVariableStream::IsAntithetic(), NS_LOG_FUNCTION, ns3::RandomVariableStream::Peek(), and ns3::RngStream::RandU01().

+ Here is the call graph for this function:

Member Data Documentation

◆ m_alpha

double ns3::GammaRandomVariable::m_alpha
private

The alpha value for the gamma distribution returned by this RNG stream.

Definition at line 1298 of file random-variable-stream.h.

Referenced by GetAlpha(), GetTypeId(), and GetValue().

◆ m_beta

double ns3::GammaRandomVariable::m_beta
private

The beta value for the gamma distribution returned by this RNG stream.

Definition at line 1301 of file random-variable-stream.h.

Referenced by GetBeta(), GetTypeId(), and GetValue().

◆ m_nextValid

bool ns3::GammaRandomVariable::m_nextValid
private

True if the next normal value is valid.

Definition at line 1304 of file random-variable-stream.h.

Referenced by GetNormalValue().

◆ m_v2

double ns3::GammaRandomVariable::m_v2
private

The algorithm produces two values at a time.

Cache parameters for possible reuse.

Definition at line 1307 of file random-variable-stream.h.

Referenced by GetNormalValue().

◆ m_y

double ns3::GammaRandomVariable::m_y
private

The algorithm produces two values at a time.

Cache parameters for possible reuse.

Definition at line 1309 of file random-variable-stream.h.

Referenced by GetNormalValue().


The documentation for this class was generated from the following files: