A Discrete-Event Network Simulator
API
Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
ns3::BernoulliRandomVariable Class Reference
Core » Random Variables

The Bernoulli distribution Random Number Generator (RNG). More...

#include "random-variable-stream.h"

+ Inheritance diagram for ns3::BernoulliRandomVariable:
+ Collaboration diagram for ns3::BernoulliRandomVariable:

Public Member Functions

 BernoulliRandomVariable ()
 
virtual uint32_t GetInteger ()
 Get the next random value drawn from the distribution. More...
 
uint32_t GetInteger (uint32_t probability)
 Get the next random value drawn from the distribution. More...
 
double GetValue () override
 Get the next random value drawn from the distribution. More...
 
double GetValue (double probability)
 Get the next random value drawn from the distribution. More...
 
- Public Member Functions inherited from ns3::RandomVariableStream
 RandomVariableStream ()
 Default constructor. More...
 
 RandomVariableStream (const RandomVariableStream &)=delete
 
 ~RandomVariableStream () override
 Destructor. More...
 
int64_t GetStream () const
 Returns the stream number for the RngStream. More...
 
bool IsAntithetic () const
 Check if antithetic values will be generated. More...
 
RandomVariableStream & operator= (const RandomVariableStream &)=delete
 
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...
 
 ~Object () override
 Destructor. More...
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together. More...
 
void Dispose ()
 Dispose of this Object. More...
 
AggregateIterator GetAggregateIterator () const
 Get an iterator to the Objects aggregated to this one. More...
 
TypeId GetInstanceTypeId () const override
 Get the most derived TypeId for this Object. More...
 
template<typename T >
Ptr< T > GetObject () const
 Get a pointer to the requested aggregated 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...
 
void Initialize ()
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
bool IsInitialized () 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 () const
 Get the reference count of the object. More...
 
SimpleRefCount & operator= (const SimpleRefCount &o[[maybe_unused]])
 Assignment operator. More...
 
void Ref () const
 Increment the reference count. More...
 
void Unref () 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 errors. 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 ()
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::RandomVariableStream
static TypeId GetTypeId ()
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId ()
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId ()
 Get the type ID. More...
 

Private Attributes

double m_probability
 The probability of success. More...
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::RandomVariableStream
RngStream * Peek () 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 ()
 Destructor implementation. More...
 
virtual void DoInitialize ()
 Initialize() implementation. More...
 
virtual void NotifyNewAggregate ()
 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 ()
 Notifier called once the ObjectBase is fully constructed. More...
 
- Related Functions inherited from ns3::ObjectBase
static TypeId GetObjectIid ()
 Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More...
 

Detailed Description

The Bernoulli distribution Random Number Generator (RNG).

This class supports the creation of objects that return random numbers from a fixed Bernoulli distribution. It also supports the generation of single random numbers from various Bernoulli distributions.

The probability mass function of a Bernoulli variable is defined as:

\[ P(n; p) = p^n (1-p)^{1-n}, \\ \quad n \in \{0, 1\} \]

where $ p $ is the probability of success and n is the indicator of success, with n=1 representing success and n=0 representing failure. The mean of this distribution is $ \mu = p $ and the variance is $ \sigma^2 = p(1-p) $.

The Bernoulli RNG value $n$ is generated by

\[ n = \begin{cases} 1 & \text{if } u \leq p \\ 0 & \text{otherwise} \end{cases} \]

where $u$ is a uniform random variable on [0,1) and $p$ is the probability of success.

Example

Here is an example of how to use this class:

double probability = 0.5;
Ptr<BernoulliRandomVariable> x = CreateObject<BernoulliRandomVariable> ();
x->SetAttribute ("Probability", DoubleValue (probability));
double success = x->GetValue ();
Antithetic Values.

If an instance of this RNG is configured to return antithetic values, the actual value returned, $x'$, is determined by:

\[ x' = \begin{cases} 1 & \text{if } (1 - u) \leq p \\ 0 & \text{otherwise} \end{cases} \]

where $u$ is a uniform random variable on [0,1) and $p$ is the probability of success.

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

Constructor & Destructor Documentation

◆ BernoulliRandomVariable()

ns3::BernoulliRandomVariable::BernoulliRandomVariable ( )

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

References NS_LOG_FUNCTION.

Member Function Documentation

◆ GetInteger() [1/2]

uint32_t ns3::RandomVariableStream::GetInteger
virtual

Get the next random value drawn from the distribution.

Returns
A random value.

Reimplemented from ns3::RandomVariableStream.

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

◆ GetInteger() [2/2]

uint32_t ns3::BernoulliRandomVariable::GetInteger ( uint32_t  probability)

Get the next random value drawn from the distribution.

Returns
A random value.
Parameters
[in]probabilityProbability of success.
Returns
Returns 1 if the trial is successful, or 0 if it is not. This function is similar to GetValue(), but it returns a uint32_t instead of a double.

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

References GetValue(), and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ GetTypeId()

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

Register this type.

Returns
The object TypeId.

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

References m_probability, ns3::MakeDoubleAccessor(), and ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ GetValue() [1/2]

double ns3::BernoulliRandomVariable::GetValue ( )
overridevirtual

Get the next random value drawn from the distribution.

Returns
A random value.

Implements ns3::RandomVariableStream.

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

References m_probability, and NS_LOG_FUNCTION.

Referenced by GetInteger().

+ Here is the caller graph for this function:

◆ GetValue() [2/2]

double ns3::BernoulliRandomVariable::GetValue ( double  probability)

Get the next random value drawn from the distribution.

Returns
A random value.
Parameters
[in]probabilityProbability of success.
Returns
Returns 1 if the trial is successful, or 0 if it is not.

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

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

+ Here is the call graph for this function:

Member Data Documentation

◆ m_probability

double ns3::BernoulliRandomVariable::m_probability
private

The probability of success.

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

Referenced by GetTypeId(), and GetValue().

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