CLHEP::RandGeneral Class Reference

#include <RandGeneral.h>

Inheritance diagram for CLHEP::RandGeneral:

Public Member Functions
	RandGeneral (const double *aProbFunc, int theProbSize, int IntType=0)
	RandGeneral (HepRandomEngine &anEngine, const double *aProbFunc, int theProbSize, int IntType=0)
	RandGeneral (HepRandomEngine *anEngine, const double *aProbFunc, int theProbSize, int IntType=0)
virtual	~RandGeneral ()
double	shoot ()
void	shootArray (const int size, double *vect)
double	shoot (HepRandomEngine *anEngine)
void	shootArray (HepRandomEngine *anEngine, const int size, double *vect)
double	fire ()
void	fireArray (const int size, double *vect)
double	operator() ()
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 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

Definition at line 40 of file RandGeneral.h.

Constructor & Destructor Documentation

RandGeneral() [1/3]

CLHEP::RandGeneral::RandGeneral	(	const double *	aProbFunc,
		int	theProbSize,
		int	IntType = 0
	)

Definition at line 68 of file RandGeneral.cc.

  : HepRandom(),
    localEngine(HepRandom::getTheEngine(), do_nothing_deleter()),
    nBins(theProbSize), 
    InterpolationType(IntType)
{
  prepareTable(aProbFunc);
}

RandGeneral() [2/3]

CLHEP::RandGeneral::RandGeneral	(	HepRandomEngine &	anEngine,
		const double *	aProbFunc,
		int	theProbSize,
		int	IntType = 0
	)

Definition at line 79 of file RandGeneral.cc.

: HepRandom(),
  localEngine(&anEngine, do_nothing_deleter()), 
  nBins(theProbSize),
  InterpolationType(IntType)
{
  prepareTable(aProbFunc);
}

RandGeneral() [3/3]

CLHEP::RandGeneral::RandGeneral	(	HepRandomEngine *	anEngine,
		const double *	aProbFunc,
		int	theProbSize,
		int	IntType = 0
	)

Definition at line 91 of file RandGeneral.cc.

: HepRandom(),
  localEngine(anEngine), 
  nBins(theProbSize),
  InterpolationType(IntType)
{
  prepareTable(aProbFunc);
}

~RandGeneral()

CLHEP::RandGeneral::~RandGeneral ( )

virtual

Definition at line 176 of file RandGeneral.cc.

                          {
}

Member Function Documentation

distributionName()

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

inlinestatic

Definition at line 126 of file RandGeneral.h.

{return "RandGeneral";}  

engine()

HepRandomEngine & CLHEP::RandGeneral::engine ( )

virtual

Reimplemented from CLHEP::HepRandom.

Definition at line 61 of file RandGeneral.cc.

{return *localEngine;}

Referenced by checkRandGeneralDistribution().

fire()

double CLHEP::RandGeneral::fire

(

)

Referenced by fireArray(), and testRandGeneral().

fireArray()

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

Definition at line 242 of file RandGeneral.cc.

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

get()

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

virtual

Reimplemented from CLHEP::HepRandom.

Definition at line 278 of file RandGeneral.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", nBins)) {
    std::vector<unsigned long> t(2);
    is >> nBins >> oneOverNbins >> InterpolationType;
    is >> t[0] >> t[1]; oneOverNbins = DoubConv::longs2double(t); 
    theIntegralPdf.resize(nBins+1);
    for (unsigned int i=0; i<theIntegralPdf.size(); ++i) {
      is >> theIntegralPdf[i] >> t[0] >> t[1];
      theIntegralPdf[i] = DoubConv::longs2double(t); 
    }
    return is;
  }
  // is >> nBins encompassed by possibleKeywordInput
  is >> oneOverNbins >> InterpolationType;
  theIntegralPdf.resize(nBins+1);
  for (unsigned int i=0; i<theIntegralPdf.size(); ++i) is >> theIntegralPdf[i];
  return is;
}

name()

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

virtual

Reimplemented from CLHEP::HepRandom.

Definition at line 60 of file RandGeneral.cc.

{return "RandGeneral";}

Referenced by checkRandGeneralDistribution(), get(), and put().

operator()()

double CLHEP::RandGeneral::operator() ( )

virtual

Reimplemented from CLHEP::HepRandom.

put()

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

virtual

Reimplemented from CLHEP::HepRandom.

Definition at line 251 of file RandGeneral.cc.

                                                      {
  long pr=os.precision(20);
  std::vector<unsigned long> t(2);
  os << " " << name() << "\n";
  os << "Uvec" << "\n";
  os << nBins << " " << oneOverNbins << " " << InterpolationType << "\n";    
  t = DoubConv::dto2longs(oneOverNbins);
  os << t[0] << " " << t[1] << "\n";
  assert (static_cast<int>(theIntegralPdf.size())==nBins+1);
  for (unsigned int i=0; i<theIntegralPdf.size(); ++i) {
    t = DoubConv::dto2longs(theIntegralPdf[i]);
    os << theIntegralPdf[i] << " " << t[0] << " " << t[1] << "\n";
  }
  os.precision(pr);
  return os;
#ifdef REMOVED
  long pr=os.precision(20);
  os << " " << name() << "\n";
  os << nBins << " " << oneOverNbins << " " << InterpolationType << "\n";
  assert (static_cast<int>(theIntegralPdf.size())==nBins+1);
  for (unsigned int i=0; i<theIntegralPdf.size(); ++i) 
    os << theIntegralPdf[i] << "\n";
  os.precision(pr);
  return os;
#endif
}

shoot() [1/2]

double CLHEP::RandGeneral::shoot ( )

inline

Referenced by shootArray().

shoot() [2/2]

double CLHEP::RandGeneral::shoot

(

HepRandomEngine *

anEngine

)

shootArray() [1/2]

void CLHEP::RandGeneral::shootArray ( const int  size, double *  vect  )

inline

shootArray() [2/2]

void CLHEP::RandGeneral::shootArray	(	HepRandomEngine *	anEngine,
		const int	size,
		double *	vect
	)

Definition at line 232 of file RandGeneral.cc.

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

---

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

• RandGeneral.h
• RandGeneral.cc