Geant4 11.1.1
Toolkit for the simulation of the passage of particles through matter
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | List of all members
CLHEP::RandStudentT Class Reference

#include <RandStudentT.h>

+ Inheritance diagram for CLHEP::RandStudentT:

Public Member Functions

 RandStudentT (HepRandomEngine &anEngine, double a=1.0)
 
 RandStudentT (HepRandomEngine *anEngine, double a=1.0)
 
virtual ~RandStudentT ()
 
std::ostream & put (std::ostream &os) const
 
std::istream & get (std::istream &is)
 
double fire ()
 
double fire (double a)
 
void fireArray (const int size, double *vect)
 
void fireArray (const int size, double *vect, double a)
 
double operator() ()
 
double operator() (double a)
 
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 (double a)
 
static void shootArray (const int size, double *vect, double a=1.0)
 
static double shoot (HepRandomEngine *anEngine)
 
static double shoot (HepRandomEngine *anEngine, double a)
 
static void shootArray (HepRandomEngine *anEngine, const int size, double *vect, double a=1.0)
 
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 41 of file RandStudentT.h.

Constructor & Destructor Documentation

◆ RandStudentT() [1/2]

CLHEP::RandStudentT::RandStudentT ( HepRandomEngine &  anEngine,
double  a = 1.0 
)
inline

◆ RandStudentT() [2/2]

CLHEP::RandStudentT::RandStudentT ( HepRandomEngine *  anEngine,
double  a = 1.0 
)
inline

◆ ~RandStudentT()

CLHEP::RandStudentT::~RandStudentT ( )
virtual

Definition at line 33 of file RandStudentT.cc.

34{
35}

Member Function Documentation

◆ distributionName()

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

Definition at line 99 of file RandStudentT.h.

99{return "RandStudentT";}

◆ engine()

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

Reimplemented from CLHEP::HepRandom.

Definition at line 31 of file RandStudentT.cc.

31{return *localEngine;}

◆ fire() [1/2]

double CLHEP::RandStudentT::fire ( )
inline

Referenced by fireArray(), and operator()().

◆ fire() [2/2]

double CLHEP::RandStudentT::fire ( double  a)

Definition at line 101 of file RandStudentT.cc.

101 {
102
103 double u,v,w;
104
105 do
106 {
107 u = 2.0 * localEngine->flat() - 1.0;
108 v = 2.0 * localEngine->flat() - 1.0;
109 }
110 while ((w = u * u + v * v) > 1.0);
111
112 return(u * std::sqrt( a * ( std::exp(- 2.0 / a * std::log(w)) - 1.0) / w));
113}

◆ fireArray() [1/2]

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

Definition at line 115 of file RandStudentT.cc.

116{
117 for( double* v = vect; v != vect + size; ++v )
118 *v = fire(defaultA);
119}

◆ fireArray() [2/2]

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

Definition at line 121 of file RandStudentT.cc.

123{
124 for( double* v = vect; v != vect + size; ++v )
125 *v = fire(a);
126}

◆ get()

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

Reimplemented from CLHEP::HepRandom.

Definition at line 153 of file RandStudentT.cc.

153 {
154 std::string inName;
155 is >> inName;
156 if (inName != name()) {
157 is.clear(std::ios::badbit | is.rdstate());
158 std::cerr << "Mismatch when expecting to read state of a "
159 << name() << " distribution\n"
160 << "Name found was " << inName
161 << "\nistream is left in the badbit state\n";
162 return is;
163 }
164 if (possibleKeywordInput(is, "Uvec", defaultA)) {
165 std::vector<unsigned long> t(2);
166 is >> defaultA >> t[0] >> t[1]; defaultA = DoubConv::longs2double(t);
167 return is;
168 }
169 // is >> defaultA encompassed by possibleKeywordInput
170 return is;
171}
CLHEP::DoubConv::longs2double
static double longs2double(const std::vector< unsigned long > &v)
Definition: DoubConv.cc:110
CLHEP::RandStudentT::name
std::string name() const
Definition: RandStudentT.cc:30
CLHEP::possibleKeywordInput
bool possibleKeywordInput(IS &is, const std::string &key, T &t)
Definition: RandomEngine.h:166

◆ name()

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

Reimplemented from CLHEP::HepRandom.

Definition at line 30 of file RandStudentT.cc.

30{return "RandStudentT";}

Referenced by get(), and put().

◆ operator()() [1/2]

double CLHEP::RandStudentT::operator() ( )
virtual

Reimplemented from CLHEP::HepRandom.

Definition at line 37 of file RandStudentT.cc.

37 {
38 return fire( defaultA );
39}

◆ operator()() [2/2]

double CLHEP::RandStudentT::operator() ( double  a)

Definition at line 41 of file RandStudentT.cc.

41 {
42 return fire( a );
43}

◆ put()

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

Reimplemented from CLHEP::HepRandom.

Definition at line 142 of file RandStudentT.cc.

142 {
143 int pr=os.precision(20);
144 std::vector<unsigned long> t(2);
145 os << " " << name() << "\n";
146 os << "Uvec" << "\n";
147 t = DoubConv::dto2longs(defaultA);
148 os << defaultA << " " << t[0] << " " << t[1] << "\n";
149 os.precision(pr);
150 return os;
151}
CLHEP::DoubConv::dto2longs
static std::vector< unsigned long > dto2longs(double d)
Definition: DoubConv.cc:94

◆ shoot() [1/4]

static double CLHEP::RandStudentT::shoot ( )
inlinestatic

Referenced by shootArray().

◆ shoot() [2/4]

double CLHEP::RandStudentT::shoot ( double  a)
static

Definition at line 45 of file RandStudentT.cc.

45 {
46/******************************************************************
47 * *
48 * Student-t Distribution - Polar Method *
49 * *
50 ******************************************************************
51 * *
52 * The polar method of Box/Muller for generating Normal variates *
53 * is adapted to the Student-t distribution. The two generated *
54 * variates are not independent and the expected no. of uniforms *
55 * per variate is 2.5464. *
56 * *
57 ******************************************************************
58 * *
59 * FUNCTION : - tpol samples a random number from the *
60 * Student-t distribution with parameter a > 0. *
61 * REFERENCE : - R.W. Bailey (1994): Polar generation of random *
62 * variates with the t-distribution, Mathematics *
63 * of Computation 62, 779-781. *
64 * SUBPROGRAM : - ... (0,1)-Uniform generator *
65 * *
66 * *
67 * Implemented by F. Niederl, 1994 *
68 ******************************************************************/
69
70 double u,v,w;
71
72// Check for valid input value
73
74 if( a < 0.0) return (DBL_MAX);
75
76 do
77 {
78 u = 2.0 * HepRandom::getTheEngine()->flat() - 1.0;
79 v = 2.0 * HepRandom::getTheEngine()->flat() - 1.0;
80 }
81 while ((w = u * u + v * v) > 1.0);
82
83 return(u * std::sqrt( a * ( std::exp(- 2.0 / a * std::log(w)) - 1.0) / w));
84}
CLHEP::HepRandomEngine::flat
virtual double flat()=0
CLHEP::HepRandom::getTheEngine
static HepRandomEngine * getTheEngine()
Definition: Random.cc:268
DBL_MAX
#define DBL_MAX
Definition: templates.hh:62

◆ shoot() [3/4]

static double CLHEP::RandStudentT::shoot ( HepRandomEngine *  anEngine)
inlinestatic

◆ shoot() [4/4]

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

Definition at line 128 of file RandStudentT.cc.

128 {
129
130 double u,v,w;
131
132 do
133 {
134 u = 2.0 * anEngine->flat() - 1.0;
135 v = 2.0 * anEngine->flat() - 1.0;
136 }
137 while ((w = u * u + v * v) > 1.0);
138
139 return(u * std::sqrt( a * ( std::exp(- 2.0 / a * std::log(w)) - 1.0) / w));
140}

◆ shootArray() [1/2]

void CLHEP::RandStudentT::shootArray ( const int  size,
double *  vect,
double  a = 1.0 
)
static

Definition at line 86 of file RandStudentT.cc.

88{
89 for( double* v = vect; v != vect + size; ++v )
90 *v = shoot(a);
91}
CLHEP::RandStudentT::shoot
static double shoot()

◆ shootArray() [2/2]

void CLHEP::RandStudentT::shootArray ( HepRandomEngine *  anEngine,
const int  size,
double *  vect,
double  a = 1.0 
)
static

Definition at line 93 of file RandStudentT.cc.

96{
97 for( double* v = vect; v != vect + size; ++v )
98 *v = shoot(anEngine,a);
99}
The documentation for this class was generated from the following files: