A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
ns3::RandomVariableStream Class Reference
Random Variable Distributions

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

#include <random-variable-stream.h>

+ Inheritance diagram for ns3::RandomVariableStream:
+ Collaboration diagram for ns3::RandomVariableStream:

Public Member Functions

 RandomVariableStream ()
virtual ~RandomVariableStream ()
virtual uint32_t GetInteger (void)=0
 Returns a random integer integer from the underlying distribution.
int64_t GetStream (void) const
 Returns the stream number for this RNG stream.
virtual double GetValue (void)=0
 Returns a random double from the underlying distribution.
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::RandomVariableStream.

Protected Member Functions

RngStream * Peek (void) const
 Returns a pointer to the underlying RNG stream.
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
virtual void DoDispose (void)
virtual void DoStart (void)
virtual void NotifyNewAggregate (void)

Private Member Functions

 RandomVariableStream (const RandomVariableStream &o)
RandomVariableStream & operator= (const RandomVariableStream &o)

Private Attributes

bool m_isAntithetic
 Indicates if antithetic values should be generated by this RNG stream.
RngStream * m_rng
 Pointer to the underlying RNG stream.
int64_t m_stream
 The stream number for this RNG stream.

Detailed Description

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

Note: The underlying random number generation method used by NS-3 is the RngStream code by Pierre L'Ecuyer at the University of Montreal.

NS-3 has a rich set of random number generators that allow stream numbers to be set deterministically if desired. Class RandomVariableStream defines the base class functionalty required for all such random number generators.

By default, the underlying generator is seeded all the time with the same seed value and run number coming from the ns3::GlobalValue RngSeed and RngRun. Also by default, the stream number value for this RNG stream is automatically allocated.

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

Constructor & Destructor Documentation

ns3::RandomVariableStream::RandomVariableStream ( )

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

ns3::RandomVariableStream::~RandomVariableStream ( )
virtual

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

References m_rng.

ns3::RandomVariableStream::RandomVariableStream ( const RandomVariableStream &  o)
private

Member Function Documentation

virtual uint32_t ns3::RandomVariableStream::GetInteger ( void  )
pure virtual

Returns a random integer integer from the underlying distribution.

Returns
Integer cast of RandomVariableStream::GetValue

Implemented in ns3::EmpiricalRandomVariable, ns3::DeterministicRandomVariable, ns3::ZetaRandomVariable, ns3::ZipfRandomVariable, ns3::TriangularRandomVariable, ns3::ErlangRandomVariable, ns3::GammaRandomVariable, ns3::LogNormalRandomVariable, ns3::NormalRandomVariable, ns3::WeibullRandomVariable, ns3::ParetoRandomVariable, ns3::ExponentialRandomVariable, ns3::SequentialRandomVariable, ns3::ConstantRandomVariable, and ns3::UniformRandomVariable.

int64_t ns3::RandomVariableStream::GetStream ( void  ) const

Returns the stream number for this RNG stream.

Returns
The stream number for this RNG stream. -1 means "allocate a stream number automatically".

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

References m_stream.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

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

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

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

  • /NodeList/[i]/$ns3::MobilityModel/$ns3::GaussMarkovMobilityModel/MeanDirection
  • /NodeList/[i]/$ns3::MobilityModel/$ns3::GaussMarkovMobilityModel/MeanPitch
  • /NodeList/[i]/$ns3::MobilityModel/$ns3::GaussMarkovMobilityModel/MeanVelocity
  • /NodeList/[i]/$ns3::MobilityModel/$ns3::RandomDirection2dMobilityModel/Pause
  • /NodeList/[i]/$ns3::MobilityModel/$ns3::RandomDirection2dMobilityModel/Speed
  • /NodeList/[i]/$ns3::MobilityModel/$ns3::RandomWalk2dMobilityModel/Direction
  • /NodeList/[i]/$ns3::MobilityModel/$ns3::RandomWalk2dMobilityModel/Speed
  • /NodeList/[i]/$ns3::MobilityModel/$ns3::RandomWaypointMobilityModel/Pause
  • /NodeList/[i]/$ns3::MobilityModel/$ns3::RandomWaypointMobilityModel/PositionAllocator/$ns3::RandomBoxPositionAllocator/X
  • /NodeList/[i]/$ns3::MobilityModel/$ns3::RandomWaypointMobilityModel/PositionAllocator/$ns3::RandomBoxPositionAllocator/Y
  • /NodeList/[i]/$ns3::MobilityModel/$ns3::RandomWaypointMobilityModel/PositionAllocator/$ns3::RandomBoxPositionAllocator/Z
  • /NodeList/[i]/$ns3::MobilityModel/$ns3::RandomWaypointMobilityModel/PositionAllocator/$ns3::RandomDiscPositionAllocator/Rho
  • /NodeList/[i]/$ns3::MobilityModel/$ns3::RandomWaypointMobilityModel/PositionAllocator/$ns3::RandomDiscPositionAllocator/Theta
  • /NodeList/[i]/$ns3::MobilityModel/$ns3::RandomWaypointMobilityModel/PositionAllocator/$ns3::RandomRectanglePositionAllocator/X
  • /NodeList/[i]/$ns3::MobilityModel/$ns3::RandomWaypointMobilityModel/PositionAllocator/$ns3::RandomRectanglePositionAllocator/Y
  • /NodeList/[i]/$ns3::MobilityModel/$ns3::RandomWaypointMobilityModel/Speed
  • /NodeList/[i]/ApplicationList/[i]/$ns3::OnOffApplication/OffTime
  • /NodeList/[i]/ApplicationList/[i]/$ns3::OnOffApplication/OnTime
  • /NodeList/[i]/DeviceList/[i]/$ns3::CsmaNetDevice/ReceiveErrorModel/$ns3::RateErrorModel/RanVar
  • /NodeList/[i]/DeviceList/[i]/$ns3::PointToPointNetDevice/ReceiveErrorModel/$ns3::RateErrorModel/RanVar
  • /NodeList/[i]/DeviceList/[i]/$ns3::SimpleNetDevice/ReceiveErrorModel/$ns3::RateErrorModel/RanVar
  • /NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Channel/$ns3::YansWifiChannel/PropagationDelayModel/$ns3::RandomPropagationDelayModel/Variable
  • /NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Channel/$ns3::YansWifiChannel/PropagationLossModel/$ns3::RandomPropagationLossModel/Variable

Attributes defined for this type:

  • 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::Object.

Reimplemented in ns3::EmpiricalRandomVariable, ns3::DeterministicRandomVariable, ns3::ZetaRandomVariable, ns3::ZipfRandomVariable, ns3::TriangularRandomVariable, ns3::ErlangRandomVariable, ns3::GammaRandomVariable, ns3::LogNormalRandomVariable, ns3::NormalRandomVariable, ns3::WeibullRandomVariable, ns3::ParetoRandomVariable, ns3::ExponentialRandomVariable, ns3::SequentialRandomVariable, ns3::ConstantRandomVariable, and ns3::UniformRandomVariable.

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

References GetStream(), IsAntithetic(), SetAntithetic(), ns3::TypeId::SetParent(), and SetStream().

+ Here is the call graph for this function:

virtual double ns3::RandomVariableStream::GetValue ( void  )
pure virtual

Returns a random double from the underlying distribution.

Returns
A floating point random value.

Implemented in ns3::EmpiricalRandomVariable, ns3::DeterministicRandomVariable, ns3::ZetaRandomVariable, ns3::ZipfRandomVariable, ns3::TriangularRandomVariable, ns3::ErlangRandomVariable, ns3::GammaRandomVariable, ns3::LogNormalRandomVariable, ns3::NormalRandomVariable, ns3::WeibullRandomVariable, ns3::ParetoRandomVariable, ns3::ExponentialRandomVariable, ns3::SequentialRandomVariable, ns3::ConstantRandomVariable, and ns3::UniformRandomVariable.

Referenced by ns3::RandomDirection2dMobilityModel::BeginPause(), ns3::RandomWaypointMobilityModel::BeginWalk(), ns3::RandomPropagationLossModel::DoCalcRxPower(), ns3::RateErrorModel::DoCorruptBit(), ns3::RateErrorModel::DoCorruptByte(), ns3::RateErrorModel::DoCorruptPkt(), ns3::RandomWalk2dMobilityModel::DoStartPrivate(), ns3::RandomWaypointMobilityModel::DoStartPrivate(), ns3::RandomPropagationDelayModel::GetDelay(), ns3::RandomRectanglePositionAllocator::GetNext(), ns3::RandomBoxPositionAllocator::GetNext(), ns3::RandomDiscPositionAllocator::GetNext(), ns3::SequentialRandomVariable::GetValue(), Histogramm(), ns3::RandomDirection2dMobilityModel::SetDirectionAndSpeed(), and ns3::GaussMarkovMobilityModel::Start().

+ Here is the caller graph for this function:

bool ns3::RandomVariableStream::IsAntithetic ( void  ) const

Returns true if antithetic values should be generated.

Returns
A bool value that indicates if antithetic values should be generated by this RNG stream.

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

References m_isAntithetic.

Referenced by ns3::ErlangRandomVariable::GetExponentialValue(), ns3::GammaRandomVariable::GetNormalValue(), GetTypeId(), ns3::UniformRandomVariable::GetValue(), ns3::ExponentialRandomVariable::GetValue(), ns3::ParetoRandomVariable::GetValue(), ns3::WeibullRandomVariable::GetValue(), ns3::NormalRandomVariable::GetValue(), ns3::LogNormalRandomVariable::GetValue(), ns3::GammaRandomVariable::GetValue(), ns3::TriangularRandomVariable::GetValue(), ns3::ZipfRandomVariable::GetValue(), ns3::ZetaRandomVariable::GetValue(), and ns3::EmpiricalRandomVariable::GetValue().

+ Here is the caller graph for this function:

RandomVariableStream& ns3::RandomVariableStream::operator= ( const RandomVariableStream &  o)
private
RngStream * ns3::RandomVariableStream::Peek ( void  ) const
protected

Returns a pointer to the underlying RNG stream.

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

References m_rng.

Referenced by ns3::ErlangRandomVariable::GetExponentialValue(), ns3::GammaRandomVariable::GetNormalValue(), ns3::UniformRandomVariable::GetValue(), ns3::ExponentialRandomVariable::GetValue(), ns3::ParetoRandomVariable::GetValue(), ns3::WeibullRandomVariable::GetValue(), ns3::NormalRandomVariable::GetValue(), ns3::LogNormalRandomVariable::GetValue(), ns3::GammaRandomVariable::GetValue(), ns3::TriangularRandomVariable::GetValue(), ns3::ZipfRandomVariable::GetValue(), ns3::ZetaRandomVariable::GetValue(), and ns3::EmpiricalRandomVariable::GetValue().

+ Here is the caller graph for this function:

void ns3::RandomVariableStream::SetAntithetic ( bool  isAntithetic)

Specifies whether antithetic values should be generated.

Parameters
isAntitheticSet equal to true if antithetic values should be generated by this RNG stream.

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

References m_isAntithetic.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

void ns3::RandomVariableStream::SetStream ( int64_t  stream)

Specifies the stream number for this RNG stream.

Parameters
streamThe stream number for this RNG stream. -1 means "allocate a stream number automatically".

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

References ns3::RngSeedManager::GetNextStreamIndex(), ns3::RngSeedManager::GetRun(), ns3::RngSeedManager::GetSeed(), m_rng, m_stream, NS_ASSERT, and NS_LOG_FUNCTION.

Referenced by ns3::RandomBuildingPositionAllocator::AssignStreams(), ns3::RandomVariableStreamHelper::AssignStreams(), ns3::RealRandomStream::AssignStreams(), ns3::Radvd::AssignStreams(), ns3::RandomRoomPositionAllocator::AssignStreams(), ns3::dsdv::RoutingProtocol::AssignStreams(), ns3::dot11s::HwmpProtocol::AssignStreams(), ns3::Backoff::AssignStreams(), ns3::UanMacCw::AssignStreams(), ns3::aodv::RoutingProtocol::AssignStreams(), ns3::MinstrelWifiManager::AssignStreams(), ns3::olsr::RoutingProtocol::AssignStreams(), ns3::Ipv6Extension::AssignStreams(), ns3::SameRoomPositionAllocator::AssignStreams(), ns3::MeshWifiInterfaceMac::AssignStreams(), ns3::YansWifiPhy::AssignStreams(), ns3::dot11s::PeerManagementProtocol::AssignStreams(), ns3::UanMacRc::AssignStreams(), ns3::RedQueue::AssignStreams(), ns3::SimpleOfdmWimaxPhy::AssignStreams(), ns3::RandomRectanglePositionAllocator::AssignStreams(), ns3::RateErrorModel::AssignStreams(), ns3::RandomBoxPositionAllocator::AssignStreams(), ns3::UanPhyGen::AssignStreams(), ns3::LteSpectrumPhy::AssignStreams(), ns3::Ipv4GlobalRouting::AssignStreams(), ns3::RandomDiscPositionAllocator::AssignStreams(), ns3::UniformDiscPositionAllocator::AssignStreams(), ns3::AnimationInterface::AssignStreams(), ns3::dsr::DsrRouting::AssignStreams(), ns3::JakesPropagationLossModel::DoAssignStreams(), ns3::RandomDirection2dMobilityModel::DoAssignStreams(), ns3::RandomWaypointMobilityModel::DoAssignStreams(), ns3::RandomWalk2dMobilityModel::DoAssignStreams(), ns3::SteadyStateRandomWaypointMobilityModel::DoAssignStreams(), ns3::RandomPropagationDelayModel::DoAssignStreams(), ns3::GaussMarkovMobilityModel::DoAssignStreams(), ns3::BuildingsPropagationLossModel::DoAssignStreams(), ns3::RandomPropagationLossModel::DoAssignStreams(), ns3::NakagamiPropagationLossModel::DoAssignStreams(), ErrorModelSimple::DoRun(), and GetTypeId().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Member Data Documentation

bool ns3::RandomVariableStream::m_isAntithetic
private

Indicates if antithetic values should be generated by this RNG stream.

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

Referenced by IsAntithetic(), and SetAntithetic().

RngStream* ns3::RandomVariableStream::m_rng
private

Pointer to the underlying RNG stream.

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

Referenced by Peek(), SetStream(), and ~RandomVariableStream().

int64_t ns3::RandomVariableStream::m_stream
private

The stream number for this RNG stream.

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

Referenced by GetStream(), and SetStream().

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