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

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

#include <random-variable-stream.h>

+ Inheritance diagram for ns3::UniformRandomVariable:

Public Member Functions

 UniformRandomVariable ()
 Creates a uniform distribution RNG with the default range.
 
uint32_t GetInteger (uint32_t min, uint32_t max)
 Returns a random unsigned integer from a uniform distribution over the interval [min,max] including both ends. More...
 
virtual uint32_t GetInteger (void)
 Returns a random unsigned integer from a uniform distribution over the interval [min,max] including both ends, where min and max are the current lower and upper bounds. More...
 
double GetMax (void) const
 Returns the upper bound on values that can be returned by this RNG stream. More...
 
double GetMin (void) const
 Returns the lower bound on values that can be returned by this RNG stream. More...
 
double GetValue (double min, double max)
 Returns a random double from the uniform distribution with the specified range. More...
 
virtual double GetValue (void)
 Returns a random double from the uniform distribution with the range [min,max), where min and max are the current lower and upper bounds. More...
 
- Public Member Functions inherited from ns3::RandomVariableStream
int64_t GetStream (void) const
 Returns the stream number for this RNG stream. More...
 
bool IsAntithetic (void) const
 Returns true if antithetic values should be generated. More...
 
void SetAntithetic (bool isAntithetic)
 Specifies whether antithetic values should be generated. More...
 
void SetStream (int64_t stream)
 Specifies the stream number for this RNG stream. More...
 
- Public Member Functions inherited from ns3::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 Initialize (void)
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 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
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)
 
- Static Public Member Functions inherited from ns3::RandomVariableStream
static TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void Cleanup (void)
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 

Private Attributes

double m_max
 The upper bound on values that can be returned by this RNG stream.
 
double m_min
 The lower bound on values that can be 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.
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 
virtual void DoDispose (void)
 
virtual void DoInitialize (void)
 
virtual void NotifyNewAggregate (void)
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 
virtual void NotifyConstructionCompleted (void)
 

Detailed Description

The uniform 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 uniform distribution. It also supports the generation of single random numbers from various uniform distributions.

The low end of the range is always included and the high end of the range is always excluded.

Here is an example of how to use this class:

double min = 0.0;
double max = 10.0;
Ptr<UniformRandomVariable> x = CreateObject<UniformRandomVariable> ();
x->SetAttribute ("Min", DoubleValue (min));
x->SetAttribute ("Max", DoubleValue (max));
// The values returned by a uniformly distributed random
// variable should always be within the range
//
// [min, max) .
//
double value = x->GetValue ();

Config Paths

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

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

Attributes

  • Min: The lower 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
  • Max: 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: 1
    • 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.

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

Member Function Documentation

uint32_t ns3::UniformRandomVariable::GetInteger ( uint32_t  min,
uint32_t  max 
)

Returns a random unsigned integer from a uniform distribution over the interval [min,max] including both ends.

Parameters
minLow end of the range.
maxHigh end of the range.
Returns
A random unsigned integer value.

Note that antithetic values are being generated if m_isAntithetic is equal to true. If $x$ is a value that would be returned normally, then $(max - x$) is the distance that $x$ would be from $max$. The value returned in the antithetic case, $x'$, is calculated as

\[ x' = min + (max - x) , \]

which is the lower bound plus the distance $x$ is from the upper bound.

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

References GetValue(), NS_ASSERT, and NS_LOG_FUNCTION.

Referenced by ns3::dsr::DsrRouting::CancelPacketTimerNextHop(), ns3::MinstrelWifiManager::FindRate(), ns3::RandomBuildingPositionAllocator::GetNext(), ns3::RandomRoomPositionAllocator::GetNext(), ns3::aodv::RoutingProtocol::HelloTimerExpire(), ns3::MinstrelWifiManager::InitSampleTable(), ns3::dsr::DsrRouting::PriorityScheduler(), ns3::dsdv::RoutingProtocol::RecvDsdv(), ns3::aodv::RoutingProtocol::RecvRequest(), ns3::dsdv::RoutingProtocol::RouteOutput(), ns3::dsr::DsrRouting::ScheduleInterRequest(), ns3::dsr::DsrRouting::Send(), ns3::dsr::DsrRouting::SendPacketFromBuffer(), ns3::dsdv::RoutingProtocol::SendPacketFromQueue(), ns3::dsdv::RoutingProtocol::SendPeriodicUpdate(), ns3::aodv::RoutingProtocol::SendRequest(), ns3::dsr::DsrRouting::SendRerrWhenBreaksLinkToNextHop(), ns3::aodv::RoutingProtocol::SetIpv4(), and ns3::dsdv::RoutingProtocol::Start().

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

Returns a random unsigned integer from a uniform distribution over the interval [min,max] including both ends, where min and max are the current lower and upper bounds.

Returns
A random unsigned integer value.

Note that antithetic values are being generated if m_isAntithetic is equal to true. If $x$ is a value that would be returned normally, then $(max - x$) is the distance that $x$ would be from $max$. The value returned in the antithetic case, $x'$, is calculated as

\[ x' = min + (max - x) , \]

which is the lower bound plus the distance $x$ is from the upper bound.

Implements ns3::RandomVariableStream.

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

References GetValue(), m_max, m_min, and NS_LOG_FUNCTION.

double ns3::UniformRandomVariable::GetMax ( 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 165 of file random-variable-stream.cc.

References m_max, and NS_LOG_FUNCTION.

double ns3::UniformRandomVariable::GetMin ( void  ) const

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

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

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

References m_min, and NS_LOG_FUNCTION.

double ns3::UniformRandomVariable::GetValue ( double  min,
double  max 
)

Returns a random double from the uniform distribution with the specified range.

Parameters
minLow end of the range.
maxHigh end of the range.
Returns
A floating point random value.

Note that antithetic values are being generated if m_isAntithetic is equal to true. If $x$ is a value that would be returned normally, then $(max - x$) is the distance that $x$ would be from $max$. The value returned in the antithetic case, $x'$, is calculated as

\[ x' = min + (max - x) , \]

which is the lower bound plus the distance $x$ is from the upper bound.

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

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

Referenced by ns3::MeshWifiInterfaceMac::DoInitialize(), BufferTest::DoRun(), OneUniformRandomVariableManyGetValueCallsTestCase::DoRun(), ns3::LteX2HandoverTestCase::DoRun(), RandomVariableStreamUniformTestCase::DoRun(), RandomVariableStreamUniformAntitheticTestCase::DoRun(), ns3::UanMacCw::Enqueue(), ns3::Backoff::GetBackoffTime(), ns3::Ipv6ExtensionFragment::GetFragments(), ns3::RandomBuildingPositionAllocator::GetNext(), ns3::RandomRoomPositionAllocator::GetNext(), ns3::SameRoomPositionAllocator::GetNext(), ns3::UniformDiscPositionAllocator::GetNext(), ns3::Radvd::HandleRead(), ns3::dsr::DsrRouting::ScheduleCachedReply(), ns3::Radvd::Send(), and ns3::SimpleOfdmWimaxPhy::StartReceive().

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

Returns a random double from the uniform distribution with the range [min,max), where min and max are the current lower and upper bounds.

Returns
A floating point random value.

Note that antithetic values are being generated if m_isAntithetic is equal to true. If $x$ is a value that would be returned normally, then $(max - x$) is the distance that $x$ would be from $max$. The value returned in the antithetic case, $x'$, is calculated as

\[ x' = min + (max - x) , \]

which is the lower bound plus the distance $x$ is from the upper bound.

Note that we have to re-implement this method here because the method is overloaded above for the two-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 191 of file random-variable-stream.cc.

References m_max, m_min, and NS_LOG_FUNCTION.

Referenced by GetInteger().

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