| Geant4 Cross Reference |
>> 1 // $Id:$
1 // -*- C++ -*- 2 // -*- C++ -*-
2 // 3 //
3 // ------------------------------------------- 4 // -----------------------------------------------------------------------
4 // HEP Random 5 // HEP Random
5 // --- RandGaussQ --- 6 // --- RandGaussQ ---
6 // class header file 7 // class header file
7 // ------------------------------------------- 8 // -----------------------------------------------------------------------
8 9
9 // Class defining methods RandGaussQ, which is 10 // Class defining methods RandGaussQ, which is derived from RandGauss.
10 // The user interface is identical; but RandGa 11 // The user interface is identical; but RandGaussQ is faster and a bit less
11 // accurate. 12 // accurate.
12 13
13 // =========================================== 14 // =======================================================================
14 // M. Fischler - Created: 24th Jan 2000 15 // M. Fischler - Created: 24th Jan 2000
15 // M Fischler - put and get to/from strea 16 // M Fischler - put and get to/from streams 12/10/04
16 // 17 //
17 // =========================================== 18 // =======================================================================
18 19
19 #ifndef RandGaussQ_h 20 #ifndef RandGaussQ_h
20 #define RandGaussQ_h 1 21 #define RandGaussQ_h 1
21 22
22 #include "CLHEP/Random/RandGauss.h" 23 #include "CLHEP/Random/RandGauss.h"
23 24
24 namespace CLHEP { 25 namespace CLHEP {
25 26
26 /** 27 /**
27 * @author 28 * @author
28 * @ingroup random 29 * @ingroup random
29 */ 30 */
30 class RandGaussQ : public RandGauss { 31 class RandGaussQ : public RandGauss {
31 32
32 public: 33 public:
33 34
34 inline RandGaussQ ( HepRandomEngine& anEngin 35 inline RandGaussQ ( HepRandomEngine& anEngine, double mean=0.0,
35 36 double stdDev=1.0 );
36 inline RandGaussQ ( HepRandomEngine* anEngin 37 inline RandGaussQ ( HepRandomEngine* anEngine, double mean=0.0,
37 38 double stdDev=1.0 );
38 // These constructors should be used to inst 39 // These constructors should be used to instantiate a RandGaussQ
39 // distribution object defining a local engi 40 // distribution object defining a local engine for it.
40 // The static generator will be skipped usin 41 // The static generator will be skipped using the non-static methods
41 // defined below. 42 // defined below.
42 // If the engine is passed by pointer the co 43 // If the engine is passed by pointer the corresponding engine object
43 // will be deleted by the RandGaussQ destruc 44 // will be deleted by the RandGaussQ destructor.
44 // If the engine is passed by reference the 45 // If the engine is passed by reference the corresponding engine object
45 // will not be deleted by the RandGaussQ des 46 // will not be deleted by the RandGaussQ destructor.
46 47
47 // Destructor 48 // Destructor
48 virtual ~RandGaussQ(); 49 virtual ~RandGaussQ();
49 50
50 // 51 //
51 // Methods to generate Gaussian-distributed 52 // Methods to generate Gaussian-distributed random deviates:
52 // 53 //
53 // If a fast good engine takes 1 usec, Ran 54 // If a fast good engine takes 1 usec, RandGauss::fire() adds 1 usec while
54 // RandGaussQ::fire() adds only .4 usec. 55 // RandGaussQ::fire() adds only .4 usec.
55 // 56 //
56 57
57 // Static methods to shoot random values usi 58 // Static methods to shoot random values using the static generator
58 59
59 static inline double shoot(); 60 static inline double shoot();
60 61
61 static inline double shoot( double mean, do 62 static inline double shoot( double mean, double stdDev );
62 63
63 static void shootArray ( const int size, do 64 static void shootArray ( const int size, double* vect,
64 double mean=0.0, d 65 double mean=0.0, double stdDev=1.0 );
65 66
66 // Static methods to shoot random values us 67 // Static methods to shoot random values using a given engine
67 // by-passing the static generator. 68 // by-passing the static generator.
68 69
69 static inline double shoot( HepRandomEngine 70 static inline double shoot( HepRandomEngine* anotherEngine );
70 71
71 static inline double shoot( HepRandomEngine 72 static inline double shoot( HepRandomEngine* anotherEngine,
72 double mean, 73 double mean, double stdDev );
73 74
74 75
75 static void shootArray ( HepRandomEngine* a 76 static void shootArray ( HepRandomEngine* anotherEngine,
76 const int size, 77 const int size,
77 double* vect, doub 78 double* vect, double mean=0.0,
78 double stdDev=1.0 79 double stdDev=1.0 );
79 80
80 // Instance methods using the localEngine t 81 // Instance methods using the localEngine to instead of the static
81 // generator, and the default mean and stdD 82 // generator, and the default mean and stdDev established at construction
82 83
83 inline double fire(); 84 inline double fire();
84 85
85 inline double fire ( double mean, double std 86 inline double fire ( double mean, double stdDev );
86 87
87 void fireArray ( const int size, double* ve 88 void fireArray ( const int size, double* vect);
88 void fireArray ( const int size, double* ve 89 void fireArray ( const int size, double* vect,
89 double mean, double stdDev 90 double mean, double stdDev );
90 91
91 virtual double operator()(); 92 virtual double operator()();
92 virtual double operator()( double mean, doub 93 virtual double operator()( double mean, double stdDev );
93 94
94 // Save and restore to/from streams 95 // Save and restore to/from streams
95 96
96 std::ostream & put ( std::ostream & os ) con 97 std::ostream & put ( std::ostream & os ) const;
97 std::istream & get ( std::istream & is ); 98 std::istream & get ( std::istream & is );
98 99
99 std::string name() const; 100 std::string name() const;
100 HepRandomEngine & engine(); 101 HepRandomEngine & engine();
101 102
102 static std::string distributionName() {retur 103 static std::string distributionName() {return "RandGaussQ";}
103 // Provides the name of this distribution cl 104 // Provides the name of this distribution class
104 105
105 106
106 protected: 107 protected:
107 108
108 static double transformQuick (double r); 109 static double transformQuick (double r);
109 static double transformSmall (double r); 110 static double transformSmall (double r);
110 111
111 private: 112 private:
112 113
113 // All the engine info, and the default mean 114 // All the engine info, and the default mean and sigma, are in the RandGauss
114 // base class. 115 // base class.
115 116
116 }; 117 };
117 118
118 } // namespace CLHEP 119 } // namespace CLHEP
119 120
120 #include "CLHEP/Random/RandGaussQ.icc" 121 #include "CLHEP/Random/RandGaussQ.icc"
121 122
122 #endif 123 #endif
123 124