The normal (Gaussian) distribution Random Number Generator (RNG) that allows stream numbers to be set deterministically. More...
#include <random-variable-stream.h>
Inheritance diagram for ns3::NormalRandomVariable:
Collaboration diagram for ns3::NormalRandomVariable:Public Member Functions | |
| NormalRandomVariable () | |
| Creates a normal distribution RNG with the default values for the mean, variance, and bound. More... | |
| double | GetBound (void) const |
| Returns the bound on values that can be returned by this RNG stream. More... | |
| uint32_t | GetInteger (uint32_t mean, uint32_t variance, uint32_t bound) |
| Returns a random unsigned integer from a normal distribution with the specified mean, variance, and bound. More... | |
| virtual uint32_t | GetInteger (void) |
| Returns a random unsigned integer from a normal distribution with the current mean, variance, and bound. More... | |
| double | GetMean (void) const |
| Returns the mean value for the normal distribution returned by this RNG stream. More... | |
| double | GetValue (double mean, double variance, double bound=NormalRandomVariable::INFINITE_VALUE) |
| Returns a random double from a normal distribution with the specified mean, variance, and bound. More... | |
| virtual double | GetValue (void) |
| Returns a random double from a normal distribution with the current mean, variance, and bound. More... | |
| double | GetVariance (void) const |
| Returns the variance value for the normal distribution returned by this RNG stream. More... | |
Public Member Functions inherited from ns3::RandomVariableStream | |
| 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... | |
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 |
| Implement the GetInstanceTypeId method defined in ObjectBase. More... | |
| template<typename T > | |
| Ptr< T > | GetObject (void) const |
| Get a pointer to the requested aggregated Object. More... | |
| template<typename T > | |
| Ptr< T > | GetObject (TypeId tid) const |
| Get a pointer to the requested aggregated Object. More... | |
| void | Initialize (void) |
| Invoke DoInitialize on all Objects aggregated to this one. More... | |
Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter > | |
| 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... | |
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) |
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::SimpleRefCount< Object, ObjectBase, ObjectDeleter > | |
| static void | Cleanup (void) |
| Noop. More... | |
Static Public Member Functions inherited from ns3::ObjectBase | |
| static TypeId | GetTypeId (void) |
| Get the type ID. More... | |
Static Public Attributes | |
| static const double | INFINITE_VALUE = 1e307 |
Private Attributes | |
| double | m_bound |
| The bound on values that can be returned by this RNG stream. More... | |
| double | m_mean |
| The mean value for the normal distribution returned by this RNG stream. More... | |
| double | m_next |
| The algorithm produces two values at a time. More... | |
| bool | m_nextValid |
| True if the next value is valid. More... | |
| double | m_variance |
| The variance value for the normal distribution returned by this RNG stream. More... | |
Additional Inherited Members | |
Protected Member Functions inherited from ns3::RandomVariableStream | |
| RngStream * | Peek (void) const |
| Returns a pointer to the underlying RNG stream. 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 normal (Gaussian) 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 normal distribution. It also supports the generation of single random numbers from various normal distributions.
The density probability function is defined over the interval (
,
) as:
where
and 
Since normal distributions can theoretically return unbounded values, it is sometimes useful to specify a fixed bound. The NormalRandomVariable is bounded symmetrically about the mean by this bound, i.e. its values are confined to the interval [
,
].
Here is an example of how to use this class:
ns3::NormalRandomVariable is accessible through the following paths with Config::Set and Config::Connect:
No TraceSources are defined for this type.
Size of this type is 96 bytes (on a 64-bit architecture).
Definition at line 1058 of file random-variable-stream.h.
| ns3::NormalRandomVariable::NormalRandomVariable | ( | ) |
Creates a normal distribution RNG with the default values for the mean, variance, and bound.
Definition at line 664 of file random-variable-stream.cc.
References NS_LOG_FUNCTION.
| double ns3::NormalRandomVariable::GetBound | ( | void | ) | const |
Returns the bound on values that can be returned by this RNG stream.
Definition at line 686 of file random-variable-stream.cc.
References m_bound, and NS_LOG_FUNCTION.
| uint32_t ns3::NormalRandomVariable::GetInteger | ( | uint32_t | mean, |
| uint32_t | variance, | ||
| uint32_t | bound | ||
| ) |
Returns a random unsigned integer from a normal distribution with the specified mean, variance, and bound.
| mean | Mean value for the normal distribution. |
| variance | Variance value for the normal distribution. |
| bound | Bound on values returned. |
Note that antithetic values are being generated if m_isAntithetic is equal to true. If
and
are uniform variables over [0,1], then the values that would be returned normally,
and
, are calculated as follows:
For the antithetic case,
) and
) are the distances that
and
would be from
. The antithetic values returned,
and
, are calculated as follows:
which now involves the distances
and
are from 1.
Definition at line 739 of file random-variable-stream.cc.
References GetValue(), and NS_LOG_FUNCTION.
Here is the call graph for this function:
|
virtual |
Returns a random unsigned integer from a normal distribution with the current mean, variance, and bound.
Note that antithetic values are being generated if m_isAntithetic is equal to true. If
and
are uniform variables over [0,1], then the values that would be returned normally,
and
, are calculated as follows:
For the antithetic case,
) and
) are the distances that
and
would be from
. The antithetic values returned,
and
, are calculated as follows:
which now involves the distances
and
are from 1.
Implements ns3::RandomVariableStream.
Definition at line 752 of file random-variable-stream.cc.
References GetValue(), m_bound, m_mean, m_variance, and NS_LOG_FUNCTION.
Here is the call graph for this function:| double ns3::NormalRandomVariable::GetMean | ( | void | ) | const |
Returns the mean value for the normal distribution returned by this RNG stream.
Definition at line 674 of file random-variable-stream.cc.
References m_mean, and NS_LOG_FUNCTION.
|
static |
Definition at line 643 of file random-variable-stream.cc.
References INFINITE_VALUE, m_bound, m_mean, m_variance, ns3::MakeDoubleAccessor(), and ns3::TypeId::SetParent().
Here is the call graph for this function:| double ns3::NormalRandomVariable::GetValue | ( | double | mean, |
| double | variance, | ||
| double | bound = NormalRandomVariable::INFINITE_VALUE |
||
| ) |
Returns a random double from a normal distribution with the specified mean, variance, and bound.
| mean | Mean value for the normal distribution. |
| variance | Variance value for the normal distribution. |
| bound | Bound on values returned. |
Note that antithetic values are being generated if m_isAntithetic is equal to true. If
and
are uniform variables over [0,1], then the values that would be returned normally,
and
, are calculated as follows:
For the antithetic case,
) and
) are the distances that
and
would be from
. The antithetic values returned,
and
, are calculated as follows:
which now involves the distances
and
are from 1.
Definition at line 693 of file random-variable-stream.cc.
References ns3::RandomVariableStream::IsAntithetic(), m_next, m_nextValid, NS_LOG_FUNCTION, ns3::RandomVariableStream::Peek(), ns3::RngStream::RandU01(), and visualizer.higcontainer::w.
Referenced by RngNormalTestCase::ChiSquaredTest(), RandomVariableStreamNormalTestCase::ChiSquaredTest(), RandomVariableStreamNormalAntitheticTestCase::ChiSquaredTest(), RandomVariableStreamNormalTestCase::DoRun(), and RandomVariableStreamNormalAntitheticTestCase::DoRun().
Here is the call graph for this function:
Here is the caller graph for this function:
|
virtual |
Returns a random double from a normal distribution with the current mean, variance, and bound.
Note that antithetic values are being generated if m_isAntithetic is equal to true. If
and
are uniform variables over [0,1], then the values that would be returned normally,
and
, are calculated as follows:
For the antithetic case,
) and
) are the distances that
and
would be from
. The antithetic values returned,
and
, are calculated as follows:
which now involves the distances
and
are from 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 746 of file random-variable-stream.cc.
References m_bound, m_mean, m_variance, and NS_LOG_FUNCTION.
Referenced by GetInteger().
Here is the caller graph for this function:| double ns3::NormalRandomVariable::GetVariance | ( | void | ) | const |
Returns the variance value for the normal distribution returned by this RNG stream.
Definition at line 680 of file random-variable-stream.cc.
References m_variance, and NS_LOG_FUNCTION.
|
static |
Definition at line 1061 of file random-variable-stream.h.
Referenced by GetTypeId(), and ns3::GammaRandomVariable::GetValue().
|
private |
The bound on values that can be returned by this RNG stream.
Definition at line 1248 of file random-variable-stream.h.
Referenced by GetBound(), GetInteger(), GetTypeId(), and GetValue().
|
private |
The mean value for the normal distribution returned by this RNG stream.
Definition at line 1242 of file random-variable-stream.h.
Referenced by GetInteger(), GetMean(), GetTypeId(), and GetValue().
|
private |
The algorithm produces two values at a time.
Definition at line 1254 of file random-variable-stream.h.
Referenced by GetValue().
|
private |
True if the next value is valid.
Definition at line 1251 of file random-variable-stream.h.
Referenced by GetValue().
|
private |
The variance value for the normal distribution returned by this RNG stream.
Definition at line 1245 of file random-variable-stream.h.
Referenced by GetInteger(), GetTypeId(), GetValue(), and GetVariance().