timeit

Time a snippet.

Installation

To use as a general utility, install the CLI package globally

npm install -g @stdlib/utils-timeit-cli

Usage

Usage: timeit [options] [<code>]

Options:

  -h,    --help                Print this message.
  -V,    --version             Print the package version.
         --iterations iter     Number of iterations.
         --repeats repeats     Number of repeats. Default: 3.
         --before setup        Setup code.
         --after cleanup       Cleanup code.
         --async               Time asynchronous code.
         --format fmt          Output format: pretty, csv, json. Default: pretty.

Notes

• When the output format is csv, the output consists of only raw timing results.
• If not explicitly provided --iterations, the implementation tries successive powers of 10 until the total time is at least 0.1 seconds.

Examples

$ timeit "$(cat ./examples/code.txt)" --before "$(cat ./examples/before.txt)" --iterations 1000000

iterations: 1000000
repeats: 3
iterations/s: 7261975.851461222
elapsed time: 0.13770357 sec
lower bound: 0.13770357 usec/iteration

To output results as JSON,

$ timeit "$(cat ./examples/code.txt)" --before "$(cat ./examples/before.txt)" --iterations 1000000 --format json
{"iterations":1000000,"repeats":3,"min":[0,132431806],"elapsed":0.132431806,"rate":7551056.1261997735,"times":[[0,142115140],[0,132431806],[0,134808376]]}

To output results as comma-separated values (CSV),

$ timeit "$(cat ./examples/code.txt)" --before "$(cat ./examples/before.txt)" --iterations 1000000 --format csv
seconds,nanoseconds
0,139365407
0,138033545
0,135175834

To use as part of a pipeline,

$ cat ./examples/code.txt | timeit --before "$(cat ./examples/before.txt)" --iterations 1000000

iterations: 1000000
repeats: 3
iterations/s: 7433536.674260073
elapsed time: 0.134525468 sec
lower bound: 0.134525468 usec/iteration

References

• Chen, Jiahao, and Jarrett Revels. 2016. "Robust benchmarking in noisy environments." CoRR abs/1608.04295 (August). http://arxiv.org/abs/1608.04295.

See Also

• @stdlib/utils-timeit: time a snippet.

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.