Benchmark.bs.js

To add your own benchmarks, start by forking or cloning this git repository. Then, open Suites.re to add your own code.

module ArrayAccess = {
  let name = "Array access";
  let arr = Belt.Array.make(100, "a");
  let setup = {j|let arr = Belt.Array.make(100, "a");|j};
  let benchmarks = [|
    {
      name: "Array.get",
      f: (.) => arr[50]->Any,
      code: "arr[50];"
    },
    {
      name: "Belt.Array.get",
      f: (.) => Belt.(arr[50]->Any),
      code: "Belt.(arr[50]);",
    },
    {
      name: "Belt.Array.getExn",
      f: (.) => arr->Belt.Array.getExn(50)->Any,
      code: "arr->Belt.Array.getExn(50);",
    },
  |];
  let suite = {setup, name, benchmarks};
};

All f functions have to return an Any type. This is just an opaque type that allows polymorphic returns.

Be aware that BuckleScript does aggresive optimizations, so check the compiled JavaScript to ensure that your benchmark functions are actually doing what you expect. Sometimes BuckleScript will remove "no-op" code.

Namespacing your benchmark with a module isn't necessary, but helps keep it organized.

To make your code accessible on the web interface, you need to register it in the Routes module (located at the bottom of the Suites module).

module Routes = {
  type item = {
    suite: t,
    url: string,
  };
  type key =
    | ArrayAccess; /* <- Add a variant here to identify it. */

  let map =
    fun
    /* Add the suite and the url here. */
    | ArrayAccess => {suite: ArrayAccess.suite, url: "array-access"};

  let fromUrl =
    fun
    | "array-access" => Some(ArrayAccess) /* <- Add the same url here. */
    | _ => None;

  /* Add it to this array to be listed on the main menu. */
  let routes = [|ArrayAccess|];
};

Build the project.

npm run build:re

And load the development server.

npm run dev

And then navigate to the URL provided in the terminal (usually localhost:1234). Click on your benchmark and press "run."

Benchmark.js bindings

This project uses zero-runtime bindings to Benchmark.js. You can see them in BenchmarkJs.re. Feel free to use them for your own projects. They are not the complete Benchmark.js API (yet).

Contributions

Contributions are welcome. If you have a really cool benchmark suite that you think should be included on the site, feel free to open a pull request.