The triangular distribution Random Number Generator (RNG) that allows stream numbers to be set deterministically. More...
#include "random-variable-stream.h"
Public Member Functions | |
TriangularRandomVariable () | |
Creates a triangular distribution RNG with the default values for the mean, lower bound, and upper bound. More... | |
uint32_t | GetInteger (uint32_t mean, uint32_t min, uint32_t max) |
Returns a random unsigned integer from a triangular distribution with the specified mean, min, and max. More... | |
virtual uint32_t | GetInteger (void) |
Returns a random unsigned integer from a triangular distribution with the current mean, min, and max. More... | |
double | GetMax (void) const |
Returns the upper bound on values that can be returned by this RNG stream. More... | |
double | GetMean (void) const |
Returns the mean value for the triangular distribution returned by this RNG stream. More... | |
double | GetMin (void) const |
Returns the lower bound for the triangular distribution returned by this RNG stream. More... | |
double | GetValue (double mean, double min, double max) |
Returns a random double from a triangular distribution with the specified mean, min, and max. More... | |
virtual double | GetValue (void) |
Returns a random double from a triangular distribution with the current mean, min, and max. More... | |
Public Member Functions inherited from ns3::RandomVariableStream | |
RandomVariableStream () | |
Default constructor. More... | |
virtual | ~RandomVariableStream () |
Destructor. More... | |
int64_t | GetStream (void) const |
Returns the stream number for the RngStream. 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::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... | |
Private Attributes | |
double | m_max |
The upper bound on values that can be returned by this RNG stream. More... | |
double | m_mean |
The mean value for the triangular distribution returned by this RNG stream. More... | |
double | m_min |
The lower bound on values that can be returned by this RNG stream. 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 triangular 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 triangular distribution. It also supports the generation of single random numbers from various triangular distributions.
This distribution is a triangular distribution. The probability density is in the shape of a triangle.
Here is an example of how to use this class:
ns3::TriangularRandomVariable is accessible through the following paths with Config::Set and Config::Connect:
No TraceSources are defined for this type.
Size of this type is 80 bytes (on a 64-bit architecture).
Definition at line 1831 of file random-variable-stream.h.
ns3::TriangularRandomVariable::TriangularRandomVariable | ( | ) |
Creates a triangular distribution RNG with the default values for the mean, lower bound, and upper bound.
Definition at line 1201 of file random-variable-stream.cc.
References NS_LOG_FUNCTION.
uint32_t ns3::TriangularRandomVariable::GetInteger | ( | uint32_t | mean, |
uint32_t | min, | ||
uint32_t | max | ||
) |
Returns a random unsigned integer from a triangular distribution with the specified mean, min, and max.
[in] | mean | Mean value for the triangular distribution. |
[in] | min | Low end of the range. |
[in] | max | High end of the range. |
Note that antithetic values are being generated if m_isAntithetic is equal to true. If is a uniform variable over [0,1] and
is a value that would be returned normally, where the mode or peak of the triangle is calculated as
Then, ) is the distance that would be from . The value returned in the antithetic case, , is calculated as
which now involves the distance is from the 1.
Definition at line 1253 of file random-variable-stream.cc.
References GetValue(), max, min, and NS_LOG_FUNCTION.
|
virtual |
Returns a random unsigned integer from a triangular distribution with the current mean, min, and max.
Note that antithetic values are being generated if m_isAntithetic is equal to true. If is a uniform variable over [0,1] and
is a value that would be returned normally, where the mode or peak of the triangle is calculated as
Then, ) is the distance that would be from . The value returned in the antithetic case, , is calculated as
which now involves the distance is from the 1.
Implements ns3::RandomVariableStream.
Definition at line 1266 of file random-variable-stream.cc.
References GetValue(), m_max, m_mean, m_min, and NS_LOG_FUNCTION.
double ns3::TriangularRandomVariable::GetMax | ( | void | ) | const |
Returns the upper bound on values that can be returned by this RNG stream.
Definition at line 1221 of file random-variable-stream.cc.
References m_max, and NS_LOG_FUNCTION.
double ns3::TriangularRandomVariable::GetMean | ( | void | ) | const |
Returns the mean value for the triangular distribution returned by this RNG stream.
Definition at line 1209 of file random-variable-stream.cc.
References m_mean, and NS_LOG_FUNCTION.
double ns3::TriangularRandomVariable::GetMin | ( | void | ) | const |
Returns the lower bound for the triangular distribution returned by this RNG stream.
Definition at line 1215 of file random-variable-stream.cc.
References m_min, and NS_LOG_FUNCTION.
|
static |
Register this type.
Definition at line 1180 of file random-variable-stream.cc.
References m_max, m_mean, m_min, ns3::MakeDoubleAccessor(), and ns3::TypeId::SetParent().
double ns3::TriangularRandomVariable::GetValue | ( | double | mean, |
double | min, | ||
double | max | ||
) |
Returns a random double from a triangular distribution with the specified mean, min, and max.
[in] | mean | Mean value for the triangular distribution. |
[in] | min | Low end of the range. |
[in] | max | High end of the range. |
Note that antithetic values are being generated if m_isAntithetic is equal to true. If is a uniform variable over [0,1] and
is a value that would be returned normally, where the mode or peak of the triangle is calculated as
Then, ) is the distance that would be from . The value returned in the antithetic case, , is calculated as
which now involves the distance is from the 1.
Definition at line 1228 of file random-variable-stream.cc.
References ns3::RandomVariableStream::IsAntithetic(), max, min, NS_LOG_FUNCTION, ns3::RandomVariableStream::Peek(), and ns3::RngStream::RandU01().
|
virtual |
Returns a random double from a triangular distribution with the current mean, min, and max.
Note that antithetic values are being generated if m_isAntithetic is equal to true. If is a uniform variable over [0,1] and
is a value that would be returned normally, where the mode or peak of the triangle is calculated as
Then, ) is the distance that would be from . The value returned in the antithetic case, , is calculated as
which now involves the distance is from the 1.
Note that we have to re-implement this method here because the method is overloaded above for the three-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 1260 of file random-variable-stream.cc.
References m_max, m_mean, m_min, and NS_LOG_FUNCTION.
Referenced by GetInteger().
|
private |
The upper bound on values that can be returned by this RNG stream.
Definition at line 2031 of file random-variable-stream.h.
Referenced by GetInteger(), GetMax(), GetTypeId(), and GetValue().
|
private |
The mean value for the triangular distribution returned by this RNG stream.
Definition at line 2025 of file random-variable-stream.h.
Referenced by GetInteger(), GetMean(), GetTypeId(), and GetValue().
|
private |
The lower bound on values that can be returned by this RNG stream.
Definition at line 2028 of file random-variable-stream.h.
Referenced by GetInteger(), GetMin(), GetTypeId(), and GetValue().