Attachment #2599 for bug #2513

View | Details | Raw Unified | Return to bug 2513
Collapse All | Expand All




    plot.AppendExtra ("set xrange [0:2]");

    Ptr<ParetoRandomVariable> x1 = CreateObject<ParetoRandomVariable> ();
    x1->SetAttribute ("Scale", DoubleValue (1.0));
    x1->SetAttribute ("Shape", DoubleValue (1.5));

    plot.AddDataset ( Histogramm (x1, probes, precision,
                                  "ParetoRandomVariable scale=1.0 shape=1.5") );

    Ptr<ParetoRandomVariable> x2 = CreateObject<ParetoRandomVariable> ();
    x2->SetAttribute ("Scale", DoubleValue (1.0));
    x2->SetAttribute ("Shape", DoubleValue (2.0));

    plot.AddDataset ( Histogramm (x2, probes, precision,
                                  "ParetoRandomVariable scale=1.0 shape=2.0") );

    Ptr<ParetoRandomVariable> x3 = CreateObject<ParetoRandomVariable> ();
    x3->SetAttribute ("Scale", DoubleValue (1.0));
    x3->SetAttribute ("Shape", DoubleValue (2.5));

    plot.AddDataset ( Histogramm (x3, probes, precision,
                                  "ParetoRandomVariable scale=1.0 shape=2.5") );

    gnuplots.AddPlot (plot);
  }

    x1->SetAttribute ("Shape", DoubleValue (1.0));

    plot.AddDataset ( Histogramm (x1, probes, precision,
                                  "WeibullRandomVariable scale=1.0 shape=1.0") );

    Ptr<WeibullRandomVariable> x2 = CreateObject<WeibullRandomVariable> ();
    x2->SetAttribute ("Scale", DoubleValue (1.0));
    x2->SetAttribute ("Shape", DoubleValue (2.0));

    plot.AddDataset ( Histogramm (x2, probes, precision,
                                  "WeibullRandomVariable scale=1.0 shape=2.0") );

    Ptr<WeibullRandomVariable> x3 = CreateObject<WeibullRandomVariable> ();
    x3->SetAttribute ("Scale", DoubleValue (1.0));
    x3->SetAttribute ("Shape", DoubleValue (3.0));

    plot.AddDataset ( Histogramm (x3, probes, precision,
                                  "WeibullRandomVariable scale=1.0 shape=3.0") );

    gnuplots.AddPlot (plot);
  }




    plot.AppendExtra ("set xrange [0:2]");

    Ptr<ParetoRandomVariable> x1 = CreateObject<ParetoRandomVariable> ();
    x1->SetAttribute ("Scale", DoubleValue (1.0));
    x1->SetAttribute ("Shape", DoubleValue (1.5));

    plot.AddDataset ( Histogramm (x1, probes, precision,
                                  "ParetoRandomVariable scale=1.0 shape=1.5") );

    Ptr<ParetoRandomVariable> x2 = CreateObject<ParetoRandomVariable> ();
    x2->SetAttribute ("Scale", DoubleValue (1.0));
    x2->SetAttribute ("Shape", DoubleValue (2.0));

    plot.AddDataset ( Histogramm (x2, probes, precision,
                                  "ParetoRandomVariable scale=1.0 shape=2.0") );

    Ptr<ParetoRandomVariable> x3 = CreateObject<ParetoRandomVariable> ();
    x3->SetAttribute ("Scale", DoubleValue (1.0));
    x3->SetAttribute ("Shape", DoubleValue (2.5));

    plot.AddDataset ( Histogramm (x3, probes, precision,
                                  "ParetoRandomVariable scale=1.0 shape=2.5") );

    gnuplots.AddPlot (plot);
  }

    x1->SetAttribute ("Shape", DoubleValue (1.0));

    plot.AddDataset ( Histogramm (x1, probes, precision,
                                  "WeibullRandomVariable scale=1.0 shape=1.0") );

    Ptr<WeibullRandomVariable> x2 = CreateObject<WeibullRandomVariable> ();
    x2->SetAttribute ("Scale", DoubleValue (1.0));
    x2->SetAttribute ("Shape", DoubleValue (2.0));

    plot.AddDataset ( Histogramm (x2, probes, precision,
                                  "WeibullRandomVariable scale=1.0 shape=2.0") );

    Ptr<WeibullRandomVariable> x3 = CreateObject<WeibullRandomVariable> ();
    x3->SetAttribute ("Scale", DoubleValue (1.0));
    x3->SetAttribute ("Shape", DoubleValue (3.0));

    plot.AddDataset ( Histogramm (x3, probes, precision,
                                  "WeibullRandomVariable scale=1.0 shape=3.0") );

    gnuplots.AddPlot (plot);
  }

(-)a/src/core/model/random-variable-stream.cc (-8 / +25 lines)

Lines 33-38	Link Here

#include "log.h"

#include "log.h"

#include "rng-stream.h"

#include "rng-stream.h"

#include "rng-seed-manager.h"

#include "rng-seed-manager.h"

#include "unused.h"

#include <cmath>

#include <cmath>

#include <iostream>

#include <iostream>

Lines 455-463	Link Here

455

    .SetGroupName ("Core")

456

    .SetGroupName ("Core")

456

    .AddConstructor<ParetoRandomVariable> ()

457

    .AddConstructor<ParetoRandomVariable> ()

457

    .AddAttribute("Mean", "The mean parameter for the Pareto distribution returned by this RNG stream.",

458

    .AddAttribute("Mean", "The mean parameter for the Pareto distribution returned by this RNG stream.",

458

		  DoubleValue(1.0),

459

      DoubleValue(0.0),

459

		  MakeDoubleAccessor(&ParetoRandomVariable::m_mean),

460

      MakeDoubleAccessor(&ParetoRandomVariable::m_mean),

460

		  MakeDoubleChecker<double>())

461

      MakeDoubleChecker<double>(),

462

      TypeId::DEPRECATED,

463

      "Not anymore used. Use 'Scale' instead.")

464

    .AddAttribute("Scale", "The scale parameter for the Pareto distribution returned by this RNG stream.",

465

      DoubleValue(1.0),

466

      MakeDoubleAccessor(&ParetoRandomVariable::m_scale),

467

      MakeDoubleChecker<double>())

461

    .AddAttribute("Shape", "The shape parameter for the Pareto distribution returned by this RNG stream.",

468

    .AddAttribute("Shape", "The shape parameter for the Pareto distribution returned by this RNG stream.",

462

		  DoubleValue(2.0),

469

		  DoubleValue(2.0),

463

		  MakeDoubleAccessor(&ParetoRandomVariable::m_shape),

470

		  MakeDoubleAccessor(&ParetoRandomVariable::m_shape),

Lines 471-493	Link Here

471

478

472

ParetoRandomVariable::ParetoRandomVariable ()

479

ParetoRandomVariable::ParetoRandomVariable ()

473

480

474

  // m_mean, m_shape, and m_bound are initialized after constructor

481

  // m_shape, m_shape, and m_bound are initialized after constructor

475

  // by attributes

482

  // by attributes

476

  NS_LOG_FUNCTION (this);

483

  NS_LOG_FUNCTION (this);

484

  NS_UNUSED (m_mean);

477

485

478

486

479

double

487

double

480

ParetoRandomVariable::GetMean (void) const

488

ParetoRandomVariable::GetMean (void) const

481

489

482

  NS_LOG_FUNCTION (this);

490

  NS_LOG_FUNCTION (this);

483

  return m_mean;

491

492

  double mean = std::numeric_limits<double>::infinity();

493

494

  if (m_shape > 1)

495

496

      mean = m_shape * m_scale / (m_shape -1);

497

498

499

  return mean;

484

500

501

485

double

502

double

486

ParetoRandomVariable::GetShape (void) const

503

ParetoRandomVariable::GetShape (void) const

487

504

488

  NS_LOG_FUNCTION (this);

505

  NS_LOG_FUNCTION (this);

489

  return m_shape;

506

  return m_shape;

490

507

508

491

double

509

double

492

ParetoRandomVariable::GetBound (void) const

510

ParetoRandomVariable::GetBound (void) const

493

511

Lines 496-506	Link Here

496

514

497

515

498

double

516

double

499

ParetoRandomVariable::GetValue (double mean, double shape, double bound)

517

ParetoRandomVariable::GetValue (double scale, double shape, double bound)

500

518

501

  // Calculate the scale parameter.

519

  // Calculate the scale parameter.

502

  NS_LOG_FUNCTION (this << mean << shape << bound);

520

  NS_LOG_FUNCTION (this << scale << shape << bound);

503

  double scale = mean * (shape - 1.0) / shape;

504

521

505

  while (1)

522

  while (1)

506

523




 * The probability density function of a Pareto variable is defined
 * over the range [\f$x_m\f$,\f$+\infty\f$) as: \f$ k \frac{x_m^k}{x^{k+1}}\f$
 * where \f$x_m > 0\f$ is called the scale parameter and \f$ k > 0\f$
 * is called the Pareto index or shape.
 *
 * The parameter \f$ x_m \f$ can be inferred from the mean and the parameter \f$ k \f$
 * with the equation \f$ x_m = mean \frac{k-1}{k},  k > 1\f$.
 *
 * Since Pareto distributions can theoretically return unbounded values,

 *
 * Here is an example of how to use this class:
 * \code
 *   double scale = 5.0;
 *   double shape = 2.0;
 * 
 *   Ptr<ParetoRandomVariable> x = CreateObject<ParetoRandomVariable> ();
 *   x->SetAttribute ("Scale", DoubleValue (scale));
 *   x->SetAttribute ("Shape", DoubleValue (shape));
 * 
 *   // The expected value for the mean of the values returned by a

 *   //                   shape * scale
 *   //     E[value]  =  ---------------  ,
 *   //                     shape - 1
 *
 *   // where
 *   // 
 *   //     scale  =  mean * (shape - 1.0) / shape .
 *   //
 *   double value = x->GetValue ();
 * \endcode
 */

   * \brief Returns the mean parameter for the Pareto distribution returned by this RNG stream.
   * \return The mean parameter for the Pareto distribution returned by this RNG stream.
   */
  NS_DEPRECATED
  double GetMean (void) const;

  /**
   * \brief Returns the scale parameter for the Pareto distribution returned by this RNG stream.
   * \return The scale parameter for the Pareto distribution returned by this RNG stream.
   */
  double GetScale (void) const;

  /**
   * \brief Returns the shape parameter for the Pareto distribution returned by this RNG stream.
   * \return The shape parameter for the Pareto distribution returned by this RNG stream.
   */

  double GetBound (void) const;

  /**
   * \brief Returns a random double from a Pareto distribution with the specified scale, shape, and upper bound.
   * \param [in] scale Mean parameter for the Pareto distribution.
   * \param [in] shape Shape parameter for the Pareto distribution.
   * \param [in] bound Upper bound on values returned.
   * \return A floating point random value.

   *         x = \frac{scale}{u^{\frac{1}{shape}}}
   *    \f]
   *
   * is a value that would be returned normally.
   *     
   *    \f[
   *         scale  =  mean * (shape - 1.0) / shape  .
   *    \f]
   *    
   * The value returned in the antithetic case, \f$x'\f$, is
   * \f$1\f$.  The value returned in the antithetic case, \f$x'\f$, is
   * calculated as
   *
   *    \f[
   *         x' = \frac{scale}{{(1 - u)}^{\frac{1}{shape}}} ,
   *    \f]
   *
   * which now involves the distance \f$u\f$ is from 1 in the denominator.
   */
  double GetValue (double scale, double shape, double bound);

  /**
   * \brief Returns a random unsigned integer from a Pareto distribution with the specified mean, shape, and upper bound.
   * \param [in] scale Scale parameter for the Pareto distribution.
   * \param [in] shape Shape parameter for the Pareto distribution.
   * \param [in] bound Upper bound on values returned.
   * \return A random unsigned integer value.

   *         x = \frac{scale}{u^{\frac{1}{shape}}}
   *    \f]
   *
   * is a value that would be returned normally.
   *
   * The value returned in the antithetic case, \f$x'\f$, is
   *         scale  =  mean * (shape - 1.0) / shape  .
   *    \f]
   *    
   * Then \f$(1 - u\f$) is the distance that \f$u\f$ would be from
   * \f$1\f$.  The value returned in the antithetic case, \f$x'\f$, is
   * calculated as
   *
   *    \f[
   *         x' = \frac{scale}{{(1 - u)}^{\frac{1}{shape}}} ,
   *    \f]
   *
   * which now involves the distance \f$u\f$ is from 1 in the denominator.
   */
  uint32_t GetInteger (uint32_t scale, uint32_t shape, uint32_t bound);

  /**
   * \brief Returns a random double from a Pareto distribution with the current mean, shape, and upper bound.

   *         scale  =  mean * (shape - 1.0) / shape  .
   *    \f]
   *    
   * The value returned in the antithetic case, \f$x'\f$, is
   * \f$1\f$.  The value returned in the antithetic case, \f$x'\f$, is
   * calculated as
   *
   *    \f[
   *         x' = \frac{scale}{{(1 - u)}^{\frac{1}{shape}}} ,
   *    \f]
   *
   * which now involves the distance \f$u\f$ is from 1 in the denominator.
   *
   * 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

   *         x = \frac{scale}{u^{\frac{1}{shape}}}
   *    \f]
   *
   * is a value that would be returned normally.
   *
   * The value returned in the antithetic case, \f$x'\f$, is
   *         scale  =  mean * (shape - 1.0) / shape  .
   *    \f]
   *    
   * Then \f$(1 - u\f$) is the distance that \f$u\f$ would be from
   * \f$1\f$.  The value returned in the antithetic case, \f$x'\f$, is
   * calculated as
   *
   *    \f[
   *         x' = \frac{scale}{{(1 - u)}^{\frac{1}{shape}}} ,
   *    \f]
   *
   * which now involves the distance \f$u\f$ is from 1 in the denominator.
   */
  virtual uint32_t GetInteger (void);


  /** The mean parameter for the Pareto distribution returned by this RNG stream. */
  double m_mean;

  /** The scale parameter for the Pareto distribution returned by this RNG stream. */
  double m_scale;

  /** The shape parameter for the Pareto distribution returned by this RNG stream. */
  double m_shape;


Return to bug 2513