| Geant4 Cross Reference |
1 // 1 //
2 // ******************************************* 2 // ********************************************************************
3 // * License and Disclaimer 3 // * License and Disclaimer *
4 // * 4 // * *
5 // * The Geant4 software is copyright of th 5 // * The Geant4 software is copyright of the Copyright Holders of *
6 // * the Geant4 Collaboration. It is provided 6 // * the Geant4 Collaboration. It is provided under the terms and *
7 // * conditions of the Geant4 Software License 7 // * conditions of the Geant4 Software License, included in the file *
8 // * LICENSE and available at http://cern.ch/ 8 // * LICENSE and available at http://cern.ch/geant4/license . These *
9 // * include a list of copyright holders. 9 // * include a list of copyright holders. *
10 // * 10 // * *
11 // * Neither the authors of this software syst 11 // * Neither the authors of this software system, nor their employing *
12 // * institutes,nor the agencies providing fin 12 // * institutes,nor the agencies providing financial support for this *
13 // * work make any representation or warran 13 // * work make any representation or warranty, express or implied, *
14 // * regarding this software system or assum 14 // * regarding this software system or assume any liability for its *
15 // * use. Please see the license in the file 15 // * use. Please see the license in the file LICENSE and URL above *
16 // * for the full disclaimer and the limitatio 16 // * for the full disclaimer and the limitation of liability. *
17 // * 17 // * *
18 // * This code implementation is the result 18 // * This code implementation is the result of the scientific and *
19 // * technical work of the GEANT4 collaboratio 19 // * technical work of the GEANT4 collaboration. *
20 // * By using, copying, modifying or distri 20 // * By using, copying, modifying or distributing the software (or *
21 // * any work based on the software) you ag 21 // * any work based on the software) you agree to acknowledge its *
22 // * use in resulting scientific publicati 22 // * use in resulting scientific publications, and indicate your *
23 // * acceptance of all terms of the Geant4 Sof 23 // * acceptance of all terms of the Geant4 Software license. *
24 // ******************************************* 24 // ********************************************************************
25 // 25 //
26 // G4Timer << 26 //
>> 27 //
>> 28 //
>> 29 // ----------------------------------------------------------------------
>> 30 // Class G4Timer
27 // 31 //
28 // Class description: 32 // Class description:
29 // 33 //
30 // Class for timer objects, able to measure el 34 // Class for timer objects, able to measure elasped user/system process time.
31 // 35 //
32 // Note: Uses <sys/times.h> & <unistd.h> - POS 36 // Note: Uses <sys/times.h> & <unistd.h> - POSIX.1 defined
33 // If used, this header must be included 37 // If used, this header must be included in the source (.cc) file and it
34 // must be the first header file to be i 38 // must be the first header file to be included!
35 // 39 //
36 // Member functions: 40 // Member functions:
37 // 41 //
38 // G4Timer() 42 // G4Timer()
39 // Construct a timer object 43 // Construct a timer object
40 // Start() 44 // Start()
41 // Start timing 45 // Start timing
42 // Stop() 46 // Stop()
43 // Stop timing 47 // Stop timing
44 // G4bool IsValid() 48 // G4bool IsValid()
45 // Return true if have a valid time (ie star 49 // Return true if have a valid time (ie start() and stop() called)
46 // G4double GetRealElapsed() 50 // G4double GetRealElapsed()
47 // Return the elapsed real time between last 51 // Return the elapsed real time between last calling start() and stop()
48 // G4double GetSystemElapsed() 52 // G4double GetSystemElapsed()
49 // Return the elapsed system time between la 53 // Return the elapsed system time between last calling start() and stop()
50 // G4double GetUserElapsed() 54 // G4double GetUserElapsed()
51 // Return the elapsed user time between last 55 // Return the elapsed user time between last calling start() and stop()
52 // 56 //
53 // Operators: 57 // Operators:
54 // 58 //
55 // std::ostream& operator << (std::ostream& os 59 // std::ostream& operator << (std::ostream& os, const G4Timer& t);
56 // Print the elapsed real,system and usertim 60 // Print the elapsed real,system and usertimes on os. Prints **s for times
57 // if !IsValid 61 // if !IsValid
58 // 62 //
59 // Member data: 63 // Member data:
60 // 64 //
61 // G4bool fValidTimes 65 // G4bool fValidTimes
62 // True after start and stop have both been 66 // True after start and stop have both been called more than once and
63 // an equal number of times 67 // an equal number of times
64 // clock_t fStartRealTime,fEndRealTime 68 // clock_t fStartRealTime,fEndRealTime
65 // Real times (arbitrary time 0) 69 // Real times (arbitrary time 0)
66 // tms fStartTimes,fEndTimes 70 // tms fStartTimes,fEndTimes
67 // Timing structures (see times(2)) for star 71 // Timing structures (see times(2)) for start and end times
68 72
69 // Author: P.Kent, 21.08.95 - First implementa << 73 // History:
70 // Revision: G.Cosmo, 29.04.97 - Added timings << 74 // 23.08.96 P.Kent Updated to also computed real elapsed time
71 // ------------------------------------------- << 75 // 21.08.95 P.Kent
>> 76 // 29.04.97 G.Cosmo Added timings for Windows/NT
>> 77
72 #ifndef G4TIMER_HH 78 #ifndef G4TIMER_HH
73 #define G4TIMER_HH 1 << 79 #define G4TIMER_HH
74 80
75 #if !(defined(WIN32) || defined(__MINGW32__)) << 81 #ifndef WIN32
76 # include <sys/times.h> <<
77 # include <unistd.h> 82 # include <unistd.h>
>> 83 # include <sys/times.h>
78 #else 84 #else
79 # include <time.h> 85 # include <time.h>
80 # define _SC_CLK_TCK 1 << 86 # define _SC_CLK_TCK 1
81 87
82 extern "C" << 88 extern "C" {
83 { << 89 int sysconf(int);
84 int sysconf(int); << 90 };
85 }; << 91
86 << 92 // Structure returned by times()
87 // Structure returned by times() << 93
88 << 94 struct tms {
89 struct tms << 95 clock_t tms_utime; /* user time */
90 { << 96 clock_t tms_stime; /* system time */
91 clock_t tms_utime; /* user time */ << 97 clock_t tms_cutime; /* user time, children */
92 clock_t tms_stime; /* system time */ << 98 clock_t tms_cstime; /* system time, children */
93 clock_t tms_cutime; /* user time, children * << 99 };
94 clock_t tms_cstime; /* system time, children << 100
95 }; << 101 extern "C" {
96 << 102 extern clock_t times(struct tms *);
97 extern "C" << 103 };
98 { << 104 #endif /* WIN32 */
99 extern clock_t times(struct tms*); <<
100 }; <<
101 #endif /* WIN32 */ <<
102 105
103 #include "G4Types.hh" 106 #include "G4Types.hh"
104 #include "G4ios.hh" 107 #include "G4ios.hh"
105 108
106 #include <chrono> 109 #include <chrono>
107 110
108 class G4Timer 111 class G4Timer
109 { 112 {
110 public: << 113 typedef std::chrono::high_resolution_clock clock_type;
111 inline void Start(); << 114
112 inline void Stop(); << 115 public:
113 inline G4bool IsValid() const; << 116
114 inline const char* GetClockTime() const; << 117 G4Timer();
115 G4double GetRealElapsed() const; << 118
116 G4double GetSystemElapsed() const; << 119 inline void Start();
117 G4double GetUserElapsed() const; << 120 inline void Stop();
118 << 121 inline G4bool IsValid() const;
119 private: << 122 inline const char* GetClockTime() const;
120 G4bool fValidTimes{false}; << 123 G4double GetRealElapsed() const;
121 using clock_type = std::chrono::high_resolut << 124 G4double GetSystemElapsed() const;
122 std::chrono::time_point<clock_type> fStartRe << 125 G4double GetUserElapsed() const;
123 tms fStartTimes, fEndTimes; << 126
>> 127 private:
>> 128
>> 129 G4bool fValidTimes;
>> 130 std::chrono::time_point<clock_type> fStartRealTime, fEndRealTime;
>> 131 tms fStartTimes,fEndTimes;
124 }; 132 };
125 133
126 std::ostream& operator<<(std::ostream& os, con << 134 std::ostream& operator << (std::ostream& os, const G4Timer& t);
127 135
128 #include "G4Timer.icc" 136 #include "G4Timer.icc"
129 137
130 #endif 138 #endif
131 139