wns::distribution::Geometric Class Reference

Geometric distributed random numbers. More...

#include <distribution/Geometric.hpp>

Inheritance diagram for wns::distribution::Geometric:

[legend]

Collaboration diagram for wns::distribution::Geometric:

[legend]

List of all members.

Public Member Functions
	Geometric (wns::rng::RNGen *rng, const pyconfig::View &config)
	Geometric (const pyconfig::View &config)
	Geometric (double mean, wns::rng::RNGen *rng=wns::simulator::getRNG())
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
virtual	~Geometric ()
Private Attributes
StandardUniform	dis_
double	mean_

---

Detailed Description

Author:

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

Returns number of trials until the first successful trial appears. The success rate for a single experiment is p = 1 / (mean + 1)

Definition at line 44 of file Geometric.hpp.

---

Constructor & Destructor Documentation

Geometric::Geometric	(	double	mean,
		wns::rng::RNGen *	rng = wns::simulator::getRNG()
	)			[explicit]

Definition at line 45 of file Geometric.cpp.

Geometric::Geometric

(

const pyconfig::View &

config

)

[explicit]

Definition at line 52 of file Geometric.cpp.

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

Definition at line 59 of file Geometric.cpp.

Geometric::~Geometric

(

)

[virtual]

Definition at line 67 of file Geometric.cpp.

---

Member Function Documentation

double Geometric::getMean

(

)

const [virtual]

Implements wns::distribution::IHasMean.

Definition at line 84 of file Geometric.cpp.

double Geometric::operator()

(

)

[virtual]

Implements wns::distribution::Distribution.

Definition at line 72 of file Geometric.cpp.

std::string Geometric::paramString

(

)

const [virtual]

Implements wns::distribution::Distribution.

Definition at line 90 of file Geometric.cpp.

---

Member Data Documentation

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

Definition at line 73 of file Geometric.hpp.

double wns::distribution::Geometric::mean_ [private]

Definition at line 72 of file Geometric.hpp.

---

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

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