| 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 // $Id$
>> 28 //
>> 29 //
>> 30 // ----------------------------------------------------------------------
>> 31 // Class G4Timer
27 // 32 //
28 // Class description: 33 // Class description:
29 // 34 //
30 // Class for timer objects, able to measure el 35 // Class for timer objects, able to measure elasped user/system process time.
31 // 36 //
32 // Note: Uses <sys/times.h> & <unistd.h> - POS 37 // Note: Uses <sys/times.h> & <unistd.h> - POSIX.1 defined
33 // If used, this header must be included 38 // If used, this header must be included in the source (.cc) file and it
34 // must be the first header file to be i 39 // must be the first header file to be included!
35 // 40 //
36 // Member functions: 41 // Member functions:
37 // 42 //
38 // G4Timer() 43 // G4Timer()
39 // Construct a timer object 44 // Construct a timer object
40 // Start() 45 // Start()
41 // Start timing 46 // Start timing
42 // Stop() 47 // Stop()
43 // Stop timing 48 // Stop timing
44 // G4bool IsValid() 49 // G4bool IsValid()
45 // Return true if have a valid time (ie star 50 // Return true if have a valid time (ie start() and stop() called)
46 // G4double GetRealElapsed() 51 // G4double GetRealElapsed()
47 // Return the elapsed real time between last 52 // Return the elapsed real time between last calling start() and stop()
48 // G4double GetSystemElapsed() 53 // G4double GetSystemElapsed()
49 // Return the elapsed system time between la 54 // Return the elapsed system time between last calling start() and stop()
50 // G4double GetUserElapsed() 55 // G4double GetUserElapsed()
51 // Return the elapsed user time between last 56 // Return the elapsed user time between last calling start() and stop()
52 // 57 //
53 // Operators: 58 // Operators:
54 // 59 //
55 // std::ostream& operator << (std::ostream& os 60 // std::ostream& operator << (std::ostream& os, const G4Timer& t);
56 // Print the elapsed real,system and usertim 61 // Print the elapsed real,system and usertimes on os. Prints **s for times
57 // if !IsValid 62 // if !IsValid
58 // 63 //
59 // Member data: 64 // Member data:
60 // 65 //
61 // G4bool fValidTimes 66 // G4bool fValidTimes
62 // True after start and stop have both been 67 // True after start and stop have both been called more than once and
63 // an equal number of times 68 // an equal number of times
64 // clock_t fStartRealTime,fEndRealTime 69 // clock_t fStartRealTime,fEndRealTime
65 // Real times (arbitrary time 0) 70 // Real times (arbitrary time 0)
66 // tms fStartTimes,fEndTimes 71 // tms fStartTimes,fEndTimes
67 // Timing structures (see times(2)) for star 72 // Timing structures (see times(2)) for start and end times
68 73
69 // Author: P.Kent, 21.08.95 - First implementa << 74 // History:
70 // Revision: G.Cosmo, 29.04.97 - Added timings << 75 // 23.08.96 P.Kent Updated to also computed real elapsed time
71 // ------------------------------------------- << 76 // 21.08.95 P.Kent
>> 77 // 29.04.97 G.Cosmo Added timings for Windows/NT
>> 78
72 #ifndef G4TIMER_HH 79 #ifndef G4TIMER_HH
73 #define G4TIMER_HH 1 << 80 #define G4TIMER_HH
74 81
75 #if !(defined(WIN32) || defined(__MINGW32__)) << 82 #ifndef WIN32
76 # include <sys/times.h> <<
77 # include <unistd.h> 83 # include <unistd.h>
>> 84 # include <sys/times.h>
78 #else 85 #else
79 # include <time.h> 86 # include <time.h>
80 # define _SC_CLK_TCK 1 << 87 # define _SC_CLK_TCK 1
81 <<
82 extern "C" <<
83 { <<
84 int sysconf(int); <<
85 }; <<
86 <<
87 // Structure returned by times() <<
88 88
89 struct tms << 89 extern "C" {
90 { << 90 int sysconf(int);
91 clock_t tms_utime; /* user time */ << 91 };
92 clock_t tms_stime; /* system time */ << 92
93 clock_t tms_cutime; /* user time, children * << 93 // Structure returned by times()
94 clock_t tms_cstime; /* system time, children << 94
95 }; << 95 struct tms {
96 << 96 clock_t tms_utime; /* user time */
97 extern "C" << 97 clock_t tms_stime; /* system time */
98 { << 98 clock_t tms_cutime; /* user time, children */
99 extern clock_t times(struct tms*); << 99 clock_t tms_cstime; /* system time, children */
100 }; << 100 };
101 #endif /* WIN32 */ << 101
>> 102 extern "C" {
>> 103 extern clock_t times(struct tms *);
>> 104 };
>> 105 #endif /* WIN32 */
102 106
103 #include "G4Types.hh" 107 #include "G4Types.hh"
104 #include "G4ios.hh" 108 #include "G4ios.hh"
105 109
106 #include <chrono> <<
107 <<
108 class G4Timer 110 class G4Timer
109 { 111 {
110 public: << 112 public:
111 inline void Start(); << 113
112 inline void Stop(); << 114 G4Timer();
113 inline G4bool IsValid() const; << 115
114 inline const char* GetClockTime() const; << 116 inline void Start();
115 G4double GetRealElapsed() const; << 117 inline void Stop();
116 G4double GetSystemElapsed() const; << 118 inline G4bool IsValid() const;
117 G4double GetUserElapsed() const; << 119 inline const char* GetClockTime() const;
118 << 120 G4double GetRealElapsed() const;
119 private: << 121 G4double GetSystemElapsed() const;
120 G4bool fValidTimes{false}; << 122 G4double GetUserElapsed() const;
121 using clock_type = std::chrono::high_resolut << 123
122 std::chrono::time_point<clock_type> fStartRe << 124 private:
123 tms fStartTimes, fEndTimes; << 125
>> 126 G4bool fValidTimes;
>> 127 clock_t fStartRealTime,fEndRealTime;
>> 128 tms fStartTimes,fEndTimes;
124 }; 129 };
125 130
126 std::ostream& operator<<(std::ostream& os, con << 131 std::ostream& operator << (std::ostream& os, const G4Timer& t);
127 132
128 #include "G4Timer.icc" 133 #include "G4Timer.icc"
>> 134
>> 135 #define times ostimes
129 136
130 #endif 137 #endif
131 138