⚠️ ⚠️ ⚠️ Warning: Outdated, not recommended benchmarking method ⚠️ ⚠️ ⚠️

This template pretty old and originated in times before the official OpenJDK (Micro)benchmark Harness (JMH) was made available.

Nowadays it is recommended to use the sbt plugin sbt-jmh for benchmarking Scala code.

To understand why a proper benchmark harness is so important you may want to read the excellent articles on the matter by Aleksey Shipilëv, e.g. Java vs. Scala: Divided We Fail or Nanotrusting the Nanotime, as well as examples in the JMH repository.

Scala Micro-Benchmarking Template

This is an SBT template project for creating micro benchmarks for scala code snippets. It's not much more than a simple wrapper around Caliper, an open-source library for properly running benchmark code on the JVM (written by some guys at Google).

Manually writing benchmarks for the JVM that actually measure what you intend to measure is much harder than it initially appears. There are quite a few rules you need to keep in mind, so it's best to rely on a framework that takes care of the details and let's you focus on the code relevant to your application. Caliper provides just this framework and this project makes it easily accessible for Scala developers.

How to create your own Scala micro-benchmark

1. Git-clone this repository:

    $ git clone git://github.com/sirthias/scala-benchmarking-template.git my-benchmark
   

2. Change directory into your clone:

    $ cd my-benchmark
   

3. Launch SBT:

    $ sbt
   

4. Run the existing benchmark:

    > run
   

5. Start hacking on src/main/scala/org/example/Benchmark.scala

As a simple example the project already contains a small benchmark testing the performance of foreaching over a Scala Array against a simple while loop as well as a specialized, custom for loop replacement implementation. In order to run your own benchmark code simply replace the respectively marked code snippets with your own.