|
Criterion.Types | Portability | GHC | Stability | experimental | Maintainer | bos@serpentine.com |
|
|
|
Description |
Types for benchmarking.
The core class is Benchmarkable, which admits both pure functions
and IO actions.
For a pure function of type Int -> a, the benchmarking harness
calls this function repeatedly, each time with a different Int
argument, and reduces the result the function returns to weak head
normal form. If you need the result reduced to normal form, that
is your responsibility.
For an action of type IO a, the benchmarking harness calls the
action repeatedly, but does not reduce the result.
|
|
Synopsis |
|
|
|
Documentation |
|
class Benchmarkable b where | Source |
|
A benchmarkable function or action.
| | Methods | | | Instances | |
|
|
|
A benchmark may consist of either a single Benchmarkable item
with a name, created with bench, or a (possibly nested) group of
Benchmarks, created with bgroup.
| Constructors | | Instances | |
|
|
|
|
|
|
:: String | A name to identify the group of benchmarks.
| -> [Benchmark] | Benchmarks to group under this name.
| -> Benchmark | | Group several benchmarks together under a common name.
|
|
|
|
Retrieve the names of all benchmarks. Grouped benchmarks are
prefixed with the name of the group they're in.
|
|
Produced by Haddock version 2.6.0 |