The Pareto distribution Random Number Generator (RNG) that allows stream numbers to be set deterministically. 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.
double	GetBound (void) const
	Returns the upper bound on values that can be returned by this RNG stream.
uint32_t	GetInteger (uint32_t mean, uint32_t shape, uint32_t bound)
	Returns a random unsigned integer from a Pareto distribution with the specified mean, shape, and upper bound.
virtual uint32_t	GetInteger (void)
	Returns a random unsigned integer from a Pareto distribution with the current mean, shape, and upper bound.
double	GetMean (void) const
	Returns the mean parameter for the Pareto distribution returned by this RNG stream.
double	GetShape (void) const
	Returns the shape parameter for the Pareto distribution returned by this RNG stream.
double	GetValue (double mean, double shape, double bound)
	Returns a random double from a Pareto distribution with the specified mean, shape, and upper bound.
virtual double	GetValue (void)
	Returns a random double from a Pareto distribution with the current mean, shape, and upper bound.
Public Member Functions inherited from ns3::RandomVariableStream
	RandomVariableStream ()
virtual	~RandomVariableStream ()
int64_t	GetStream (void) const
	Returns the stream number for this RNG stream.
bool	IsAntithetic (void) const
	Returns true if antithetic values should be generated.
void	SetAntithetic (bool isAntithetic)
	Specifies whether antithetic values should be generated.
void	SetStream (int64_t stream)
	Specifies the stream number for this RNG stream.
Public Member Functions inherited from ns3::Object
	Object ()
virtual	~Object ()
void	AggregateObject (Ptr< Object > other)
void	Dispose (void)
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	Start (void)
Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	SimpleRefCount (const SimpleRefCount &o)
uint32_t	GetReferenceCount (void) const
SimpleRefCount &	operator= (const SimpleRefCount &o)
void	Ref (void) const
void	Unref (void) const
Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
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)
	This method returns the TypeId associated to ns3::ParetoRandomVariable.

Private Attributes
double	m_bound
	The upper bound on values that can be returned by this RNG stream.
double	m_mean
	The mean parameter for the Pareto distribution returned by this RNG stream.
double	m_shape
	The shape parameter for the Pareto distribution returned by this RNG stream.

Additional Inherited Members
Protected Member Functions inherited from ns3::RandomVariableStream
RngStream *	Peek (void) const
	Returns a pointer to the underlying RNG stream.

Detailed Description

The Pareto 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 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 infered 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 mean = 5.0;
double shape = 2.0;
Ptr<ParetoRandomVariable> x = CreateObject<ParetoRandomVariable> ();
x->SetAttribute ("Mean", DoubleValue (mean));
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
// 
// where
// 
//     scale  =  mean * (shape - 1.0) / shape .
//
double value = x->GetValue ();

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

Constructor & Destructor Documentation

ns3::ParetoRandomVariable::ParetoRandomVariable ( )

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

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

Member Function Documentation

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

References m_bound.

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

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

Parameters

mean	Mean parameter for the Pareto distribution.
shape	Shape parameter for the Pareto distribution.
bound	Upper 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, where

$scale = mean * (shape - 1.0) / shape .$

Then $(1 - u$ ) is the distance that $u$ would be from $1$ . 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 denonator.

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

References GetValue().

Here is the call graph for this function:

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, where

$scale = mean * (shape - 1.0) / shape .$

Then $(1 - u$ ) is the distance that $u$ would be from $1$ . 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 denonator.

Implements ns3::RandomVariableStream.

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

References GetValue(), m_bound, m_mean, and m_shape.

Here is the call graph for this function:

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

References m_mean.

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

References m_shape.

TypeId ns3::ParetoRandomVariable::GetTypeId ( void )

static

This method returns the TypeId associated to ns3::ParetoRandomVariable.

This object is accessible through the following paths with Config::Set and Config::Connect:

/NodeList/[i]/$ns3::MobilityModel/$ns3::GaussMarkovMobilityModel/MeanDirection/$ns3::ParetoRandomVariable
/NodeList/[i]/$ns3::MobilityModel/$ns3::GaussMarkovMobilityModel/MeanPitch/$ns3::ParetoRandomVariable
/NodeList/[i]/$ns3::MobilityModel/$ns3::GaussMarkovMobilityModel/MeanVelocity/$ns3::ParetoRandomVariable
/NodeList/[i]/$ns3::MobilityModel/$ns3::RandomDirection2dMobilityModel/Pause/$ns3::ParetoRandomVariable
/NodeList/[i]/$ns3::MobilityModel/$ns3::RandomDirection2dMobilityModel/Speed/$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/Pause/$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/Rho/$ns3::ParetoRandomVariable
/NodeList/[i]/$ns3::MobilityModel/$ns3::RandomWaypointMobilityModel/PositionAllocator/$ns3::RandomDiscPositionAllocator/Theta/$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/Speed/$ns3::ParetoRandomVariable
/NodeList/[i]/ApplicationList/[i]/$ns3::OnOffApplication/OffTime/$ns3::ParetoRandomVariable
/NodeList/[i]/ApplicationList/[i]/$ns3::OnOffApplication/OnTime/$ns3::ParetoRandomVariable
/NodeList/[i]/DeviceList/[i]/$ns3::CsmaNetDevice/ReceiveErrorModel/$ns3::RateErrorModel/RanVar/$ns3::ParetoRandomVariable
/NodeList/[i]/DeviceList/[i]/$ns3::PointToPointNetDevice/ReceiveErrorModel/$ns3::RateErrorModel/RanVar/$ns3::ParetoRandomVariable
/NodeList/[i]/DeviceList/[i]/$ns3::SimpleNetDevice/ReceiveErrorModel/$ns3::RateErrorModel/RanVar/$ns3::ParetoRandomVariable
/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Channel/$ns3::YansWifiChannel/PropagationDelayModel/$ns3::RandomPropagationDelayModel/Variable/$ns3::ParetoRandomVariable
/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Channel/$ns3::YansWifiChannel/PropagationLossModel/$ns3::RandomPropagationLossModel/Variable/$ns3::ParetoRandomVariable

Attributes defined for this type:

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: 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.
- 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 defined for this type.

Reimplemented from ns3::RandomVariableStream.

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

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

Here is the call graph for this function:

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

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

Parameters

mean	Mean parameter for the Pareto distribution.
shape	Shape parameter for the Pareto distribution.
bound	Upper 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, where

$scale = mean * (shape - 1.0) / shape .$

Then $(1 - u$ ) is the distance that $u$ would be from $1$ . 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 denonator.

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

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 .$

Then $(1 - u$ ) is the distance that $u$ would be from $1$ . 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 denonator.

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

References m_bound, m_mean, and m_shape.

Referenced by GetInteger().

Here is the caller graph for this function: