mirror of
https://bitbucket.org/Mattrixwv/myhelpers.git
synced 2025-12-06 18:43:59 -05:00
Updated the README to show usage for the stowatch
This commit is contained in:
16
README.md
16
README.md
@@ -1,2 +1,16 @@
|
||||
#myHelpers
|
||||
These are some structures and functions that I have created that are not part of the standard library, but that I have found helpful to keep around.
|
||||
These are some structures and functions that I have created that are not part of the standard library, but that I have found helpful to keep around.
|
||||
|
||||
#Stopwatch
|
||||
This is a struct and set of functions that can be used to time portions of your code.
|
||||
Usage example:
|
||||
struct Stopwatch timer;
|
||||
init(&timer);
|
||||
start(&timer);
|
||||
//Algorithm that you wish to time here
|
||||
stop(&timer);
|
||||
printf("It took %s to run this algorithm\n", getStr(&timer));
|
||||
You can get automatic resolutions of time with the getStr() function, but you can also get specific resolutions of time with the other get functions.
|
||||
These are the other get functions:
|
||||
getNano(), getMicro(), getMilli(), getSecond(), getMinute(), getHour()
|
||||
getNano() returns a uint64_t, but the rest of the get functions return doubles
|
||||
Reference in New Issue
Block a user