EPIC::RandomNumberModule Class Reference

Definition of module for generation of random numbers. More...

#include <RandomNumberModule.h>

Inheritance diagram for EPIC::RandomNumberModule:

Public Member Functions
	RandomNumberModule (const std::string &className)
	RandomNumberModule (const RandomNumberModule &other)
virtual	~RandomNumberModule ()
virtual bool	runTest () const
virtual double	diceFlat ()=0
double	diceFlat (double min, double max)
virtual double	diceNormal ()=0
double	diceNormal (double mean, double sigma)
Public Member Functions inherited from EPIC::EpicModuleObject
virtual	~EpicModuleObject ()
virtual bool	runTest () const =0
size_t	getSeed () const

Static Public Attributes
static const std::string	RANDOM_NUMBER_MODULE_CLASS_NAME
	Class name used in parsing XML.

Protected Member Functions
virtual void	initModule ()
virtual void	isModuleWellConfigured ()
double	diceNormalFromFlat ()
Protected Member Functions inherited from EPIC::EpicModuleObject
	EpicModuleObject (const std::string &className, PARTONS::ChannelType::Type channelType)
	EpicModuleObject (const EpicModuleObject &other)

Additional Inherited Members
Protected Attributes inherited from EPIC::EpicModuleObject
size_t	m_seed
	Random seed.

Detailed Description

Definition of module for generation of random numbers.

This class provides a definition of modules used to generate random numbers.

Constructor & Destructor Documentation

RandomNumberModule() [1/2]

EPIC::RandomNumberModule::RandomNumberModule

(

const std::string &

className

)

Constructor.

RandomNumberModule() [2/2]

EPIC::RandomNumberModule::RandomNumberModule

(

const RandomNumberModule &

other

)

Copy constructor.

~RandomNumberModule()

virtual EPIC::RandomNumberModule::~RandomNumberModule ( )

virtual

Destructor.

Member Function Documentation

diceFlat() [1/2]

virtual double EPIC::RandomNumberModule::diceFlat ( )

pure virtual

Dice double precision number from flat distribution in range [0, 1)

Implemented in EPIC::RandomNumberGSL.

diceFlat() [2/2]

double EPIC::RandomNumberModule::diceFlat	(	double	min,
		double	max
	)

Dice double precision number from flat distribution in given range

Parameters

min	Min
max	Max

diceNormal() [1/2]

virtual double EPIC::RandomNumberModule::diceNormal ( )

pure virtual

Dice double precision number from normal distribution with mean = 0 and sigma = 1

Implemented in EPIC::RandomNumberGSL.

diceNormal() [2/2]

double EPIC::RandomNumberModule::diceNormal	(	double	mean,
		double	sigma
	)

Dice double precision number from normal distribution with given mean and sigma

Parameters

mean	Mean
sigma	Sigma

diceNormalFromFlat()

double EPIC::RandomNumberModule::diceNormalFromFlat ( )

protected

Generate normal from flat distribution. Useful if used method does not provide a genuine method for generation according to normal distribution.

runTest()

virtual bool EPIC::RandomNumberModule::runTest ( ) const

virtual

Definition of test.

Implements EPIC::EpicModuleObject.

---

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

• /Users/pawel/projects/epic/NEW2/epic/include/modules/random_generator/RandomNumberModule.h