CLHEP::RandGaussZiggurat Class Reference

#include <RandGaussZiggurat.h>

Inheritance diagram for CLHEP::RandGaussZiggurat:

Public Member Functions
	RandGaussZiggurat (HepRandomEngine &anEngine, double mean=0.0, double stdDev=1.0)
	RandGaussZiggurat (HepRandomEngine *anEngine, double mean=0.0, double stdDev=1.0)
virtual	~RandGaussZiggurat ()
float	fire ()
float	fire (float mean, float stdDev)
void	fireArray (const int size, float *vect)
void	fireArray (const int size, double *vect)
void	fireArray (const int size, float *vect, float mean, float stdDev)
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 float	shoot ()
static float	shoot (float mean, float stdDev)
static void	shootArray (const int size, float *vect, float mean=0.0, float stdDev=1.0)
static void	shootArray (const int size, double *vect, double mean=0.0, double stdDev=1.0)
static float	shoot (HepRandomEngine *anotherEngine)
static float	shoot (HepRandomEngine *anotherEngine, float mean, float stdDev)
static void	shootArray (HepRandomEngine *anotherEngine, const int size, float *vect, float mean=0.0, float stdDev=1.0)
static void	shootArray (HepRandomEngine *anotherEngine, const int size, double *vect, double mean=0.0, double stdDev=1.0)
static std::string	distributionName ()
static bool	ziggurat_init ()
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 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 Member Functions
static unsigned long	ziggurat_SHR3 (HepRandomEngine *anEngine)
static float	ziggurat_UNI (HepRandomEngine *anEngine)
static float	ziggurat_RNOR (HepRandomEngine *anEngine)
static float	ziggurat_nfix (long hz, HepRandomEngine *anEngine)
Static Protected Member Functions inherited from CLHEP::RandGauss
static double	getVal ()
static void	setVal (double nextVal)

Static Protected Attributes
static CLHEP_THREAD_LOCAL unsigned long	kn [128]
static CLHEP_THREAD_LOCAL unsigned long	ke [256]
static CLHEP_THREAD_LOCAL float	wn [128]
static CLHEP_THREAD_LOCAL float	fn [128]
static CLHEP_THREAD_LOCAL float	we [256]
static CLHEP_THREAD_LOCAL float	fe [256]
static CLHEP_THREAD_LOCAL bool	ziggurat_is_init = false
Static Protected Attributes inherited from CLHEP::HepRandom
static const long	seedTable [215][2]

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

Detailed Description

Author

ATLAS

Definition at line 37 of file RandGaussZiggurat.h.

Constructor & Destructor Documentation

RandGaussZiggurat() [1/2]

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

inline

Definition at line 137 of file RandGaussZiggurat.h.

                                                                                          : RandGauss(anEngine, mean, stdDev) 
{
}

RandGaussZiggurat() [2/2]

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

inline

Definition at line 141 of file RandGaussZiggurat.h.

                                                                                          : RandGauss(anEngine, mean, stdDev) 
{
}

~RandGaussZiggurat()

CLHEP::RandGaussZiggurat::~RandGaussZiggurat ( )

virtual

Definition at line 14 of file RandGaussZiggurat.cc.

                                      {
}

Member Function Documentation

distributionName()

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

inlinestatic

Definition at line 87 of file RandGaussZiggurat.h.

{return "RandGaussZiggurat";}  

engine()

HepRandomEngine & CLHEP::RandGaussZiggurat::engine ( )

virtual

Reimplemented from CLHEP::RandGauss.

Definition at line 12 of file RandGaussZiggurat.cc.

{return RandGauss::engine();}

fire() [1/2]

float CLHEP::RandGaussZiggurat::fire ( )

inline

Definition at line 67 of file RandGaussZiggurat.h.

{return float(ziggurat_RNOR(localEngine.get()) * defaultStdDev + defaultMean);}

Referenced by fireArray().

fire() [2/2]

float CLHEP::RandGaussZiggurat::fire ( float  mean, float  stdDev  )

inline

Definition at line 69 of file RandGaussZiggurat.h.

{return ziggurat_RNOR(localEngine.get()) * stdDev + mean;}

fireArray() [1/4]

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

Definition at line 144 of file RandGaussZiggurat.cc.

{
   for (int i=0; i<size; ++i) {
     vect[i] = fire( defaultMean, defaultStdDev );
   }
}

fireArray() [2/4]

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

Definition at line 158 of file RandGaussZiggurat.cc.

{
   for (int i=0; i<size; ++i) {
     vect[i] = fire( mean, stdDev );
   }
}

fireArray() [3/4]

void CLHEP::RandGaussZiggurat::fireArray	(	const int	size,
		float *	vect
	)

Definition at line 137 of file RandGaussZiggurat.cc.

{
   for (int i=0; i<size; ++i) {
     vect[i] = fire( defaultMean, defaultStdDev );
   }
}

fireArray() [4/4]

void CLHEP::RandGaussZiggurat::fireArray	(	const int	size,
		float *	vect,
		float	mean,
		float	stdDev
	)

Definition at line 151 of file RandGaussZiggurat.cc.

{
   for (int i=0; i<size; ++i) {
     vect[i] = fire( mean, stdDev );
   }
}

get()

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

virtual

Reimplemented from CLHEP::RandGauss.

Definition at line 173 of file RandGaussZiggurat.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::RandGaussZiggurat::name ( ) const

virtual

Reimplemented from CLHEP::RandGauss.

Definition at line 17 of file RandGaussZiggurat.cc.

{
  return "RandGaussZiggurat";
}

Referenced by get(), and put().

operator()() [1/2]

double CLHEP::RandGaussZiggurat::operator() ( )

virtual

Reimplemented from CLHEP::RandGauss.

Definition at line 101 of file RandGaussZiggurat.cc.

                                     {
  return ziggurat_RNOR(localEngine.get()) * defaultStdDev + defaultMean;
}

operator()() [2/2]

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

virtual

Reimplemented from CLHEP::RandGauss.

Definition at line 105 of file RandGaussZiggurat.cc.

                                                                 {
  return ziggurat_RNOR(localEngine.get()) * stdDev + mean;
}

put()

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

virtual

Reimplemented from CLHEP::RandGauss.

Definition at line 165 of file RandGaussZiggurat.cc.

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

shoot() [1/4]

static float CLHEP::RandGaussZiggurat::shoot ( )

inlinestatic

Definition at line 49 of file RandGaussZiggurat.h.

{return ziggurat_RNOR(HepRandom::getTheEngine());}

Referenced by shootArray().

shoot() [2/4]

static float CLHEP::RandGaussZiggurat::shoot ( float  mean, float  stdDev  )

inlinestatic

Definition at line 50 of file RandGaussZiggurat.h.

{return shoot()*stdDev + mean;}

Referenced by shoot().

shoot() [3/4]

static float CLHEP::RandGaussZiggurat::shoot ( HepRandomEngine *  anotherEngine )

inlinestatic

Definition at line 58 of file RandGaussZiggurat.h.

{return ziggurat_RNOR(anotherEngine);}

shoot() [4/4]

static float CLHEP::RandGaussZiggurat::shoot ( HepRandomEngine *  anotherEngine, float  mean, float  stdDev  )

inlinestatic

Definition at line 59 of file RandGaussZiggurat.h.

{return shoot(anotherEngine)*stdDev + mean;}

Referenced by shoot().

shootArray() [1/4]

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

static

Definition at line 116 of file RandGaussZiggurat.cc.

{
   for (int i=0; i<size; ++i) {
     vect[i] = shoot(mean,stdDev);
   }
}

shootArray() [2/4]

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

static

Definition at line 109 of file RandGaussZiggurat.cc.

{
   for (int i=0; i<size; ++i) {
     vect[i] = shoot(mean,stdDev);
   }
}

shootArray() [3/4]

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

static

Definition at line 130 of file RandGaussZiggurat.cc.

{
   for (int i=0; i<size; ++i) {
     vect[i] = shoot(anEngine,mean,stdDev);
   }
}

shootArray() [4/4]

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

static

Definition at line 123 of file RandGaussZiggurat.cc.

{
   for (int i=0; i<size; ++i) {
     vect[i] = shoot(anEngine,mean,stdDev);
   }
}

ziggurat_init()

bool CLHEP::RandGaussZiggurat::ziggurat_init ( )

static

Definition at line 22 of file RandGaussZiggurat.cc.

{  
  const double rzm1 = 2147483648.0, rzm2 = 4294967296.;
  double dn=3.442619855899,tn=dn,vn=9.91256303526217e-3, q;
  double de=7.697117470131487, te=de, ve=3.949659822581572e-3;
  int i;
 
/* Set up tables for RNOR */
  q=vn/std::exp(-.5*dn*dn);
  kn[0]=(unsigned long)((dn/q)*rzm1);
  kn[1]=0;
 
  wn[0]=q/rzm1;
  wn[127]=dn/rzm1;
 
  fn[0]=1.;
  fn[127]=std::exp(-.5*dn*dn);
 
  for(i=126;i>=1;i--) {
    dn=std::sqrt(-2.*std::log(vn/dn+std::exp(-.5*dn*dn)));
    kn[i+1]=(unsigned long)((dn/tn)*rzm1);
    tn=dn;
    fn[i]=std::exp(-.5*dn*dn);
    wn[i]=dn/rzm1;
  }
 
/* Set up tables for REXP */
  q = ve/std::exp(-de);
  ke[0]=(unsigned long)((de/q)*rzm2);
  ke[1]=0;
 
  we[0]=q/rzm2;
  we[255]=de/rzm2;
 
  fe[0]=1.;
  fe[255]=std::exp(-de);
 
  for(i=254;i>=1;i--) {
    de=-std::log(ve/de+std::exp(-de));
    ke[i+1]= (unsigned long)((de/te)*rzm2);
    te=de;
    fe[i]=std::exp(-de);
    we[i]=de/rzm2;
  }
  ziggurat_is_init=true;
  
  //std::cout<<"Done RandGaussZiggurat::ziggurat_init()"<<std::endl;
  
  return true;
}

Referenced by ziggurat_nfix(), and ziggurat_RNOR().

ziggurat_nfix()

float CLHEP::RandGaussZiggurat::ziggurat_nfix ( long  hz, HepRandomEngine *  anEngine  )

staticprotected

Definition at line 73 of file RandGaussZiggurat.cc.

{
  if(!ziggurat_is_init) ziggurat_init();
  const float r = 3.442620f;     /* The start of the right tail */
  float x, y;
  unsigned long iz=hz&127;
  for(;;)
  {  
    x=hz*wn[iz];      /* iz==0, handles the base strip */
    if(iz==0) {
      do { 
        /* change to (1.0 - UNI) as argument to std::log(), because CLHEP generates [0,1), 
           while the original UNI generates (0,1] */
        x=-std::log(1.0 - ziggurat_UNI(anEngine))*0.2904764; /* .2904764 is 1/r */
        y=-std::log(1.0 - ziggurat_UNI(anEngine));
      } while(y+y<x*x);
      return (hz>0)? r+x : -r-x;
    }
    /* iz>0, handle the wedges of other strips */
    if( fn[iz]+(1.0 - ziggurat_UNI(anEngine))*(fn[iz-1]-fn[iz]) < std::exp(-.5*x*x) ) return x;
 
    /* initiate, try to exit for(;;) for loop*/
    hz=(signed)ziggurat_SHR3(anEngine);
    iz=hz&127;
    if((unsigned long)std::abs(hz)<kn[iz]) return (hz*wn[iz]);
  }
}

Referenced by ziggurat_RNOR().

ziggurat_RNOR()

static float CLHEP::RandGaussZiggurat::ziggurat_RNOR ( HepRandomEngine *  anEngine )

inlinestaticprotected

Definition at line 115 of file RandGaussZiggurat.h.

                                                               {
    if(!ziggurat_is_init) ziggurat_init();
    long hz=(signed)ziggurat_SHR3(anEngine);
    unsigned long iz=hz&127;
    return ((unsigned long)std::abs(hz)<kn[iz]) ? hz*wn[iz] : ziggurat_nfix(hz,anEngine);
  }

Referenced by fire(), operator()(), and shoot().

ziggurat_SHR3()

static unsigned long CLHEP::RandGaussZiggurat::ziggurat_SHR3 ( HepRandomEngine *  anEngine )

inlinestaticprotected

Definition at line 113 of file RandGaussZiggurat.h.

{return (unsigned int)(*anEngine);}

Referenced by ziggurat_nfix(), and ziggurat_RNOR().

ziggurat_UNI()

static float CLHEP::RandGaussZiggurat::ziggurat_UNI ( HepRandomEngine *  anEngine )

inlinestaticprotected

Definition at line 114 of file RandGaussZiggurat.h.

{return float(anEngine->flat());}

Referenced by ziggurat_nfix().

Member Data Documentation

fe

CLHEP_THREAD_LOCAL float CLHEP::RandGaussZiggurat::fe

staticprotected

Definition at line 109 of file RandGaussZiggurat.h.

Referenced by ziggurat_init().

fn

CLHEP_THREAD_LOCAL float CLHEP::RandGaussZiggurat::fn

staticprotected

Definition at line 109 of file RandGaussZiggurat.h.

Referenced by ziggurat_init(), and ziggurat_nfix().

ke

CLHEP_THREAD_LOCAL unsigned long CLHEP::RandGaussZiggurat::ke

staticprotected

Definition at line 108 of file RandGaussZiggurat.h.

Referenced by ziggurat_init().

kn

CLHEP_THREAD_LOCAL unsigned long CLHEP::RandGaussZiggurat::kn

staticprotected

Definition at line 108 of file RandGaussZiggurat.h.

Referenced by ziggurat_init(), ziggurat_nfix(), and ziggurat_RNOR().

we

CLHEP_THREAD_LOCAL float CLHEP::RandGaussZiggurat::we

staticprotected

Definition at line 109 of file RandGaussZiggurat.h.

Referenced by ziggurat_init().

wn

CLHEP_THREAD_LOCAL float CLHEP::RandGaussZiggurat::wn

staticprotected

Definition at line 109 of file RandGaussZiggurat.h.

Referenced by ziggurat_init(), ziggurat_nfix(), and ziggurat_RNOR().

ziggurat_is_init

CLHEP_THREAD_LOCAL bool CLHEP::RandGaussZiggurat::ziggurat_is_init = false

staticprotected

Definition at line 111 of file RandGaussZiggurat.h.

Referenced by ziggurat_init(), ziggurat_nfix(), and ziggurat_RNOR().

---

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

• RandGaussZiggurat.h
• RandGaussZiggurat.cc