|
7 | 7 | |:---:|:---:| |
8 | 8 | |[![][pkg-0.6-img]][pkg-0.6-url] [![][pkg-0.7-img]][pkg-0.7-url] | [![][travis-img]][travis-url] [![][appveyor-img]][appveyor-url] [![][codecov-img]][codecov-url] | |
9 | 9 |
|
10 | | -This module provides `tick()`, `tock()`, and `tok()` functions. They're similar to the `tic()`, `toc()`, and `toq()` functions that you might find in MATLAB and similar software. There are also `laptime()` and `peektime()` functions that reveal the state of the current timers without stopping them. |
| 10 | +This module provides `tick()`, `tock()`, and `tok()` functions. They're similar to the `tic()`, `toc()`, and `toq()` functions that you might find in MATLAB and similar software. There are also `laptimer()` and `peektimer()` functions that reveal the state of the current timers without stopping them. |
11 | 11 |
|
12 | 12 | **Don't use these for timing code execution!** Julia provides much better facilities for measuring performance, ranging from the `@time` and `@elapsed` macros to packages such as [BenchmarkTools.jl](https://github.com/JuliaCI/BenchmarkTools.jl). (And remember, don't time Julia code running in global scope!) The [TimerOutputs.jl](https://github.com/KristofferC/TimerOutputs.jl) package provides tools for timing different sections of a program. |
13 | 13 |
|
14 | 14 | ## Functions |
15 | 15 |
|
16 | | -- `tick() ` start timing |
17 | | -- `tock() ` stop timing, show total elapsed time |
18 | | -- `tok() ` stop timing, return elapsed seconds |
19 | | -- `peektime() ` continue timing, return elapsed seconds |
| 16 | +- `tick()` start timing |
| 17 | +- `tock()` stop timing, show total elapsed time |
| 18 | +- `tok()` stop timing, return elapsed seconds |
| 19 | +- `peektimer() ` continue timing, return elapsed seconds |
20 | 20 | - `laptimer() ` continue timing, show total elapsed time |
21 | 21 |
|
22 | 22 | ## Suggestions for use |
@@ -92,12 +92,13 @@ Some of this code used to live in Julia Base in the `tic()`, `toc()`, and `toq() |
92 | 92 | [travis-url]: https://travis-ci.org/cormullion/TickTock.jl |
93 | 93 |
|
94 | 94 | [appveyor-img]: https://ci.appveyor.com/api/projects/status/j4w1iwued4ojsfm6?svg=true |
95 | | -[appveyor-url]: https://ci.appveyor.com/project/JuliaDocs/ticktock-jl |
96 | | - |
| 95 | +[appveyor-url]: https://ci.appveyor.com/project/cormullion/ticktock-jl/branch/master |
| 96 | + |
97 | 97 | [codecov-img]: https://codecov.io/github/cormullion/TickTock.jl/coverage.svg?branch=master |
98 | 98 | [codecov-url]: https://codecov.io/github/cormullion/TickTock.jl |
99 | 99 |
|
100 | 100 | [pkg-0.6-img]: http://pkg.julialang.org/badges/TickTock_0.6.svg |
101 | 101 | [pkg-0.6-url]: http://pkg.julialang.org/?pkg=TickTock&ver=0.6 |
102 | 102 | [pkg-0.7-img]: http://pkg.julialang.org/badges/TickTock_0.7.svg |
103 | 103 | [pkg-0.7-url]: http://pkg.julialang.org/?pkg=TickTock&ver=0.7 |
| 104 | + |
0 commit comments