CLHEP 2.4.7.1
C++ Class Library for High Energy Physics
Public Member Functions | Static Public Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
CLHEP::HepRandomEngine Class Referenceabstract

#include <CLHEP/Random/RandomEngine.h>

Inheritance diagram for CLHEP::HepRandomEngine:
CLHEP::DRand48Engine CLHEP::DualRand CLHEP::HepJamesRandom CLHEP::Hurd160Engine CLHEP::Hurd288Engine CLHEP::MTwistEngine CLHEP::MixMaxRng CLHEP::NonRandomEngine CLHEP::RandEngine CLHEP::RanecuEngine CLHEP::Ranlux64Engine CLHEP::RanluxEngine CLHEP::RanluxppEngine CLHEP::RanshiEngine CLHEP::TripleRand

Public Member Functions

 HepRandomEngine ()
 
virtual ~HepRandomEngine ()
 
bool operator== (const HepRandomEngine &engine)
 
bool operator!= (const HepRandomEngine &engine)
 
virtual double flat ()=0
 
virtual void flatArray (const int size, double *vect)=0
 
virtual void setSeed (long seed, int)=0
 
virtual void setSeeds (const long *seeds, int)=0
 
virtual void saveStatus (const char filename[]="Config.conf") const =0
 
virtual void restoreStatus (const char filename[]="Config.conf")=0
 
virtual void showStatus () const =0
 
virtual std::string name () const =0
 
virtual std::ostream & put (std::ostream &os) const
 
virtual std::istream & get (std::istream &is)
 
virtual std::istream & getState (std::istream &is)
 
virtual std::vector< unsigned long > put () const
 
virtual bool get (const std::vector< unsigned long > &v)
 
virtual bool getState (const std::vector< unsigned long > &v)
 
long getSeed () const
 
const long * getSeeds () const
 
virtual operator double ()
 
virtual operator float ()
 
virtual operator unsigned int ()
 

Static Public Member Functions

static std::string beginTag ()
 
static HepRandomEngine * newEngine (std::istream &is)
 
static HepRandomEngine * newEngine (const std::vector< unsigned long > &v)
 

Static Protected Member Functions

static double exponent_bit_32 ()
 
static double mantissa_bit_12 ()
 
static double mantissa_bit_24 ()
 
static double mantissa_bit_32 ()
 
static double twoToMinus_32 ()
 
static double twoToMinus_48 ()
 
static double twoToMinus_49 ()
 
static double twoToMinus_53 ()
 
static double nearlyTwoToMinus_54 ()
 
static bool checkFile (std::istream &file, const std::string &filename, const std::string &classname, const std::string &methodname)
 

Protected Attributes

long theSeed
 
const long * theSeeds
 

Detailed Description

Author
Gabri.nosp@m.ele..nosp@m.Cosmo.nosp@m.@cer.nosp@m.n.ch

Definition at line 55 of file RandomEngine.h.

Constructor & Destructor Documentation

◆ HepRandomEngine()

CLHEP::HepRandomEngine::HepRandomEngine ( )

◆ ~HepRandomEngine()

virtual CLHEP::HepRandomEngine::~HepRandomEngine ( )
virtual

Member Function Documentation

◆ beginTag()

static std::string CLHEP::HepRandomEngine::beginTag ( )
static

◆ checkFile()

static bool CLHEP::HepRandomEngine::checkFile ( std::istream &  file,
const std::string &  filename,
const std::string &  classname,
const std::string &  methodname 
)
staticprotected

◆ exponent_bit_32()

double CLHEP::HepRandomEngine::exponent_bit_32 ( )
inlinestaticprotected

Definition at line 29 of file RandomEngine.icc.

References exponent_bit_32().

Referenced by exponent_bit_32().

◆ flat()

virtual double CLHEP::HepRandomEngine::flat ( )
pure virtual

Implemented in CLHEP::DRand48Engine, CLHEP::DualRand, CLHEP::Hurd160Engine, CLHEP::Hurd288Engine, CLHEP::HepJamesRandom, CLHEP::MixMaxRng, CLHEP::MTwistEngine, CLHEP::NonRandomEngine, CLHEP::RandEngine, CLHEP::RanecuEngine, CLHEP::Ranlux64Engine, CLHEP::RanluxEngine, CLHEP::RanshiEngine, CLHEP::TripleRand, and CLHEP::RanluxppEngine.

Referenced by CLHEP::HepRandomVector::flat(), CLHEP::HepRandom::flat(), CLHEP::HepRandomVector::flat(), CLHEP::HepRandomVector::flatArray(), CLHEP::HepRandomVector::flatArray(), CLHEP::RandGaussQ::shoot(), CLHEP::RandGaussT::shoot(), CLHEP::RandLandau::shoot(), CLHEP::RandExponential::shoot(), CLHEP::RandFlat::shoot(), CLHEP::RandGeneral::shoot(), CLHEP::RandFlat::shoot(), CLHEP::RandExponential::shoot(), CLHEP::RandFlat::shoot(), CLHEP::RandGaussQ::shoot(), CLHEP::RandGaussT::shoot(), CLHEP::RandLandau::shoot(), CLHEP::RandFlat::shootInt(), CLHEP::RandFlat::shootInt(), CLHEP::RandExpZiggurat::ziggurat_UNI(), and CLHEP::RandGaussZiggurat::ziggurat_UNI().

◆ flatArray()

virtual void CLHEP::HepRandomEngine::flatArray ( const int  size,
double *  vect 
)
pure virtual

Implemented in CLHEP::DRand48Engine, CLHEP::DualRand, CLHEP::Hurd160Engine, CLHEP::Hurd288Engine, CLHEP::HepJamesRandom, CLHEP::MixMaxRng, CLHEP::MTwistEngine, CLHEP::NonRandomEngine, CLHEP::RandEngine, CLHEP::RanecuEngine, CLHEP::Ranlux64Engine, CLHEP::RanluxEngine, CLHEP::RanshiEngine, CLHEP::TripleRand, and CLHEP::RanluxppEngine.

Referenced by CLHEP::HepRandom::flatArray(), and CLHEP::RandFlat::shootArray().

◆ get() [1/2]

virtual bool CLHEP::HepRandomEngine::get ( const std::vector< unsigned long > &  v)
virtual

Reimplemented in CLHEP::DRand48Engine, CLHEP::DualRand, CLHEP::Hurd160Engine, CLHEP::Hurd288Engine, CLHEP::HepJamesRandom, CLHEP::MTwistEngine, CLHEP::NonRandomEngine, CLHEP::RandEngine, CLHEP::RanecuEngine, CLHEP::Ranlux64Engine, CLHEP::RanluxEngine, CLHEP::RanshiEngine, CLHEP::TripleRand, CLHEP::RanluxppEngine, and CLHEP::MixMaxRng.

◆ get() [2/2]

virtual std::istream & CLHEP::HepRandomEngine::get ( std::istream &  is)
virtual

Reimplemented in CLHEP::DRand48Engine, CLHEP::DualRand, CLHEP::Hurd160Engine, CLHEP::Hurd288Engine, CLHEP::HepJamesRandom, CLHEP::MixMaxRng, CLHEP::MTwistEngine, CLHEP::NonRandomEngine, CLHEP::RandEngine, CLHEP::RanecuEngine, CLHEP::Ranlux64Engine, CLHEP::RanluxEngine, CLHEP::RanshiEngine, CLHEP::TripleRand, and CLHEP::RanluxppEngine.

◆ getSeed()

long CLHEP::HepRandomEngine::getSeed ( ) const
inline

Definition at line 114 of file RandomEngine.h.

References theSeed.

◆ getSeeds()

const long * CLHEP::HepRandomEngine::getSeeds ( ) const
inline

Definition at line 117 of file RandomEngine.h.

References theSeeds.

◆ getState() [1/2]

virtual bool CLHEP::HepRandomEngine::getState ( const std::vector< unsigned long > &  v)
virtual

Reimplemented in CLHEP::DRand48Engine, CLHEP::DualRand, CLHEP::Hurd160Engine, CLHEP::Hurd288Engine, CLHEP::HepJamesRandom, CLHEP::MTwistEngine, CLHEP::NonRandomEngine, CLHEP::RandEngine, CLHEP::RanecuEngine, CLHEP::Ranlux64Engine, CLHEP::RanluxEngine, CLHEP::RanshiEngine, CLHEP::TripleRand, CLHEP::RanluxppEngine, and CLHEP::MixMaxRng.

◆ getState() [2/2]

virtual std::istream & CLHEP::HepRandomEngine::getState ( std::istream &  is)
virtual

Reimplemented in CLHEP::DRand48Engine, CLHEP::DualRand, CLHEP::Hurd160Engine, CLHEP::Hurd288Engine, CLHEP::HepJamesRandom, CLHEP::MixMaxRng, CLHEP::MTwistEngine, CLHEP::NonRandomEngine, CLHEP::RandEngine, CLHEP::RanecuEngine, CLHEP::Ranlux64Engine, CLHEP::RanluxEngine, CLHEP::RanshiEngine, CLHEP::TripleRand, and CLHEP::RanluxppEngine.

◆ mantissa_bit_12()

double CLHEP::HepRandomEngine::mantissa_bit_12 ( )
inlinestaticprotected

Definition at line 34 of file RandomEngine.icc.

References mantissa_bit_12().

Referenced by mantissa_bit_12().

◆ mantissa_bit_24()

double CLHEP::HepRandomEngine::mantissa_bit_24 ( )
inlinestaticprotected

Definition at line 39 of file RandomEngine.icc.

References mantissa_bit_24().

Referenced by mantissa_bit_24().

◆ mantissa_bit_32()

static double CLHEP::HepRandomEngine::mantissa_bit_32 ( )
inlinestaticprotected

◆ name()

virtual std::string CLHEP::HepRandomEngine::name ( ) const
pure virtual

Implemented in CLHEP::DRand48Engine, CLHEP::DualRand, CLHEP::Hurd160Engine, CLHEP::Hurd288Engine, CLHEP::HepJamesRandom, CLHEP::MixMaxRng, CLHEP::MTwistEngine, CLHEP::NonRandomEngine, CLHEP::RandEngine, CLHEP::RanecuEngine, CLHEP::Ranlux64Engine, CLHEP::RanluxEngine, CLHEP::RanshiEngine, CLHEP::TripleRand, and CLHEP::RanluxppEngine.

Referenced by CLHEP::RandGaussQ::shoot().

◆ nearlyTwoToMinus_54()

double CLHEP::HepRandomEngine::nearlyTwoToMinus_54 ( )
inlinestaticprotected

Definition at line 64 of file RandomEngine.icc.

References nearlyTwoToMinus_54().

Referenced by nearlyTwoToMinus_54().

◆ newEngine() [1/2]

static HepRandomEngine * CLHEP::HepRandomEngine::newEngine ( const std::vector< unsigned long > &  v)
static

◆ newEngine() [2/2]

static HepRandomEngine * CLHEP::HepRandomEngine::newEngine ( std::istream &  is)
static

◆ operator double()

virtual CLHEP::HepRandomEngine::operator double ( )
virtual

Reimplemented in CLHEP::DualRand, CLHEP::Hurd160Engine, CLHEP::Hurd288Engine, CLHEP::HepJamesRandom, CLHEP::MixMaxRng, CLHEP::MTwistEngine, CLHEP::RandEngine, CLHEP::RanecuEngine, CLHEP::RanluxEngine, CLHEP::RanshiEngine, CLHEP::TripleRand, and CLHEP::RanluxppEngine.

◆ operator float()

virtual CLHEP::HepRandomEngine::operator float ( )
virtual

Reimplemented in CLHEP::DualRand, CLHEP::Hurd160Engine, CLHEP::Hurd288Engine, CLHEP::HepJamesRandom, CLHEP::MixMaxRng, CLHEP::MTwistEngine, CLHEP::RandEngine, CLHEP::RanecuEngine, CLHEP::RanluxEngine, CLHEP::RanshiEngine, CLHEP::TripleRand, and CLHEP::RanluxppEngine.

◆ operator unsigned int()

virtual CLHEP::HepRandomEngine::operator unsigned int ( )
virtual

Reimplemented in CLHEP::DualRand, CLHEP::Hurd160Engine, CLHEP::Hurd288Engine, CLHEP::HepJamesRandom, CLHEP::MixMaxRng, CLHEP::MTwistEngine, CLHEP::RandEngine, CLHEP::RanecuEngine, CLHEP::RanluxEngine, CLHEP::RanshiEngine, CLHEP::TripleRand, and CLHEP::RanluxppEngine.

◆ operator!=()

bool CLHEP::HepRandomEngine::operator!= ( const HepRandomEngine &  engine)
inline

Definition at line 25 of file RandomEngine.icc.

◆ operator==()

bool CLHEP::HepRandomEngine::operator== ( const HepRandomEngine &  engine)
inline

Definition at line 21 of file RandomEngine.icc.

◆ put() [1/2]

virtual std::vector< unsigned long > CLHEP::HepRandomEngine::put ( ) const
virtual

Reimplemented in CLHEP::DRand48Engine, CLHEP::DualRand, CLHEP::Hurd160Engine, CLHEP::Hurd288Engine, CLHEP::HepJamesRandom, CLHEP::MixMaxRng, CLHEP::MTwistEngine, CLHEP::NonRandomEngine, CLHEP::RandEngine, CLHEP::RanecuEngine, CLHEP::Ranlux64Engine, CLHEP::RanluxEngine, CLHEP::RanshiEngine, CLHEP::TripleRand, and CLHEP::RanluxppEngine.

◆ put() [2/2]

virtual std::ostream & CLHEP::HepRandomEngine::put ( std::ostream &  os) const
virtual

Reimplemented in CLHEP::DRand48Engine, CLHEP::DualRand, CLHEP::Hurd160Engine, CLHEP::Hurd288Engine, CLHEP::HepJamesRandom, CLHEP::MixMaxRng, CLHEP::MTwistEngine, CLHEP::NonRandomEngine, CLHEP::RandEngine, CLHEP::RanecuEngine, CLHEP::Ranlux64Engine, CLHEP::RanluxEngine, CLHEP::RanshiEngine, CLHEP::TripleRand, and CLHEP::RanluxppEngine.

◆ restoreStatus()

virtual void CLHEP::HepRandomEngine::restoreStatus ( const char  filename[] = "Config.conf")
pure virtual

Implemented in CLHEP::DRand48Engine, CLHEP::DualRand, CLHEP::Hurd160Engine, CLHEP::Hurd288Engine, CLHEP::HepJamesRandom, CLHEP::MixMaxRng, CLHEP::MTwistEngine, CLHEP::RandEngine, CLHEP::RanecuEngine, CLHEP::RanluxEngine, CLHEP::Ranlux64Engine, CLHEP::RanluxppEngine, CLHEP::RanshiEngine, and CLHEP::TripleRand.

◆ saveStatus()

virtual void CLHEP::HepRandomEngine::saveStatus ( const char  filename[] = "Config.conf") const
pure virtual

Implemented in CLHEP::DRand48Engine, CLHEP::DualRand, CLHEP::Hurd160Engine, CLHEP::Hurd288Engine, CLHEP::HepJamesRandom, CLHEP::MixMaxRng, CLHEP::MTwistEngine, CLHEP::RandEngine, CLHEP::RanecuEngine, CLHEP::RanluxEngine, CLHEP::Ranlux64Engine, CLHEP::RanluxppEngine, CLHEP::RanshiEngine, and CLHEP::TripleRand.

◆ setSeed()

virtual void CLHEP::HepRandomEngine::setSeed ( long  seed,
int   
)
pure virtual

Implemented in CLHEP::RanecuEngine, CLHEP::MixMaxRng, CLHEP::DRand48Engine, CLHEP::HepJamesRandom, CLHEP::RandEngine, CLHEP::RanluxppEngine, CLHEP::Ranlux64Engine, CLHEP::RanluxEngine, CLHEP::DualRand, CLHEP::Hurd160Engine, CLHEP::Hurd288Engine, CLHEP::MTwistEngine, CLHEP::RanshiEngine, and CLHEP::TripleRand.

◆ setSeeds()

virtual void CLHEP::HepRandomEngine::setSeeds ( const long *  seeds,
int   
)
pure virtual

Implemented in CLHEP::DRand48Engine, CLHEP::HepJamesRandom, CLHEP::RandEngine, CLHEP::RanluxppEngine, CLHEP::RanecuEngine, CLHEP::Ranlux64Engine, CLHEP::RanluxEngine, CLHEP::MixMaxRng, CLHEP::DualRand, CLHEP::Hurd160Engine, CLHEP::Hurd288Engine, CLHEP::MTwistEngine, CLHEP::RanshiEngine, and CLHEP::TripleRand.

◆ showStatus()

virtual void CLHEP::HepRandomEngine::showStatus ( ) const
pure virtual

Implemented in CLHEP::DRand48Engine, CLHEP::DualRand, CLHEP::Hurd160Engine, CLHEP::Hurd288Engine, CLHEP::HepJamesRandom, CLHEP::MixMaxRng, CLHEP::MTwistEngine, CLHEP::RandEngine, CLHEP::RanecuEngine, CLHEP::Ranlux64Engine, CLHEP::RanluxEngine, CLHEP::RanshiEngine, CLHEP::TripleRand, and CLHEP::RanluxppEngine.

◆ twoToMinus_32()

double CLHEP::HepRandomEngine::twoToMinus_32 ( )
inlinestaticprotected

Definition at line 44 of file RandomEngine.icc.

References twoToMinus_32().

Referenced by twoToMinus_32().

◆ twoToMinus_48()

double CLHEP::HepRandomEngine::twoToMinus_48 ( )
inlinestaticprotected

Definition at line 49 of file RandomEngine.icc.

References twoToMinus_48().

Referenced by twoToMinus_48().

◆ twoToMinus_49()

double CLHEP::HepRandomEngine::twoToMinus_49 ( )
inlinestaticprotected

Definition at line 54 of file RandomEngine.icc.

References twoToMinus_49().

Referenced by twoToMinus_49().

◆ twoToMinus_53()

double CLHEP::HepRandomEngine::twoToMinus_53 ( )
inlinestaticprotected

Definition at line 59 of file RandomEngine.icc.

References twoToMinus_53().

Referenced by twoToMinus_53().

Member Data Documentation

◆ theSeed

long CLHEP::HepRandomEngine::theSeed
protected

Definition at line 144 of file RandomEngine.h.

Referenced by getSeed().

◆ theSeeds

const long* CLHEP::HepRandomEngine::theSeeds
protected

Definition at line 145 of file RandomEngine.h.

Referenced by getSeeds().

The documentation for this class was generated from the following files:
Generated by doxygen 1.9.8