diff options
| author | Steve Bennett <steveb@workware.net.au> | 2023-02-09 12:28:14 +1000 |
|---|---|---|
| committer | Steve Bennett <steveb@workware.net.au> | 2023-02-13 10:44:10 +1000 |
| commit | d295fb1b6124575793add4b95860fabd1539a099 (patch) | |
| tree | a24f3671c4539c2d83584b178ad82ceb1e9b2942 | |
| parent | ccd47be1301935fcb5efe9bf721f1d33691aa65f (diff) | |
| download | jimtcl-d295fb1b6124575793add4b95860fabd1539a099.zip jimtcl-d295fb1b6124575793add4b95860fabd1539a099.tar.gz jimtcl-d295fb1b6124575793add4b95860fabd1539a099.tar.bz2 | |
docs: Add documentation for timerate command
Signed-off-by: Steve Bennett <steveb@workware.net.au>
| -rw-r--r-- | jim_tcl.txt | 26 |
1 files changed, 25 insertions, 1 deletions
diff --git a/jim_tcl.txt b/jim_tcl.txt index 3adf900..fe432e0 100644 --- a/jim_tcl.txt +++ b/jim_tcl.txt @@ -3,7 +3,7 @@ Jim Tcl(n) NAME ---- -Jim Tcl v0.81+ - reference manual for the Jim Tcl scripting language +Jim Tcl v0.82 - reference manual for the Jim Tcl scripting language SYNOPSIS -------- @@ -60,6 +60,8 @@ Changes between 0.81 and 0.82 4. The handles created by `socket pty` now make the replica name available via 'filename' 5. `info frame` now returns a (largely) Tcl-compatible dictionary, and supports 'info frame 0' 6. `vwait -signal` is now supported +7. ./configure now defaults to '--full' +8. New `timerate` command as an improvement over `time`, somewhat compatible with TIP 527 Changes between 0.80 and 0.81 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -4593,6 +4595,28 @@ in microseconds. Time is measured in elapsed time, not CPU time. +timerate +~~~~~~~~ ++*timerate* 'script ?milliseconds?'+ + +Evaluates the given script continuously until at least +'milliseconds'+ time has elapsed (defaults to 1000) +and returns a dictionary containing performance results. The dictionary contains the following: + +* us_per_iter - average elapsed time (microseconds) per iteration +* iters_per_sec - estimated number of iterations per second +* count - number of iterations performed +* elapsed_us - elapsed time (microseconds) + +Note that `timerate` attempts to subtract the overhead of `timerate` itself in the result, hence +the returned elapsed time will typically be less than the specified run time. + +The following is an example result of using timerate: + +---- + . timerate {expr {pow(1.5,7)}} 2000 + us_per_iter 0.09866879769 iters_per_sec 10134916.2391 count 13046627 elapsed_us 1287295 +---- + try ~~~ +*try* '?catchopts? tryscript' ?*on|trap* 'match {?resultvar? ?optsvar?} handlerscript \...'? ?*finally* 'finalscript'?+ |