Hyperion.Benchmark

Benchmarks

data Benchmark where

Constructors

Bench :: Text -> Batch () -> Benchmark

Group :: Text -> [Benchmark] -> Benchmark

Bracket :: NFData r => IO r -> (r -> IO ()) -> (Env r -> Benchmark) -> Benchmark

Series :: (Show a, Enum a) => Vector a -> (a -> Benchmark) -> Benchmark

Instances

Show Benchmark

Methods

showsPrec :: Int -> Benchmark -> ShowS

show :: Benchmark -> String

showList :: [Benchmark] -> ShowS

bench :: String -> Batch () -> Benchmark

bgroup :: String -> [Benchmark] -> Benchmark

env

Arguments

:: NFData r

=> IO r

Acquire resource

-> (r -> IO ())

Finalize resource

-> (Env r -> Benchmark)

-> Benchmark

series :: (Show a, Enum a) => Vector a -> (a -> Benchmark) -> Benchmark

Batches

data Batch a

Instances

Monad Batch

Methods

(>>=) :: Batch a -> (a -> Batch b) -> Batch b

(>>) :: Batch a -> Batch b -> Batch b

return :: a -> Batch a

fail :: String -> Batch a

Functor Batch

Methods

fmap :: (a -> b) -> Batch a -> Batch b

(<$) :: a -> Batch b -> Batch a

Applicative Batch

Methods

pure :: a -> Batch a

(<*>) :: Batch (a -> b) -> Batch a -> Batch b

(*>) :: Batch a -> Batch b -> Batch b

(<*) :: Batch a -> Batch b -> Batch a

runBatch :: Batch () -> Int64 -> IO ()

Run a batch of the given size.

nf :: NFData b => (a -> b) -> a -> Batch ()

Apply an argument to a function, and evaluate the result to head normal form (NF).

nfIO :: NFData a => IO a -> Batch ()

Perform an action, then evaluate its result to head normal form. This is particularly useful for forcing a lazy IO action to be completely performed.

whnf :: (a -> b) -> a -> Batch ()

Apply an argument to a function, and evaluate the result to weak head normal form (WHNF).

whnfIO :: IO a -> Batch ()

Perform an action, then evaluate its result to weak head normal form (WHNF). This is useful for forcing an IO action whose result is an expression to be evaluated down to a more useful value.

Environments

data Env r

use :: Env r -> Batch r