A Discrete-Event Network Simulator
API
ns3::ParetoRandomVariable Class Reference

The Pareto distribution Random Number Generator (RNG). More...

#include "random-variable-stream.h"

+ Inheritance diagram for ns3::ParetoRandomVariable:
+ Collaboration diagram for ns3::ParetoRandomVariable:

Public Member Functions

 ParetoRandomVariable ()
 Creates a Pareto distribution RNG with the default values for the mean, the 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 Pareto distribution with the specified mean, shape, and upper bound. More...
 
virtual uint32_t GetInteger (void)
 Returns a random unsigned integer from a Pareto distribution with the current mean, shape, and upper bound. More...
 
NS_DEPRECATED double GetMean (void) const
 Returns the mean parameter for the Pareto distribution returned by this RNG stream. More...
 
double GetScale (void) const
 Returns the scale parameter for the Pareto distribution returned by this RNG stream. More...
 
double GetShape (void) const
 Returns the shape parameter for the Pareto distribution returned by this RNG stream. More...
 
double GetValue (double scale, double shape, double bound)
 Returns a random double from a Pareto distribution with the specified scale, shape, and upper bound. More...
 
virtual double GetValue (void)
 Returns a random double from a Pareto distribution with the current mean, 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...
 
SimpleRefCountoperator= (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_mean
 The mean parameter for the Pareto distribution returned by this RNG stream. More...
 
double m_scale
 The scale parameter for the Pareto distribution returned by this RNG stream. More...
 
double m_shape
 The shape parameter for the Pareto distribution returned by this RNG stream. More...
 

Additional Inherited Members

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

Detailed Description

The Pareto distribution Random Number Generator (RNG).


This class supports the creation of objects that return random numbers from a fixed Pareto distribution. It also supports the generation of single random numbers from various Pareto distributions.

The probability density function of a Pareto variable is defined over the range [ $x_m$, $+\infty$) as: $ k \frac{x_m^k}{x^{k+1}}$ where $x_m > 0$ is called the scale parameter and $ k > 0$ is called the Pareto index or shape.

The parameter $ x_m $ can be inferred from the mean and the parameter $ k $ with the equation $ x_m = mean \frac{k-1}{k}, k > 1$.

Since Pareto 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:

double scale = 5.0;
double shape = 2.0;
Ptr<ParetoRandomVariable> x = CreateObject<ParetoRandomVariable> ();
x->SetAttribute ("Scale", DoubleValue (scale));
x->SetAttribute ("Shape", DoubleValue (shape));
// The expected value for the mean of the values returned by a
// Pareto distributed random variable is
//
// shape * scale
// E[value] = --------------- ,
// shape - 1
double value = x->GetValue ();

Config Paths

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

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

Attributes

  • Mean: The mean parameter for the Pareto distribution returned by this RNG stream.
    • Set with class: ns3::DoubleValue
    • Underlying type: double -1.79769e+308:1.79769e+308
    • Initial value: 0
    • Flags: construct write read
  • Scale: The scale parameter for the Pareto distribution returned by this RNG stream.
    • Set with class: ns3::DoubleValue
    • Underlying type: double -1.79769e+308:1.79769e+308
    • Initial value: 1
    • Flags: construct write read
  • Shape: The shape parameter for the Pareto distribution returned by this RNG stream.
    • Set with class: ns3::DoubleValue
    • Underlying type: double -1.79769e+308:1.79769e+308
    • Initial value: 2
    • Flags: construct write read
  • Bound: The upper bound on the values returned by this RNG stream (if non-zero).
    • Set with class: ns3::DoubleValue
    • Underlying type: double -1.79769e+308:1.79769e+308
    • Initial value: 0
    • Flags: construct write read

Attributes defined in parent class ns3::RandomVariableStream

  • 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: construct write read
  • Antithetic: Set this RNG stream to generate antithetic values
    • Set with class: BooleanValue
    • Underlying type: bool
    • Initial value: false
    • Flags: construct write read

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

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

Constructor & Destructor Documentation

◆ ParetoRandomVariable()

ns3::ParetoRandomVariable::ParetoRandomVariable ( )

Creates a Pareto distribution RNG with the default values for the mean, the shape, and upper bound.

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

References m_mean, NS_LOG_FUNCTION, and NS_UNUSED.

Member Function Documentation

◆ GetBound()

double ns3::ParetoRandomVariable::GetBound ( void  ) const

Returns the upper bound on values that can be returned by this RNG stream.

Returns
The upper bound on values that can be returned by this RNG stream.

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

References m_bound, and NS_LOG_FUNCTION.

◆ GetInteger() [1/2]

uint32_t ns3::ParetoRandomVariable::GetInteger ( uint32_t  scale,
uint32_t  shape,
uint32_t  bound 
)

Returns a random unsigned integer from a Pareto distribution with the specified mean, shape, and upper bound.

Parameters
[in]scaleScale parameter for the Pareto distribution.
[in]shapeShape parameter for the Pareto distribution.
[in]boundUpper bound on values returned.
Returns
A random unsigned integer value.

Note that antithetic values are being generated if m_isAntithetic is equal to true. If $u$ is a uniform variable over [0,1] and

\[ x = \frac{scale}{u^{\frac{1}{shape}}} \]

is a value that would be returned normally.

The value returned in the antithetic case, $x'$, is calculated as

\[ x' = \frac{scale}{{(1 - u)}^{\frac{1}{shape}}} , \]

which now involves the distance $u$ is from 1 in the denominator.

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

References GetValue(), and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ GetInteger() [2/2]

uint32_t ns3::ParetoRandomVariable::GetInteger ( void  )
virtual

Returns a random unsigned integer from a Pareto distribution with the current mean, shape, and upper bound.

Returns
A random unsigned integer value.

Note that antithetic values are being generated if m_isAntithetic is equal to true. If $u$ is a uniform variable over [0,1] and

\[ x = \frac{scale}{u^{\frac{1}{shape}}} \]

is a value that would be returned normally.

The value returned in the antithetic case, $x'$, is calculated as

\[ x' = \frac{scale}{{(1 - u)}^{\frac{1}{shape}}} , \]

which now involves the distance $u$ is from 1 in the denominator.

Implements ns3::RandomVariableStream.

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

References GetValue(), m_bound, m_scale, m_shape, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ GetMean()

double ns3::ParetoRandomVariable::GetMean ( void  ) const

Returns the mean parameter for the Pareto distribution returned by this RNG stream.

Returns
The mean parameter for the Pareto distribution returned by this RNG stream.

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

References m_scale, m_shape, and NS_LOG_FUNCTION.

◆ GetScale()

double ns3::ParetoRandomVariable::GetScale ( void  ) const

Returns the scale parameter for the Pareto distribution returned by this RNG stream.

Returns
The scale parameter for the Pareto distribution returned by this RNG stream.

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

References m_scale, and NS_LOG_FUNCTION.

◆ GetShape()

double ns3::ParetoRandomVariable::GetShape ( void  ) const

Returns the shape parameter for the Pareto distribution returned by this RNG stream.

Returns
The shape parameter for the Pareto distribution returned by this RNG stream.

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

References m_shape, and NS_LOG_FUNCTION.

◆ GetTypeId()

TypeId ns3::ParetoRandomVariable::GetTypeId ( void  )
static

Register this type.

Returns
The object TypeId.

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

References ns3::TypeId::DEPRECATED, m_bound, m_mean, m_scale, m_shape, ns3::MakeDoubleAccessor(), and ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ GetValue() [1/2]

double ns3::ParetoRandomVariable::GetValue ( double  scale,
double  shape,
double  bound 
)

Returns a random double from a Pareto distribution with the specified scale, shape, and upper bound.

Parameters
[in]scaleMean parameter for the Pareto distribution.
[in]shapeShape parameter for the Pareto distribution.
[in]boundUpper bound on values returned.
Returns
A floating point random value.

Note that antithetic values are being generated if m_isAntithetic is equal to true. If $u$ is a uniform variable over [0,1] and

\[ x = \frac{scale}{u^{\frac{1}{shape}}} \]

is a value that would be returned normally.

The value returned in the antithetic case, $x'$, is calculated as

\[ x' = \frac{scale}{{(1 - u)}^{\frac{1}{shape}}} , \]

which now involves the distance $u$ is from 1 in the denominator.

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

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

Referenced by RngParetoTestCase::ChiSquaredTest(), RandomVariableStreamParetoTestCase::ChiSquaredTest(), and RandomVariableStreamParetoAntitheticTestCase::ChiSquaredTest().

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

◆ GetValue() [2/2]

double ns3::ParetoRandomVariable::GetValue ( void  )
virtual

Returns a random double from a Pareto distribution with the current mean, shape, and upper bound.

Returns
A floating point random value.

Note that antithetic values are being generated if m_isAntithetic is equal to true. If $u$ is a uniform variable over [0,1] and

\[ x = \frac{scale}{u^{\frac{1}{shape}}} \]

is a value that would be returned normally, where

\[ scale = mean * (shape - 1.0) / shape . \]

The value returned in the antithetic case, $x'$, is calculated as

\[ x' = \frac{scale}{{(1 - u)}^{\frac{1}{shape}}} , \]

which now involves the distance $u$ is from 1 in the denominator.

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 556 of file random-variable-stream.cc.

References m_bound, m_scale, m_shape, and NS_LOG_FUNCTION.

Referenced by GetInteger().

+ Here is the caller graph for this function:

Member Data Documentation

◆ m_bound

double ns3::ParetoRandomVariable::m_bound
private

The upper bound on values that can be returned by this RNG stream.

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

Referenced by GetBound(), GetInteger(), GetTypeId(), and GetValue().

◆ m_mean

double ns3::ParetoRandomVariable::m_mean
private

The mean parameter for the Pareto distribution returned by this RNG stream.

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

Referenced by GetTypeId(), and ParetoRandomVariable().

◆ m_scale

double ns3::ParetoRandomVariable::m_scale
private

The scale parameter for the Pareto distribution returned by this RNG stream.

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

Referenced by GetInteger(), GetMean(), GetScale(), GetTypeId(), and GetValue().

◆ m_shape

double ns3::ParetoRandomVariable::m_shape
private

The shape parameter for the Pareto distribution returned by this RNG stream.

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

Referenced by GetInteger(), GetMean(), GetShape(), GetTypeId(), and GetValue().


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