|
A Discrete-Event Network Simulator
|
API |
|
|
A Discrete-Event Network Simulator
|
API |
The uniform distribution Random Number Generator (RNG). More...
#include "random-variable-stream.h"
Inheritance diagram for ns3::UniformRandomVariable:Public Member Functions | |
| UniformRandomVariable () | |
| Creates a uniform distribution RNG with the default range. More... | |
| double | GetMax (void) const |
| Get the upper bound on values returned by GetValue(void). More... | |
| double | GetMin (void) const |
| Get the lower bound on randoms returned by GetValue(void). More... | |
| double | GetValue (double min, double max) |
Get the next random value, as a double in the specified range  . More... | |
| Public Member Functions inherited from ns3::RandomVariableStream | |
| 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<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... | |
| SimpleRefCount & | operator= (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... | |
Additional Inherited Members | |
| Protected Member Functions inherited from ns3::RandomVariableStream | |
| 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... | |
| 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 uniform distribution Random Number Generator (RNG).
This class supports the creation of objects that return random numbers from a fixed uniform distribution. It also supports the generation of single random numbers from various uniform distributions.
The output range is for floating point values, (max excluded), and ![$[min, max]$](form_4.png)
(max included) for integral values.
Here is an example of how to use this class:
Normally this RNG returns values 
in the interval 
. If an instance of this RNG is configured to return antithetic values, the actual value returned is calculated as follows:
as normal.
:ns3::UniformRandomVariable is accessible through the following paths with Config::Set and Config::Connect:
No TraceSources are defined for this type.
Size of this type is 72 bytes (on a 64-bit architecture).
Definition at line 234 of file random-variable-stream.h.
| ns3::UniformRandomVariable::UniformRandomVariable | ( | ) |
Creates a uniform distribution RNG with the default range.
Definition at line 161 of file random-variable-stream.cc.
References NS_LOG_FUNCTION.
| double ns3::UniformRandomVariable::GetMax | ( | void | ) | const |
Get the upper bound on values returned by GetValue(void).
Definition at line 174 of file random-variable-stream.cc.
References NS_LOG_FUNCTION.
| double ns3::UniformRandomVariable::GetMin | ( | void | ) | const |
Get the lower bound on randoms returned by GetValue(void).
Definition at line 168 of file random-variable-stream.cc.
References NS_LOG_FUNCTION.
|
static |
Register this type.
Definition at line 144 of file random-variable-stream.cc.
References ns3::MakeDoubleAccessor(), and ns3::TypeId::SetParent().
| double ns3::UniformRandomVariable::GetValue | ( | double | min, |
| double | max | ||
| ) |
Get the next random value, as a double in the specified range .
| [in] | min | Low end of the range (included). |
| [in] | max | High end of the range (excluded). |
Definition at line 181 of file random-variable-stream.cc.
References ns3::RandomVariableStream::IsAntithetic(), max, min, NS_LOG_FUNCTION, ns3::RandomVariableStream::Peek(), and ns3::RngStream::RandU01().
Referenced by ns3::SteadyStateRandomWaypointMobilityModel::BeginWalk(), ns3::LrWpanPhy::CheckInterference(), RngUniformTestCase::ChiSquaredTest(), RandomVariableStreamUniformTestCase::ChiSquaredTest(), RandomVariableStreamUniformAntitheticTestCase::ChiSquaredTest(), FemtocellBlockAllocator::Create(), ns3::SixLowPanNetDevice::DoFragmentation(), ns3::dot11s::HwmpProtocol::DoInitialize(), ns3::MeshWifiInterfaceMac::DoInitialize(), ns3::Rip::DoInitialize(), ns3::RipNg::DoInitialize(), ns3::ApWifiMac::DoInitialize(), ns3::RandomDirection2dMobilityModel::DoInitializePrivate(), ns3::SteadyStateRandomWaypointMobilityModel::DoInitializePrivate(), BufferTest::DoRun(), ns3::tests::OneUniformRandomVariableManyGetValueCallsTestCase::DoRun(), LteX2HandoverTestCase::DoRun(), LteX2HandoverMeasuresTestCase::DoRun(), LteDistributedFfrAreaTestCase::DoRun(), ns3::PieQueueDisc::DropEarly(), ns3::RedQueueDisc::DropEarly(), ns3::WifiPhy::EndReceive(), ns3::LteSpectrumPhy::EndRxData(), ns3::LteSpectrumPhy::EndRxDlCtrl(), ns3::UanMacCw::Enqueue(), ns3::Backoff::GetBackoffTime(), ns3::Ipv6ExtensionFragment::GetFragments(), ns3::ThreeGppHttpVariables::GetMtuSize(), ns3::RandomBuildingPositionAllocator::GetNext(), ns3::RandomRoomPositionAllocator::GetNext(), ns3::SameRoomPositionAllocator::GetNext(), ns3::FixedRoomPositionAllocator::GetNext(), ns3::UniformDiscPositionAllocator::GetNext(), ns3::Radvd::HandleRead(), DsdvManetExample::InstallApplications(), ns3::LrWpanMac::LrWpanMac(), modify(), Tunnel::N3VirtualSend(), ns3::GeographicPositions::RandCartesianPointsAroundGeographicPoint(), ns3::LrWpanCsmaCa::RandomBackoffDelay(), ns3::RandomDirection2dMobilityModel::ResetDirectionAndSpeed(), NetAnimExperiment::Run(), Experiment::Run(), RoutingExperiment::Run(), ns3::RrpaaWifiManager::RunBasicAlgorithm(), ns3::UanPhyGen::RxEndEvent(), ns3::dsr::DsrRouting::ScheduleCachedReply(), ns3::Radvd::Send(), Experiment::SendMultiDestinations(), UanExperiment::SendPackets(), ns3::Rip::SendTriggeredRouteUpdate(), ns3::RipNg::SendTriggeredRouteUpdate(), ns3::Rip::SendUnsolicitedRouteUpdate(), ns3::RipNg::SendUnsolicitedRouteUpdate(), RoutingHelper::SetupRoutingMessages(), ns3::dot11s::PeerManagementProtocol::ShiftOwnBeacon(), ns3::SteadyStateRandomWaypointMobilityModel::Start(), ns3::SimpleOfdmWimaxPhy::StartReceive(), ns3::WifiPhy::StartReceivePacket(), ns3::SteadyStateRandomWaypointMobilityModel::SteadyStateBeginWalk(), ns3::AnimationInterface::UpdatePosition(), NetAnimExperiment::UpdatePositions(), and Experiment::UpdatePositions().
1.8.14
