CLHEP::RandGauss Class Reference

#include <RandGauss.h>

Inheritance diagram for CLHEP::RandGauss:

Public Member Functions
	RandGauss (HepRandomEngine &anEngine, double mean=0.0, double stdDev=1.0)
	RandGauss (HepRandomEngine *anEngine, double mean=0.0, double stdDev=1.0)
virtual	~RandGauss ()
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)
virtual double	operator() ()
virtual double	operator() (double mean, double stdDev)
std::string	name () const
HepRandomEngine &	engine ()
std::ostream &	put (std::ostream &os) const
std::istream &	get (std::istream &is)
bool	getF () const
void	setF (bool val)
Public Member Functions inherited from CLHEP::HepRandom
	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)

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

Protected Member Functions
double	normal ()

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

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

Additional Inherited Members
Static Protected Attributes inherited from CLHEP::HepRandom
static const long	seedTable [215][2]

Detailed Description

Author

Definition at line 41 of file RandGauss.h.

Constructor & Destructor Documentation

RandGauss() [1/2]

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

inline

RandGauss() [2/2]

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

inline

~RandGauss()

CLHEP::RandGauss::~RandGauss ( )

virtual

Definition at line 51 of file RandGauss.cc.

                      {
}

Member Function Documentation

distributionName()

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

inlinestatic

Definition at line 99 of file RandGauss.h.

{return "RandGauss";}  

Referenced by restoreDistState(), and saveDistState().

engine()

HepRandomEngine & CLHEP::RandGauss::engine ( )

virtual

Reimplemented from CLHEP::HepRandom.

Reimplemented in CLHEP::RandGaussQ, and CLHEP::RandGaussZiggurat.

Definition at line 45 of file RandGauss.cc.

{return *localEngine;}

Referenced by CLHEP::RandGaussQ::engine(), and CLHEP::RandGaussZiggurat::engine().

fire() [1/2]

double CLHEP::RandGauss::fire

(

)

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

fire() [2/2]

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

inline

fireArray() [1/2]

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

Definition at line 158 of file RandGauss.cc.

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

fireArray() [2/2]

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

Definition at line 164 of file RandGauss.cc.

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

get()

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

virtual

Reimplemented from CLHEP::HepRandom.

Reimplemented in CLHEP::RandGaussQ, and CLHEP::RandGaussZiggurat.

Definition at line 277 of file RandGauss.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;
  }
  std::string c1;
  std::string c2;
  if (possibleKeywordInput(is, "Uvec", c1)) {
    std::vector<unsigned long> t(2);
    is >> defaultMean >> t[0] >> t[1]; defaultMean = DoubConv::longs2double(t); 
    is >> defaultStdDev>>t[0]>>t[1]; defaultStdDev = DoubConv::longs2double(t); 
    std::string ng;
    is >> ng;
    set = false;
    if (ng == "nextGauss") {
      is >> nextGauss >> t[0] >> t[1]; nextGauss = DoubConv::longs2double(t);
      set = true;
    }
    return is;
  }
  // is >> c1 encompassed by possibleKeywordInput
  is >> defaultMean >> c2 >> defaultStdDev;
  if ( (!is) || (c1 != "Mean:") || (c2 != "Sigma:") ) {
    std::cerr << "i/o problem while expecting to read state of a "
              << name() << " distribution\n"
          << "default mean and/or sigma could not be read\n";
    return is;
  }
  is >> c1 >> c2 >> nextGauss;
  if ( (!is) || (c1 != "RANDGAUSS") ) {
    is.clear(std::ios::badbit | is.rdstate());
    std::cerr << "Failure when reading caching state of RandGauss\n";
    return is;
  }
  if (c2 == "CACHED_GAUSSIAN:") {
    set = true;
  } else if (c2 == "NO_CACHED_GAUSSIAN:") {
    set = false;  
  } else {
    is.clear(std::ios::badbit | is.rdstate());
    std::cerr << "Unexpected caching state keyword of RandGauss:" << c2
          << "\nistream is left in the badbit state\n";
  } 
  return is;
} // get

Referenced by CLHEP::RandGaussQ::get(), and CLHEP::RandGaussZiggurat::get().

getF()

bool CLHEP::RandGauss::getF ( ) const

inline

Definition at line 115 of file RandGauss.h.

{return set;}

getFlag()

bool CLHEP::RandGauss::getFlag ( )

static

Definition at line 171 of file RandGauss.cc.

{
  return set_st;
}

Referenced by saveDistState(), saveEngineStatus(), shoot(), and shoot().

getVal()

double CLHEP::RandGauss::getVal ( )

staticprotected

Definition at line 181 of file RandGauss.cc.

{
  return nextGauss_st;
}

Referenced by saveDistState(), saveEngineStatus(), shoot(), and shoot().

name()

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

virtual

Reimplemented from CLHEP::HepRandom.

Reimplemented in CLHEP::RandGaussQ, and CLHEP::RandGaussZiggurat.

Definition at line 44 of file RandGauss.cc.

{return "RandGauss";}

Referenced by get(), and put().

normal()

double CLHEP::RandGauss::normal ( )

protected

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;
}

operator()() [1/2]

double CLHEP::RandGauss::operator() ( )

virtual

Reimplemented from CLHEP::HepRandom.

Reimplemented in CLHEP::RandGaussQ, and CLHEP::RandGaussZiggurat.

Definition at line 54 of file RandGauss.cc.

                             {
  return fire( defaultMean, defaultStdDev );
}

operator()() [2/2]

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

virtual

Reimplemented in CLHEP::RandGaussQ, and CLHEP::RandGaussZiggurat.

Definition at line 58 of file RandGauss.cc.

                                                         {
  return fire( mean, stdDev );
}

put()

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

virtual

Reimplemented from CLHEP::HepRandom.

Reimplemented in CLHEP::RandGaussQ, and CLHEP::RandGaussZiggurat.

Definition at line 258 of file RandGauss.cc.

                                                    {
  os << name() << "\n";
  long prec = os.precision(20);
  std::vector<unsigned long> t(2);
  os << "Uvec\n";
  t = DoubConv::dto2longs(defaultMean);
  os << defaultMean << " " << t[0] << " " << t[1] << "\n";
  t = DoubConv::dto2longs(defaultStdDev);
  os << defaultStdDev << " " << t[0] << " " << t[1] << "\n";
  if ( set ) {
    t = DoubConv::dto2longs(nextGauss);
    os << "nextGauss " << nextGauss << " " << t[0] << " " << t[1] << "\n";
  } else {
    os << "no_cached_nextGauss \n";
  }
  os.precision(prec);
  return os;
} // put   

Referenced by CLHEP::RandGaussQ::put(), and CLHEP::RandGaussZiggurat::put().

restoreDistState()

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

static

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;
} 

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

restoreEngineStatus()

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

static

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

restoreFullState()

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

static

Definition at line 396 of file RandGauss.cc.

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

saveDistState()

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

static

Definition at line 331 of file RandGauss.cc.

                                                        {
  long 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;
}    

Referenced by saveFullState().

saveEngineStatus()

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

static

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

saveFullState()

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

static

Definition at line 390 of file RandGauss.cc.

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

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

setF()

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

inline

Definition at line 117 of file RandGauss.h.

{set = val;}

setFlag()

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

static

Definition at line 176 of file RandGauss.cc.

{
  set_st = val;
}

Referenced by restoreDistState(), restoreEngineStatus(), shoot(), and shoot().

setVal()

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

staticprotected

Definition at line 186 of file RandGauss.cc.

{
  nextGauss_st = nextVal;
}

Referenced by shoot(), and shoot().

shoot() [1/4]

double CLHEP::RandGauss::shoot ( )

static

Definition at line 62 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 ( getFlag() ) {
    setFlag(false);
    double x = getVal();
    return x; 
    // return getVal();
  } 
 
  double r;
  double v1,v2,fac,val;
  HepRandomEngine* anEngine = HepRandom::getTheEngine();
 
  do {
    v1 = 2.0 * anEngine->flat() - 1.0;
    v2 = 2.0 * anEngine->flat() - 1.0;
    r = v1*v1 + v2*v2;
  } while ( r > 1.0 );
 
  fac = std::sqrt(-2.0*std::log(r)/r);
  val = v1*fac;
  setVal(val);
  setFlag(true);
  return v2*fac;
}

Referenced by shootArray(), and shootArray().

shoot() [2/4]

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

inlinestatic

shoot() [3/4]

double CLHEP::RandGauss::shoot ( HepRandomEngine * anEngine )

static

Definition at line 98 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 ( getFlag() ) {
    setFlag(false);
    return getVal();
  }
 
  double r;
  double v1,v2,fac,val;
 
  do {
    v1 = 2.0 * anEngine->flat() - 1.0;
    v2 = 2.0 * anEngine->flat() - 1.0;
    r = v1*v1 + v2*v2;
  } while ( r > 1.0 );
 
  fac = std::sqrt( -2.0*std::log(r)/r);
  val = v1*fac;
  setVal(val);
  setFlag(true);
  return v2*fac;
}

shoot() [4/4]

static double CLHEP::RandGauss::shoot ( HepRandomEngine * anEngine, double mean, double stdDev )

inlinestatic

shootArray() [1/2]

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

static

Definition at line 91 of file RandGauss.cc.

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

shootArray() [2/2]

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

static

Definition at line 124 of file RandGauss.cc.

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

Member Data Documentation

defaultMean

double CLHEP::RandGauss::defaultMean

protected

Definition at line 151 of file RandGauss.h.

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

defaultStdDev

double CLHEP::RandGauss::defaultStdDev

protected

Definition at line 152 of file RandGauss.h.

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

localEngine

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

protected

Definition at line 154 of file RandGauss.h.

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

---

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

• RandGauss.h
• RandGauss.cc