Geant4 9.6.0
Toolkit for the simulation of the passage of particles through matter
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Static Protected Attributes | List of all members
CLHEP::HepRandom Class Reference

#include <Random.h>

+ Inheritance diagram for CLHEP::HepRandom:

Public Member Functions

 HepRandom ()
 
 HepRandom (long seed)
 
 HepRandom (HepRandomEngine &algorithm)
 
 HepRandom (HepRandomEngine *algorithm)
 
virtual ~HepRandom ()
 
double flat ()
 
void flatArray (const int size, double *vect)
 
double flat (HepRandomEngine *theNewEngine)
 
void flatArray (HepRandomEngine *theNewEngine, const int size, double *vect)
 
virtual double operator() ()
 
virtual std::string name () const
 
virtual HepRandomEngine & engine ()
 
virtual std::ostream & put (std::ostream &os) const
 
virtual std::istream & get (std::istream &is)
 

Static Public Member Functions

static void setTheSeed (long seed, int lux=3)
 
static long getTheSeed ()
 
static void setTheSeeds (const long *seeds, int aux=-1)
 
static const long * getTheSeeds ()
 
static void getTheTableSeeds (long *seeds, int index)
 
static HepRandom * getTheGenerator ()
 
static void setTheEngine (HepRandomEngine *theNewEngine)
 
static HepRandomEngine * getTheEngine ()
 
static void saveEngineStatus (const char filename[]="Config.conf")
 
static void restoreEngineStatus (const char filename[]="Config.conf")
 
static std::ostream & saveFullState (std::ostream &os)
 
static std::istream & restoreFullState (std::istream &is)
 
static std::ostream & saveDistState (std::ostream &os)
 
static std::istream & restoreDistState (std::istream &is)
 
static std::ostream & saveStaticRandomStates (std::ostream &os)
 
static std::istream & restoreStaticRandomStates (std::istream &is)
 
static void showEngineStatus ()
 
static int createInstance ()
 
static std::string distributionName ()
 

Static Protected Attributes

static const long seedTable [215][2]
 

Detailed Description

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

Definition at line 49 of file Random.h.

Constructor & Destructor Documentation

◆ HepRandom() [1/4]

CLHEP::HepRandom::HepRandom ( )

Definition at line 75 of file Random.cc.

76{ }

◆ HepRandom() [2/4]

CLHEP::HepRandom::HepRandom ( long  seed)

Definition at line 78 of file Random.cc.

79{
80 setTheSeed(seed);
81}
CLHEP::HepRandom::setTheSeed
static void setTheSeed(long seed, int lux=3)
Definition: Random.cc:131

◆ HepRandom() [3/4]

CLHEP::HepRandom::HepRandom ( HepRandomEngine &  algorithm)

Definition at line 83 of file Random.cc.

84{
85 theDefaults().resetEngine( algorithm );
86}

◆ HepRandom() [4/4]

CLHEP::HepRandom::HepRandom ( HepRandomEngine *  algorithm)

Definition at line 88 of file Random.cc.

89{
90 theDefaults().resetEngine( algorithm );
91}

◆ ~HepRandom()

CLHEP::HepRandom::~HepRandom ( )
virtual

Definition at line 93 of file Random.cc.

94{ }

Member Function Documentation

◆ createInstance()

int CLHEP::HepRandom::createInstance ( )
static

Definition at line 208 of file Random.cc.

209{
210 return static_cast<int>( theDefaults().ensureInitialized() );
211}

◆ distributionName()

static std::string CLHEP::HepRandom::distributionName ( )
inlinestatic

Definition at line 152 of file Random.h.

152{return "HepRandomEngine";}

◆ engine()

HepRandomEngine & CLHEP::HepRandom::engine ( )
virtual

Reimplemented in CLHEP::RandBinomial, CLHEP::RandBreitWigner, CLHEP::RandChiSquare, CLHEP::RandExponential, CLHEP::RandFlat, CLHEP::RandGamma, CLHEP::RandGauss, CLHEP::RandGaussQ, CLHEP::RandGeneral, CLHEP::RandLandau, CLHEP::RandPoisson, CLHEP::RandPoissonQ, and CLHEP::RandStudentT.

Definition at line 111 of file Random.cc.

111 {
112 std::cerr << "HepRandom::engine() called -- there is no assigned engine!\n";
113 return *theDefaults().theEngine.get();
114}

◆ flat() [1/2]

double CLHEP::HepRandom::flat ( )

Definition at line 96 of file Random.cc.

97{
98 return theDefaults().theEngine->flat();
99}

Referenced by operator()(), and CLHEP::RandExponential::shoot().

◆ flat() [2/2]

double CLHEP::HepRandom::flat ( HepRandomEngine *  theNewEngine)
inline

◆ flatArray() [1/2]

void CLHEP::HepRandom::flatArray ( const int  size,
double *  vect 
)

Definition at line 101 of file Random.cc.

102{
103 theDefaults().theEngine->flatArray(size,vect);
104}

◆ flatArray() [2/2]

void CLHEP::HepRandom::flatArray ( HepRandomEngine *  theNewEngine,
const int  size,
double *  vect 
)
inline

◆ get()

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

Reimplemented in CLHEP::RandBinomial, CLHEP::RandBit, CLHEP::RandBreitWigner, CLHEP::RandChiSquare, CLHEP::RandExponential, CLHEP::RandFlat, CLHEP::RandGamma, CLHEP::RandGauss, CLHEP::RandGaussQ, CLHEP::RandGeneral, CLHEP::RandLandau, CLHEP::RandPoisson, CLHEP::RandPoissonQ, and CLHEP::RandStudentT.

Definition at line 125 of file Random.cc.

125{return is;}

Referenced by getTheGenerator(), and CLHEP::operator>>().

◆ getTheEngine()

HepRandomEngine * CLHEP::HepRandom::getTheEngine ( )
static

Definition at line 165 of file Random.cc.

166{
167 return theDefaults().theEngine.get();
168}

Referenced by CLHEP::StaticRandomStates::restore(), CLHEP::RandFlat::restoreEngineStatus(), CLHEP::RandGauss::restoreEngineStatus(), restoreFullState(), CLHEP::RandFlat::saveEngineStatus(), CLHEP::RandGauss::saveEngineStatus(), saveFullState(), CLHEP::RandExponential::shoot(), CLHEP::RandFlat::shoot(), CLHEP::RandGauss::shoot(), CLHEP::RandChiSquare::shoot(), CLHEP::RandStudentT::shoot(), CLHEP::RandBreitWigner::shoot(), CLHEP::RandGamma::shoot(), CLHEP::RandPoisson::shoot(), CLHEP::RandPoissonQ::shoot(), CLHEP::RandBinomial::shoot(), CLHEP::RandFlat::shootArray(), and tpia_misc_drng().

◆ getTheGenerator()

HepRandom * CLHEP::HepRandom::getTheGenerator ( )
static

Definition at line 160 of file Random.cc.

161{
162 return theDefaults().theGenerator.get();
163}

◆ getTheSeed()

long CLHEP::HepRandom::getTheSeed ( )
static

Definition at line 136 of file Random.cc.

137{
138 return theDefaults().theEngine->getSeed();
139}

◆ getTheSeeds()

const long * CLHEP::HepRandom::getTheSeeds ( )
static

Definition at line 146 of file Random.cc.

147{
148 return theDefaults().theEngine->getSeeds();
149}

◆ getTheTableSeeds()

void CLHEP::HepRandom::getTheTableSeeds ( long *  seeds,
int  index 
)
static

Definition at line 151 of file Random.cc.

152{
153 if ((index >= 0) && (index < 215)) {
154 seeds[0] = seedTable[index][0];
155 seeds[1] = seedTable[index][1];
156 }
157 else seeds = NULL;
158}
CLHEP::HepRandom::seedTable
static const long seedTable[215][2]
Definition: Random.h:157

Referenced by CLHEP::HepJamesRandom::HepJamesRandom(), CLHEP::MTwistEngine::MTwistEngine(), CLHEP::RanecuEngine::RanecuEngine(), CLHEP::Ranlux64Engine::Ranlux64Engine(), CLHEP::RanluxEngine::RanluxEngine(), and CLHEP::RanecuEngine::setSeed().

◆ name()

std::string CLHEP::HepRandom::name ( ) const
virtual

Reimplemented in CLHEP::RandBinomial, CLHEP::RandBit, CLHEP::RandBreitWigner, CLHEP::RandChiSquare, CLHEP::RandExponential, CLHEP::RandFlat, CLHEP::RandGamma, CLHEP::RandGauss, CLHEP::RandGaussQ, CLHEP::RandGeneral, CLHEP::RandLandau, CLHEP::RandPoisson, CLHEP::RandPoissonQ, and CLHEP::RandStudentT.

Definition at line 110 of file Random.cc.

110{return "HepRandom";}

◆ operator()()

double CLHEP::HepRandom::operator() ( )
virtual

Reimplemented in CLHEP::RandBinomial, CLHEP::RandBreitWigner, CLHEP::RandChiSquare, CLHEP::RandExponential, CLHEP::RandFlat, CLHEP::RandGamma, CLHEP::RandGauss, CLHEP::RandGaussQ, CLHEP::RandGeneral, CLHEP::RandLandau, CLHEP::RandPoisson, CLHEP::RandPoissonQ, and CLHEP::RandStudentT.

Definition at line 106 of file Random.cc.

106 {
107 return flat();
108}
CLHEP::HepRandom::flat
double flat()
Definition: Random.cc:96

◆ put()

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

Reimplemented in CLHEP::RandBinomial, CLHEP::RandBit, CLHEP::RandBreitWigner, CLHEP::RandChiSquare, CLHEP::RandExponential, CLHEP::RandFlat, CLHEP::RandGamma, CLHEP::RandGauss, CLHEP::RandGaussQ, CLHEP::RandGeneral, CLHEP::RandLandau, CLHEP::RandPoisson, CLHEP::RandPoissonQ, and CLHEP::RandStudentT.

Definition at line 124 of file Random.cc.

124{return os;}

Referenced by CLHEP::operator<<().

◆ restoreDistState()

static std::istream & CLHEP::HepRandom::restoreDistState ( std::istream &  is)
inlinestatic

Definition at line 137 of file Random.h.

137{return is;}

◆ restoreEngineStatus()

void CLHEP::HepRandom::restoreEngineStatus ( const char  filename[] = "Config.conf")
static

Definition at line 180 of file Random.cc.

181{
182 theDefaults().theEngine->restoreStatus( filename );
183}

Referenced by G4RunManager::RestoreRandomNumberStatus().

◆ restoreFullState()

std::istream & CLHEP::HepRandom::restoreFullState ( std::istream &  is)
static

Definition at line 190 of file Random.cc.

190 {
191 is >> *getTheEngine();
192 return is;
193}
CLHEP::HepRandom::getTheEngine
static HepRandomEngine * getTheEngine()
Definition: Random.cc:165

Referenced by CLHEP::RandFlat::restoreFullState(), and CLHEP::RandGauss::restoreFullState().

◆ restoreStaticRandomStates()

std::istream & CLHEP::HepRandom::restoreStaticRandomStates ( std::istream &  is)
static

Definition at line 199 of file Random.cc.

199 {
200 return StaticRandomStates::restore(is);
201}
CLHEP::StaticRandomStates::restore
static std::istream & restore(std::istream &is)
Definition: StaticRandomStates.cc:51

◆ saveDistState()

static std::ostream & CLHEP::HepRandom::saveDistState ( std::ostream &  os)
inlinestatic

Definition at line 134 of file Random.h.

134{return os;}

◆ saveEngineStatus()

void CLHEP::HepRandom::saveEngineStatus ( const char  filename[] = "Config.conf")
static

Definition at line 175 of file Random.cc.

176{
177 theDefaults().theEngine->saveStatus( filename );
178}

Referenced by G4CascadeInterface::ApplyYourself(), G4RunManager::GenerateEvent(), G4HadronicProcess::PostStepDoIt(), G4CascadeInterface::Propagate(), and G4RunManager::RunInitialization().

◆ saveFullState()

std::ostream & CLHEP::HepRandom::saveFullState ( std::ostream &  os)
static

Definition at line 185 of file Random.cc.

185 {
186 os << *getTheEngine();
187 return os;
188}

Referenced by G4RunManager::G4RunManager(), G4RunManager::GenerateEvent(), G4EventManager::ProcessOneEvent(), G4RunManager::RunInitialization(), CLHEP::RandFlat::saveFullState(), and CLHEP::RandGauss::saveFullState().

◆ saveStaticRandomStates()

std::ostream & CLHEP::HepRandom::saveStaticRandomStates ( std::ostream &  os)
static

Definition at line 195 of file Random.cc.

195 {
196 return StaticRandomStates::save(os);
197}
CLHEP::StaticRandomStates::save
static std::ostream & save(std::ostream &os)
Definition: StaticRandomStates.cc:37

◆ setTheEngine()

void CLHEP::HepRandom::setTheEngine ( HepRandomEngine *  theNewEngine)
static

Definition at line 170 of file Random.cc.

171{
172 theDefaults().theEngine.reset( theNewEngine, do_nothing_deleter() );
173}

Referenced by CLHEP::StaticRandomStates::restore().

◆ setTheSeed()

void CLHEP::HepRandom::setTheSeed ( long  seed,
int  lux = 3 
)
static

Definition at line 131 of file Random.cc.

132{
133 theDefaults().theEngine->setSeed(seed,lux);
134}

Referenced by HepRandom().

◆ setTheSeeds()

void CLHEP::HepRandom::setTheSeeds ( const long *  seeds,
int  aux = -1 
)
static

Definition at line 141 of file Random.cc.

142{
143 theDefaults().theEngine->setSeeds(seeds,aux);
144}

Referenced by G4RunMessenger::SetNewValue().

◆ showEngineStatus()

void CLHEP::HepRandom::showEngineStatus ( )
static

Definition at line 203 of file Random.cc.

204{
205 theDefaults().theEngine->showStatus();
206}

Referenced by G4RunManager::RestoreRandomNumberStatus().

Member Data Documentation

◆ seedTable

const long CLHEP::HepRandom::seedTable
staticprotected

Definition at line 157 of file Random.h.

Referenced by getTheTableSeeds().

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