Nektar++
Timer.h
Go to the documentation of this file.
1 ///////////////////////////////////////////////////////////////////////////////
2 //
3 // File: Timer.h
4 //
5 // For more information, please see: http://www.nektar.info
6 //
7 // The MIT License
8 //
9 // Copyright (c) 2006 Scientific Computing and Imaging Institute,
10 // University of Utah (USA) and Department of Aeronautics, Imperial
11 // College London (UK).
12 //
13 // License for the specific language governing rights and limitations under
14 // Permission is hereby granted, free of charge, to any person obtaining a
15 // copy of this software and associated documentation files (the "Software"),
16 // to deal in the Software without restriction, including without limitation
17 // the rights to use, copy, modify, merge, publish, distribute, sublicense,
18 // and/or sell copies of the Software, and to permit persons to whom the
19 // Software is furnished to do so, subject to the following conditions:
20 //
21 // The above copyright notice and this permission notice shall be included
22 // in all copies or substantial portions of the Software.
23 //
24 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
25 // OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
26 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
27 // THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
28 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
29 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
30 // DEALINGS IN THE SOFTWARE.
31 //
32 // Description: Time getting class
33 //
34 ///////////////////////////////////////////////////////////////////////////////
35 
36 
37 #ifndef NEKTAR_LIB_UTILITIES_BASIC_UTILS_TIMER_H
38 #define NEKTAR_LIB_UTILITIES_BASIC_UTILS_TIMER_H
39 
40 #ifdef _WIN32
41 #include <windows.h>
42 #else
43 #include <sys/time.h>
44 #include <time.h>
45 #endif
46 
49 
50 namespace Nektar
51 {
52  class Timer
53  {
54  public:
55  #ifdef _WIN32
56  typedef LARGE_INTEGER CounterType;
57  #elif defined(__APPLE__)
58  typedef timeval CounterType;
59  #else
60  typedef timespec CounterType;
61  #endif
62 
63  public:
66 
69  LIB_UTILITIES_EXPORT CounterType Elapsed();
70 
71  /// \brief Returns amount of seconds per iteration in
72  /// a test with n iterations.
74 
75  private:
76  Timer(const Timer& rhs);
77  Timer& operator=(const Timer& rhs);
78 
79  CounterType m_start;
80  CounterType m_end;
81  CounterType m_resolution;
82  };
83 }
84 
85 #endif //NEKTAR_LIB_UTILITIES_BASIC_UTILS_TIMER_H
CounterType m_start
Definition: Timer.h:79
CounterType m_end
Definition: Timer.h:80
Timer & operator=(const Timer &rhs)
void Stop()
Definition: Timer.cpp:62
#define LIB_UTILITIES_EXPORT
timespec CounterType
Definition: Timer.h:60
double NekDouble
CounterType Elapsed()
Definition: Timer.cpp:73
CounterType m_resolution
Definition: Timer.h:81
void Start()
Definition: Timer.cpp:51
NekDouble TimePerTest(unsigned int n)
Returns amount of seconds per iteration in a test with n iterations.
Definition: Timer.cpp:108