-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Micro-benchmarking with detailed statistics.
--   
--   Runs benchmarks and produces detailed reports that includes common
--   statistical measures like mean execution time but also groups
--   execution times into percentiles.
@package benchpress
@version 0.1


-- | Benchmarks actions and produces statistics such as min, mean, median,
--   standard deviation, and max execution time. Also computes execution
--   time percentiles. There are functions to pretty-print the results.
--   
--   Here's an example showing a benchmark of copying a file:
--   
--   <pre>
--   import Control.Monad.Trans
--   import qualified Data.ByteString as B
--   import System.IO
--   import Test.BenchPress
--   
--   inpath, outpath :: String
--   inpath = "/tmp/infile"
--   outpath = "/tmp/outfile"
--   
--   blockSize :: Int
--   blockSize = 4 * 1024
--   
--   copyUsingByteString :: Handle -&gt; Handle -&gt; IO ()
--   copyUsingByteString inf outf = go
--       where
--         go = do
--           bs &lt;- B.hGet inf blockSize
--           let numRead = B.length bs
--           if numRead &gt; 0
--              then B.hPut outf bs &gt;&gt; go
--              else return ()
--   
--   main :: IO ()
--   main = bench 100 $ liftIO $ do
--            inf &lt;- openBinaryFile inpath ReadMode
--            outf &lt;- openBinaryFile outpath WriteMode
--            copyUsingByteString inf outf
--            hClose outf
--            hClose inf
--   </pre>
module Test.BenchPress
data Benchmark a

-- | Starts the benchmark timer again after it has been previously stopped
--   by calling <a>stop</a>. It's not necessary to call <a>start</a> at the
--   beginning of the action you want to benchmark as it is done
--   automatically by <a>benchmark</a>.
start :: Benchmark ()

-- | Stops the benchmark timer. Stopping the timer is useful when you need
--   to perform some set up that you don't want to count in the benchmark
--   timings. It's not necessary to call <a>stop</a> at the end of the
--   action you want to benchmark as it is done automatically by
--   <a>benchmark</a>.
stop :: Benchmark ()

-- | <tt>benchmark iters bm</tt> runs the action <tt>bm</tt> <tt>iters</tt>
--   times measuring the execution time of each run.
benchmark :: Int -> Benchmark a -> IO Stats

-- | Convenience function that runs a benchmark using <a>benchmark</a> and
--   prints timing statistics.
bench :: Int -> Benchmark a -> IO ()

-- | Convenience function that runs several benchmarks using
--   <a>benchmark</a> and prints a timing statistics summary. Each
--   benchmark has an associated label that is used to identify the
--   benchmark in the printed results.
benchMany :: Int -> [(String, Benchmark a)] -> IO ()

-- | Timing statistics for the benchmark. All measured times are given in
--   milliseconds.
data Stats
Stats :: Double -> Double -> Double -> Double -> Double -> [(Int, Double)] -> Stats

-- | Shortest execution time.
min :: Stats -> Double

-- | Average execution time.
mean :: Stats -> Double

-- | Execution time standard deviation.
stddev :: Stats -> Double

-- | Median execution time.
median :: Stats -> Double

-- | Longest execution time.
max :: Stats -> Double

-- | Execution time divided into percentiles. The first component of the
--   pair is the percentile given as an integer between 0 and 100,
--   inclusive. The second component is the execution time of the slowest
--   iteration within the percentile.
percentiles :: Stats -> [(Int, Double)]
instance Eq Stats
instance Show Stats
instance MonadIO Benchmark
instance Monad Benchmark