CLHEP 2.4.7.1
C++ Class Library for High Energy Physics
Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
CLHEP::RandGauss Class Reference

#include <CLHEP/Random/RandGauss.h>

Inheritance diagram for CLHEP::RandGauss:
CLHEP::HepRandom CLHEP::RandGaussQ CLHEP::RandGaussT CLHEP::RandGaussZiggurat

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 43 of file RandGauss.h.

Constructor & Destructor Documentation

◆ RandGauss() [1/2]

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

Definition at line 17 of file RandGauss.icc.

◆ RandGauss() [2/2]

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

Definition at line 22 of file RandGauss.icc.

◆ ~RandGauss()

virtual CLHEP::RandGauss::~RandGauss ( )
virtual

Member Function Documentation

◆ distributionName()

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

Definition at line 101 of file RandGauss.h.

◆ engine()

HepRandomEngine & CLHEP::RandGauss::engine ( )
virtual

Reimplemented from CLHEP::HepRandom.

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

◆ fire() [1/2]

double CLHEP::RandGauss::fire ( )
inline

Definition at line 36 of file RandGauss.icc.

References defaultMean, defaultStdDev, and normal().

◆ fire() [2/2]

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

Definition at line 40 of file RandGauss.icc.

References normal().

◆ fireArray() [1/2]

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

◆ fireArray() [2/2]

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

◆ get()

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

Reimplemented from CLHEP::HepRandom.

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

◆ getF()

bool CLHEP::RandGauss::getF ( ) const
inline

Definition at line 117 of file RandGauss.h.

◆ getFlag()

static bool CLHEP::RandGauss::getFlag ( )
static

◆ getVal()

static double CLHEP::RandGauss::getVal ( )
staticprotected

◆ name()

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

Reimplemented from CLHEP::HepRandom.

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

◆ normal()

double CLHEP::RandGauss::normal ( )
protected

Referenced by fire(), and fire().

◆ operator()() [1/2]

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

Reimplemented from CLHEP::HepRandom.

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

◆ operator()() [2/2]

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

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

◆ put()

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

Reimplemented from CLHEP::HepRandom.

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

◆ restoreDistState()

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

◆ restoreEngineStatus()

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

◆ restoreFullState()

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

◆ saveDistState()

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

◆ saveEngineStatus()

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

◆ saveFullState()

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

◆ setF()

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

Definition at line 119 of file RandGauss.h.

◆ setFlag()

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

◆ setVal()

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

◆ shoot() [1/4]

static double CLHEP::RandGauss::shoot ( )
static

Referenced by shoot(), and shoot().

◆ shoot() [2/4]

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

Definition at line 27 of file RandGauss.icc.

References shoot().

◆ shoot() [3/4]

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

◆ shoot() [4/4]

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

Definition at line 31 of file RandGauss.icc.

References shoot().

◆ shootArray() [1/2]

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

◆ shootArray() [2/2]

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

Member Data Documentation

◆ defaultMean

double CLHEP::RandGauss::defaultMean
protected

Definition at line 153 of file RandGauss.h.

Referenced by fire(), CLHEP::RandGaussQ::fire(), CLHEP::RandGaussT::fire(), and CLHEP::RandGaussZiggurat::fire().

◆ defaultStdDev

double CLHEP::RandGauss::defaultStdDev
protected

Definition at line 154 of file RandGauss.h.

Referenced by fire(), CLHEP::RandGaussQ::fire(), CLHEP::RandGaussT::fire(), and CLHEP::RandGaussZiggurat::fire().

◆ localEngine

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

Definition at line 156 of file RandGauss.h.

Referenced by CLHEP::RandGaussQ::fire(), CLHEP::RandGaussT::fire(), CLHEP::RandGaussZiggurat::fire(), CLHEP::RandGaussQ::fire(), CLHEP::RandGaussT::fire(), and CLHEP::RandGaussZiggurat::fire().

The documentation for this class was generated from the following files:
Generated by doxygen 1.9.8