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

CLHEP::HepRandom::HepRandom

(

)

Definition at line 75 of file Random.cc.

{ }

CLHEP::HepRandom::HepRandom

(

long

seed

)

Definition at line 78 of file Random.cc.

References setTheSeed().

{
  setTheSeed(seed);
}

CLHEP::HepRandom::HepRandom

(

HepRandomEngine &

algorithm

)

Definition at line 83 of file Random.cc.

{
  theDefaults().resetEngine( algorithm );
}

CLHEP::HepRandom::HepRandom

(

HepRandomEngine *

algorithm

)

Definition at line 88 of file Random.cc.

{
  theDefaults().resetEngine( algorithm );
}

CLHEP::HepRandom::~HepRandom ( )

virtual

Definition at line 93 of file Random.cc.

{ }

Member Function Documentation

int CLHEP::HepRandom::createInstance ( )

static

Definition at line 208 of file Random.cc.

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

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

inlinestatic

Definition at line 152 of file Random.h.

{return "HepRandomEngine";}  

HepRandomEngine & CLHEP::HepRandom::engine ( )

virtual

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

Definition at line 111 of file Random.cc.

References CLHEP::HepRandomEngine::get().

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

double CLHEP::HepRandom::flat

(

)

Definition at line 96 of file Random.cc.

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

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

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

inline

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

Definition at line 101 of file Random.cc.

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

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

inline

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

virtual

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

Definition at line 125 of file Random.cc.

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

{return is;}

HepRandomEngine * CLHEP::HepRandom::getTheEngine ( )

static

Definition at line 165 of file Random.cc.

References CLHEP::HepRandomEngine::get().

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

{
  return theDefaults().theEngine.get();
}

HepRandom * CLHEP::HepRandom::getTheGenerator ( )

static

Definition at line 160 of file Random.cc.

References get().

{
  return theDefaults().theGenerator.get();
}

long CLHEP::HepRandom::getTheSeed ( )

static

Definition at line 136 of file Random.cc.

Referenced by G4MPImanager::ShowSeeds().

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

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

static

Definition at line 146 of file Random.cc.

Referenced by DMXPrimaryGeneratorAction::GeneratePrimaries().

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

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

static

Definition at line 151 of file Random.cc.

References seedTable.

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

{
  if ((index >= 0) && (index < 215)) {
    seeds[0] = seedTable[index][0];
    seeds[1] = seedTable[index][1];
  }
  else seeds = NULL;
}

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

virtual

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

Definition at line 110 of file Random.cc.

{return "HepRandom";}

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

virtual

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

Definition at line 106 of file Random.cc.

References flat().

                             {
  return flat();
}

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

virtual

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

Definition at line 124 of file Random.cc.

Referenced by CLHEP::operator<<().

{return os;}

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

inlinestatic

Definition at line 137 of file Random.h.

{return is;}

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

static

Definition at line 180 of file Random.cc.

Referenced by ExG4RunAction01::BeginOfRunAction(), and Em10RunMessenger::SetNewValue().

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

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

static

Definition at line 190 of file Random.cc.

References getTheEngine().

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

                                                          {
  is >> *getTheEngine();
  return is;
}

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

static

Definition at line 199 of file Random.cc.

References CLHEP::StaticRandomStates::restore().

                                                                   {
  return StaticRandomStates::restore(is);
}

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

inlinestatic

Definition at line 134 of file Random.h.

{return os;}

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

static

Definition at line 175 of file Random.cc.

Referenced by G4CascadeInterface::ApplyYourself(), PurgMagRunAction::BeginOfRunAction(), ExG4RunAction01::BeginOfRunAction(), Em10RunAction::BeginOfRunAction(), ExG4EventAction01::EndOfEventAction(), Em10EventAction::EndOfEventAction(), PurgMagRunAction::EndOfRunAction(), ExG4RunAction01::EndOfRunAction(), Em10RunAction::EndOfRunAction(), G4HadronicProcess::PostStepDoIt(), and G4CascadeInterface::Propagate().

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

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

static

Definition at line 185 of file Random.cc.

References getTheEngine().

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

                                                       {
  os << *getTheEngine();
  return os;
}

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

static

Definition at line 195 of file Random.cc.

References CLHEP::StaticRandomStates::save().

                                                                {
  return StaticRandomStates::save(os);
}

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

static

Definition at line 170 of file Random.cc.

Referenced by main(), CLHEP::StaticRandomStates::restore(), and XrayFluoSimulation::RunSimulation().

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

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

static

Definition at line 131 of file Random.cc.

Referenced by G4MPImanager::DistributeSeeds(), HepRandom(), main(), XrayFluoSimulation::RunSimulation(), and G4MPImanager::SetSeed().

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

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

static

Definition at line 141 of file Random.cc.

Referenced by ExG4RunAction01::BeginOfRunAction(), main(), and G4RunMessenger::SetNewValue().

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

void CLHEP::HepRandom::showEngineStatus ( )

static

Definition at line 203 of file Random.cc.

Referenced by PurgMagRunAction::BeginOfRunAction(), ExG4RunAction01::BeginOfRunAction(), Em10RunAction::BeginOfRunAction(), ExG4EventAction01::EndOfEventAction(), Em10EventAction::EndOfEventAction(), PurgMagRunAction::EndOfRunAction(), ExG4RunAction01::EndOfRunAction(), Em10RunAction::EndOfRunAction(), and Em10RunMessenger::SetNewValue().

{
  theDefaults().theEngine->showStatus();
}  

Field Documentation

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:

• Random.h
• SeedTable.h
• Random.cc