CLHEP 2.4.6.4
C++ Class Library for High Energy Physics
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 lxr=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 50 of file Random.h.

Constructor & Destructor Documentation

◆ HepRandom() [1/4]

CLHEP::HepRandom::HepRandom ( )

Definition at line 180 of file Random.cc.

181{ }

◆ HepRandom() [2/4]

CLHEP::HepRandom::HepRandom ( long  seed)

Definition at line 183 of file Random.cc.

184{
185 setTheSeed(seed);
186}
CLHEP::HepRandom::setTheSeed
static void setTheSeed(long seed, int lxr=3)
Definition: Random.cc:236

◆ HepRandom() [3/4]

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

Definition at line 188 of file Random.cc.

189{
190 theDefaults().resetEngine( algorithm );
191}

◆ HepRandom() [4/4]

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

Definition at line 193 of file Random.cc.

194{
195 theDefaults().resetEngine( algorithm );
196}

◆ ~HepRandom()

CLHEP::HepRandom::~HepRandom ( )
virtual

Definition at line 198 of file Random.cc.

199{ }

Member Function Documentation

◆ createInstance()

int CLHEP::HepRandom::createInstance ( )
static

Definition at line 313 of file Random.cc.

314{
315 return static_cast<int>( theDefaults().ensureInitialized() );
316}

◆ distributionName()

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

Definition at line 153 of file Random.h.

153{return "HepRandomEngine";}

◆ engine()

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

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

Definition at line 216 of file Random.cc.

216 {
217 std::cerr << "HepRandom::engine() called -- there is no assigned engine!\n";
218 return *theDefaults().theEngine.get();
219}

◆ flat() [1/2]

double CLHEP::HepRandom::flat ( )

Definition at line 201 of file Random.cc.

202{
203 return theDefaults().theEngine->flat();
204}

Referenced by 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 206 of file Random.cc.

207{
208 theDefaults().theEngine->flatArray(size,vect);
209}

◆ 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::RandExpZiggurat, CLHEP::RandFlat, CLHEP::RandGamma, CLHEP::RandGauss, CLHEP::RandGaussQ, CLHEP::RandGaussT, CLHEP::RandGaussZiggurat, CLHEP::RandGeneral, CLHEP::RandLandau, CLHEP::RandPoisson, CLHEP::RandPoissonQ, CLHEP::RandPoissonT, CLHEP::RandSkewNormal, and CLHEP::RandStudentT.

Definition at line 230 of file Random.cc.

230{return is;}

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

◆ getTheEngine()

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

Definition at line 270 of file Random.cc.

271{
272 return theDefaults().theEngine.get();
273}

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

◆ getTheGenerator()

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

Definition at line 265 of file Random.cc.

266{
267 return theDefaults().theGenerator.get();
268}

Referenced by main().

◆ getTheSeed()

long CLHEP::HepRandom::getTheSeed ( )
static

Definition at line 241 of file Random.cc.

242{
243 return theDefaults().theEngine->getSeed();
244}

◆ getTheSeeds()

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

Definition at line 251 of file Random.cc.

252{
253 return theDefaults().theEngine->getSeeds();
254}

◆ getTheTableSeeds()

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

Definition at line 256 of file Random.cc.

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

Referenced by CLHEP::DRand48Engine::DRand48Engine(), CLHEP::HepJamesRandom::HepJamesRandom(), CLHEP::Hurd160Engine::Hurd160Engine(), CLHEP::Hurd288Engine::Hurd288Engine(), CLHEP::MTwistEngine::MTwistEngine(), CLHEP::RandEngine::RandEngine(), 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::RandExpZiggurat, CLHEP::RandFlat, CLHEP::RandGamma, CLHEP::RandGauss, CLHEP::RandGaussQ, CLHEP::RandGaussT, CLHEP::RandGaussZiggurat, CLHEP::RandGeneral, CLHEP::RandLandau, CLHEP::RandPoisson, CLHEP::RandPoissonQ, CLHEP::RandPoissonT, CLHEP::RandSkewNormal, and CLHEP::RandStudentT.

Definition at line 215 of file Random.cc.

215{return "HepRandom";}

◆ operator()()

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

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

Definition at line 211 of file Random.cc.

211 {
212 return flat();
213}
CLHEP::HepRandom::flat
double flat()
Definition: Random.cc:201

◆ put()

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

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

Definition at line 229 of file Random.cc.

229{return os;}

Referenced by CLHEP::operator<<().

◆ restoreDistState()

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

Definition at line 138 of file Random.h.

138{return is;}

◆ restoreEngineStatus()

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

Definition at line 285 of file Random.cc.

286{
287 theDefaults().theEngine->restoreStatus( filename );
288}

Referenced by BrestoreStepX(), and restoreStepX().

◆ restoreFullState()

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

Definition at line 295 of file Random.cc.

295 {
296 is >> *getTheEngine();
297 return is;
298}
CLHEP::HepRandom::getTheEngine
static HepRandomEngine * getTheEngine()
Definition: Random.cc:270

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

◆ restoreStaticRandomStates()

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

Definition at line 304 of file Random.cc.

304 {
305 return StaticRandomStates::restore(is);
306}
CLHEP::StaticRandomStates::restore
static std::istream & restore(std::istream &is)
Definition: StaticRandomStates.cc:52

◆ saveDistState()

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

Definition at line 135 of file Random.h.

135{return os;}

◆ saveEngineStatus()

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

Definition at line 280 of file Random.cc.

281{
282 theDefaults().theEngine->saveStatus( filename );
283}

Referenced by BsaveStepX(), and saveStepX().

◆ saveFullState()

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

Definition at line 290 of file Random.cc.

290 {
291 os << *getTheEngine();
292 return os;
293}

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

◆ saveStaticRandomStates()

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

Definition at line 300 of file Random.cc.

300 {
301 return StaticRandomStates::save(os);
302}
CLHEP::StaticRandomStates::save
static std::ostream & save(std::ostream &os)
Definition: StaticRandomStates.cc:38

◆ setTheEngine()

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

Definition at line 275 of file Random.cc.

276{
277 theDefaults().theEngine.reset( theNewEngine, do_nothing_deleter() );
278}

Referenced by anonymousRestoreStatics(), anonymousRestoreStatics1(), main(), CLHEP::StaticRandomStates::restore(), start_test(), and testRandGauss().

◆ setTheSeed()

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

Definition at line 236 of file Random.cc.

237{
238 theDefaults().theEngine->setSeed(seed,lux);
239}

Referenced by diagmatrix_test(), main(), matrix_test(), symmatrix_test(), useSeed(), and vector_test().

◆ setTheSeeds()

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

Definition at line 246 of file Random.cc.

247{
248 theDefaults().theEngine->setSeeds(seeds,aux);
249}

◆ showEngineStatus()

void CLHEP::HepRandom::showEngineStatus ( )
static

Definition at line 308 of file Random.cc.

309{
310 theDefaults().theEngine->showStatus();
311}

Member Data Documentation

◆ seedTable

const long CLHEP::HepRandom::seedTable
staticprotected

Definition at line 158 of file Random.h.

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