Weigh

Framework for seeing how much a function allocates.

Main entry point.

mainWith :: Weigh a -> IO ()

Just run the measuring and print a report.

Types

data Weigh a

Weigh specification monad.

Instances

Monad Weigh

Methods

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

(>>) :: Weigh a -> Weigh b -> Weigh b

return :: a -> Weigh a

fail :: String -> Weigh a

Functor Weigh

Methods

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

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

Applicative Weigh

Methods

pure :: a -> Weigh a

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

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

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

data Weight

How much a computation weighed in at.

Constructors

Weight

Fields

• weightLabel :: !String
• weightAllocatedBytes :: !Int64
• weightGCs :: !Int64

Instances

Read Weight

Methods

readsPrec :: Int -> ReadS Weight

readList :: ReadS [Weight]

readPrec :: ReadPrec Weight

readListPrec :: ReadPrec [Weight]

Show Weight

Methods

showsPrec :: Int -> Weight -> ShowS

show :: Weight -> String

showList :: [Weight] -> ShowS

Simple combinators

func :: NFData a => String -> (b -> a) -> b -> Weigh ()

Weigh a function applied to an argument.

Implemented in terms of validateFunc.

io :: NFData a => String -> (b -> IO a) -> b -> Weigh ()

Weigh a function applied to an argument.

Implemented in terms of validateFunc.

value :: NFData a => String -> a -> Weigh ()

Weigh a value.

Implemented in terms of action.

action :: NFData a => String -> IO a -> Weigh ()

Weigh an IO action.

Implemented in terms of validateAction.

Validating combinators

validateAction :: NFData a => String -> (b -> IO a) -> b -> (Weight -> Maybe String) -> Weigh ()

Weigh an IO action, validating the result.

validateFunc :: NFData a => String -> (b -> a) -> b -> (Weight -> Maybe String) -> Weigh ()

Weigh a function, validating the result

Validators

maxAllocs :: Int64 -> Weight -> Maybe String

Make a validator that set sthe maximum allocations.

Handy utilities

commas :: (Num a, Integral a, Show a) => a -> String

Formatting an integral number to 1,000,000, etc.