The Random Number Generator (RNG) that returns a constant. More...
#include "random-variable-stream.h"
Public Member Functions | |
ConstantRandomVariable () | |
Creates a constant RNG with the default constant value. More... | |
double | GetConstant () const |
Get the constant value returned by this RNG stream. More... | |
virtual uint32_t | GetInteger () |
Get the next random value drawn from the distribution. More... | |
uint32_t | GetInteger (uint32_t constant) |
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 constant) |
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_constant |
The constant value returned by this RNG stream. 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... | |
The Random Number Generator (RNG) that returns a constant.
This RNG returns the same Constant
value for every sample.
This distribution has mean equal to the Constant
and zero variance.
This RNG ignores the antithetic setting.
Definition at line 308 of file random-variable-stream.h.
ns3::ConstantRandomVariable::ConstantRandomVariable | ( | ) |
Creates a constant RNG with the default constant value.
Definition at line 246 of file random-variable-stream.cc.
References NS_LOG_FUNCTION.
double ns3::ConstantRandomVariable::GetConstant | ( | ) | const |
Get the constant value returned by this RNG stream.
Definition at line 253 of file random-variable-stream.cc.
References m_constant, and NS_LOG_FUNCTION.
|
virtual |
Get the next random value drawn from the distribution.
Reimplemented from ns3::RandomVariableStream.
Definition at line 155 of file random-variable-stream.cc.
References ns3::UniformRandomVariable::m_max, ns3::UniformRandomVariable::m_min, ns3::MakeDoubleAccessor(), and ns3::TypeId::SetParent().
uint32_t ns3::ConstantRandomVariable::GetInteger | ( | uint32_t | constant | ) |
Get the next random value drawn from the distribution.
[in] | constant | The value to return. |
Definition at line 267 of file random-variable-stream.cc.
References NS_LOG_FUNCTION.
Referenced by ns3::ThreeGppHttpVariables::GetRequestSize().
|
static |
Register this type.
Definition at line 232 of file random-variable-stream.cc.
References m_constant, ns3::MakeDoubleAccessor(), and ns3::TypeId::SetParent().
|
overridevirtual |
Get the next random value drawn from the distribution.
Implements ns3::RandomVariableStream.
Definition at line 274 of file random-variable-stream.cc.
References m_constant, and NS_LOG_FUNCTION.
double ns3::ConstantRandomVariable::GetValue | ( | double | constant | ) |
Get the next random value drawn from the distribution.
[in] | constant | The value to return. |
Definition at line 260 of file random-variable-stream.cc.
References NS_LOG_FUNCTION.
Referenced by ns3::test::RandomVariable::ConstantTestCase::DoRun(), ns3::ThreeGppHttpVariables::GetEmbeddedObjectGenerationDelay(), and ns3::ThreeGppHttpVariables::GetMainObjectGenerationDelay().
|
private |
The constant value returned by this RNG stream.
Definition at line 347 of file random-variable-stream.h.
Referenced by GetConstant(), GetTypeId(), and GetValue().