EPIC::RandomNumberGSL Class Reference

Generation of random numbers based on GSL. More...

#include <RandomNumberGSL.h>

Inheritance diagram for EPIC::RandomNumberGSL:

Public Member Functions
	RandomNumberGSL (const std::string &className)
	RandomNumberGSL (const RandomNumberGSL &other)
virtual	~RandomNumberGSL ()
virtual RandomNumberGSL *	clone () const
virtual void	configure (const ElemUtils::Parameters &parameters)
virtual double	diceFlat ()
virtual double	diceNormal ()
std::string	getAlgorithmName () const
Public Member Functions inherited from EPIC::RandomNumberModule
	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	PARAMETER_NAME_ALGORITHM_NAME
static const unsigned int	classId
Static Public Attributes inherited from EPIC::RandomNumberModule
static const std::string	RANDOM_NUMBER_MODULE_CLASS_NAME
	Class name used in parsing XML.

Additional Inherited Members
Protected Member Functions inherited from EPIC::RandomNumberModule
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)
Protected Attributes inherited from EPIC::EpicModuleObject
size_t	m_seed
	Random seed.

Detailed Description

Generation of random numbers based on GSL.

Module dedicated to the generation of random numbers using algorithms available in GSL.

Constructor & Destructor Documentation

RandomNumberGSL() [1/2]

EPIC::RandomNumberGSL::RandomNumberGSL

(

const std::string &

className

)

Default constructor.

RandomNumberGSL() [2/2]

EPIC::RandomNumberGSL::RandomNumberGSL

(

const RandomNumberGSL &

other

)

Copy constructor.

~RandomNumberGSL()

virtual EPIC::RandomNumberGSL::~RandomNumberGSL ( )

virtual

Destructor.

Member Function Documentation

diceFlat()

virtual double EPIC::RandomNumberGSL::diceFlat ( )

virtual

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

Implements EPIC::RandomNumberModule.

diceNormal()

virtual double EPIC::RandomNumberGSL::diceNormal ( )

virtual

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

Implements EPIC::RandomNumberModule.

getAlgorithmName()

std::string EPIC::RandomNumberGSL::getAlgorithmName

(

)

const

Get name of currently used algorithm.

Member Data Documentation

classId

const unsigned int EPIC::RandomNumberGSL::classId

static

Unique ID to automatically register the class in the registry.

PARAMETER_NAME_ALGORITHM_NAME

const std::string EPIC::RandomNumberGSL::PARAMETER_NAME_ALGORITHM_NAME

static

String used to set algorithm through RandomNumberGSL::configure().

---

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

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