| Geant4 Cross Reference |
1 // -*- C++ -*- 1 // -*- C++ -*-
2 // 2 //
3 // ------------------------------------------- 3 // -----------------------------------------------------------------------
4 // HEP Random 4 // HEP Random
5 // --- RandExponential 5 // --- RandExponential ---
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 exponen 10 // Class defining methods for shooting exponential distributed random
11 // values, given a mean (default mean = 1). 11 // values, given a mean (default mean = 1).
12 // Default mean is used for operator()(). 12 // Default mean is used for operator()().
13 13
14 // =========================================== 14 // =======================================================================
15 // Gabriele Cosmo - Created: 5th September 199 15 // Gabriele Cosmo - Created: 5th September 1995
16 // - Added methods to shoot arr 16 // - Added methods to shoot arrays: 28th July 1997
17 // J.Marraffino - Added default mean as attr 17 // J.Marraffino - Added default mean as attribute and
18 // operator() with mean: 16th 18 // operator() with mean: 16th Feb 1998
19 // M Fischler - put and get to/from strea 19 // M Fischler - put and get to/from streams 12/10/04
20 // =========================================== 20 // =======================================================================
21 21
22 #ifndef RandExponential_h 22 #ifndef RandExponential_h
23 #define RandExponential_h 1 23 #define RandExponential_h 1
24 24
25 #include "CLHEP/Random/Random.h" 25 #include "CLHEP/Random/Random.h"
26 #include "CLHEP/Utility/memory.h" 26 #include "CLHEP/Utility/memory.h"
27 27
28 namespace CLHEP { 28 namespace CLHEP {
29 29
30 /** 30 /**
31 * @author <Gabriele.Cosmo@cern.ch> 31 * @author <Gabriele.Cosmo@cern.ch>
32 * @ingroup random 32 * @ingroup random
33 */ 33 */
34 class RandExponential : public HepRandom { 34 class RandExponential : public HepRandom {
35 35
36 public: 36 public:
37 37
38 inline RandExponential ( HepRandomEngine& an 38 inline RandExponential ( HepRandomEngine& anEngine, double mean=1.0 );
39 inline RandExponential ( HepRandomEngine* an 39 inline RandExponential ( HepRandomEngine* anEngine, double mean=1.0 );
40 // These constructors should be used to inst 40 // These constructors should be used to instantiate a RandExponential
41 // distribution object defining a local engi 41 // distribution object defining a local engine for it.
42 // The static generator will be skipped usin 42 // The static generator will be skipped using the non-static methods
43 // defined below. 43 // defined below.
44 // If the engine is passed by pointer the co 44 // If the engine is passed by pointer the corresponding engine object
45 // will be deleted by the RandExponential de 45 // will be deleted by the RandExponential destructor.
46 // If the engine is passed by reference the 46 // If the engine is passed by reference the corresponding engine object
47 // will not be deleted by the RandExponentia 47 // will not be deleted by the RandExponential destructor.
48 48
49 virtual ~RandExponential(); 49 virtual ~RandExponential();
50 // Destructor 50 // Destructor
51 51
52 // Static methods to shoot random values usi 52 // Static methods to shoot random values using the static generator
53 53
54 static double shoot(); 54 static double shoot();
55 55
56 static double shoot( double mean ); 56 static double shoot( double mean );
57 57
58 static void shootArray ( const int size, do 58 static void shootArray ( const int size, double* vect,
59 double mean=1.0 ); 59 double mean=1.0 );
60 60
61 // Static methods to shoot random values us 61 // Static methods to shoot random values using a given engine
62 // by-passing the static generator. 62 // by-passing the static generator.
63 63
64 static inline double shoot( HepRandomEngine 64 static inline double shoot( HepRandomEngine* anEngine );
65 65
66 static inline double shoot( HepRandomEngine 66 static inline double shoot( HepRandomEngine* anEngine, double mean );
67 67
68 static void shootArray ( HepRandomEngine* a 68 static void shootArray ( HepRandomEngine* anEngine, const int size,
69 double* vect, doub 69 double* vect, double mean=1.0 );
70 70
71 // Methods using the localEngine to shoot r 71 // Methods using the localEngine to shoot random values, by-passing
72 // the static generator. 72 // the static generator.
73 73
74 inline double fire(); 74 inline double fire();
75 75
76 inline double fire( double mean ); 76 inline double fire( double mean );
77 77
78 void fireArray ( const int size, double* vec 78 void fireArray ( const int size, double* vect );
79 void fireArray ( const int size, double* vec 79 void fireArray ( const int size, double* vect, double mean );
80 80
81 double operator()(); 81 double operator()();
82 double operator()( double mean ); 82 double operator()( double mean );
83 83
84 // Save and restore to/from streams 84 // Save and restore to/from streams
85 85
86 std::ostream & put ( std::ostream & os ) con 86 std::ostream & put ( std::ostream & os ) const;
87 std::istream & get ( std::istream & is ); 87 std::istream & get ( std::istream & is );
88 88
89 std::string name() const; 89 std::string name() const;
90 HepRandomEngine & engine(); 90 HepRandomEngine & engine();
91 91
92 static std::string distributionName() {retur 92 static std::string distributionName() {return "RandExponential";}
93 // Provides the name of this distribution cl 93 // Provides the name of this distribution class
94 94
95 private: 95 private:
96 96
97 std::shared_ptr<HepRandomEngine> localEngine 97 std::shared_ptr<HepRandomEngine> localEngine;
98 double defaultMean; 98 double defaultMean;
99 99
100 }; 100 };
101 101
102 } // namespace CLHEP 102 } // namespace CLHEP
103 103
104 #include "CLHEP/Random/RandExponential.icc" 104 #include "CLHEP/Random/RandExponential.icc"
105 105
106 #endif 106 #endif
107 107