@stdlib/bench-harness-cli NPM

Benchmark

Benchmark harness.

Installation

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

npm install -g @stdlib/bench-harness-cli

Usage

Usage: bench [options] <glob> ...

Options:

  -h,    --help                Print this message.
  -V,    --version             Print the package version.
  -r,    --require module      Load module before running benchmarks.

Notes

Running benchmark files does not require using the command-line interface. For example, to run a single file containing benchmarks,
```
$ node /path/to/benchmark.js
```
To load one or more modules before running benchmarks, set the -r flag one or more times. For example,
```
$ bench -r foo -r bar 'benchmark/*.js'
```
the modules foo and bar will both be loaded before any benchmarks matching the glob benchmark/*.js. The -r flag behaves exactly like require, and modules are resolved relative to the current working directory. To load local modules, use relative paths.
```
$ bench -r ./foo/bar.js -r ./beep/boop/bap 'benchmark/*.js'
```
Note that -r modules are loaded before running benchmarks regardless of order. Hence,
```
$ bench -r foo -r bar 'benchmark/*.js'
```
and
```
$ bench -r foo 'benchmark/*.js' -r bar
```
behave the same.
Depending on the preloaded module, a module may support parameterization via environment variables, command-line options, and/or configuration files.
To perform shell expansion on systems supporting globbing, do not quote provided globs.
```
$ bench benchmark/*.js
```
Beware, however, that globbing via shell expansion may result in shell argument lists which exceed length limits. To prevent shell expansion, wrap globs in quotes.
```
$ bench 'benchmark/*.js'
$ bench "benchmark/*.js"
```

Examples

$ bench ./examples/index.js

will generate TAP output similar to the following

TAP version 13
# Math.sin
  ---
  iterations: 1000000
  elapsed: 0.107631765
  rate: 9290937.484858675
  ...
ok 1 benchmark finished
# Math.sin
  ---
  iterations: 1000000
  elapsed: 0.100319363
  rate: 9968165.368035682
  ...
ok 2 benchmark finished
# Math.sin
  ---
  iterations: 1000000
  elapsed: 0.095116262
  rate: 10513449.31952856
  ...
ok 3 benchmark finished
# sin
  ---
  iterations: 1000000
  elapsed: 0.173696195
  rate: 5757178.503536016
  ...
ok 4 benchmark finished
# sin
  ---
  iterations: 1000000
  elapsed: 0.158544701
  rate: 6307369.42762912
  ...
ok 5 benchmark finished
# sin
  ---
  iterations: 1000000
  elapsed: 0.157709895
  rate: 6340756.234730865
  ...
ok 6 benchmark finished
#
1..6
# total 6
# pass  6
#
# ok

References

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

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.