The Random Number Generator (RNG) that has a specified empirical distribution. More...
#include <random-variable-stream.h>
Classes | |
class | ValueCDF |
Public Member Functions | |
EmpiricalRandomVariable () | |
Creates an empirical RNG that has a specified, empirical distribution. More... | |
void | CDF (double v, double c) |
Specifies a point in the empirical distribution. More... | |
virtual uint32_t | GetInteger (void) |
Returns the next value in the empirical distribution. More... | |
virtual double | GetValue (void) |
Returns the next value in the empirical distribution. More... | |
![]() | |
RandomVariableStream () | |
virtual | ~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... | |
![]() | |
Object () | |
virtual | ~Object () |
void | AggregateObject (Ptr< Object > other) |
void | Dispose (void) |
Run the DoDispose methods of this object and all the objects aggregated to it. More... | |
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) |
This method calls the virtual DoInitialize method on all the objects aggregated to this object. More... | |
![]() | |
SimpleRefCount () | |
Constructor. More... | |
SimpleRefCount (const SimpleRefCount &o) | |
Copy constructor. More... | |
uint32_t | GetReferenceCount (void) const |
Get the reference count of the object. More... | |
SimpleRefCount & | operator= (const SimpleRefCount &o) |
Assignment. More... | |
void | Ref (void) const |
Increment the reference count. More... | |
void | Unref (void) const |
Decrement the reference count. More... | |
![]() | |
virtual | ~ObjectBase () |
Virtual destructor. More... | |
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 TypeId | GetTypeId (void) |
![]() | |
static TypeId | GetTypeId (void) |
Register this type. More... | |
![]() | |
static void | Cleanup (void) |
Noop. More... | |
![]() | |
static TypeId | GetTypeId (void) |
Get the type ID. More... | |
Private Member Functions | |
virtual double | Interpolate (double, double, double, double, double) |
virtual void | Validate () |
Private Attributes | |
std::vector< ValueCDF > | emp |
bool | validated |
Additional Inherited Members | |
![]() | |
RngStream * | Peek (void) const |
Returns a pointer to the underlying RNG stream. More... | |
![]() | |
Object (const Object &o) | |
virtual void | DoDispose (void) |
This method is called by Object::Dispose or by the object's destructor, whichever comes first. More... | |
virtual void | DoInitialize (void) |
This method is called only once by Object::Initialize. More... | |
virtual void | NotifyNewAggregate (void) |
This method is invoked whenever two sets of objects are aggregated together. More... | |
![]() | |
void | ConstructSelf (const AttributeConstructionList &attributes) |
virtual void | NotifyConstructionCompleted (void) |
This method is invoked once all member attributes have been initialized. More... | |
The Random Number Generator (RNG) that has a specified empirical distribution.
Defines a random variable that has a specified, empirical distribution. The distribution is specified by a series of calls to the CDF member function, specifying a value and the probability that the function value is less than the specified value. When values are requested, a uniform random variable is used to select a probability, and the return value is interpreted linearly between the two appropriate points in the CDF. The method is known as inverse transform sampling: (http://en.wikipedia.org/wiki/Inverse_transform_sampling).
Here is an example of how to use this class:
ns3::EmpiricalRandomVariable 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.
Definition at line 2399 of file random-variable-stream.h.
ns3::EmpiricalRandomVariable::EmpiricalRandomVariable | ( | ) |
Creates an empirical RNG that has a specified, empirical distribution.
Definition at line 1535 of file random-variable-stream.cc.
References NS_LOG_FUNCTION.
void ns3::EmpiricalRandomVariable::CDF | ( | double | v, |
double | c | ||
) |
Specifies a point in the empirical distribution.
v | The function value for this point |
c | Probability that the function is less than or equal to v |
Definition at line 1603 of file random-variable-stream.cc.
References emp, and NS_LOG_FUNCTION.
Referenced by RandomVariableStreamEmpiricalTestCase::DoRun(), RandomVariableStreamEmpiricalAntitheticTestCase::DoRun(), and main().
|
virtual |
Returns the next value in the empirical distribution.
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, then
) is the distance that
would be from
. The value returned in the antithetic case,
, uses (1-u), which is the distance
is from the 1.
Implements ns3::RandomVariableStream.
Definition at line 1597 of file random-variable-stream.cc.
References GetValue(), and NS_LOG_FUNCTION.
|
static |
Definition at line 1527 of file random-variable-stream.cc.
References ns3::TypeId::SetParent().
|
virtual |
Returns the next value in the empirical distribution.
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, then
) is the distance that
would be from
. The value returned in the antithetic case,
, uses (1-u), which is the distance
is from the 1.
Implements ns3::RandomVariableStream.
Definition at line 1543 of file random-variable-stream.cc.
References emp, Interpolate(), ns3::RandomVariableStream::IsAntithetic(), NS_LOG_FUNCTION, ns3::RandomVariableStream::Peek(), ns3::RngStream::RandU01(), Validate(), and validated.
Referenced by RandomVariableStreamEmpiricalTestCase::DoRun(), RandomVariableStreamEmpiricalAntitheticTestCase::DoRun(), and GetInteger().
|
privatevirtual |
Definition at line 1631 of file random-variable-stream.cc.
References NS_LOG_FUNCTION.
Referenced by GetValue().
|
privatevirtual |
Definition at line 1610 of file random-variable-stream.cc.
References ns3::EmpiricalRandomVariable::ValueCDF::cdf, current, emp, NS_FATAL_ERROR, NS_LOG_FUNCTION, validated, and ns3::EmpiricalRandomVariable::ValueCDF::value.
Referenced by GetValue().
|
private |
Definition at line 2456 of file random-variable-stream.h.
Referenced by CDF(), GetValue(), and Validate().
|
private |
Definition at line 2455 of file random-variable-stream.h.
Referenced by GetValue(), and Validate().