CLHEP::RandLandau Class Reference

#include <RandLandau.h>

Inheritance diagram for CLHEP::RandLandau:

Collaboration diagram for CLHEP::RandLandau:

Public Member Functions
	RandLandau (HepRandomEngine &anEngine)
	RandLandau (HepRandomEngine *anEngine)
virtual	~RandLandau ()
std::ostream &	put (std::ostream &os) const
std::istream &	get (std::istream &is)
double	fire ()
void	fireArray (const int size, double *vect)
double	operator() ()
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 void	shootArray (const int size, double *vect)
static double	shoot (HepRandomEngine *anotherEngine)
static void	shootArray (HepRandomEngine *anotherEngine, const int size, double *vect)
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 ()

Static Protected Member Functions
static double	transform (double r)
static double	transformSmall (double r)

Private Attributes
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 42 of file RandLandau.h.

Constructor & Destructor Documentation

RandLandau() [1/2]

CLHEP::RandLandau::RandLandau ( HepRandomEngine &  anEngine )

inline

RandLandau() [2/2]

CLHEP::RandLandau::RandLandau ( HepRandomEngine *  anEngine )

inline

~RandLandau()

CLHEP::RandLandau::~RandLandau ( )

virtual

Definition at line 30 of file RandLandau.cc.

                        {
}

Member Function Documentation

distributionName()

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

inlinestatic

Definition at line 99 of file RandLandau.h.

{return "RandLandau";}  

Here is the call graph for this function:

engine()

HepRandomEngine & CLHEP::RandLandau::engine ( )

virtual

Reimplemented from CLHEP::HepRandom.

Definition at line 28 of file RandLandau.cc.

{return *localEngine;}

fire()

double CLHEP::RandLandau::fire ( )

inline

Here is the caller graph for this function:

fireArray()

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

Definition at line 47 of file RandLandau.cc.

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

Here is the call graph for this function:

get()

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

virtual

Reimplemented from CLHEP::HepRandom.

Definition at line 371 of file RandLandau.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;
  }
  return is;
}

Here is the call graph for this function:

name()

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

virtual

Reimplemented from CLHEP::HepRandom.

Definition at line 27 of file RandLandau.cc.

{return "RandLandau";}

Here is the caller graph for this function:

operator()()

double CLHEP::RandLandau::operator() ( )

inlinevirtual

Reimplemented from CLHEP::HepRandom.

put()

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

virtual

Reimplemented from CLHEP::HepRandom.

Definition at line 364 of file RandLandau.cc.

                                                     {
  int pr=os.precision(20);
  os << " " << name() << "\n";
  os.precision(pr);
  return os;
}

Here is the call graph for this function:

shoot() [1/2]

static double CLHEP::RandLandau::shoot ( )

inlinestatic

Here is the caller graph for this function:

shoot() [2/2]

static double CLHEP::RandLandau::shoot ( HepRandomEngine *  anotherEngine )

inlinestatic

shootArray() [1/2]

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

static

Definition at line 33 of file RandLandau.cc.

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

Here is the call graph for this function:

shootArray() [2/2]

void CLHEP::RandLandau::shootArray ( HepRandomEngine *  anotherEngine, const int  size, double *  vect  )

static

Definition at line 40 of file RandLandau.cc.

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

Here is the call graph for this function:

transform()

double CLHEP::RandLandau::transform ( double  r )

staticprotected

Definition at line 286 of file RandLandau.cc.

                                      {

  double  u = r * TABLE_MULTIPLIER; 
  int index = int(u);
  double du = u - index;

  // du is scaled such that the we dont have to multiply by TABLE_INTERVAL
  // when interpolating.

  // Five cases:
  // A) Between .070 and .800 the function is so smooth, straight
  //    linear interpolation is adequate.
  // B) Between .007 and .070, and between .800 and .980, quadratic
  //    interpolation is used.  This requires the same 4 points as
  //    a cubic spline (thus we need .006 and .981 and .982) but
  //    the quadratic interpolation is accurate enough and quicker.
  // C) Below .007 an asymptotic expansion for low negative lambda 
  //    (involving two logs) is used; there is a pade-style correction 
  //    factor.
  // D) Above .980, a simple pade approximation is made (asymptotic to
  //    1/(1-r)), but...
  // E) the coefficients in that pade are different above r=.999.

  if ( index >= 70 && index <= 800 ) {      // (A)

    double f0 = inverseLandau [index];
    double f1 = inverseLandau [index+1];
    return f0 + du * (f1 - f0);

  } else if ( index >= 7 && index <= 980 ) {    // (B)

    double f_1 = inverseLandau [index-1];
    double f0  = inverseLandau [index];
    double f1  = inverseLandau [index+1];
    double f2  = inverseLandau [index+2];

    return f0 + du * (f1 - f0 - .25*(1-du)* (f2 -f1 - f0 + f_1) );

  } else if ( index < 7 ) {         // (C)

    const double n0 =  0.99858950;
    const double n1 = 34.5213058;   const double d1 = 34.1760202;
    const double n2 = 17.0854528;   const double d2 =  4.01244582;

    double logr = std::log(r);
    double x    = 1/logr;
    double x2   = x*x;

    double pade = (n0 + n1*x + n2*x2) / (1.0 + d1*x + d2*x2);

    return ( - std::log ( -.91893853 - logr ) -1 ) * pade;

  } else if ( index <= 999 ) {          // (D)

    const double n0 =    1.00060006;
    const double n1 =  263.991156;  const double d1 =  257.368075;
    const double n2 = 4373.20068;   const double d2 = 3414.48018;

    double x = 1-r;
    double x2   = x*x;

    return (n0 + n1*x + n2*x2) / (x * (1.0 + d1*x + d2*x2));

  } else {                  // (E)

    const double n0 =      1.00001538;
    const double n1 =   6075.14119; const double d1 =   6065.11919;
    const double n2 = 734266.409;   const double d2 = 694021.044;

    double x = 1-r;
    double x2   = x*x;

    return (n0 + n1*x + n2*x2) / (x * (1.0 + d1*x + d2*x2));

  }

} // transform()

Here is the caller graph for this function:

transformSmall()

static double CLHEP::RandLandau::transformSmall ( double  r )

staticprotected

Here is the caller graph for this function:

Member Data Documentation

localEngine

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

private

Definition at line 110 of file RandLandau.h.

---

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

• RandLandau.h
• RandLandau.cc