benchmark

Type Members

1. final class Benchmark[-P] extends AnyRef

   

   A benchmark.

   A benchmark. A single procedure to measure.

   P

   A param that alters the benchmark / data used by the benchmark.

2. final case class Plan[P](suite: Suite[P], params: Vector[P]) extends Product with Serializable

   

3. final case class PlanKey[P](bmIndex: Int, paramIndex: Int)(bm: Benchmark[P], param: P) extends Product with Serializable

   

   Unique key for a (benchmark, param) tuple in a Plan.

   Unique key for a (benchmark, param) tuple in a Plan.

   Universal equality holds; it can be used as a map key.

4. final class Setup[-A, +B] extends AnyVal

   

   Given a A, set a B up and provide a Teardown.

5. final class Suite[-P] extends AnyRef

   

   A suite of benchmarks.

   A suite of benchmarks.

   If you want to use this suite in the GUI, you'll need a japgolly.scalajs.benchmark.gui.GuiSuite which combines this with some extra data needed just for the GUI.

   Benchmarks take parameter data (or if they don't need any, then they'll take Unit). To run a suite of benchmarks (without using a GUI), combine this with your desired param values to form a Plan, and then pass it to one of the run methods in japgolly.scalajs.benchmark.engine.Engine.

6. final class Teardown extends AnyVal

   

   Perform some effect to teardown something setup via Setup.