CLHEP::RandGaussQ Class Reference

#include <RandGaussQ.h>

Inheritance diagram for CLHEP::RandGaussQ:

Public Member Functions
	RandGaussQ (HepRandomEngine &anEngine, double mean=0.0, double stdDev=1.0)
	RandGaussQ (HepRandomEngine *anEngine, double mean=0.0, double stdDev=1.0)
virtual	~RandGaussQ ()
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::ostream &	put (std::ostream &os) const
std::istream &	get (std::istream &is)
std::string	name () const
HepRandomEngine &	engine ()
Public Member Functions inherited from CLHEP::RandGauss
	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)
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 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 *anotherEngine)
static double	shoot (HepRandomEngine *anotherEngine, double mean, double stdDev)
static void	shootArray (HepRandomEngine *anotherEngine, const int size, double *vect, double mean=0.0, double stdDev=1.0)
static std::string	distributionName ()
Static Public Member Functions inherited from CLHEP::RandGauss
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 ()

Static Protected Member Functions
static double	transformQuick (double r)
static double	transformSmall (double r)
Static Protected Member Functions inherited from CLHEP::RandGauss
static double	getVal ()
static void	setVal (double nextVal)

Additional Inherited Members
Protected Member Functions inherited from CLHEP::RandGauss
double	normal ()
Protected Attributes inherited from CLHEP::RandGauss
double	defaultMean
double	defaultStdDev
std::shared_ptr< HepRandomEngine >	localEngine
Static Protected Attributes inherited from CLHEP::HepRandom
static const long	seedTable [215][2]

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

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

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

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

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

name()

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

virtual

Reimplemented from CLHEP::RandGauss.

Definition at line 21 of file RandGaussQ.cc.

{return "RandGaussQ";}

Referenced by get(), and put().

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

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

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

shoot() [1/4]

static double CLHEP::RandGaussQ::shoot ( )

inlinestatic

Referenced by 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);
}

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

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()

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()

Referenced by transformQuick().

---

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

• RandGaussQ.h
• RandGaussQ.cc