CLHEP::RandExponential Class Reference

#include <RandExponential.h>

Inheritance diagram for CLHEP::RandExponential:

Public Member Functions
	RandExponential (HepRandomEngine &anEngine, double mean=1.0)
	RandExponential (HepRandomEngine *anEngine, double mean=1.0)
virtual	~RandExponential ()
double	fire ()
double	fire (double mean)
void	fireArray (const int size, double *vect)
void	fireArray (const int size, double *vect, double mean)
double	operator() ()
double	operator() (double 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)

Static Public Member Functions
static double	shoot ()
static double	shoot (double mean)
static void	shootArray (const int size, double *vect, double mean=1.0)
static double	shoot (HepRandomEngine *anEngine)
static double	shoot (HepRandomEngine *anEngine, double mean)
static void	shootArray (HepRandomEngine *anEngine, const int size, double *vect, double mean=1.0)
static std::string	distributionName ()
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 ()

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

Detailed Description

Author

Gabri.nosp@m.ele..nosp@m.Cosmo.nosp@m.@cer.nosp@m.n.ch

Definition at line 34 of file RandExponential.h.

Constructor & Destructor Documentation

RandExponential() [1/2]

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

inline

RandExponential() [2/2]

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

inline

~RandExponential()

CLHEP::RandExponential::~RandExponential ( )

virtual

Definition at line 33 of file RandExponential.cc.

                                  {
}

Member Function Documentation

distributionName()

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

inlinestatic

Definition at line 92 of file RandExponential.h.

{return "RandExponential";}  

engine()

HepRandomEngine & CLHEP::RandExponential::engine ( )

virtual

Reimplemented from CLHEP::HepRandom.

Definition at line 31 of file RandExponential.cc.

{return *localEngine;}

fire() [1/2]

double CLHEP::RandExponential::fire ( )

inline

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

fire() [2/2]

double CLHEP::RandExponential::fire ( double mean )

inline

fireArray() [1/2]

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

Definition at line 66 of file RandExponential.cc.

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

fireArray() [2/2]

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

Definition at line 72 of file RandExponential.cc.

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

get()

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

virtual

Reimplemented from CLHEP::HepRandom.

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

virtual

Reimplemented from CLHEP::HepRandom.

Definition at line 30 of file RandExponential.cc.

{return "RandExponential";}

Referenced by get(), and put().

operator()() [1/2]

double CLHEP::RandExponential::operator() ( )

virtual

Reimplemented from CLHEP::HepRandom.

Definition at line 36 of file RandExponential.cc.

                                   {
  return fire( defaultMean );
}

operator()() [2/2]

double CLHEP::RandExponential::operator()

(

double

mean

)

Definition at line 40 of file RandExponential.cc.

                                                {
  return fire( mean );
}

put()

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

virtual

Reimplemented from CLHEP::HepRandom.

Definition at line 79 of file RandExponential.cc.

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

shoot() [1/4]

double CLHEP::RandExponential::shoot ( )

static

Definition at line 44 of file RandExponential.cc.

                              {
  return -std::log(HepRandom::getTheEngine()->flat());
}

Referenced by shootArray(), and shootArray().

shoot() [2/4]

double CLHEP::RandExponential::shoot ( double mean )

static

Definition at line 48 of file RandExponential.cc.

                                         {
  return -std::log(HepRandom::getTheEngine()->flat())*mean;
}

shoot() [3/4]

static double CLHEP::RandExponential::shoot ( HepRandomEngine * anEngine )

inlinestatic

shoot() [4/4]

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

inlinestatic

shootArray() [1/2]

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

static

Definition at line 52 of file RandExponential.cc.

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

shootArray() [2/2]

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

static

Definition at line 59 of file RandExponential.cc.

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

---

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

• RandExponential.h
• RandExponential.cc