CLHEP::RandFlat Class Reference

#include <RandFlat.h>

Inheritance diagram for CLHEP::RandFlat:

Collaboration diagram for CLHEP::RandFlat:

Public Member Functions
	RandFlat (HepRandomEngine &anEngine)
	RandFlat (HepRandomEngine &anEngine, double width)
	RandFlat (HepRandomEngine &anEngine, double a, double b)
	RandFlat (HepRandomEngine *anEngine)
	RandFlat (HepRandomEngine *anEngine, double width)
	RandFlat (HepRandomEngine *anEngine, double a, double b)
virtual	~RandFlat ()
double	fire ()
double	fire (double width)
double	fire (double a, double b)
long	fireInt (long n)
long	fireInt (long a1, long n)
int	fireBit ()
void	fireArray (const int size, double *vect)
void	fireArray (const int size, double *vect, double lx, double dx)
double	operator() ()
double	operator() (double width)
double	operator() (double a, double b)
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 width)
static double	shoot (double a, double b)
static long	shootInt (long n)
static long	shootInt (long a1, long n)
static int	shootBit ()
static void	shootArray (const int size, double *vect)
static void	shootArray (const int size, double *vect, double lx, double dx)
static double	shoot (HepRandomEngine *anEngine)
static double	shoot (HepRandomEngine *anEngine, double width)
static double	shoot (HepRandomEngine *anEngine, double a, double b)
static long	shootInt (HepRandomEngine *anEngine, long n)
static long	shootInt (HepRandomEngine *anEngine, long a1, long n)
static int	shootBit (HepRandomEngine *)
static void	shootArray (HepRandomEngine *anEngine, const int size, double *vect)
static void	shootArray (HepRandomEngine *anEngine, const int size, double *vect, double lx, double dx)
static std::string	distributionName ()
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 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 ()

Private Member Functions
void	fireBits ()

Static Private Member Functions
static void	shootBits ()
static void	shootBits (HepRandomEngine *)

Private Attributes
unsigned long	randomInt
unsigned long	firstUnusedBit
std::shared_ptr< HepRandomEngine >	localEngine
double	defaultWidth
double	defaultA
double	defaultB

Static Private Attributes
static const unsigned long	MSB = 1ul<<RandFlat::MSBBits
static const int	MSBBits = 15
static CLHEP_THREAD_LOCAL unsigned long	staticRandomInt = 0
static CLHEP_THREAD_LOCAL unsigned long	staticFirstUnusedBit = 0

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 42 of file RandFlat.h.

Constructor & Destructor Documentation

RandFlat() [1/6]

CLHEP::RandFlat::RandFlat ( HepRandomEngine &  anEngine )

inline

Here is the caller graph for this function:

RandFlat() [2/6]

CLHEP::RandFlat::RandFlat ( HepRandomEngine &  anEngine, double  width  )

inline

RandFlat() [3/6]

CLHEP::RandFlat::RandFlat ( HepRandomEngine &  anEngine, double  a, double  b  )

inline

RandFlat() [4/6]

CLHEP::RandFlat::RandFlat ( HepRandomEngine *  anEngine )

inline

RandFlat() [5/6]

CLHEP::RandFlat::RandFlat ( HepRandomEngine *  anEngine, double  width  )

inline

RandFlat() [6/6]

CLHEP::RandFlat::RandFlat ( HepRandomEngine *  anEngine, double  a, double  b  )

inline

~RandFlat()

CLHEP::RandFlat::~RandFlat ( )

virtual

Definition at line 44 of file RandFlat.cc.

                    {
}

Member Function Documentation

distributionName()

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

inlinestatic

Definition at line 137 of file RandFlat.h.

{return "RandFlat";}  

Here is the call graph for this function:

Here is the caller graph for this function:

engine()

HepRandomEngine & CLHEP::RandFlat::engine ( )

virtual

Reimplemented from CLHEP::HepRandom.

Definition at line 42 of file RandFlat.cc.

{return *localEngine;}

fire() [1/3]

double CLHEP::RandFlat::fire ( )

inline

Here is the caller graph for this function:

fire() [2/3]

double CLHEP::RandFlat::fire ( double  width )

inline

fire() [3/3]

double CLHEP::RandFlat::fire ( double  a, double  b  )

inline

fireArray() [1/2]

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

Definition at line 86 of file RandFlat.cc.

{
   int i;

   for (i=0; i<size; ++i)
     vect[i] = fire( defaultA, defaultB );
}

Here is the call graph for this function:

fireArray() [2/2]

void CLHEP::RandFlat::fireArray	(	const int	size,
		double *	vect,
		double	lx,
		double	dx
	)

Definition at line 94 of file RandFlat.cc.

{
   int i;

   for (i=0; i<size; ++i)
     vect[i] = fire( lx, dx );
}

Here is the call graph for this function:

fireBit()

int CLHEP::RandFlat::fireBit ( )

inline

fireBits()

void CLHEP::RandFlat::fireBits ( )

inlineprivate

Here is the caller graph for this function:

fireInt() [1/2]

long CLHEP::RandFlat::fireInt ( long  n )

inline

fireInt() [2/2]

long CLHEP::RandFlat::fireInt ( long  a1, long  n  )

inline

get()

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

virtual

Reimplemented from CLHEP::HepRandom.

Definition at line 171 of file RandFlat.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", randomInt)) {
    std::vector<unsigned long> t(2);
    is >> randomInt >> firstUnusedBit;
    is >> defaultWidth >>t[0]>>t[1]; defaultWidth = DoubConv::longs2double(t); 
    is >> defaultA >> t[0] >> t[1]; defaultA = DoubConv::longs2double(t); 
    is >> defaultB >> t[0] >> t[1]; defaultB = DoubConv::longs2double(t); 
    if (!is) {
      is.clear(std::ios::badbit | is.rdstate());
      std::cerr << "\nRandFlat input failed"
         << "\nInput stream is probably mispositioned now." << std::endl;
      return is;
    }
    return is;
  }
  // is >> randomInt encompassed by possibleKeywordInput
  is >> firstUnusedBit;
  is >> defaultWidth >> defaultA >> defaultB;
  return is;
}

Here is the call graph for this function:

Here is the caller graph for this function:

name()

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

virtual

Reimplemented from CLHEP::HepRandom.

Definition at line 41 of file RandFlat.cc.

{return "RandFlat";}

Here is the caller graph for this function:

operator()() [1/3]

double CLHEP::RandFlat::operator() ( )

virtual

Reimplemented from CLHEP::HepRandom.

Definition at line 47 of file RandFlat.cc.

                            {
  return fire( defaultA, defaultB );
}

Here is the call graph for this function:

operator()() [2/3]

double CLHEP::RandFlat::operator()

(

double

width

)

Definition at line 51 of file RandFlat.cc.

                                      {
  return fire( w );
}

Here is the call graph for this function:

operator()() [3/3]

double CLHEP::RandFlat::operator()	(	double	a,
		double	b
	)

Definition at line 55 of file RandFlat.cc.

                                                {
  return fire( a, b );
}

Here is the call graph for this function:

put()

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

virtual

Reimplemented from CLHEP::HepRandom.

Definition at line 155 of file RandFlat.cc.

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

Here is the call graph for this function:

Here is the caller graph for this function:

restoreDistState()

std::istream & CLHEP::RandFlat::restoreDistState ( std::istream &  is )

static

Definition at line 211 of file RandFlat.cc.

                                                          {
  std::string inName;
  is >> inName;
  if (inName != distributionName()) {
    is.clear(std::ios::badbit | is.rdstate());
    std::cerr << "Mismatch when expecting to read static state of a "
              << distributionName() << " distribution\n"
          << "Name found was " << inName
          << "\nistream is left in the badbit state\n";
    return is;
  }
  std::string keyword;
  std::string c1;
  std::string c2;
  is >> keyword;
  if (keyword!="RANDFLAT") {
    is.clear(std::ios::badbit | is.rdstate());
    std::cerr << "Mismatch when expecting to read RANDFLAT bit cache info: "
              << keyword << "\n";
    return is;
  }
  is >> c1 >> staticRandomInt >> c2 >> staticFirstUnusedBit;
  return is;
} 

Here is the call graph for this function:

Here is the caller graph for this function:

restoreEngineStatus()

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

static

Definition at line 118 of file RandFlat.cc.

                                                          {

  // First restore the engine status just like the base class would do:
  getTheEngine()->restoreStatus( filename );

  // Now find the line describing the cached data:

  std::ifstream infile ( filename, std::ios::in );
  if (!infile) return;
  char inputword[] = "NO_KEYWORD    "; // leaves room for 14 characters plus \0
  while (true) {
    infile.width(13);
    infile >> inputword;
    if (strcmp(inputword,"RANDFLAT")==0) break;
    if (infile.eof()) break;
        // If the file ends without the RANDFLAT line, that means this
        // was a file produced by an earlier version of RandFlat.  We will
        // replicate the old behavior in that case:  staticFirstUnusedBit 
    // and staticRandomInt retain their existing values.
  }

  // Then read and use the caching info:

  if (strcmp(inputword,"RANDFLAT")==0) {
    char setword[40];   // the longest, staticFirstUnusedBit: has length 21
    infile.width(39);
    infile >> setword;
    // setword should be staticRandomInt:  
    infile >> staticRandomInt;
    infile.width(39);
    infile >> setword;
    // setword should be staticFirstUnusedBit: 
    infile >> staticFirstUnusedBit;
  }

} // restoreEngineStatus

Here is the call graph for this function:

Here is the caller graph for this function:

restoreFullState()

std::istream & CLHEP::RandFlat::restoreFullState ( std::istream &  is )

static

Definition at line 242 of file RandFlat.cc.

                                                          {
  HepRandom::restoreFullState(is);
  restoreDistState(is);
  return is;
}

Here is the call graph for this function:

Here is the caller graph for this function:

saveDistState()

std::ostream & CLHEP::RandFlat::saveDistState ( std::ostream &  os )

static

Definition at line 202 of file RandFlat.cc.

                                                       {
  os << distributionName() << "\n";
  int prec = os.precision(20);
  os << "RANDFLAT staticRandomInt: " << staticRandomInt 
     << "    staticFirstUnusedBit: " << staticFirstUnusedBit << "\n";
  os.precision(prec);
  return os;
}    

Here is the call graph for this function:

Here is the caller graph for this function:

saveEngineStatus()

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

static

Definition at line 103 of file RandFlat.cc.

                                                        {

  // First save the engine status just like the base class would do:
  getTheEngine()->saveStatus( filename );

  // Now append the cached random Int, and first unused bit:

  std::ofstream outfile ( filename, std::ios::app );

  outfile << "RANDFLAT staticRandomInt: " << staticRandomInt 
          << "    staticFirstUnusedBit: " << staticFirstUnusedBit << "\n";

} // saveEngineStatus

Here is the call graph for this function:

Here is the caller graph for this function:

saveFullState()

std::ostream & CLHEP::RandFlat::saveFullState ( std::ostream &  os )

static

Definition at line 236 of file RandFlat.cc.

                                                       {
  HepRandom::saveFullState(os);
  saveDistState(os);
  return os;
}

Here is the call graph for this function:

Here is the caller graph for this function:

shoot() [1/6]

double CLHEP::RandFlat::shoot ( )

static

Definition at line 59 of file RandFlat.cc.

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

Here is the call graph for this function:

Here is the caller graph for this function:

shoot() [2/6]

static double CLHEP::RandFlat::shoot ( double  width )

inlinestatic

shoot() [3/6]

static double CLHEP::RandFlat::shoot ( double  a, double  b  )

inlinestatic

shoot() [4/6]

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

inlinestatic

shoot() [5/6]

static double CLHEP::RandFlat::shoot ( HepRandomEngine *  anEngine, double  width  )

inlinestatic

shoot() [6/6]

static double CLHEP::RandFlat::shoot ( HepRandomEngine *  anEngine, double  a, double  b  )

inlinestatic

shootArray() [1/4]

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

static

Definition at line 63 of file RandFlat.cc.

                                                      {
  HepRandom::getTheEngine()->flatArray(size,vect);
}

Here is the call graph for this function:

shootArray() [2/4]

void CLHEP::RandFlat::shootArray ( const int  size, double *  vect, double  lx, double  dx  )

static

Definition at line 67 of file RandFlat.cc.

{
   int i;

   for (i=0; i<size; ++i)
     vect[i] = shoot(lx,dx);
}

Here is the call graph for this function:

shootArray() [3/4]

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

inlinestatic

shootArray() [4/4]

void CLHEP::RandFlat::shootArray ( HepRandomEngine *  anEngine, const int  size, double *  vect, double  lx, double  dx  )

static

Definition at line 76 of file RandFlat.cc.

{
   int i;

   for (i=0; i<size; ++i)
     vect[i] = shoot(anEngine,lx,dx);
}

Here is the call graph for this function:

shootBit() [1/2]

static int CLHEP::RandFlat::shootBit ( )

inlinestatic

shootBit() [2/2]

static int CLHEP::RandFlat::shootBit ( HepRandomEngine *  )

inlinestatic

shootBits() [1/2]

static void CLHEP::RandFlat::shootBits ( )

inlinestaticprivate

Here is the caller graph for this function:

shootBits() [2/2]

static void CLHEP::RandFlat::shootBits ( HepRandomEngine *  )

inlinestaticprivate

shootInt() [1/4]

static long CLHEP::RandFlat::shootInt ( long  n )

inlinestatic

shootInt() [2/4]

static long CLHEP::RandFlat::shootInt ( long  a1, long  n  )

inlinestatic

shootInt() [3/4]

static long CLHEP::RandFlat::shootInt ( HepRandomEngine *  anEngine, long  n  )

inlinestatic

shootInt() [4/4]

static long CLHEP::RandFlat::shootInt ( HepRandomEngine *  anEngine, long  a1, long  n  )

inlinestatic

Member Data Documentation

defaultA

double CLHEP::RandFlat::defaultA

private

Definition at line 202 of file RandFlat.h.

defaultB

double CLHEP::RandFlat::defaultB

private

Definition at line 203 of file RandFlat.h.

defaultWidth

double CLHEP::RandFlat::defaultWidth

private

Definition at line 201 of file RandFlat.h.

firstUnusedBit

unsigned long CLHEP::RandFlat::firstUnusedBit

private

Definition at line 196 of file RandFlat.h.

localEngine

std::shared_ptr<HepRandomEngine> CLHEP::RandFlat::localEngine

private

Definition at line 200 of file RandFlat.h.

MSB

const unsigned long CLHEP::RandFlat::MSB = 1ul<<RandFlat::MSBBits

staticprivate

Definition at line 191 of file RandFlat.h.

MSBBits

const int CLHEP::RandFlat::MSBBits = 15

staticprivate

Definition at line 192 of file RandFlat.h.

randomInt

unsigned long CLHEP::RandFlat::randomInt

private

Definition at line 195 of file RandFlat.h.

staticFirstUnusedBit

CLHEP_THREAD_LOCAL unsigned long CLHEP::RandFlat::staticFirstUnusedBit = 0

staticprivate

Definition at line 198 of file RandFlat.h.

staticRandomInt

CLHEP_THREAD_LOCAL unsigned long CLHEP::RandFlat::staticRandomInt = 0

staticprivate

Definition at line 197 of file RandFlat.h.

---

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

• RandFlat.h
• RandFlat.cc