Safe Haskell	None
Language	Haskell2010

ParkBench.Internal

Contents

Benchmarking
- Low-level
Statistics
RTS stats
Table rendering
- High-level row/cell machinery
- Table machinery

Synopsis

benchmark1 :: forall a. Roll a => (Word64 -> IO (Timed a)) -> Pull1 a
newtype Pull1 a = Pull1 (IO (Estimate a, Pull1 a))
benchmark :: forall a. Roll a => (Word64 -> IO (Timed a)) -> IO (IO (Estimate a), Pull a)
data Pull a
data Pulls a
pulls :: NonEmpty (Pull a) -> Pulls a
pull :: Pulls a -> IO (Pulls a)
whnf :: (a -> b) -> a -> Word64 -> IO ()
whnfIO :: IO a -> Word64 -> IO ()
measure :: IO () -> IO (Timed RtsStats)
data Timed a = Timed {
- nanoseconds :: !Rational
- value :: !a
}
data Estimate a = Estimate {
- kvariance :: !Rational
- mean :: !(Timed a)
- samples :: !Word64
}
initialEstimate :: Timed a -> Estimate a
updateEstimate :: Roll a => Word64 -> Timed a -> Estimate a -> Estimate a
stdev :: Estimate a -> Double
variance :: Estimate a -> Rational
class Roll a where
- roll :: (Rational -> Rational -> Rational) -> a -> a -> a
data RtsStats = RtsStats !Rational !Rational !Rational !Rational !Rational !Rational !Rational !Rational !Rational !Rational !Rational !Rational !Rational !Rational !Rational !Rational !Rational !Rational
allocated_bytes_per_second :: RtsStats -> Rational
average_live_data :: RtsStats -> Rational
gc_average_ns :: RtsStats -> Rational
gc_cpu_percent :: RtsStats -> Rational
gc_wall_percent :: RtsStats -> Rational
max_normal_objects_bytes :: RtsStats -> Rational
minor_gcs :: RtsStats -> Rational
mut_cpu_percent :: RtsStats -> Rational
mut_wall_percent :: RtsStats -> Rational
work_balance :: RtsStats -> Maybe Rational
data R a b = R Cell (a -> Maybe b)
class Ord a => Cellular a where
- cellDelta :: a -> a -> Double
- cellString :: a -> Builder
newtype BytesCell = BytesCell Double
newtype BytesPerSecondCell = BytesPerSecondCell Double
newtype IncomparableWord3Cell = IncomparableWord3Cell Word64
newtype IncomparablePercentageCell = IncomparablePercentageCell Double
newtype NanosecondsCell = NanosecondsCell Double
newtype NumberCell = NumberCell Double
newtype NumberCell' = NumberCell' Double
newtype PercentageCell = PercentageCell Double
newtype PercentageCell' = PercentageCell' Double
rowMaker :: forall a. NonEmpty a -> forall b. Cellular b => R a b -> Row
data Table = Table ![Cell] ![RowGroup]
renderTable :: Table -> Builder
data RowGroup = RowGroup !Text ![Row]
data Row
- = Row ![Cell]
- | EmptyRow
data Cell
- = EmptyCell
- | Cell !Color !Text
isEmptyCell :: Cell -> Bool
data Color
- = Blue
- | Green
- | Red
- | White

Benchmarking

benchmark1 :: forall a. Roll a => (Word64 -> IO (Timed a)) -> Pull1 a Source #

Like benchmark, but optimized for only running one benchmark.

newtype Pull1 a Source #

Constructors

Pull1 (IO (Estimate a, Pull1 a))

benchmark :: forall a. Roll a => (Word64 -> IO (Timed a)) -> IO (IO (Estimate a), Pull a) Source #

data Pull a Source #

data Pulls a Source #

A Pulls represents the suspended state of a collection of 1+ benchmarks.

pulls :: NonEmpty (Pull a) -> Pulls a Source #

Construct a Pulls from a non-empty list of Pull.

pull :: Pulls a -> IO (Pulls a) Source #

Pull on a Pulls, which blocks until the benchmark that has heretofore accumulated the smallest amount of runtime runs once more.

Returns the Pulls to use next time, which reflects the latest benchmark run that just completed.

Low-level

whnf :: (a -> b) -> a -> Word64 -> IO () Source #

whnfIO :: IO a -> Word64 -> IO () Source #

measure :: IO () -> IO (Timed RtsStats) Source #

Measure the time/memory usage of an IO action.

Statistics

data Timed a Source #

A value that took a certan time to compute.

Constructors

Timed
Fields nanoseconds :: !Rational value :: !a

Instances

Instances details

Functor Timed Source #
Instance details Defined in ParkBench.Statistics Methods fmap :: (a -> b) -> Timed a -> Timed b # (<$) :: a -> Timed b -> Timed a #
Show a => Show (Timed a) Source #
Instance details Defined in ParkBench.Statistics Methods showsPrec :: Int -> Timed a -> ShowS # show :: Timed a -> String # showList :: [Timed a] -> ShowS #
Semigroup a => Semigroup (Timed a) Source #
Instance details Defined in ParkBench.Statistics Methods (<>) :: Timed a -> Timed a -> Timed a # sconcat :: NonEmpty (Timed a) -> Timed a # stimes :: Integral b => b -> Timed a -> Timed a #
Monoid a => Monoid (Timed a) Source #
Instance details Defined in ParkBench.Statistics Methods mempty :: Timed a # mappend :: Timed a -> Timed a -> Timed a # mconcat :: [Timed a] -> Timed a #

data Estimate a Source #

Constructors

Estimate
Fields kvariance :: !Rational mean :: !(Timed a) samples :: !Word64

Instances

Instances details

Functor Estimate Source #
Instance details Defined in ParkBench.Statistics Methods fmap :: (a -> b) -> Estimate a -> Estimate b # (<$) :: a -> Estimate b -> Estimate a #
Show a => Show (Estimate a) Source #
Instance details Defined in ParkBench.Statistics Methods showsPrec :: Int -> Estimate a -> ShowS # show :: Estimate a -> String # showList :: [Estimate a] -> ShowS #

initialEstimate :: Timed a -> Estimate a Source #

initialEstimate v creates an estimate per thing-that-took-time v that was a run of 1 iteration.

updateEstimate :: Roll a => Word64 -> Timed a -> Estimate a -> Estimate a Source #

updateEstimate n v e updates estimate e per thing-that-took-time v that was a run of n iterations.

stdev :: Estimate a -> Double Source #

variance :: Estimate a -> Rational Source #

class Roll a where Source #

Methods

roll :: (Rational -> Rational -> Rational) -> a -> a -> a Source #

Instances

Instances details

Roll RtsStats Source #
Instance details Defined in ParkBench.RtsStats Methods roll :: (Rational -> Rational -> Rational) -> RtsStats -> RtsStats -> RtsStats Source #

RTS stats

data RtsStats Source #

RTS stats type.

This type is intentionally not a record, because it's kind of large, and generated record accessors cause quadratic time to compile.

The hand-written accessors do, too, but we don't need the generated setters at all, so there are some savings by writing it all out by hand.

TODO nonmoving_gc_*

Constructors

RtsStats !Rational !Rational !Rational !Rational !Rational !Rational !Rational !Rational !Rational !Rational !Rational !Rational !Rational !Rational !Rational !Rational !Rational !Rational

Instances

Instances details

Roll RtsStats Source #
Instance details Defined in ParkBench.RtsStats Methods roll :: (Rational -> Rational -> Rational) -> RtsStats -> RtsStats -> RtsStats Source #

allocated_bytes_per_second :: RtsStats -> Rational Source #

average_live_data :: RtsStats -> Rational Source #

gc_average_ns :: RtsStats -> Rational Source #

gc_cpu_percent :: RtsStats -> Rational Source #

gc_wall_percent :: RtsStats -> Rational Source #

max_normal_objects_bytes :: RtsStats -> Rational Source #

minor_gcs :: RtsStats -> Rational Source #

mut_cpu_percent :: RtsStats -> Rational Source #

mut_wall_percent :: RtsStats -> Rational Source #

work_balance :: RtsStats -> Maybe Rational Source #

Table rendering

High-level row/cell machinery

data R a b Source #

Constructors

R Cell (a -> Maybe b)

class Ord a => Cellular a where Source #

Methods

cellDelta :: a -> a -> Double Source #

cellString :: a -> Builder Source #

Instances

Instances details

Cellular IncomparableWord3Cell Source #
Instance details Defined in ParkBench.Pretty Methods cellDelta :: IncomparableWord3Cell -> IncomparableWord3Cell -> Double Source # cellString :: IncomparableWord3Cell -> Builder Source #
Cellular PercentageCell' Source #
Instance details Defined in ParkBench.Pretty Methods cellDelta :: PercentageCell' -> PercentageCell' -> Double Source # cellString :: PercentageCell' -> Builder Source #
Cellular PercentageCell Source #
Instance details Defined in ParkBench.Pretty Methods cellDelta :: PercentageCell -> PercentageCell -> Double Source # cellString :: PercentageCell -> Builder Source #
Cellular NanosecondsCell Source #
Instance details Defined in ParkBench.Pretty Methods cellDelta :: NanosecondsCell -> NanosecondsCell -> Double Source # cellString :: NanosecondsCell -> Builder Source #
Cellular NumberCell' Source #
Instance details Defined in ParkBench.Pretty Methods cellDelta :: NumberCell' -> NumberCell' -> Double Source # cellString :: NumberCell' -> Builder Source #
Cellular NumberCell Source #
Instance details Defined in ParkBench.Pretty Methods cellDelta :: NumberCell -> NumberCell -> Double Source # cellString :: NumberCell -> Builder Source #
Cellular IncomparablePercentageCell Source #
Instance details Defined in ParkBench.Pretty Methods cellDelta :: IncomparablePercentageCell -> IncomparablePercentageCell -> Double Source # cellString :: IncomparablePercentageCell -> Builder Source #
Cellular BytesPerSecondCell Source #
Instance details Defined in ParkBench.Pretty Methods cellDelta :: BytesPerSecondCell -> BytesPerSecondCell -> Double Source # cellString :: BytesPerSecondCell -> Builder Source #
Cellular BytesCell Source #
Instance details Defined in ParkBench.Pretty Methods cellDelta :: BytesCell -> BytesCell -> Double Source # cellString :: BytesCell -> Builder Source #

newtype BytesCell Source #

Constructors

BytesCell Double

Instances

Instances details

Eq BytesCell Source #
Instance details Defined in ParkBench.Pretty Methods (==) :: BytesCell -> BytesCell -> Bool # (/=) :: BytesCell -> BytesCell -> Bool #
Ord BytesCell Source #
Instance details Defined in ParkBench.Pretty Methods compare :: BytesCell -> BytesCell -> Ordering # (<) :: BytesCell -> BytesCell -> Bool # (<=) :: BytesCell -> BytesCell -> Bool # (>) :: BytesCell -> BytesCell -> Bool # (>=) :: BytesCell -> BytesCell -> Bool # max :: BytesCell -> BytesCell -> BytesCell # min :: BytesCell -> BytesCell -> BytesCell #
Cellular BytesCell Source #
Instance details Defined in ParkBench.Pretty Methods cellDelta :: BytesCell -> BytesCell -> Double Source # cellString :: BytesCell -> Builder Source #

newtype BytesPerSecondCell Source #

Constructors

BytesPerSecondCell Double

Instances

Instances details

Eq BytesPerSecondCell Source #
Instance details Defined in ParkBench.Pretty Methods (==) :: BytesPerSecondCell -> BytesPerSecondCell -> Bool # (/=) :: BytesPerSecondCell -> BytesPerSecondCell -> Bool #
Ord BytesPerSecondCell Source #
Instance details Defined in ParkBench.Pretty Methods compare :: BytesPerSecondCell -> BytesPerSecondCell -> Ordering # (<) :: BytesPerSecondCell -> BytesPerSecondCell -> Bool # (<=) :: BytesPerSecondCell -> BytesPerSecondCell -> Bool # (>) :: BytesPerSecondCell -> BytesPerSecondCell -> Bool # (>=) :: BytesPerSecondCell -> BytesPerSecondCell -> Bool # max :: BytesPerSecondCell -> BytesPerSecondCell -> BytesPerSecondCell # min :: BytesPerSecondCell -> BytesPerSecondCell -> BytesPerSecondCell #
Cellular BytesPerSecondCell Source #
Instance details Defined in ParkBench.Pretty Methods cellDelta :: BytesPerSecondCell -> BytesPerSecondCell -> Double Source # cellString :: BytesPerSecondCell -> Builder Source #

newtype IncomparableWord3Cell Source #

Constructors

IncomparableWord3Cell Word64

Instances

Instances details

Eq IncomparableWord3Cell Source #
Instance details Defined in ParkBench.Pretty Methods (==) :: IncomparableWord3Cell -> IncomparableWord3Cell -> Bool # (/=) :: IncomparableWord3Cell -> IncomparableWord3Cell -> Bool #
Ord IncomparableWord3Cell Source #
Instance details Defined in ParkBench.Pretty Methods compare :: IncomparableWord3Cell -> IncomparableWord3Cell -> Ordering # (<) :: IncomparableWord3Cell -> IncomparableWord3Cell -> Bool # (<=) :: IncomparableWord3Cell -> IncomparableWord3Cell -> Bool # (>) :: IncomparableWord3Cell -> IncomparableWord3Cell -> Bool # (>=) :: IncomparableWord3Cell -> IncomparableWord3Cell -> Bool # max :: IncomparableWord3Cell -> IncomparableWord3Cell -> IncomparableWord3Cell # min :: IncomparableWord3Cell -> IncomparableWord3Cell -> IncomparableWord3Cell #
Cellular IncomparableWord3Cell Source #
Instance details Defined in ParkBench.Pretty Methods cellDelta :: IncomparableWord3Cell -> IncomparableWord3Cell -> Double Source # cellString :: IncomparableWord3Cell -> Builder Source #

newtype IncomparablePercentageCell Source #

Constructors

IncomparablePercentageCell Double

Instances

Instances details

Eq IncomparablePercentageCell Source #
Instance details Defined in ParkBench.Pretty Methods (==) :: IncomparablePercentageCell -> IncomparablePercentageCell -> Bool # (/=) :: IncomparablePercentageCell -> IncomparablePercentageCell -> Bool #
Ord IncomparablePercentageCell Source #
Instance details Defined in ParkBench.Pretty Methods compare :: IncomparablePercentageCell -> IncomparablePercentageCell -> Ordering # (<) :: IncomparablePercentageCell -> IncomparablePercentageCell -> Bool # (<=) :: IncomparablePercentageCell -> IncomparablePercentageCell -> Bool # (>) :: IncomparablePercentageCell -> IncomparablePercentageCell -> Bool # (>=) :: IncomparablePercentageCell -> IncomparablePercentageCell -> Bool # max :: IncomparablePercentageCell -> IncomparablePercentageCell -> IncomparablePercentageCell # min :: IncomparablePercentageCell -> IncomparablePercentageCell -> IncomparablePercentageCell #
Cellular IncomparablePercentageCell Source #
Instance details Defined in ParkBench.Pretty Methods cellDelta :: IncomparablePercentageCell -> IncomparablePercentageCell -> Double Source # cellString :: IncomparablePercentageCell -> Builder Source #

newtype NanosecondsCell Source #

Constructors

NanosecondsCell Double

Instances

Instances details

Eq NanosecondsCell Source #
Instance details Defined in ParkBench.Pretty Methods (==) :: NanosecondsCell -> NanosecondsCell -> Bool # (/=) :: NanosecondsCell -> NanosecondsCell -> Bool #
Ord NanosecondsCell Source #
Instance details Defined in ParkBench.Pretty Methods compare :: NanosecondsCell -> NanosecondsCell -> Ordering # (<) :: NanosecondsCell -> NanosecondsCell -> Bool # (<=) :: NanosecondsCell -> NanosecondsCell -> Bool # (>) :: NanosecondsCell -> NanosecondsCell -> Bool # (>=) :: NanosecondsCell -> NanosecondsCell -> Bool # max :: NanosecondsCell -> NanosecondsCell -> NanosecondsCell # min :: NanosecondsCell -> NanosecondsCell -> NanosecondsCell #
Cellular NanosecondsCell Source #
Instance details Defined in ParkBench.Pretty Methods cellDelta :: NanosecondsCell -> NanosecondsCell -> Double Source # cellString :: NanosecondsCell -> Builder Source #

newtype NumberCell Source #

Constructors

NumberCell Double

Instances

Instances details

Eq NumberCell Source #
Instance details Defined in ParkBench.Pretty Methods (==) :: NumberCell -> NumberCell -> Bool # (/=) :: NumberCell -> NumberCell -> Bool #
Ord NumberCell Source #
Instance details Defined in ParkBench.Pretty Methods compare :: NumberCell -> NumberCell -> Ordering # (<) :: NumberCell -> NumberCell -> Bool # (<=) :: NumberCell -> NumberCell -> Bool # (>) :: NumberCell -> NumberCell -> Bool # (>=) :: NumberCell -> NumberCell -> Bool # max :: NumberCell -> NumberCell -> NumberCell # min :: NumberCell -> NumberCell -> NumberCell #
Cellular NumberCell Source #
Instance details Defined in ParkBench.Pretty Methods cellDelta :: NumberCell -> NumberCell -> Double Source # cellString :: NumberCell -> Builder Source #

newtype NumberCell' Source #

Constructors

NumberCell' Double

Instances

Instances details

Eq NumberCell' Source #
Instance details Defined in ParkBench.Pretty Methods (==) :: NumberCell' -> NumberCell' -> Bool # (/=) :: NumberCell' -> NumberCell' -> Bool #
Ord NumberCell' Source #
Instance details Defined in ParkBench.Pretty Methods compare :: NumberCell' -> NumberCell' -> Ordering # (<) :: NumberCell' -> NumberCell' -> Bool # (<=) :: NumberCell' -> NumberCell' -> Bool # (>) :: NumberCell' -> NumberCell' -> Bool # (>=) :: NumberCell' -> NumberCell' -> Bool # max :: NumberCell' -> NumberCell' -> NumberCell' # min :: NumberCell' -> NumberCell' -> NumberCell' #
Cellular NumberCell' Source #
Instance details Defined in ParkBench.Pretty Methods cellDelta :: NumberCell' -> NumberCell' -> Double Source # cellString :: NumberCell' -> Builder Source #

newtype PercentageCell Source #

Constructors

PercentageCell Double

Instances

Instances details

Eq PercentageCell Source #
Instance details Defined in ParkBench.Pretty Methods (==) :: PercentageCell -> PercentageCell -> Bool # (/=) :: PercentageCell -> PercentageCell -> Bool #
Ord PercentageCell Source #
Instance details Defined in ParkBench.Pretty Methods compare :: PercentageCell -> PercentageCell -> Ordering # (<) :: PercentageCell -> PercentageCell -> Bool # (<=) :: PercentageCell -> PercentageCell -> Bool # (>) :: PercentageCell -> PercentageCell -> Bool # (>=) :: PercentageCell -> PercentageCell -> Bool # max :: PercentageCell -> PercentageCell -> PercentageCell # min :: PercentageCell -> PercentageCell -> PercentageCell #
Cellular PercentageCell Source #
Instance details Defined in ParkBench.Pretty Methods cellDelta :: PercentageCell -> PercentageCell -> Double Source # cellString :: PercentageCell -> Builder Source #

newtype PercentageCell' Source #

Constructors

PercentageCell' Double

Instances

Instances details

Eq PercentageCell' Source #
Instance details Defined in ParkBench.Pretty Methods (==) :: PercentageCell' -> PercentageCell' -> Bool # (/=) :: PercentageCell' -> PercentageCell' -> Bool #
Ord PercentageCell' Source #
Instance details Defined in ParkBench.Pretty Methods compare :: PercentageCell' -> PercentageCell' -> Ordering # (<) :: PercentageCell' -> PercentageCell' -> Bool # (<=) :: PercentageCell' -> PercentageCell' -> Bool # (>) :: PercentageCell' -> PercentageCell' -> Bool # (>=) :: PercentageCell' -> PercentageCell' -> Bool # max :: PercentageCell' -> PercentageCell' -> PercentageCell' # min :: PercentageCell' -> PercentageCell' -> PercentageCell' #
Cellular PercentageCell' Source #
Instance details Defined in ParkBench.Pretty Methods cellDelta :: PercentageCell' -> PercentageCell' -> Double Source # cellString :: PercentageCell' -> Builder Source #

rowMaker :: forall a. NonEmpty a -> forall b. Cellular b => R a b -> Row Source #

Table machinery

data Table Source #

Constructors

Table ![Cell] ![RowGroup]

renderTable :: Table -> Builder Source #

data RowGroup Source #

Constructors

RowGroup !Text ![Row]

data Row Source #

Constructors

Row ![Cell]	Invariant: 1+ cells; not all cells are empty
EmptyRow

data Cell Source #

Constructors

EmptyCell
Cell !Color !Text

Instances

Instances details

IsString Cell Source #
Instance details Defined in ParkBench.Pretty Methods fromString :: String -> Cell #

isEmptyCell :: Cell -> Bool Source #

data Color Source #

Constructors

Blue
Green
Red
White