cvr::randomDistribution::randomDistribution::rndBase Class Reference

Pure virtual nested class base of all random number generators. More...

#include <cvrRandomDistribution.h>

Inheritance diagram for cvr::randomDistribution::randomDistribution::rndBase:

[legend]

List of all members.

Public Member Functions
virtual	~rndBase ()
virtual uint32	draw ()=0
virtual void	setSeed (const uint32 seed)=0
virtual uint32	max () const =0
virtual bool	write (ioHandler &handler, const bool complete=true) const =0
virtual bool	read (ioHandler &handler, const bool complete=true)=0

---

Detailed Description

Pure virtual nested class base of all random number generators.

It does not need copy constructors, since the updateParameters of each new functor will create a new instance of the correct rndBase class.

---

Constructor & Destructor Documentation

virtual cvr::randomDistribution::randomDistribution::rndBase::~rndBase

(

)

[virtual]

Destructor.

---

Member Function Documentation

virtual uint32 cvr::randomDistribution::randomDistribution::rndBase::draw

(

)

[pure virtual]

Get a single number.

Implemented in cvr::randomDistribution::randomDistribution::rndSystem, cvr::randomDistribution::randomDistribution::rndStochastic, cvr::randomDistribution::randomDistribution::rndMinStd, cvr::randomDistribution::randomDistribution::rndMinStd0, and cvr::randomDistribution::randomDistribution::rndMersenneTwister.

virtual uint32 cvr::randomDistribution::randomDistribution::rndBase::max

(

)

const [pure virtual]

Return the maximal obtainable number (inclusive).

Implemented in cvr::randomDistribution::randomDistribution::rndSystem, cvr::randomDistribution::randomDistribution::rndStochastic, cvr::randomDistribution::randomDistribution::rndMinStd, cvr::randomDistribution::randomDistribution::rndMinStd0, and cvr::randomDistribution::randomDistribution::rndMersenneTwister.

virtual bool cvr::randomDistribution::randomDistribution::rndBase::read	(	ioHandler &	handler,
		const bool	complete = true
	)			[pure virtual]

Read the parameters from the given ioHandler.

Parameters:

	handler	the ioHandler to be used
	complete	if true (the default) the enclosing begin/end will be also written, otherwise only the data block will be written.

Returns:

true if write was successful

Implemented in cvr::randomDistribution::randomDistribution::rndSystem, cvr::randomDistribution::randomDistribution::rndStochastic, cvr::randomDistribution::randomDistribution::rndMinStd, cvr::randomDistribution::randomDistribution::rndMinStd0, and cvr::randomDistribution::randomDistribution::rndMersenneTwister.

virtual void cvr::randomDistribution::randomDistribution::rndBase::setSeed

(

const uint32

seed

)

[pure virtual]

Set the seed for the generator.

Implemented in cvr::randomDistribution::randomDistribution::rndSystem, cvr::randomDistribution::randomDistribution::rndStochastic, cvr::randomDistribution::randomDistribution::rndMinStd, cvr::randomDistribution::randomDistribution::rndMinStd0, and cvr::randomDistribution::randomDistribution::rndMersenneTwister.

virtual bool cvr::randomDistribution::randomDistribution::rndBase::write	(	ioHandler &	handler,
		const bool	complete = true
	)			const [pure virtual]

Write the parameters in the given ioHandler.

Parameters:

	handler	the ioHandler to be used
	complete	if true (the default) the enclosing begin/end will be also written, otherwise only the data block will be written.

Returns:

true if write was successful

Implemented in cvr::randomDistribution::randomDistribution::rndSystem, cvr::randomDistribution::randomDistribution::rndStochastic, cvr::randomDistribution::randomDistribution::rndMinStd, cvr::randomDistribution::randomDistribution::rndMinStd0, and cvr::randomDistribution::randomDistribution::rndMersenneTwister.

---

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

• cvrRandomDistribution.h