CLHEP::RandExpZiggurat Class Reference

#include <RandExpZiggurat.h>

Inheritance diagram for CLHEP::RandExpZiggurat:

Public Member Functions
	RandExpZiggurat (HepRandomEngine &anEngine, double mean=1.0)
	RandExpZiggurat (HepRandomEngine *anEngine, double mean=1.0)
virtual	~RandExpZiggurat ()
float	fire ()
float	fire (float mean)
void	fireArray (const int size, float *vect)
void	fireArray (const int size, double *vect)
void	fireArray (const int size, float *vect, float mean)
void	fireArray (const int size, double *vect, double mean)
virtual double	operator() ()
float	operator() (float mean)
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::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)
static void	shootArray (const int size, float *vect, float mean=1.0)
static void	shootArray (const int size, double *vect, double mean=1.0)
static float	shoot (HepRandomEngine *anEngine)
static float	shoot (HepRandomEngine *anEngine, float mean)
static void	shootArray (HepRandomEngine *anEngine, const int size, float *vect, float mean=1.0)
static void	shootArray (HepRandomEngine *anEngine, const int size, double *vect, double mean=1.0)
static std::string	distributionName ()
static bool	ziggurat_init ()
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 unsigned long	ziggurat_SHR3 (HepRandomEngine *anEngine)
static float	ziggurat_UNI (HepRandomEngine *anEngine)
static float	ziggurat_REXP (HepRandomEngine *anEngine)
static float	ziggurat_efix (unsigned long jz, HepRandomEngine *anEngine)

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]

Detailed Description

Author

ATLAS

Definition at line 36 of file RandExpZiggurat.h.

Constructor & Destructor Documentation

RandExpZiggurat() [1/2]

CLHEP::RandExpZiggurat::RandExpZiggurat ( HepRandomEngine &  anEngine, double  mean = 1.0  )

inline

Definition at line 158 of file RandExpZiggurat.h.

                                                                                : localEngine(&anEngine, do_nothing_deleter()), defaultMean(mean) 
{
}

RandExpZiggurat() [2/2]

CLHEP::RandExpZiggurat::RandExpZiggurat ( HepRandomEngine *  anEngine, double  mean = 1.0  )

inline

Definition at line 162 of file RandExpZiggurat.h.

                                                                                : localEngine(anEngine), defaultMean(mean) 
{
}

~RandExpZiggurat()

CLHEP::RandExpZiggurat::~RandExpZiggurat ( )

virtual

Definition at line 19 of file RandExpZiggurat.cc.

                                  {
}

Member Function Documentation

distributionName()

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

inlinestatic

Definition at line 109 of file RandExpZiggurat.h.

{return "RandExpZiggurat";}  

engine()

HepRandomEngine & CLHEP::RandExpZiggurat::engine ( )

virtual

Reimplemented from CLHEP::HepRandom.

Definition at line 17 of file RandExpZiggurat.cc.

{return *localEngine;}

fire() [1/2]

float CLHEP::RandExpZiggurat::fire ( )

inline

Definition at line 85 of file RandExpZiggurat.h.

{return fire(float(defaultMean));}

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

fire() [2/2]

float CLHEP::RandExpZiggurat::fire ( float  mean )

inline

Definition at line 86 of file RandExpZiggurat.h.

{return ziggurat_REXP(localEngine.get())*mean;}

fireArray() [1/4]

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

Definition at line 56 of file RandExpZiggurat.cc.

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

fireArray() [2/4]

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

Definition at line 66 of file RandExpZiggurat.cc.

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

fireArray() [3/4]

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

Definition at line 51 of file RandExpZiggurat.cc.

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

fireArray() [4/4]

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

Definition at line 61 of file RandExpZiggurat.cc.

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

get()

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

virtual

Reimplemented from CLHEP::HepRandom.

Definition at line 89 of file RandExpZiggurat.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;
  }
  if (possibleKeywordInput(is, "Uvec", defaultMean)) {
    std::vector<unsigned long> t(2);
    is >> defaultMean >> t[0] >> t[1]; defaultMean = DoubConv::longs2double(t); 
    return is;
  }
  // is >> defaultMean encompassed by possibleKeywordInput
  return is;
}

name()

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

virtual

Reimplemented from CLHEP::HepRandom.

Definition at line 15 of file RandExpZiggurat.cc.

{return "RandExpZiggurat";}

Referenced by get(), and put().

operator()() [1/2]

double CLHEP::RandExpZiggurat::operator() ( )

virtual

Reimplemented from CLHEP::HepRandom.

Definition at line 26 of file RandExpZiggurat.cc.

{
  return fire( defaultMean );
}

operator()() [2/2]

float CLHEP::RandExpZiggurat::operator() ( float  mean )

inline

Definition at line 99 of file RandExpZiggurat.h.

{return fire( mean );}

put()

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

virtual

Reimplemented from CLHEP::HepRandom.

Definition at line 71 of file RandExpZiggurat.cc.

                                                          {
  int pr=os.precision(20);
  std::vector<unsigned long> t(2);
  os << " " << name() << "\n";
  os << "Uvec" << "\n";
  t = DoubConv::dto2longs(defaultMean);
  os << defaultMean << " " << t[0] << " " << t[1] << "\n";
  os.precision(pr);
  return os;
#ifdef REMOVED
  int pr=os.precision(20);
  os << " " << name() << "\n";
  os << defaultMean << "\n";
  os.precision(pr);
  return os;
#endif
}

shoot() [1/4]

static float CLHEP::RandExpZiggurat::shoot ( )

inlinestatic

Definition at line 56 of file RandExpZiggurat.h.

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

Referenced by shoot(), and shootArray().

shoot() [2/4]

static float CLHEP::RandExpZiggurat::shoot ( float  mean )

inlinestatic

Definition at line 57 of file RandExpZiggurat.h.

{return shoot(HepRandom::getTheEngine(),mean);}

Referenced by shoot().

shoot() [3/4]

static float CLHEP::RandExpZiggurat::shoot ( HepRandomEngine *  anEngine )

inlinestatic

Definition at line 70 of file RandExpZiggurat.h.

{return ziggurat_REXP(anEngine);}

shoot() [4/4]

static float CLHEP::RandExpZiggurat::shoot ( HepRandomEngine *  anEngine, float  mean  )

inlinestatic

Definition at line 71 of file RandExpZiggurat.h.

{return shoot(anEngine)*mean;}

Referenced by shoot().

shootArray() [1/4]

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

static

Definition at line 36 of file RandExpZiggurat.cc.

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

shootArray() [2/4]

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

static

Definition at line 31 of file RandExpZiggurat.cc.

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

shootArray() [3/4]

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

static

Definition at line 46 of file RandExpZiggurat.cc.

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

shootArray() [4/4]

void CLHEP::RandExpZiggurat::shootArray ( HepRandomEngine *  anEngine, const int  size, float *  vect, float  mean = 1.0  )

static

Definition at line 41 of file RandExpZiggurat.cc.

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

ziggurat_efix()

float CLHEP::RandExpZiggurat::ziggurat_efix ( unsigned long  jz, HepRandomEngine *  anEngine  )

staticprotected

Definition at line 110 of file RandExpZiggurat.cc.

{ 
  if(!ziggurat_is_init) ziggurat_init();
 
  unsigned long iz=jz&255;
  
  float x;
  for(;;)
  {  
    if(iz==0) return (7.69711-std::log(ziggurat_UNI(anEngine)));          /* iz==0 */
    x=jz*we[iz]; 
    if( fe[iz]+ziggurat_UNI(anEngine)*(fe[iz-1]-fe[iz]) < std::exp(-x) ) return (x);
 
    /* initiate, try to exit for(;;) loop */
    jz=ziggurat_SHR3(anEngine);
    iz=(jz&255);
    if(jz<ke[iz]) return (jz*we[iz]);
  }
}

Referenced by ziggurat_REXP().

ziggurat_init()

bool CLHEP::RandExpZiggurat::ziggurat_init ( )

static

Definition at line 130 of file RandExpZiggurat.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;
  return true;
}

Referenced by ziggurat_efix(), and ziggurat_REXP().

ziggurat_REXP()

static float CLHEP::RandExpZiggurat::ziggurat_REXP ( HepRandomEngine *  anEngine )

inlinestaticprotected

Definition at line 137 of file RandExpZiggurat.h.

                                                               {
    if(!ziggurat_is_init) ziggurat_init();
    unsigned long jz=ziggurat_SHR3(anEngine);
    unsigned long iz=jz&255;
    return (jz<ke[iz]) ? jz*we[iz] : ziggurat_efix(jz,anEngine);
  }

Referenced by fire(), and shoot().

ziggurat_SHR3()

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

inlinestaticprotected

Definition at line 135 of file RandExpZiggurat.h.

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

Referenced by ziggurat_efix(), and ziggurat_REXP().

ziggurat_UNI()

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

inlinestaticprotected

Definition at line 136 of file RandExpZiggurat.h.

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

Referenced by ziggurat_efix().

Member Data Documentation

fe

CLHEP_THREAD_LOCAL float CLHEP::RandExpZiggurat::fe

staticprotected

Definition at line 131 of file RandExpZiggurat.h.

Referenced by ziggurat_efix(), and ziggurat_init().

fn

CLHEP_THREAD_LOCAL float CLHEP::RandExpZiggurat::fn

staticprotected

Definition at line 131 of file RandExpZiggurat.h.

Referenced by ziggurat_init().

ke

CLHEP_THREAD_LOCAL unsigned long CLHEP::RandExpZiggurat::ke

staticprotected

Definition at line 130 of file RandExpZiggurat.h.

Referenced by ziggurat_efix(), ziggurat_init(), and ziggurat_REXP().

kn

CLHEP_THREAD_LOCAL unsigned long CLHEP::RandExpZiggurat::kn

staticprotected

Definition at line 130 of file RandExpZiggurat.h.

Referenced by ziggurat_init().

we

CLHEP_THREAD_LOCAL float CLHEP::RandExpZiggurat::we

staticprotected

Definition at line 131 of file RandExpZiggurat.h.

Referenced by ziggurat_efix(), ziggurat_init(), and ziggurat_REXP().

wn

CLHEP_THREAD_LOCAL float CLHEP::RandExpZiggurat::wn

staticprotected

Definition at line 131 of file RandExpZiggurat.h.

Referenced by ziggurat_init().

ziggurat_is_init

CLHEP_THREAD_LOCAL bool CLHEP::RandExpZiggurat::ziggurat_is_init = false

staticprotected

Definition at line 133 of file RandExpZiggurat.h.

Referenced by ziggurat_efix(), ziggurat_init(), and ziggurat_REXP().

---

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

• RandExpZiggurat.h
• RandExpZiggurat.cc