| Geant4 Cross Reference |
1 // -*- C++ -*- 1 // -*- C++ -*-
2 // 2 //
3 // ------------------------------------------- 3 // -----------------------------------------------------------------------
4 // HEP Random 4 // HEP Random
5 // --- RandGauss --- 5 // --- RandGauss ---
6 // class header file 6 // class header file
7 // ------------------------------------------- 7 // -----------------------------------------------------------------------
8 // This file is part of Geant4 (simulation too 8 // This file is part of Geant4 (simulation toolkit for HEP).
9 9
10 // Class defining methods for shooting gaussia 10 // Class defining methods for shooting gaussian distributed random values,
11 // given a mean (default=0) or specifying also 11 // given a mean (default=0) or specifying also a deviation (default=1).
12 // Gaussian random numbers are generated two a 12 // Gaussian random numbers are generated two at the time, so every
13 // other time shoot is called the number retur 13 // other time shoot is called the number returned is the one generated the
14 // time before. 14 // time before.
15 // Default values are used for operator()(). 15 // Default values are used for operator()().
16 16
17 // =========================================== 17 // =======================================================================
18 // Gabriele Cosmo - Created: 5th September 199 18 // Gabriele Cosmo - Created: 5th September 1995
19 // - Minor corrections: 31st Oc 19 // - Minor corrections: 31st October 1996
20 // - Added methods to shoot arr 20 // - Added methods to shoot arrays: 28th July 1997
21 // J.Marraffino - Added default arguments as 21 // J.Marraffino - Added default arguments as attributes and
22 // operator() with arguments. 22 // operator() with arguments. Introduced method normal()
23 // for computation in fire(): 23 // for computation in fire(): 16th Feb 1998
24 // Gabriele Cosmo - Relocated static data from 24 // Gabriele Cosmo - Relocated static data from HepRandom: 5th Jan 1999
25 // M Fischler - put and get to/from stream 25 // M Fischler - put and get to/from streams 12/8/04
26 // =========================================== 26 // =======================================================================
27 27
28 #ifndef RandGauss_h 28 #ifndef RandGauss_h
29 #define RandGauss_h 1 29 #define RandGauss_h 1
30 30
31 #include "CLHEP/Random/Random.h" 31 #include "CLHEP/Random/Random.h"
32 #include "CLHEP/Utility/memory.h" 32 #include "CLHEP/Utility/memory.h"
33 #include "CLHEP/Utility/thread_local.h" 33 #include "CLHEP/Utility/thread_local.h"
34 34
35 namespace CLHEP { 35 namespace CLHEP {
36 36
37 /** 37 /**
38 * @author 38 * @author
39 * @ingroup random 39 * @ingroup random
40 */ 40 */
41 class RandGauss : public HepRandom { 41 class RandGauss : public HepRandom {
42 42
43 public: 43 public:
44 44
45 inline RandGauss ( HepRandomEngine& anEngine 45 inline RandGauss ( HepRandomEngine& anEngine, double mean=0.0,
46 46 double stdDev=1.0 );
47 inline RandGauss ( HepRandomEngine* anEngine 47 inline RandGauss ( HepRandomEngine* anEngine, double mean=0.0,
48 48 double stdDev=1.0 );
49 // These constructors should be used to inst 49 // These constructors should be used to instantiate a RandGauss
50 // distribution object defining a local engi 50 // distribution object defining a local engine for it.
51 // The static generator will be skipped usin 51 // The static generator will be skipped using the non-static methods
52 // defined below. 52 // defined below.
53 // If the engine is passed by pointer the co 53 // If the engine is passed by pointer the corresponding engine object
54 // will be deleted by the RandGauss destruct 54 // will be deleted by the RandGauss destructor.
55 // If the engine is passed by reference the 55 // If the engine is passed by reference the corresponding engine object
56 // will not be deleted by the RandGauss dest 56 // will not be deleted by the RandGauss destructor.
57 57
58 virtual ~RandGauss(); 58 virtual ~RandGauss();
59 // Destructor 59 // Destructor
60 60
61 // Static methods to shoot random values usi 61 // Static methods to shoot random values using the static generator
62 62
63 static double shoot(); 63 static double shoot();
64 64
65 static inline double shoot( double mean, do 65 static inline double shoot( double mean, double stdDev );
66 66
67 static void shootArray ( const int size, do 67 static void shootArray ( const int size, double* vect,
68 double mean=0.0, d 68 double mean=0.0, double stdDev=1.0 );
69 69
70 // Static methods to shoot random values us 70 // Static methods to shoot random values using a given engine
71 // by-passing the static generator. 71 // by-passing the static generator.
72 72
73 static double shoot( HepRandomEngine* anEng 73 static double shoot( HepRandomEngine* anEngine );
74 74
75 static inline double shoot( HepRandomEngine 75 static inline double shoot( HepRandomEngine* anEngine,
76 double mean, 76 double mean, double stdDev );
77 77
78 static void shootArray ( HepRandomEngine* a 78 static void shootArray ( HepRandomEngine* anEngine, const int size,
79 double* vect, doub 79 double* vect, double mean=0.0,
80 double stdDev=1.0 80 double stdDev=1.0 );
81 81
82 // Methods using the localEngine to shoot r 82 // Methods using the localEngine to shoot random values, by-passing
83 // the static generator. 83 // the static generator.
84 84
85 double fire(); 85 double fire();
86 86
87 inline double fire( double mean, double stdD 87 inline double fire( double mean, double stdDev );
88 88
89 void fireArray ( const int size, double* vec 89 void fireArray ( const int size, double* vect);
90 void fireArray ( const int size, double* vec 90 void fireArray ( const int size, double* vect,
91 double mean, double stdDev 91 double mean, double stdDev );
92 92
93 virtual double operator()(); 93 virtual double operator()();
94 virtual double operator()( double mean, doub 94 virtual double operator()( double mean, double stdDev );
95 95
96 std::string name() const; 96 std::string name() const;
97 HepRandomEngine & engine(); 97 HepRandomEngine & engine();
98 98
99 static std::string distributionName() {retur 99 static std::string distributionName() {return "RandGauss";}
100 // Provides the name of this distribution cl 100 // Provides the name of this distribution class
101 101
102 // Save and restore to/from streams 102 // Save and restore to/from streams
103 103
104 std::ostream & put ( std::ostream & os ) con 104 std::ostream & put ( std::ostream & os ) const;
105 std::istream & get ( std::istream & is ); 105 std::istream & get ( std::istream & is );
106 106
107 // Methods setFlag(false) and setF(false) i 107 // Methods setFlag(false) and setF(false) if invoked in the client
108 // code before shoot/fire will force genera 108 // code before shoot/fire will force generation of a new couple of
109 // values. 109 // values.
110 110
111 static bool getFlag(); 111 static bool getFlag();
112 112
113 static void setFlag( bool val ); 113 static void setFlag( bool val );
114 114
115 bool getF() const {return set;} 115 bool getF() const {return set;}
116 116
117 void setF( bool val ) {set = val;} 117 void setF( bool val ) {set = val;}
118 118
119 // Methods overriding the base class static 119 // Methods overriding the base class static saveEngineStatus ones,
120 // by adding extra data so that save in one 120 // by adding extra data so that save in one program, then further gaussians,
121 // will produce the identical sequence to re 121 // will produce the identical sequence to restore in another program, then
122 // generating gaussian randoms there 122 // generating gaussian randoms there
123 123
124 static void saveEngineStatus( const char fil 124 static void saveEngineStatus( const char filename[] = "Config.conf" );
125 // Saves to file the current status of the c 125 // Saves to file the current status of the current engine.
126 126
127 static void restoreEngineStatus( const char 127 static void restoreEngineStatus( const char filename[] = "Config.conf" );
128 // Restores a saved status (if any) for the 128 // Restores a saved status (if any) for the current engine.
129 129
130 static std::ostream& saveFullState ( std::os 130 static std::ostream& saveFullState ( std::ostream & os );
131 // Saves to stream the state of the engine a 131 // Saves to stream the state of the engine and cached data.
132 132
133 static std::istream& restoreFullState ( std: 133 static std::istream& restoreFullState ( std::istream & is );
134 // Restores from stream the state of the eng 134 // Restores from stream the state of the engine and cached data.
135 135
136 static std::ostream& saveDistState ( std::os 136 static std::ostream& saveDistState ( std::ostream & os );
137 // Saves to stream the state of the cached d 137 // Saves to stream the state of the cached data.
138 138
139 static std::istream& restoreDistState ( std: 139 static std::istream& restoreDistState ( std::istream & is );
140 // Restores from stream the state of the cac 140 // Restores from stream the state of the cached data.
141 141
142 142
143 protected: 143 protected:
144 144
145 static double getVal(); 145 static double getVal();
146 146
147 static void setVal( double nextVal ); 147 static void setVal( double nextVal );
148 148
149 double normal(); 149 double normal();
150 150
151 double defaultMean; 151 double defaultMean;
152 double defaultStdDev; 152 double defaultStdDev;
153 153
154 std::shared_ptr<HepRandomEngine> localEngine 154 std::shared_ptr<HepRandomEngine> localEngine;
155 155
156 private: 156 private:
157 157
158 bool set; 158 bool set;
159 double nextGauss; 159 double nextGauss;
160 160
161 // static data 161 // static data
162 static CLHEP_THREAD_LOCAL bool set_st; 162 static CLHEP_THREAD_LOCAL bool set_st;
163 static CLHEP_THREAD_LOCAL double nextGauss_s 163 static CLHEP_THREAD_LOCAL double nextGauss_st;
164 164
165 }; 165 };
166 166
167 } // namespace CLHEP 167 } // namespace CLHEP
168 168
169 #include "CLHEP/Random/RandGauss.icc" 169 #include "CLHEP/Random/RandGauss.icc"
170 170
171 #endif 171 #endif
172 172