|
A Discrete-Event Network Simulator
|
API |
|
|
A Discrete-Event Network Simulator
|
API |
The basic uniform Random Number Generator (RNG). More...
#include "random-variable-stream.h"
Inheritance diagram for ns3::RandomVariableStream: Collaboration diagram for ns3::RandomVariableStream:Public Member Functions | |
| RandomVariableStream () | |
| Default constructor. More... | |
| virtual | ~RandomVariableStream () |
| Destructor. More... | |
| virtual uint32_t | GetInteger (void)=0 |
| Get the next random value as an integer drawn from the distribution. More... | |
| int64_t | GetStream (void) const |
| Returns the stream number for the RngStream. More... | |
| virtual double | GetValue (void)=0 |
| Get the next random value as a double drawn from the distribution. 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<> | |
| Ptr< Object > | GetObject () const |
| Specialization of () for objects of type ns3::Object. More... | |
| template<typename T > | |
| Ptr< T > | GetObject (TypeId tid) const |
| Get a pointer to the requested aggregated Object by TypeId. More... | |
| template<> | |
| Ptr< Object > | GetObject (TypeId tid) const |
| Specialization of (TypeId tid) for objects of type ns3::Object. More... | |
| template<typename T > | |
| Ptr< T > | GetObject (void) const |
| Get a pointer to the requested aggregated Object. 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[[maybe_unused]]) | |
| Copy constructor. More... | |
| uint32_t | GetReferenceCount (void) const |
| Get the reference count of the object. More... | |
| SimpleRefCount & | operator= ([[maybe_unused]] 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::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... | |
Protected Member Functions | |
| RngStream * | Peek (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... | |
Private Member Functions | |
| RandomVariableStream (const RandomVariableStream &o) | |
| Copy constructor. More... | |
| RandomVariableStream & | operator= (const RandomVariableStream &o) |
| Assignment operator. More... | |
Private Attributes | |
| bool | m_isAntithetic |
| Indicates if antithetic values should be generated by this RNG stream. More... | |
| RngStream * | m_rng |
| Pointer to the underlying RngStream. More... | |
| int64_t | m_stream |
| The stream number for the RngStream. More... | |
Additional Inherited Members | |
| Related Functions inherited from ns3::ObjectBase | |
| static TypeId | GetObjectIid (void) |
| Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More... | |
The basic uniform Random Number Generator (RNG).
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 functionality 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 the underlying RngStream is automatically allocated.
Instances can be configured to return "antithetic" values. See the documentation for the specific distributions to see how this modifies the returned values.
ns3::RandomVariableStream is accessible through the following paths with Config::Set and Config::Connect:
No TraceSources are defined for this type.
Size of this type is 56 bytes (on a 64-bit architecture).
Definition at line 97 of file random-variable-stream.h.
| ns3::RandomVariableStream::RandomVariableStream | ( | ) |
Default constructor.
Definition at line 75 of file random-variable-stream.cc.
References NS_LOG_FUNCTION.
|
virtual |
Destructor.
Definition at line 80 of file random-variable-stream.cc.
References m_rng, and NS_LOG_FUNCTION.
|
private |
Copy constructor.
These objects are not copyable.
| [in] | o | The RandomVariableStream to copy in construction. |
|
pure virtual |
Get the next random value as an integer drawn from the distribution.
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::BurstErrorModel::DoCorrupt(), and ns3::MeshPointDevice::GetForwardingDelay().
Here is the caller graph for this function:| int64_t ns3::RandomVariableStream::GetStream | ( | void | ) | const |
Returns the stream number for the RngStream.
Definition at line 128 of file random-variable-stream.cc.
References m_stream, and NS_LOG_FUNCTION.
Referenced by GetTypeId().
Here is the caller graph for this function:
|
static |
Register this type.
Definition at line 53 of file random-variable-stream.cc.
References GetStream(), IsAntithetic(), ns3::MakeBooleanAccessor(), ns3::MakeBooleanChecker(), ns3::MakeIntegerAccessor(), SetAntithetic(), ns3::TypeId::SetParent(), and SetStream().
Here is the call graph for this function:
|
pure virtual |
Get the next random value as a double drawn from the distribution.
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::RandomWalk2dOutdoorMobilityModel::AvoidBuilding(), ns3::RandomDirection2dMobilityModel::BeginPause(), ns3::RandomWaypointMobilityModel::BeginWalk(), ns3::DhcpClient::Boot(), ns3::BasicEnergyHarvester::CalculateHarvestedPower(), ns3::RandomPropagationLossModel::DoCalcRxPower(), ns3::BurstErrorModel::DoCorrupt(), ns3::RateErrorModel::DoCorruptBit(), ns3::RateErrorModel::DoCorruptByte(), ns3::RateErrorModel::DoCorruptPkt(), ns3::Icmpv6L4Protocol::DoDAD(), ns3::RandomWalk2dOutdoorMobilityModel::DoInitializePrivate(), ns3::RandomWalk2dMobilityModel::DoInitializePrivate(), ns3::RandomWaypointMobilityModel::DoInitializePrivate(), ns3::RandomPropagationDelayModel::GetDelay(), ns3::OutdoorPositionAllocator::GetNext(), ns3::RandomRectanglePositionAllocator::GetNext(), ns3::RandomBoxPositionAllocator::GetNext(), ns3::RandomDiscPositionAllocator::GetNext(), ns3::SequentialRandomVariable::GetValue(), ns3::ArpL3Protocol::Lookup(), ns3::SixLowPanNetDevice::ReceiveFromDevice(), ns3::DhcpClient::Request(), ns3::OnOffApplication::ScheduleStartEvent(), ns3::OnOffApplication::ScheduleStopEvent(), ns3::Icmpv6L4Protocol::SendNS(), ns3::Icmpv6L4Protocol::SendRS(), ns3::RandomDirection2dMobilityModel::SetDirectionAndSpeed(), ns3::GaussMarkovMobilityModel::Start(), and ns3::ApplicationContainer::StartWithJitter().
Here is the caller graph for this function:| bool ns3::RandomVariableStream::IsAntithetic | ( | void | ) | const |
Check if antithetic values will be generated.
true if antithetic values will be generated. Definition at line 93 of file random-variable-stream.cc.
References m_isAntithetic, and NS_LOG_FUNCTION.
Referenced by ns3::ErlangRandomVariable::GetExponentialValue(), ns3::GammaRandomVariable::GetNormalValue(), GetTypeId(), ns3::GammaRandomVariable::GetValue(), ns3::ExponentialRandomVariable::GetValue(), ns3::TriangularRandomVariable::GetValue(), ns3::NormalRandomVariable::GetValue(), ns3::UniformRandomVariable::GetValue(), ns3::LogNormalRandomVariable::GetValue(), ns3::ParetoRandomVariable::GetValue(), ns3::WeibullRandomVariable::GetValue(), ns3::ZipfRandomVariable::GetValue(), and ns3::EmpiricalRandomVariable::PreSample().
Here is the caller graph for this function:
|
private |
Assignment operator.
These objects can't be copied by assignment.
| [in] | o | The RandomVariableStream to copy. |
|
protected |
Get the pointer to the underlying RngStream.
Definition at line 135 of file random-variable-stream.cc.
References m_rng, and NS_LOG_FUNCTION.
Referenced by ns3::ErlangRandomVariable::GetExponentialValue(), ns3::GammaRandomVariable::GetNormalValue(), ns3::GammaRandomVariable::GetValue(), ns3::ExponentialRandomVariable::GetValue(), ns3::TriangularRandomVariable::GetValue(), ns3::NormalRandomVariable::GetValue(), ns3::UniformRandomVariable::GetValue(), ns3::LogNormalRandomVariable::GetValue(), ns3::ParetoRandomVariable::GetValue(), ns3::WeibullRandomVariable::GetValue(), ns3::ZipfRandomVariable::GetValue(), and ns3::EmpiricalRandomVariable::PreSample().
Here is the caller graph for this function:| void ns3::RandomVariableStream::SetAntithetic | ( | bool | isAntithetic | ) |
Specify whether antithetic values should be generated.
| [in] | isAntithetic | If true antithetic value will be generated. |
Definition at line 87 of file random-variable-stream.cc.
References m_isAntithetic, and NS_LOG_FUNCTION.
Referenced by GetTypeId().
Here is the caller graph for this function:| void ns3::RandomVariableStream::SetStream | ( | int64_t | stream | ) |
Specifies the stream number for the RngStream.
| [in] | stream | The stream number for the RngStream. -1 means "allocate a stream number automatically". |
Definition at line 99 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 RandCartAroundGeoTestSuite::RandCartAroundGeoTestSuite(), ns3::aodv::RoutingProtocol::AssignStreams(), ns3::OnOffApplication::AssignStreams(), ns3::ThreeGppHttpVariables::AssignStreams(), ns3::RandomBuildingPositionAllocator::AssignStreams(), ns3::OutdoorPositionAllocator::AssignStreams(), ns3::RandomRoomPositionAllocator::AssignStreams(), ns3::Backoff::AssignStreams(), ns3::dsdv::RoutingProtocol::AssignStreams(), ns3::dsr::DsrRouting::AssignStreams(), ns3::BasicEnergyHarvester::AssignStreams(), ns3::DhcpClient::AssignStreams(), ns3::Radvd::AssignStreams(), ns3::ArpL3Protocol::AssignStreams(), ns3::Icmpv6L4Protocol::AssignStreams(), ns3::Ipv4GlobalRouting::AssignStreams(), ns3::Ipv6Extension::AssignStreams(), ns3::Rip::AssignStreams(), ns3::RipNg::AssignStreams(), ns3::LrWpanCsmaCa::AssignStreams(), ns3::LrWpanPhy::AssignStreams(), ns3::LteSpectrumPhy::AssignStreams(), ns3::LteUeMac::AssignStreams(), ns3::dot11s::HwmpProtocol::AssignStreams(), ns3::dot11s::PeerManagementProtocol::AssignStreams(), ns3::MeshPointDevice::AssignStreams(), ns3::MeshWifiInterfaceMac::AssignStreams(), ns3::RandomRectanglePositionAllocator::AssignStreams(), ns3::RandomBoxPositionAllocator::AssignStreams(), ns3::RandomDiscPositionAllocator::AssignStreams(), ns3::UniformDiscPositionAllocator::AssignStreams(), ns3::RateErrorModel::AssignStreams(), ns3::BurstErrorModel::AssignStreams(), ns3::olsr::RoutingProtocol::AssignStreams(), ns3::SixLowPanNetDevice::AssignStreams(), ns3::ThreeGppChannelModel::AssignStreams(), ns3::CobaltQueueDisc::AssignStreams(), ns3::PieQueueDisc::AssignStreams(), ns3::RedQueueDisc::AssignStreams(), ns3::UanMacCw::AssignStreams(), ns3::UanMacRc::AssignStreams(), ns3::UanPhyGen::AssignStreams(), ns3::ApWifiMac::AssignStreams(), ns3::Txop::AssignStreams(), ns3::WifiPhy::AssignStreams(), ns3::SimpleOfdmWimaxPhy::AssignStreams(), ns3::ThreeGppChannelConditionModel::AssignStreams(), ns3::MinstrelHtWifiManager::AssignStreams(), ns3::MinstrelWifiManager::AssignStreams(), ns3::RrpaaWifiManager::AssignStreams(), ns3::BsmApplication::AssignStreams(), ns3::TrickleTimer::AssignStreams(), ns3::TvSpectrumTransmitterHelper::AssignStreams(), ns3::BriteTopologyHelper::AssignStreams(), ns3::SameRoomPositionAllocator::AssignStreams(), ns3::FixedRoomPositionAllocator::AssignStreams(), ns3::RandomVariableStreamHelper::AssignStreams(), ns3::JakesPropagationLossModel::DoAssignStreams(), ns3::RandomPropagationDelayModel::DoAssignStreams(), ns3::RandomPropagationLossModel::DoAssignStreams(), ns3::ThreeGppUmaPropagationLossModel::DoAssignStreams(), ns3::RandomWalk2dOutdoorMobilityModel::DoAssignStreams(), ns3::GaussMarkovMobilityModel::DoAssignStreams(), ns3::RandomDirection2dMobilityModel::DoAssignStreams(), ns3::RandomWalk2dMobilityModel::DoAssignStreams(), ns3::RandomWaypointMobilityModel::DoAssignStreams(), ns3::SteadyStateRandomWaypointMobilityModel::DoAssignStreams(), ns3::TraceFadingLossModel::DoCalcRxPowerSpectralDensity(), LteX2HandoverMeasuresTestCase::DoRun(), LteX2HandoverTestCase::DoRun(), ErrorModelSimple::DoRun(), BurstErrorModelSimple::DoRun(), GetTypeId(), ns3::TcpBbr::SetStream(), and RoutingHelper::SetupRoutingMessages().
Here is the call graph for this function:
|
private |
Indicates if antithetic values should be generated by this RNG stream.
Definition at line 185 of file random-variable-stream.h.
Referenced by IsAntithetic(), and SetAntithetic().
|
private |
Pointer to the underlying RngStream.
Definition at line 182 of file random-variable-stream.h.
Referenced by ~RandomVariableStream(), Peek(), and SetStream().
|
private |
The stream number for the RngStream.
Definition at line 188 of file random-variable-stream.h.
Referenced by GetStream(), and SetStream().
1.9.1 
