The Random Number Generator (RNG) that returns a predetermined sequence. More...
#include "random-variable-stream.h"
Public Member Functions | |
DeterministicRandomVariable () | |
Creates a deterministic RNG that will have a predetermined sequence of values. | |
~DeterministicRandomVariable () override | |
virtual uint32_t | GetInteger () |
Get the next random value drawn from the distribution. | |
double | GetValue () override |
Get the next random value drawn from the distribution. | |
void | SetValueArray (const double *values, std::size_t length) |
Sets the array of values that holds the predetermined sequence. | |
void | SetValueArray (const std::vector< double > &values) |
Sets the array of values that holds the predetermined sequence. | |
Public Member Functions inherited from ns3::RandomVariableStream | |
RandomVariableStream () | |
Default constructor. | |
RandomVariableStream (const RandomVariableStream &)=delete | |
~RandomVariableStream () override | |
Destructor. | |
int64_t | GetStream () const |
Returns the stream number for the RngStream. | |
bool | IsAntithetic () const |
Check if antithetic values will be generated. | |
RandomVariableStream & | operator= (const RandomVariableStream &)=delete |
void | SetAntithetic (bool isAntithetic) |
Specify whether antithetic values should be generated. | |
void | SetStream (int64_t stream) |
Specifies the stream number for the RngStream. | |
Public Member Functions inherited from ns3::Object | |
Object () | |
Constructor. | |
~Object () override | |
Destructor. | |
void | AggregateObject (Ptr< Object > other) |
Aggregate two Objects together. | |
void | Dispose () |
Dispose of this Object. | |
AggregateIterator | GetAggregateIterator () const |
Get an iterator to the Objects aggregated to this one. | |
TypeId | GetInstanceTypeId () const override |
Get the most derived TypeId for this Object. | |
template<typename T > | |
Ptr< T > | GetObject () const |
Get a pointer to the requested aggregated Object. | |
template<> | |
Ptr< Object > | GetObject () const |
Specialization of () for objects of type ns3::Object. | |
template<typename T > | |
Ptr< T > | GetObject (TypeId tid) const |
Get a pointer to the requested aggregated Object by TypeId. | |
template<> | |
Ptr< Object > | GetObject (TypeId tid) const |
Specialization of (TypeId tid) for objects of type ns3::Object. | |
void | Initialize () |
Invoke DoInitialize on all Objects aggregated to this one. | |
bool | IsInitialized () const |
Check if the object has been initialized. | |
void | UnidirectionalAggregateObject (Ptr< Object > other) |
Aggregate an Object to another Object. | |
Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter > | |
SimpleRefCount () | |
Default constructor. | |
SimpleRefCount (const SimpleRefCount &o) | |
Copy constructor. | |
uint32_t | GetReferenceCount () const |
Get the reference count of the object. | |
SimpleRefCount & | operator= (const SimpleRefCount &o) |
Assignment operator. | |
void | Ref () const |
Increment the reference count. | |
void | Unref () const |
Decrement the reference count. | |
Public Member Functions inherited from ns3::ObjectBase | |
virtual | ~ObjectBase () |
Virtual destructor. | |
void | GetAttribute (std::string name, AttributeValue &value, bool permissive=false) const |
Get the value of an attribute, raising fatal errors if unsuccessful. | |
bool | GetAttributeFailSafe (std::string name, AttributeValue &value) const |
Get the value of an attribute without raising errors. | |
void | SetAttribute (std::string name, const AttributeValue &value) |
Set a single attribute, raising fatal errors if unsuccessful. | |
bool | SetAttributeFailSafe (std::string name, const AttributeValue &value) |
Set a single attribute without raising errors. | |
bool | TraceConnect (std::string name, std::string context, const CallbackBase &cb) |
Connect a TraceSource to a Callback with a context. | |
bool | TraceConnectWithoutContext (std::string name, const CallbackBase &cb) |
Connect a TraceSource to a Callback without a context. | |
bool | TraceDisconnect (std::string name, std::string context, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected with a context. | |
bool | TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected without a context. | |
Static Public Member Functions | |
static TypeId | GetTypeId () |
Register this type. | |
Static Public Member Functions inherited from ns3::RandomVariableStream | |
static TypeId | GetTypeId () |
Register this type. | |
Static Public Member Functions inherited from ns3::Object | |
static TypeId | GetTypeId () |
Register this type. | |
Static Public Member Functions inherited from ns3::ObjectBase | |
static TypeId | GetTypeId () |
Get the type ID. | |
Private Attributes | |
std::size_t | m_count |
Size of the array of values. | |
double * | m_data |
Array of values to return in sequence. | |
std::size_t | m_next |
Position of the next value in the array of values. | |
Additional Inherited Members | |
Protected Member Functions inherited from ns3::RandomVariableStream | |
RngStream * | Peek () const |
Get the pointer to the underlying RngStream. | |
Protected Member Functions inherited from ns3::Object | |
Object (const Object &o) | |
Copy an Object. | |
virtual void | DoDispose () |
Destructor implementation. | |
virtual void | DoInitialize () |
Initialize() implementation. | |
virtual void | NotifyNewAggregate () |
Notify all Objects aggregated to this one of a new Object being aggregated. | |
Protected Member Functions inherited from ns3::ObjectBase | |
void | ConstructSelf (const AttributeConstructionList &attributes) |
Complete construction of ObjectBase; invoked by derived classes. | |
virtual void | NotifyConstructionCompleted () |
Notifier called once the ObjectBase is fully constructed. | |
Related Symbols inherited from ns3::ObjectBase | |
static TypeId | GetObjectIid () |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. | |
The Random Number Generator (RNG) that returns a predetermined sequence.
Defines a random variable that has a specified, predetermined sequence. This would be useful when trying to force the RNG to return a known sequence, perhaps to compare ns-3 to some other simulator
Creates a generator that returns successive elements from the value array on successive calls to GetValue(). Note that the values in the array are copied and stored by the generator (deep-copy). Also note that the sequence repeats if more values are requested than are present in the array.
Here is an example of how to use this class:
This will return values in the repeating sequence
This RNG ignores the antithetic setting.
ns3::DeterministicRandomVariable is accessible through the following paths with Config::Set and Config::Connect:
No Attributes are defined for this type.
No TraceSources are defined for this type.
Group: Core
Size of this type is 104 bytes (on a 64-bit architecture).
Definition at line 1837 of file random-variable-stream.h.
ns3::DeterministicRandomVariable::DeterministicRandomVariable | ( | ) |
Creates a deterministic RNG that will have a predetermined sequence of values.
Definition at line 1474 of file random-variable-stream.cc.
References NS_LOG_FUNCTION.
|
override |
Definition at line 1482 of file random-variable-stream.cc.
References m_data, and NS_LOG_FUNCTION.
|
virtual |
Get the next random value drawn from the distribution.
Reimplemented from ns3::RandomVariableStream.
Definition at line 144 of file random-variable-stream.cc.
|
static |
Register this type.
Definition at line 1465 of file random-variable-stream.cc.
References ns3::TypeId::SetParent().
|
overridevirtual |
Get the next random value drawn from the distribution.
Implements ns3::RandomVariableStream.
Definition at line 1521 of file random-variable-stream.cc.
References ns3::RandomVariableStream::GetStream(), m_count, m_data, m_next, NS_ASSERT, and NS_LOG_DEBUG.
void ns3::DeterministicRandomVariable::SetValueArray | ( | const double * | values, |
std::size_t | length ) |
Sets the array of values that holds the predetermined sequence.
Note that the values in the array are copied and stored (deep-copy).
[in] | values | Array of random values to return in sequence. |
[in] | length | Number of values in the array. |
Definition at line 1499 of file random-variable-stream.cc.
References m_count, m_data, m_next, and NS_LOG_FUNCTION.
void ns3::DeterministicRandomVariable::SetValueArray | ( | const std::vector< double > & | values | ) |
Sets the array of values that holds the predetermined sequence.
Note that the values in the array are copied and stored (deep-copy).
[in] | values | Array of random values to return in sequence. |
Definition at line 1493 of file random-variable-stream.cc.
References SetValueArray().
Referenced by SetValueArray().
|
private |
Size of the array of values.
Definition at line 1877 of file random-variable-stream.h.
Referenced by GetValue(), and SetValueArray().
|
private |
Array of values to return in sequence.
Definition at line 1883 of file random-variable-stream.h.
Referenced by ~DeterministicRandomVariable(), GetValue(), and SetValueArray().
|
private |
Position of the next value in the array of values.
Definition at line 1880 of file random-variable-stream.h.
Referenced by GetValue(), and SetValueArray().