Geant4-11
Public Member Functions | Static Public Member Functions | Static Protected Attributes | Private Attributes
CLHEP::RandExponential Class Reference

#include <RandExponential.h>

Inheritance diagram for CLHEP::RandExponential:
CLHEP::HepRandom

Public Member Functions

HepRandomEngine & engine ()
 
double fire ()
 
double fire (double mean)
 
void fireArray (const int size, double *vect)
 
void fireArray (const int size, double *vect, double mean)
 
double flat ()
 
double flat (HepRandomEngine *theNewEngine)
 
void flatArray (const int size, double *vect)
 
void flatArray (HepRandomEngine *theNewEngine, const int size, double *vect)
 
std::istream & get (std::istream &is)
 
std::string name () const
 
double operator() ()
 
double operator() (double mean)
 
std::ostream & put (std::ostream &os) const
 
 RandExponential (HepRandomEngine &anEngine, double mean=1.0)
 
 RandExponential (HepRandomEngine *anEngine, double mean=1.0)
 
virtual ~RandExponential ()
 

Static Public Member Functions

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

Static Protected Attributes

static const long seedTable [215][2]
 

Private Attributes

double defaultMean
 
std::shared_ptr< HepRandomEngine > localEngine
 

Detailed Description

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

Definition at line 34 of file RandExponential.h.

Constructor & Destructor Documentation

◆ RandExponential() [1/2]

CLHEP::RandExponential::RandExponential ( HepRandomEngine &  anEngine,
double  mean = 1.0 
)
inline

◆ RandExponential() [2/2]

CLHEP::RandExponential::RandExponential ( HepRandomEngine *  anEngine,
double  mean = 1.0 
)
inline

◆ ~RandExponential()

CLHEP::RandExponential::~RandExponential ( )
virtual

Definition at line 33 of file RandExponential.cc.

33 {
34}

Member Function Documentation

◆ createInstance()

int CLHEP::HepRandom::createInstance ( )
staticinherited

Definition at line 311 of file Random.cc.

312{
313 return static_cast<int>( theDefaults().ensureInitialized() );
314}
CLHEP::anonymous_namespace{Random.cc}::theDefaults
defaults & theDefaults()
Definition: Random.cc:167
CLHEP::anonymous_namespace{Random.cc}::defaults::ensureInitialized
bool ensureInitialized()
Definition: Random.cc:60

References CLHEP::anonymous_namespace{Random.cc}::defaults::ensureInitialized(), and CLHEP::anonymous_namespace{Random.cc}::theDefaults().

◆ distributionName()

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

Definition at line 92 of file RandExponential.h.

92{return "RandExponential";}

◆ engine()

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

Reimplemented from CLHEP::HepRandom.

Definition at line 31 of file RandExponential.cc.

31{return *localEngine;}
CLHEP::RandExponential::localEngine
std::shared_ptr< HepRandomEngine > localEngine
Definition: RandExponential.h:97

References localEngine.

◆ fire() [1/2]

double CLHEP::RandExponential::fire ( )
inline

Referenced by fireArray(), and operator()().

◆ fire() [2/2]

double CLHEP::RandExponential::fire ( double  mean)
inline

◆ fireArray() [1/2]

void CLHEP::RandExponential::fireArray ( const int  size,
double *  vect 
)

Definition at line 66 of file RandExponential.cc.

67{
68 for( double* v = vect; v != vect+size; ++v )
69 *v = fire( defaultMean );
70}

References defaultMean, and fire().

◆ fireArray() [2/2]

void CLHEP::RandExponential::fireArray ( const int  size,
double *  vect,
double  mean 
)

Definition at line 72 of file RandExponential.cc.

74{
75 for( double* v = vect; v != vect+size; ++v )
76 *v = fire( mean );
77}

References fire().

◆ flat() [1/2]

double CLHEP::HepRandom::flat ( )
inherited

Definition at line 199 of file Random.cc.

200{
201 return theDefaults().theEngine->flat();
202}
CLHEP::anonymous_namespace{Random.cc}::defaults::theEngine
std::shared_ptr< HepRandomEngine > theEngine
Definition: Random.cc:76

References CLHEP::anonymous_namespace{Random.cc}::theDefaults(), and CLHEP::anonymous_namespace{Random.cc}::defaults::theEngine.

Referenced by shoot().

◆ flat() [2/2]

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

◆ flatArray() [1/2]

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

Definition at line 204 of file Random.cc.

205{
206 theDefaults().theEngine->flatArray(size,vect);
207}

References CLHEP::anonymous_namespace{Random.cc}::theDefaults(), and CLHEP::anonymous_namespace{Random.cc}::defaults::theEngine.

◆ flatArray() [2/2]

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

◆ get()

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

Reimplemented from CLHEP::HepRandom.

Definition at line 90 of file RandExponential.cc.

90 {
91 std::string inName;
92 is >> inName;
93 if (inName != name()) {
94 is.clear(std::ios::badbit | is.rdstate());
95 std::cerr << "Mismatch when expecting to read state of a "
96 << name() << " distribution\n"
97 << "Name found was " << inName
98 << "\nistream is left in the badbit state\n";
99 return is;
100 }
101 if (possibleKeywordInput(is, "Uvec", defaultMean)) {
102 std::vector<unsigned long> t(2);
103 is >> defaultMean >> t[0] >> t[1]; defaultMean = DoubConv::longs2double(t);
104 return is;
105 }
106 // is >> defaultMean encompassed by possibleKeywordInput
107 return is;
108}
CLHEP::DoubConv::longs2double
static double longs2double(const std::vector< unsigned long > &v)
Definition: DoubConv.cc:110
CLHEP::RandExponential::name
std::string name() const
Definition: RandExponential.cc:30
CLHEP::possibleKeywordInput
bool possibleKeywordInput(IS &is, const std::string &key, T &t)
Definition: RandomEngine.h:166

References defaultMean, CLHEP::DoubConv::longs2double(), name(), and CLHEP::possibleKeywordInput().

◆ getTheEngine()

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

Definition at line 268 of file Random.cc.

269{
270 return theDefaults().theEngine.get();
271}

References CLHEP::anonymous_namespace{Random.cc}::theDefaults(), and CLHEP::anonymous_namespace{Random.cc}::defaults::theEngine.

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

◆ getTheGenerator()

HepRandom * CLHEP::HepRandom::getTheGenerator ( )
staticinherited

Definition at line 263 of file Random.cc.

264{
265 return theDefaults().theGenerator.get();
266}
CLHEP::anonymous_namespace{Random.cc}::defaults::theGenerator
std::shared_ptr< HepRandom > theGenerator
Definition: Random.cc:75

References CLHEP::anonymous_namespace{Random.cc}::theDefaults(), and CLHEP::anonymous_namespace{Random.cc}::defaults::theGenerator.

◆ getTheSeed()

long CLHEP::HepRandom::getTheSeed ( )
staticinherited

Definition at line 239 of file Random.cc.

240{
241 return theDefaults().theEngine->getSeed();
242}

References CLHEP::anonymous_namespace{Random.cc}::theDefaults(), and CLHEP::anonymous_namespace{Random.cc}::defaults::theEngine.

◆ getTheSeeds()

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

Definition at line 249 of file Random.cc.

250{
251 return theDefaults().theEngine->getSeeds();
252}

References CLHEP::anonymous_namespace{Random.cc}::theDefaults(), and CLHEP::anonymous_namespace{Random.cc}::defaults::theEngine.

◆ getTheTableSeeds()

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

Definition at line 254 of file Random.cc.

255{
256 if ((index >= 0) && (index < 215)) {
257 seeds[0] = seedTable[index][0];
258 seeds[1] = seedTable[index][1];
259 }
260 else seeds = NULL;
261}
CLHEP::HepRandom::seedTable
static const long seedTable[215][2]
Definition: Random.h:156

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::RandExponential::name ( ) const
virtual

Reimplemented from CLHEP::HepRandom.

Definition at line 30 of file RandExponential.cc.

30{return "RandExponential";}

Referenced by source.g4viscp.G4Scene::create_scene(), get(), mcscore.MCParticle::printout(), put(), and source.g4viscp.G4Scene::update_scene().

◆ operator()() [1/2]

double CLHEP::RandExponential::operator() ( )
virtual

Reimplemented from CLHEP::HepRandom.

Definition at line 36 of file RandExponential.cc.

36 {
37 return fire( defaultMean );
38}

References defaultMean, and fire().

◆ operator()() [2/2]

double CLHEP::RandExponential::operator() ( double  mean)

Definition at line 40 of file RandExponential.cc.

40 {
41 return fire( mean );
42}

References fire().

◆ put()

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

Reimplemented from CLHEP::HepRandom.

Definition at line 79 of file RandExponential.cc.

79 {
80 int pr=os.precision(20);
81 std::vector<unsigned long> t(2);
82 os << " " << name() << "\n";
83 os << "Uvec" << "\n";
84 t = DoubConv::dto2longs(defaultMean);
85 os << defaultMean << " " << t[0] << " " << t[1] << "\n";
86 os.precision(pr);
87 return os;
88}
CLHEP::DoubConv::dto2longs
static std::vector< unsigned long > dto2longs(double d)
Definition: DoubConv.cc:94

References defaultMean, CLHEP::DoubConv::dto2longs(), and name().

◆ restoreDistState()

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

Definition at line 136 of file Random.h.

136{return is;}

◆ restoreEngineStatus()

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

Definition at line 283 of file Random.cc.

284{
285 theDefaults().theEngine->restoreStatus( filename );
286}

References CLHEP::anonymous_namespace{Random.cc}::theDefaults(), and CLHEP::anonymous_namespace{Random.cc}::defaults::theEngine.

◆ restoreFullState()

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

Definition at line 293 of file Random.cc.

293 {
294 is >> *getTheEngine();
295 return is;
296}
CLHEP::HepRandom::getTheEngine
static HepRandomEngine * getTheEngine()
Definition: Random.cc:268

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

◆ restoreStaticRandomStates()

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

Definition at line 302 of file Random.cc.

302 {
303 return StaticRandomStates::restore(is);
304}
CLHEP::StaticRandomStates::restore
static std::istream & restore(std::istream &is)
Definition: StaticRandomStates.cc:51

References CLHEP::StaticRandomStates::restore().

◆ saveDistState()

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

Definition at line 133 of file Random.h.

133{return os;}

◆ saveEngineStatus()

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

Definition at line 278 of file Random.cc.

279{
280 theDefaults().theEngine->saveStatus( filename );
281}

References CLHEP::anonymous_namespace{Random.cc}::theDefaults(), and CLHEP::anonymous_namespace{Random.cc}::defaults::theEngine.

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

◆ saveFullState()

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

Definition at line 288 of file Random.cc.

288 {
289 os << *getTheEngine();
290 return os;
291}

Referenced by G4EventManager::DoProcessing(), G4EventManager::ProcessOneEvent(), CLHEP::RandFlat::saveFullState(), and CLHEP::RandGauss::saveFullState().

◆ saveStaticRandomStates()

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

Definition at line 298 of file Random.cc.

298 {
299 return StaticRandomStates::save(os);
300}
CLHEP::StaticRandomStates::save
static std::ostream & save(std::ostream &os)
Definition: StaticRandomStates.cc:37

References CLHEP::StaticRandomStates::save().

◆ setTheEngine()

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

Definition at line 273 of file Random.cc.

274{
275 theDefaults().theEngine.reset( theNewEngine, do_nothing_deleter() );
276}

References CLHEP::anonymous_namespace{Random.cc}::theDefaults(), and CLHEP::anonymous_namespace{Random.cc}::defaults::theEngine.

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

◆ setTheSeed()

void CLHEP::HepRandom::setTheSeed ( long  seed,
int  lxr = 3 
)
staticinherited

Definition at line 234 of file Random.cc.

235{
236 theDefaults().theEngine->setSeed(seed,lux);
237}
CLHEP::lux
static constexpr double lux
Definition: SystemOfUnits.h:314

References CLHEP::lux, CLHEP::anonymous_namespace{Random.cc}::theDefaults(), and CLHEP::anonymous_namespace{Random.cc}::defaults::theEngine.

◆ setTheSeeds()

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

Definition at line 244 of file Random.cc.

245{
246 theDefaults().theEngine->setSeeds(seeds,aux);
247}

References CLHEP::anonymous_namespace{Random.cc}::theDefaults(), and CLHEP::anonymous_namespace{Random.cc}::defaults::theEngine.

◆ shoot() [1/4]

double CLHEP::RandExponential::shoot ( )
static

Definition at line 44 of file RandExponential.cc.

44 {
45 return -std::log(HepRandom::getTheEngine()->flat());
46}
CLHEP::HepRandom::flat
double flat()
Definition: Random.cc:199

References CLHEP::HepRandom::flat(), and CLHEP::HepRandom::getTheEngine().

Referenced by shootArray().

◆ shoot() [2/4]

double CLHEP::RandExponential::shoot ( double  mean)
static

Definition at line 48 of file RandExponential.cc.

48 {
49 return -std::log(HepRandom::getTheEngine()->flat())*mean;
50}

References CLHEP::HepRandom::flat(), and CLHEP::HepRandom::getTheEngine().

◆ shoot() [3/4]

static double CLHEP::RandExponential::shoot ( HepRandomEngine *  anEngine)
inlinestatic

◆ shoot() [4/4]

static double CLHEP::RandExponential::shoot ( HepRandomEngine *  anEngine,
double  mean 
)
inlinestatic

◆ shootArray() [1/2]

void CLHEP::RandExponential::shootArray ( const int  size,
double *  vect,
double  mean = 1.0 
)
static

Definition at line 52 of file RandExponential.cc.

54{
55 for( double* v = vect; v != vect+size; ++v )
56 *v = shoot(mean);
57}

References shoot().

◆ shootArray() [2/2]

void CLHEP::RandExponential::shootArray ( HepRandomEngine *  anEngine,
const int  size,
double *  vect,
double  mean = 1.0 
)
static

Definition at line 59 of file RandExponential.cc.

61{
62 for( double* v = vect; v != vect+size; ++v )
63 *v = shoot(anEngine, mean);
64}

References shoot().

◆ showEngineStatus()

void CLHEP::HepRandom::showEngineStatus ( )
staticinherited

Definition at line 306 of file Random.cc.

307{
308 theDefaults().theEngine->showStatus();
309}

References CLHEP::anonymous_namespace{Random.cc}::theDefaults(), and CLHEP::anonymous_namespace{Random.cc}::defaults::theEngine.

Field Documentation

◆ defaultMean

double CLHEP::RandExponential::defaultMean
private

Definition at line 98 of file RandExponential.h.

Referenced by fireArray(), get(), operator()(), and put().

◆ localEngine

std::shared_ptr<HepRandomEngine> CLHEP::RandExponential::localEngine
private

Definition at line 97 of file RandExponential.h.

Referenced by engine().

◆ seedTable

const long CLHEP::HepRandom::seedTable
staticprotectedinherited

Definition at line 156 of file Random.h.

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