/**

 * \file

 * \ingroup randomvariable

 * Declaration of ns3::RandomVariableStream and derivatives.

 */

 * \brief The basic uniform Random Number Generator (RNG).

 * \note The underlying random number generation method used

 * by ns-3 is the RngStream code by Pierre L'Ecuyer at

 * ns-3 has a rich set of random number generators that allow stream

 *

 * Instances can be configured to return "antithetic" values.

 * See the documentation for the specific distributions to see

 * how this modifies the returned values.

  /**

   * \brief Default constructor.

   */

  /**

   * \brief Destructor.

   */

   * \param stream The stream number for this RNG stream.

   * -1 means "allocate a stream number automatically".

   */

   * \return The stream number for this RNG stream.

   * -1 means this stream was allocated automatically.

   * \brief Specify whether antithetic values should be generated.

   * \param isAntithetic If \c true antithetic value will be generated.

   * \brief Check if antithetic values will be generated.

   * \return \c true if antithetic values will be generated.

   * \brief Get the next random value as a double drawn from the distribution.

   * \brief Get the next random value as an integer drawn from the distribution.

   * \return  An integer random value.

   * \brief Get the pointer to the underlying RNG stream.

  /**

   * Copy constructor.  These objects are not copyable.

   *

   * \param o The RandomVariableStream to copy in construction.

   * \internal

   * Theoretically, it is possible to give them good copy semantics

   * but not enough time to iron out the details.

   */

  /**

   * Assignment operator.  These objects can't be copied by assignement.

   *

   * \param o The RandomVariableStream to copy.

   * \return lvalue RandomVariableStream.

   *

   * \internal

   * Theoretically, it is possible to give them good copy semantics

   * but not enough time to iron out the details.

   */

  /** Pointer to the underlying RNG stream. */

  /** Indicates if antithetic values should be generated by this RNG stream. */

  /** The stream number for this RNG stream. */

};  // class RandomVariableStream

 * \brief The uniform distribution Random Number Generator (RNG).

 * The output range is \f$[min, max)\f$ for floating point values,

 * (\c max <i>excluded</i>), and \f$[min, max]\f$ (\c max <i>included</i>)

 * for integral values.

 *

 * \par Example

 *

 * \par Antithetic Values.

 *

 * Normally this RNG returns values \f$x\f$ in the interval \f$[min,max)\f$.

 * If an instance of this RNG is configured to return antithetic values,

 * the actual value returned is calculated as follows:

 *

 *   - Compute the initial random value \f$x\f$ as normal.

 *   - Compute the distance from the maximum, \f$y = max - x\f$

 *   - Return \f$x' = min + y = min + (max - x)\f$:

  /**

   * \brief Register this type.

   * \return The object TypeId.

   */

   * \brief Get the lower bound on randoms returned by GetValue(void).

   * \return The lower bound on values from GetValue(void).

   * \brief Get the upper bound on values returned by GetValue(void).

   * \return The upper bound on values from GetValue(void).

   * \brief Get the next random value, as a double in the specified range

   * \f$[min, max)\f$.

   * \note The upper limit is excluded from the output range.

   * \param min Low end of the range (included).

   * \param max High end of the range (excluded).

   * \return A floating point random value.

   * \brief Get the next random value, as an unsigned integer in the

   * specified range \f$[min, max]/f$.

   *

   * \note The upper limit is included in the output range.

   *

  // Inherited from RandomVariableStream

   * \brief Get the next random value as a double drawn from the distribution.

   * \note The upper limit is excluded from the output range.

  */

   * \brief Get the next random value as an integer drawn from the distribution.

   * \return  An integer random value.

   * \note The upper limit is included in the output range.

  /** The lower bound on values that can be returned by this RNG stream. */

  /** The upper bound on values that can be returned by this RNG stream. */

};  // class UniformRandomVariable

 * This RNG returns the same value for every sample.

 *

 * \par Antithetic Values.

 *

 * This RNG ignores the antithetic setting.

  /**

   * \brief Register this type.

   * \return The object TypeId.

   */

   * \brief Get the constant value returned by this RNG stream.

   * \return The constant value.

   * \brief Get the next random value, as a double equal to the argument.

   * \param constant The value to return.

   * \return The floating point argument.

   * \brief Get the next random value, as an integer equal to the argument.

   * \param constant The value to return.

   * \return The integer argument.

  // Inherited from RandomVariableStream

  /* \note This RNG always returns the same value. */

  /* \note This RNG always returns the same value. */

  /** The constant value returned by this RNG stream. */

};  // class ConstantRandomVariable

 * \brief The Random Number Generator (RNG) that returns a pattern of

 * sequential values.

 *

 * This RNG has four configuration attributes:

 *

 *  - An increment, \c Increment.

 *  - A consecutive repeat numer, \c Consecutive.

 *  - The minimum value, \c Min.

 *  - The maximum value, \c Max.

 *

 * The RNG starts at the \c Min value.  Each return value is

 * repeated \c Consecutive times, before advancing by the \c Increment.

 * When the \c Increment would cause the value to equal or exceed

 * \c Max it is reset to \c Min first.

 * For example, if an instance is configured with:

 *

 *   Attribute   | Value

 *   :---------- | -----:

 *   Min         |    2

 *   Max         |   13

 *   Increment   |    4

 *   Consecutive |    3

 *

 * The sequence will repeat this pattern:  2 2 2 6 6 6 10 10 10.

 *

 * Notice that \c Max will be a strict upper bound on the values:

 * all values in the sequence will be less than \c Max.

 *

 * \par Antithetic Values.

 *

 * This RNG ignores the antithetic setting.

  /**

   * \brief Register this type.

   * \return The object TypeId.

   */

   * \brief Creates a sequential RNG with the default values

   * for the sequence parameters.

   * \brief Get the first value of the sequence.

   * \brief Get the limit of the sequence, which is (at least)

   * one more than the last value of the sequence.

   * \return The limit of the sequence.

   * \brief Get the increment for the sequence.

   * \return The increment between distinct values for the sequence.

   * \brief Get the number of times each distinct value of the sequence

   * is repeated before incrementing to the next value.

   * \return The number of times each value is repeated.

  // Inherited from RandomVariableStream

  /** The first value of the sequence. */

  /** Strict upper bound on the sequence. */

  /** Increment between distinct values. */

  /** The number of times each distinct value is repeated. */

  /** The current sequence value. */

  /** The number of times the current distinct value has been repeated. */

  /** Indicates if the current sequence value has been properly initialized. */

};  // class SequentialRandomVariable

 * \brief The exponential distribution Random Number Generator (RNG).

 * is defined as:

 *   \f[

 *       P(x) dx = \alpha  e^{-\alpha x} dx, \quad x \in [0, +\infty)

 *   \f]

 * over the interval \f$[0, +\infty)\f$, where \f$ \alpha = \frac{1}{Mean} \f$

 * and \c Mean is a configurable attribute.

 *

 * The normal RNG value \f$x\f$ is calculated by

 *

 *   \f[

 *       x = - 1/\alpha \log(u)

 *   \f]

 *

 * where \f$u\f$ is a uniform random variable on \f$[0,1)\f$.

 *

 * \par Bounded Distribution

 * bounded version is defined over the interval \f$[0,b]\f$ as:

 *