CLHEP::RandBinomial Class Reference

#include <RandBinomial.h>

Inheritance diagram for CLHEP::RandBinomial:

Public Member Functions
	RandBinomial (HepRandomEngine &anEngine, long n=1, double p=0.5)
	RandBinomial (HepRandomEngine *anEngine, long n=1, double p=0.5)
virtual	~RandBinomial ()
double	fire ()
double	fire (long n, double p)
void	fireArray (const int size, double *vect)
void	fireArray (const int size, double *vect, long n, double p)
double	operator() ()
double	operator() (long n, double p)
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 double	shoot ()
static double	shoot (long n, double p)
static void	shootArray (const int size, double *vect, long n=1, double p=0.5)
static double	shoot (HepRandomEngine *anEngine)
static double	shoot (HepRandomEngine *anEngine, long n, double p)
static void	shootArray (HepRandomEngine *anEngine, const int size, double *vect, long n=1, double p=0.5)
static std::string	distributionName ()
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 ()

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

Detailed Description

Author

Definition at line 37 of file RandBinomial.h.

Constructor & Destructor Documentation

RandBinomial() [1/2]

CLHEP::RandBinomial::RandBinomial ( HepRandomEngine &  anEngine, long  n = 1, double  p = 0.5  )

inline

RandBinomial() [2/2]

CLHEP::RandBinomial::RandBinomial ( HepRandomEngine *  anEngine, long  n = 1, double  p = 0.5  )

inline

~RandBinomial()

CLHEP::RandBinomial::~RandBinomial ( )

virtual

Definition at line 29 of file RandBinomial.cc.

                            {
}

Member Function Documentation

distributionName()

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

inlinestatic

Definition at line 99 of file RandBinomial.h.

{return "RandBinomial";}  

engine()

HepRandomEngine & CLHEP::RandBinomial::engine ( )

virtual

Reimplemented from CLHEP::HepRandom.

Definition at line 27 of file RandBinomial.cc.

{return *localEngine;}

fire() [1/2]

double CLHEP::RandBinomial::fire ( )

inline

Referenced by fireArray().

fire() [2/2]

double CLHEP::RandBinomial::fire	(	long	n,
		double	p
	)

Definition at line 42 of file RandBinomial.cc.

                                            {
  return genBinomial( localEngine.get(), n, p );
}

fireArray() [1/2]

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

Definition at line 61 of file RandBinomial.cc.

{
  for( double* v = vect; v != vect+size; ++v )
    *v = fire(defaultN,defaultP);
}

fireArray() [2/2]

void CLHEP::RandBinomial::fireArray	(	const int	size,
		double *	vect,
		long	n,
		double	p
	)

Definition at line 67 of file RandBinomial.cc.

{
  for( double* v = vect; v != vect+size; ++v )
    *v = fire(n,p);
}

get()

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

virtual

Reimplemented from CLHEP::HepRandom.

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

name()

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

virtual

Reimplemented from CLHEP::HepRandom.

Definition at line 26 of file RandBinomial.cc.

{return "RandBinomial";}

Referenced by get(), and put().

operator()() [1/2]

double CLHEP::RandBinomial::operator() ( )

inlinevirtual

Reimplemented from CLHEP::HepRandom.

operator()() [2/2]

double CLHEP::RandBinomial::operator() ( long  n, double  p  )

inline

put()

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

virtual

Reimplemented from CLHEP::HepRandom.

Definition at line 329 of file RandBinomial.cc.

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

shoot() [1/4]

static double CLHEP::RandBinomial::shoot ( )

inlinestatic

Referenced by shootArray().

shoot() [2/4]

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

inlinestatic

shoot() [3/4]

double CLHEP::RandBinomial::shoot ( HepRandomEngine *  anEngine, long  n, double  p  )

static

Definition at line 32 of file RandBinomial.cc.

                                                                     {
  return genBinomial( anEngine, n, p );
}

shoot() [4/4]

double CLHEP::RandBinomial::shoot ( long  n, double  p  )

static

Definition at line 37 of file RandBinomial.cc.

                                             {
  HepRandomEngine *anEngine = HepRandom::getTheEngine();
  return genBinomial( anEngine, n, p );
}

shootArray() [1/2]

void CLHEP::RandBinomial::shootArray ( const int  size, double *  vect, long  n = 1, double  p = 0.5  )

static

Definition at line 46 of file RandBinomial.cc.

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

shootArray() [2/2]

void CLHEP::RandBinomial::shootArray ( HepRandomEngine *  anEngine, const int  size, double *  vect, long  n = 1, double  p = 0.5  )

static

Definition at line 53 of file RandBinomial.cc.

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

---

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

• RandBinomial.h
• RandBinomial.cc