criterion-0.4.0: Robust, reliable performance measurement and analysisSource codeContentsIndex

Types for benchmarking.

The core class is Benchmarkable, which admits both pure functions and IO actions.

For a pure function of type a -> b, 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.

class Benchmarkable a where
run :: a -> Int -> IO ()
data Benchmark where
Benchmark :: Benchmarkable b => String -> b -> Benchmark
BenchGroup :: String -> [Benchmark] -> Benchmark
data Pure
whnf :: (a -> b) -> a -> Pure
nf :: NFData b => (a -> b) -> a -> Pure
bench :: Benchmarkable b => String -> b -> Benchmark
bgroup :: String -> [Benchmark] -> Benchmark
benchNames :: Benchmark -> [String]
class Benchmarkable a whereSource
A benchmarkable function or action.
:: aThe function or action to benchmark.
-> IntThe number of times to run or evaluate it.
-> IO ()
Run a function or action the specified number of times.
show/hide Instances
data Benchmark whereSource
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.
Benchmark :: Benchmarkable b => String -> b -> Benchmark
BenchGroup :: String -> [Benchmark] -> Benchmark
show/hide Instances
data Pure Source
A container for a pure function to benchmark, and an argument to supply to it each time it is evaluated.
show/hide Instances
whnf :: (a -> b) -> a -> PureSource
nf :: NFData b => (a -> b) -> a -> PureSource
:: Benchmarkable b
=> String
-> b
-> Benchmark
Create a single benchmark.
:: StringA name to identify the group of benchmarks.
-> [Benchmark]Benchmarks to group under this name.
-> Benchmark
Group several benchmarks together under a common name.
benchNames :: Benchmark -> [String]Source
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