https://github.com/tpadioleau/cxxtimer
Easy to use timing and profiling library.
https://github.com/tpadioleau/cxxtimer
chrono chronometer cpp library monitoring monitoring-tool stopwatch timer
Last synced: 8 months ago
JSON representation
Easy to use timing and profiling library.
- Host: GitHub
- URL: https://github.com/tpadioleau/cxxtimer
- Owner: tpadioleau
- License: mit
- Created: 2019-01-31T20:30:07.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2020-05-14T14:37:14.000Z (about 6 years ago)
- Last Synced: 2024-03-01T16:38:47.447Z (over 2 years ago)
- Topics: chrono, chronometer, cpp, library, monitoring, monitoring-tool, stopwatch, timer
- Language: C++
- Homepage:
- Size: 59.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# cxxtimer: A timer for modern C++
[](https://travis-ci.org/tpadioleau/cxxtimer)
This is a header only C++ library that offers an easy-to-use Timer class.
You just need to include the header file `cxxtimer.hpp` and that's it. You can aready instantiate `cxxtimer::Timer` objects to time your C++ programs.
## Quick Start
The code below shows how to use **cxxtimer** library.
```cpp
#include
#include
#include
int main(int argc, char** argv) {
// Instantiate cxxtimer::Timer object
cxxtimer::Timer timer;
// Start the timer
timer.start();
// Wait for the users
std::string input_1;
std::cout << "Please, type something and press ENTER to continue: ";
std::getline(std::cin, input_1);
// Stop/pause the timer
timer.stop();
// Get the elapsed time
std::cout << "You took " << timer.count() << " seconds." << std::endl;
std::cout << "You took " << timer.count() << " milliseconds." << std::endl;
std::cout << "You took " << timer.count() << " nanoseconds." << std::endl;
return 0;
}
```
The `cxxtimer::Timer` class can be resumed after stop/pause. You just need to call `timer.start()` again. Furthermore, you can reset the timer as well. For this, you can call the method `timer.reset()`. After calling `timer.reset()`, the timer will be paused, so you have to call `timer.start()` to start to time again.
## Constructors and Methods
### Constructors
```cpp
cxxtimer::Timer(bool start = false)
```
If the parameter `start` is set to `true`, the timer will be started just after its construction. If set to `false` or ignored, the timer won't be automatically started after construction.
Besides the constructor above, the copy constructor
```cpp
cxxtimer::Timer(const Timer& other)
```
and the move constructor
```cpp
Timer(Timer&& other)
```
are defined.
### start
Start/resume the timer.
```cpp
void cxxtimer::start()
```
### stop
```cpp
void cxxtimer::stop()
```
Stop/pause the timer. After calling the method `stop()`, every call to `count()` will return the same value. To start timing again, you have to call `start()`.
### reset
```cpp
void cxxtimer::reset()
```
Stop the timer and reset it. After calling the method `stop()`, every call to `count()` will return zero. To start timing again, you have to call `start()`.
### count
```cpp
template
typename duration_t::rep count() const
```
It returns the time elapsed so far. By default, it return the time in milliseconds. However, you can specify the precision you want. For example, to get the time in seconds, you can call `count()`. The following options are available:
- `std::chrono::nanoseconds` for nanoseconds.
- `std::chrono::microseconds` for microseconds.
- `std::chrono::milliseconds` for milliseconds (default).
- `std::chrono::seconds` for seconds.
- `std::chrono::minutes` for minutes.
- `std::chrono::hours` for hours.
## Linking
This is a header only library.
## Requirements
The only build requirement is a C++ compiler that supports C++11, since `cxxtimer.hpp` library depends on C++ library `chrono`. For example GCC >= 5.0 or clang >= 3.4.