wns::distribution::Pareto Class Reference

class for random numbers according to Pareto distribution. More...

#include <distribution/Pareto.hpp>

Inheritance diagram for wns::distribution::Pareto:

[legend]

Collaboration diagram for wns::distribution::Pareto:

[legend]

List of all members.

Public Member Functions
virtual double	getMean () const
	Mean value of the distribution.
virtual double	operator() ()
	returns the random value according to the distribution.
virtual std::string	paramString () const
	returns a string describing distribution and parameters
	Pareto (wns::rng::RNGen *rng, const pyconfig::View &config)
	Pareto (const pyconfig::View &config)
	Pareto (double shapeA, double scaleB, wns::rng::RNGen *rng=wns::simulator::getRNG())
virtual	~Pareto ()
Private Attributes
StandardUniform	dis_
	The distribution itself.
double	scaleParamB_
	Scale parameter 'b'.
double	shapeParamA_
	Shape parameter 'a'.

---

Detailed Description

Author:

Rainer Schoenen <rs@comnets.rwth-aachen.de>

The distriubtion is classified by the shape parameter A (often called beta) and the scale parameter B (proportional to mean outcome).

See also:

http://en.wikipedia.org/wiki/Pareto_distribution

Definition at line 48 of file Pareto.hpp.

---

Constructor & Destructor Documentation

Pareto::Pareto	(	double	shapeA,
		double	scaleB,
		wns::rng::RNGen *	rng = wns::simulator::getRNG()
	)			[explicit]

Definition at line 46 of file Pareto.cpp.

Pareto::Pareto

(

const pyconfig::View &

config

)

[explicit]

Definition at line 56 of file Pareto.cpp.

Pareto::Pareto	(	wns::rng::RNGen *	rng,
		const pyconfig::View &	config
	)			[explicit]

Definition at line 66 of file Pareto.cpp.

Pareto::~Pareto

(

)

[virtual]

Definition at line 77 of file Pareto.cpp.

---

Member Function Documentation

double Pareto::getMean

(

)

const [virtual]

Implements wns::distribution::IHasMean.

Definition at line 106 of file Pareto.cpp.

double Pareto::operator()

(

)

[virtual]

Implements wns::distribution::Distribution.

Definition at line 83 of file Pareto.cpp.

std::string Pareto::paramString

(

)

const [virtual]

Implements wns::distribution::Distribution.

Definition at line 117 of file Pareto.cpp.

---

Member Data Documentation

StandardUniform wns::distribution::Pareto::dis_ [private]

Definition at line 91 of file Pareto.hpp.

double wns::distribution::Pareto::scaleParamB_ [private]

Note:

b >= 0

Definition at line 86 of file Pareto.hpp.

double wns::distribution::Pareto::shapeParamA_ [private]

Definition at line 79 of file Pareto.hpp.

---

The documentation for this class was generated from the following files:

• framework/library/src/distribution/Pareto.hpp
• framework/library/src/distribution/Pareto.cpp