mirror of
https://bitbucket.org/Mattrixwv/javaclasses.git
synced 2025-12-06 15:03:58 -05:00
Updated README with stopwatch information and usage example
This commit is contained in:
15
README.md
15
README.md
@@ -1,3 +1,16 @@
|
||||
# JavaClasses
|
||||
This is a set of classes and functions, not part of the standard library, that I have found it helpful to keep around.
|
||||
|
||||
This is a set of classes and functions, not part of the standard library, that I have found it helpful to keep around.
|
||||
#Stopwatch
|
||||
This is a class that allows you to determine the execution time of an algorithm.
|
||||
You can get specific resolutions of time through their own get functions, all of which return double.
|
||||
However I have built it a function, getStr(), that automatically chooses the best resolution and returns both the number and resolution as a string.
|
||||
This is used extensively in my ProjectEuler code found at https://bitbucket.org/Mattrixwv/ProjectEuler
|
||||
Example of usage:
|
||||
Stopwatch timer = new Stopwatch();
|
||||
timer.start();
|
||||
//Code to time here
|
||||
timer.stop();
|
||||
System.out.printf("It took %s to run this algorithm", timer.getStr());
|
||||
//You could also do something like this if you prefered
|
||||
System.out.printf("It took %f milliseconds to run this algorithm", timer.getMilli());
|
||||
Reference in New Issue
Block a user