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


-- | analysis example using perf
--   
--   Analytical tools to use with perf.
@package perf-analysis
@version 0.2.0.0


-- | analytical functionality for perf
module Perf.Analysis

-- | compute deciles
--   
--   <pre>
--   &gt;&gt;&gt; deciles 5 [1..1000]
--   [1.0,200.5,400.5,600.5,800.5,1000.0]
--   </pre>
--   
--   <pre>
--   c5 &lt;- decile 5 &lt;$&gt; ticks n f a
--   </pre>
deciles :: (Functor f, Foldable f, Integral a) => a -> f a -> [Double]

-- | compute a percentile
--   
--   <pre>
--   &gt;&gt;&gt; percentile 0.1 [1..1000]
--   100.5
--   </pre>
--   
--   <pre>
--   c &lt;- percentile 0.4 . fst &lt;$&gt; ticks n f a
--   </pre>
percentile :: (Functor f, Foldable f, Integral a) => Double -> f a -> Double

-- | fixed precision for a Scientific
prec :: Int -> Format r (Scientific -> r)

-- | convert an integral to a Scientific
--   
--   <pre>
--   &gt;&gt;&gt; sformat (left 8 ' ' %. prec 1) (int2Sci 1000)
--   "   1.0e3"
--   </pre>
int2Sci :: Integral a => a -> Scientific
formatSecs :: RealFloat a => Int -> a -> Text

-- | format an Integral as a Scientific with a precision
formatI :: Integral a => Int -> a -> Text

-- | format a Float as a Scientific with a precision
formatF :: RealFloat a => Int -> a -> Text

-- | format a Float as a Scientific with a precision
formatFixed :: RealFloat a => Int -> a -> Text

-- | format the first few results, the median and average
formatRun :: Integral a => Text -> Int -> Int -> [a] -> [Text]

-- | average and time
formatRunTime :: Integral a => Text -> Double -> Int -> [a] -> [Text]
formatRuns :: Integral a => Int -> Int -> [(Text, [a])] -> Block
formatRunsTime :: Integral a => Double -> Int -> [(Text, [a])] -> Block