CLHEP::RandGaussQ Class Reference

#include <RandGaussQ.h>

Inheritance diagram for CLHEP::RandGaussQ:

Public Member Functions
HepRandomEngine &	engine ()
double	fire ()
double	fire (double mean, double stdDev)
void	fireArray (const int size, double *vect)
void	fireArray (const int size, double *vect, double mean, double stdDev)
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)
bool	getF () const
std::string	name () const
virtual double	operator() ()
virtual double	operator() (double mean, double stdDev)
std::ostream &	put (std::ostream &os) const
	RandGaussQ (HepRandomEngine &anEngine, double mean=0.0, double stdDev=1.0)
	RandGaussQ (HepRandomEngine *anEngine, double mean=0.0, double stdDev=1.0)
void	setF (bool val)
virtual	~RandGaussQ ()

Static Public Member Functions
static int	createInstance ()
static std::string	distributionName ()
static bool	getFlag ()
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	setFlag (bool val)
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, double stdDev)
static double	shoot (HepRandomEngine *anotherEngine)
static double	shoot (HepRandomEngine *anotherEngine, double mean, double stdDev)
static void	shootArray (const int size, double *vect, double mean=0.0, double stdDev=1.0)
static void	shootArray (HepRandomEngine *anotherEngine, const int size, double *vect, double mean=0.0, double stdDev=1.0)
static void	showEngineStatus ()

Protected Member Functions
double	normal ()

Static Protected Member Functions
static double	getVal ()
static void	setVal (double nextVal)
static double	transformQuick (double r)
static double	transformSmall (double r)

Protected Attributes
double	defaultMean
double	defaultStdDev
std::shared_ptr< HepRandomEngine >	localEngine

Static Protected Attributes
static const long	seedTable [215][2]

Private Attributes
double	nextGauss
bool	set

Static Private Attributes
static CLHEP_THREAD_LOCAL double	nextGauss_st = 0.0
static CLHEP_THREAD_LOCAL bool	set_st = false

Detailed Description

Author

Definition at line 30 of file RandGaussQ.h.

Constructor & Destructor Documentation

RandGaussQ() [1/2]

CLHEP::RandGaussQ::RandGaussQ ( HepRandomEngine &  anEngine, double  mean = 0.0, double  stdDev = 1.0  )

inline

RandGaussQ() [2/2]

CLHEP::RandGaussQ::RandGaussQ ( HepRandomEngine *  anEngine, double  mean = 0.0, double  stdDev = 1.0  )

inline

~RandGaussQ()

CLHEP::RandGaussQ::~RandGaussQ ( )

virtual

Definition at line 24 of file RandGaussQ.cc.

                        {
}

Member Function Documentation

createInstance()

int CLHEP::HepRandom::createInstance ( )

staticinherited

Definition at line 311 of file Random.cc.

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

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

distributionName()

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

inlinestatic

Definition at line 102 of file RandGaussQ.h.

{return "RandGaussQ";}  

engine()

HepRandomEngine & CLHEP::RandGaussQ::engine ( )

virtual

Reimplemented from CLHEP::RandGauss.

Definition at line 22 of file RandGaussQ.cc.

{return RandGauss::engine();}

References CLHEP::RandGauss::engine().

fire() [1/2]

double CLHEP::RandGaussQ::fire ( )

inline

Referenced by fireArray().

fire() [2/2]

double CLHEP::RandGaussQ::fire ( double  mean, double  stdDev  )

inline

fireArray() [1/2]

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

Definition at line 50 of file RandGaussQ.cc.

{
  for( double* v = vect; v != vect + size; ++v )
    *v = fire( defaultMean, defaultStdDev );
}

References CLHEP::RandGauss::defaultMean, CLHEP::RandGauss::defaultStdDev, and fire().

fireArray() [2/2]

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

Definition at line 56 of file RandGaussQ.cc.

{
  for( double* v = vect; v != vect + size; ++v )
    *v = fire( mean, stdDev );
}

References fire().

flat() [1/2]

double CLHEP::HepRandom::flat ( )

inherited

Definition at line 199 of file Random.cc.

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

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

Referenced by CLHEP::RandExponential::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.

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

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::RandGaussQ::get ( std::istream &  is )

virtual

Reimplemented from CLHEP::RandGauss.

Definition at line 173 of file RandGaussQ.cc.

                                               {
  std::string inName;
  is >> inName;
  if (inName != name()) {
    is.clear(std::ios::badbit | is.rdstate());
    std::cerr << "Mismatch when expecting to read state of a "
              << name() << " distribution\n"
          << "Name found was " << inName
          << "\nistream is left in the badbit state\n";
    return is;
  }
  RandGauss::get(is);
  return is;
}

References CLHEP::RandGauss::get(), and name().

getF()

bool CLHEP::RandGauss::getF ( ) const

inlineinherited

Definition at line 115 of file RandGauss.h.

{return set;}

References CLHEP::RandGauss::set.

getFlag()

bool CLHEP::RandGauss::getFlag ( )

staticinherited

Definition at line 171 of file RandGauss.cc.

{
  return set_st;
}

References CLHEP::RandGauss::set_st.

Referenced by CLHEP::RandGauss::saveDistState(), CLHEP::RandGauss::saveEngineStatus(), and CLHEP::RandGauss::shoot().

getTheEngine()

HepRandomEngine * CLHEP::HepRandom::getTheEngine ( )

staticinherited

Definition at line 268 of file Random.cc.

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

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(), CLHEP::RandExponential::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.

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

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.

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

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.

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

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.

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

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

getVal()

double CLHEP::RandGauss::getVal ( )

staticprotectedinherited

Definition at line 181 of file RandGauss.cc.

{
  return nextGauss_st;
}

References CLHEP::RandGauss::nextGauss_st.

Referenced by CLHEP::RandGauss::saveDistState(), CLHEP::RandGauss::saveEngineStatus(), and CLHEP::RandGauss::shoot().

name()

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

virtual

Reimplemented from CLHEP::RandGauss.

Definition at line 21 of file RandGaussQ.cc.

{return "RandGaussQ";}

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

normal()

double CLHEP::RandGauss::normal ( )

protectedinherited

Definition at line 132 of file RandGauss.cc.

{
  // Gaussian random numbers are generated two at the time, so every other
  // time this is called we just return a number generated the time before.
 
  if ( set ) {
    set = false;
    return nextGauss;
  }
 
  double r;
  double v1,v2,fac,val;
 
  do {
    v1 = 2.0 * localEngine->flat() - 1.0;
    v2 = 2.0 * localEngine->flat() - 1.0;
    r = v1*v1 + v2*v2;
  } while ( r > 1.0 );
 
  fac = std::sqrt(-2.0*std::log(r)/r);
  val = v1*fac;
  nextGauss = val;
  set = true;
  return v2*fac;
}

References fac, CLHEP::RandGauss::localEngine, CLHEP::RandGauss::nextGauss, and CLHEP::RandGauss::set.

operator()() [1/2]

double CLHEP::RandGaussQ::operator() ( )

virtual

Reimplemented from CLHEP::RandGauss.

Definition at line 27 of file RandGaussQ.cc.

                              {
  return transformQuick(localEngine->flat()) * defaultStdDev + defaultMean;
}

References CLHEP::RandGauss::defaultMean, CLHEP::RandGauss::defaultStdDev, CLHEP::RandGauss::localEngine, and transformQuick().

operator()() [2/2]

double CLHEP::RandGaussQ::operator() ( double  mean, double  stdDev  )

virtual

Reimplemented from CLHEP::RandGauss.

Definition at line 31 of file RandGaussQ.cc.

                                                          {
  return transformQuick(localEngine->flat()) * stdDev + mean;
}

References CLHEP::RandGauss::localEngine, and transformQuick().

put()

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

virtual

Reimplemented from CLHEP::RandGauss.

Definition at line 165 of file RandGaussQ.cc.

                                                     {
  int pr=os.precision(20);
  os << " " << name() << "\n";
  RandGauss::put(os);
  os.precision(pr);
  return os;
}

References name(), and CLHEP::RandGauss::put().

restoreDistState()

std::istream & CLHEP::RandGauss::restoreDistState ( std::istream &  is )

staticinherited

Definition at line 346 of file RandGauss.cc.

                                                           {
  std::string inName;
  is >> inName;
  if (inName != distributionName()) {
    is.clear(std::ios::badbit | is.rdstate());
    std::cerr << "Mismatch when expecting to read static state of a "
              << distributionName() << " distribution\n"
          << "Name found was " << inName
          << "\nistream is left in the badbit state\n";
    return is;
  }
  std::string c1;
  std::string c2;
  if (possibleKeywordInput(is, "Uvec", c1)) {
    std::vector<unsigned long> t(2);
    std::string ng;
    is >> ng;
    setFlag (false);
    if (ng == "nextGauss_st") {
      is >> nextGauss_st >> t[0] >> t[1]; 
      nextGauss_st = DoubConv::longs2double(t);
      setFlag (true);
    }
    return is;
  }
  // is >> c1 encompassed by possibleKeywordInput
  is >> c2 >> nextGauss_st;
  if ( (!is) || (c1 != "RANDGAUSS") ) {
    is.clear(std::ios::badbit | is.rdstate());
    std::cerr << "Failure when reading caching state of static RandGauss\n";
    return is;
  }
  if (c2 == "CACHED_GAUSSIAN:") {
    setFlag(true);
  } else if (c2 == "NO_CACHED_GAUSSIAN:") {
    setFlag(false);  
  } else {
    is.clear(std::ios::badbit | is.rdstate());
    std::cerr << "Unexpected caching state keyword of static RandGauss:" << c2
          << "\nistream is left in the badbit state\n";
  } 
  return is;
} 

References CLHEP::RandGauss::distributionName(), CLHEP::DoubConv::longs2double(), CLHEP::RandGauss::nextGauss_st, CLHEP::possibleKeywordInput(), and CLHEP::RandGauss::setFlag().

Referenced by CLHEP::StaticRandomStates::restore(), and CLHEP::RandGauss::restoreFullState().

restoreEngineStatus()

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

staticinherited

Definition at line 211 of file RandGauss.cc.

                                                           {
 
  // First restore the engine status just like the base class would do:
  getTheEngine()->restoreStatus( filename );
 
  // Now find the line describing the cached variate:
 
  std::ifstream infile ( filename, std::ios::in );
  if (!infile) return;
 
  char inputword[] = "NO_KEYWORD    "; // leaves room for 14 characters plus \0
  while (true) {
    infile.width(13);
    infile >> inputword;
    if (strcmp(inputword,"RANDGAUSS")==0) break;
    if (infile.eof()) break;
    // If the file ends without the RANDGAUSS line, that means this
    // was a file produced by an earlier version of RandGauss.  We will
    // replicated the old behavior in that case:  set_st is cleared.
  }
 
  // Then read and use the caching info:
 
  if (strcmp(inputword,"RANDGAUSS")==0) {
    char setword[40];   // the longest, staticFirstUnusedBit: has length 21
    infile.width(39);
    infile >> setword;  // setword should be CACHED_GAUSSIAN:
    if (strcmp(setword,"CACHED_GAUSSIAN:") ==0) {
      if (possibleKeywordInput(infile, "Uvec", nextGauss_st)) {
        std::vector<unsigned long> t(2);
        infile >> nextGauss_st >> t[0] >> t[1]; 
        nextGauss_st = DoubConv::longs2double(t); 
      }
      // is >> nextGauss_st encompassed by possibleKeywordInput
      setFlag(true);
    } else {
      setFlag(false);
      infile >> nextGauss_st; // because a 0 will have been output
    }
  } else {
    setFlag(false);
  }
 
} // restoreEngineStatus

References CLHEP::HepRandom::getTheEngine(), CLHEP::DoubConv::longs2double(), CLHEP::RandGauss::nextGauss_st, CLHEP::possibleKeywordInput(), CLHEP::HepRandomEngine::restoreStatus(), and CLHEP::RandGauss::setFlag().

restoreFullState()

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

staticinherited

Definition at line 396 of file RandGauss.cc.

                                                           {
  HepRandom::restoreFullState(is);
  restoreDistState(is);
  return is;
}

References CLHEP::RandGauss::restoreDistState(), and CLHEP::HepRandom::restoreFullState().

restoreStaticRandomStates()

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

staticinherited

Definition at line 302 of file Random.cc.

                                                                   {
  return StaticRandomStates::restore(is);
}

References CLHEP::StaticRandomStates::restore().

saveDistState()

std::ostream & CLHEP::RandGauss::saveDistState ( std::ostream &  os )

staticinherited

Definition at line 331 of file RandGauss.cc.

                                                        {
  int prec = os.precision(20);
  std::vector<unsigned long> t(2);
  os << distributionName() << "\n";
  os << "Uvec\n";
  if ( getFlag() ) {
    t = DoubConv::dto2longs(getVal());
    os << "nextGauss_st " << getVal() << " " << t[0] << " " << t[1] << "\n";
  } else {
    os << "no_cached_nextGauss_st \n";
  }
  os.precision(prec);
  return os;
}    

References CLHEP::RandGauss::distributionName(), CLHEP::DoubConv::dto2longs(), CLHEP::RandGauss::getFlag(), CLHEP::RandGauss::getVal(), and CLHEP::prec.

Referenced by CLHEP::RandGauss::saveFullState().

saveEngineStatus()

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

staticinherited

Definition at line 191 of file RandGauss.cc.

                                                         {
 
  // First save the engine status just like the base class would do:
  getTheEngine()->saveStatus( filename );
 
  // Now append the cached variate, if any:
 
  std::ofstream outfile ( filename, std::ios::app );
 
  if ( getFlag() ) {
    std::vector<unsigned long> t(2);
    t = DoubConv::dto2longs(getVal());
    outfile << "RANDGAUSS CACHED_GAUSSIAN: Uvec " 
        << getVal() << " " << t[0] << " " << t[1] << "\n";
  } else {
    outfile << "RANDGAUSS NO_CACHED_GAUSSIAN: 0 \n" ;
  }
 
} // saveEngineStatus

References demo::app, CLHEP::DoubConv::dto2longs(), CLHEP::RandGauss::getFlag(), CLHEP::HepRandom::getTheEngine(), CLHEP::RandGauss::getVal(), and CLHEP::HepRandomEngine::saveStatus().

saveFullState()

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

staticinherited

Definition at line 390 of file RandGauss.cc.

                                                        {
  HepRandom::saveFullState(os);
  saveDistState(os);
  return os;
}

References CLHEP::RandGauss::saveDistState(), and CLHEP::HepRandom::saveFullState().

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

saveStaticRandomStates()

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

staticinherited

Definition at line 298 of file Random.cc.

                                                                {
  return StaticRandomStates::save(os);
}

References CLHEP::StaticRandomStates::save().

setF()

void CLHEP::RandGauss::setF ( bool  val )

inlineinherited

Definition at line 117 of file RandGauss.h.

{set = val;}

References CLHEP::RandGauss::set.

setFlag()

void CLHEP::RandGauss::setFlag ( bool  val )

staticinherited

Definition at line 176 of file RandGauss.cc.

{
  set_st = val;
}

References CLHEP::RandGauss::set_st.

Referenced by CLHEP::RandGauss::restoreDistState(), CLHEP::RandGauss::restoreEngineStatus(), and CLHEP::RandGauss::shoot().

setTheEngine()

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

staticinherited

Definition at line 273 of file Random.cc.

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

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.

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

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.

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

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

setVal()

void CLHEP::RandGauss::setVal ( double  nextVal )

staticprotectedinherited

Definition at line 186 of file RandGauss.cc.

{
  nextGauss_st = nextVal;
}

References CLHEP::RandGauss::nextGauss_st.

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

shoot() [1/4]

static double CLHEP::RandGaussQ::shoot ( )

inlinestatic

Referenced by CLHEP::RandPoissonQ::poissonDeviateQuick(), and shootArray().

shoot() [2/4]

static double CLHEP::RandGaussQ::shoot ( double  mean, double  stdDev  )

inlinestatic

shoot() [3/4]

static double CLHEP::RandGaussQ::shoot ( HepRandomEngine *  anotherEngine )

inlinestatic

shoot() [4/4]

static double CLHEP::RandGaussQ::shoot ( HepRandomEngine *  anotherEngine, double  mean, double  stdDev  )

inlinestatic

shootArray() [1/2]

void CLHEP::RandGaussQ::shootArray ( const int  size, double *  vect, double  mean = 0.0, double  stdDev = 1.0  )

static

Definition at line 35 of file RandGaussQ.cc.

{
  for( double* v = vect; v != vect + size; ++v )
    *v = shoot(mean,stdDev);
}

References shoot().

shootArray() [2/2]

void CLHEP::RandGaussQ::shootArray ( HepRandomEngine *  anotherEngine, const int  size, double *  vect, double  mean = 0.0, double  stdDev = 1.0  )

static

Definition at line 42 of file RandGaussQ.cc.

{
  for( double* v = vect; v != vect + size; ++v )
    *v = shoot(anEngine,mean,stdDev);
}

References shoot().

showEngineStatus()

void CLHEP::HepRandom::showEngineStatus ( )

staticinherited

Definition at line 306 of file Random.cc.

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

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

transformQuick()

double CLHEP::RandGaussQ::transformQuick ( double  r )

staticprotected

Definition at line 91 of file RandGaussQ.cc.

                                           {
  double sign = +1.0;   // We always compute a negative number of 
                // sigmas.  For r > 0 we will multiply by
                // sign = -1 to return a positive number.
  if ( r > .5 ) {
    r = 1-r;
    sign = -1.0;
  } 
 
  int index;
  double  dx;
 
  if ( r >= Table1step ) { 
    index = int((Table1size<<1) * r);   // 1 to Table1size
    if (index == Table1size) return 0.0;
    dx = (Table1size<<1) * r - index;       // fraction of way to next bin
    index += Table1offset-1;    
  } else if ( r > Table0step ) {
    double rr = r * Table0scale;
    index = int(Table0size * rr);       // 1 to Table0size
    dx = Table0size * rr - index;       // fraction of way to next bin
    index += Table0offset-1;    
  } else {                  // r <= Table0step - not in tables
    return sign*transformSmall(r);  
  }             
 
  double y0 = gaussTables [index++];
  double y1 = gaussTables [index];
  
  return (float) (sign * ( y1 * dx + y0 * (1.0-dx) ));
 
} // transformQuick()

References CLHEP::gaussTables, G4INCL::Math::sign(), Table0offset, Table0scale, Table0size, Table0step, Table1offset, Table1size, Table1step, and transformSmall().

Referenced by operator()().

transformSmall()

double CLHEP::RandGaussQ::transformSmall ( double  r )

staticprotected

Definition at line 124 of file RandGaussQ.cc.

                                           {
 
  // Solve for -v in the asymtotic formula 
  //
  // errInt (-v) =  exp(-v*v/2)         1     1*3    1*3*5
  //           ------------ * (1 - ---- + ---- - ----- + ... )
  //           v*sqrt(2*pi)        v**2   v**4   v**6
 
  // The value of r (=errInt(-v)) supplied is going to less than 2.0E-13,
  // which is such that v < -7.25.  Since the value of r is meaningful only
  // to an absolute error of 1E-16 (double precision accuracy for a number 
  // which on the high side could be of the form 1-epsilon), computing
  // v to more than 3-4 digits of accuracy is suspect; however, to ensure 
  // smoothness with the table generator (which uses quite a few terms) we
  // also use terms up to 1*3*5* ... *13/v**14, and insist on accuracy of
  // solution at the level of 1.0e-7.
 
  // This routine is called less than one time in a million firings, so
  // speed is of no concern.  As a matter of technique, we terminate the
  // iterations in case they would be infinite, but this should not happen.
 
  double eps = 1.0e-7;
  double guess = 7.5;
  double v;
  
  for ( int i = 1; i < 50; i++ ) {
    double vn2 = 1.0/(guess*guess);
    double s1 = -13*11*9*7*5*3 * vn2*vn2*vn2*vn2*vn2*vn2*vn2;
            s1 +=    11*9*7*5*3 * vn2*vn2*vn2*vn2*vn2*vn2;
            s1 +=      -9*7*5*3 * vn2*vn2*vn2*vn2*vn2;
            s1 +=         7*5*3 * vn2*vn2*vn2*vn2;
            s1 +=          -5*3 * vn2*vn2*vn2;
            s1 +=            3 * vn2*vn2    - vn2  +    1.0;
    v = std::sqrt ( 2.0 * std::log ( s1 / (r*guess*std::sqrt(CLHEP::twopi)) ) );
    if ( std::fabs(v-guess) < eps ) break;
    guess = v;
  }
  return -v;
 
} // transformSmall()

References eps, and CLHEP::twopi.

Referenced by transformQuick().

Field Documentation

defaultMean

double CLHEP::RandGauss::defaultMean

protectedinherited

Definition at line 151 of file RandGauss.h.

Referenced by CLHEP::RandGaussZiggurat::fire(), CLHEP::RandGauss::fireArray(), fireArray(), CLHEP::RandGaussZiggurat::fireArray(), CLHEP::RandGauss::get(), CLHEP::RandGauss::operator()(), operator()(), CLHEP::RandGaussZiggurat::operator()(), and CLHEP::RandGauss::put().

defaultStdDev

double CLHEP::RandGauss::defaultStdDev

protectedinherited

Definition at line 152 of file RandGauss.h.

Referenced by CLHEP::RandGaussZiggurat::fire(), CLHEP::RandGauss::fireArray(), fireArray(), CLHEP::RandGaussZiggurat::fireArray(), CLHEP::RandGauss::get(), CLHEP::RandGauss::operator()(), operator()(), CLHEP::RandGaussZiggurat::operator()(), and CLHEP::RandGauss::put().

localEngine

std::shared_ptr<HepRandomEngine> CLHEP::RandGauss::localEngine

protectedinherited

Definition at line 154 of file RandGauss.h.

Referenced by CLHEP::RandGauss::engine(), CLHEP::RandGaussZiggurat::fire(), CLHEP::RandGauss::normal(), operator()(), and CLHEP::RandGaussZiggurat::operator()().

nextGauss

double CLHEP::RandGauss::nextGauss

privateinherited

Definition at line 159 of file RandGauss.h.

Referenced by CLHEP::RandGauss::get(), CLHEP::RandGauss::normal(), and CLHEP::RandGauss::put().

nextGauss_st

CLHEP_THREAD_LOCAL double CLHEP::RandGauss::nextGauss_st = 0.0

staticprivateinherited

Definition at line 163 of file RandGauss.h.

Referenced by CLHEP::RandGauss::getVal(), CLHEP::RandGauss::restoreDistState(), CLHEP::RandGauss::restoreEngineStatus(), and CLHEP::RandGauss::setVal().

seedTable

const long CLHEP::HepRandom::seedTable

staticprotectedinherited

Definition at line 156 of file Random.h.

set

bool CLHEP::RandGauss::set

privateinherited

Definition at line 158 of file RandGauss.h.

Referenced by CLHEP::RandGauss::get(), CLHEP::RandGauss::getF(), CLHEP::RandGauss::normal(), CLHEP::RandGauss::put(), and CLHEP::RandGauss::setF().

set_st

CLHEP_THREAD_LOCAL bool CLHEP::RandGauss::set_st = false

staticprivateinherited

Definition at line 162 of file RandGauss.h.

Referenced by CLHEP::RandGauss::getFlag(), and CLHEP::RandGauss::setFlag().

---

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

• source/externals/clhep/include/CLHEP/Random/RandGaussQ.h
• source/externals/clhep/src/RandGaussQ.cc