Control.Monad.Timing

Introduction

This package provides an mtl-like interface for timing subcomponents of an arbitrary computation.

MonadTiming

class MonadTiming m where

Monads that support timing subcomputations.

Minimal complete definition

timeGroup

Methods

timeGroup :: Tag -> m a -> m a

Time the given computation with the given tag.

Instances

MonadTiming (NoTimingT m)

Methods

timeGroup :: Tag -> NoTimingT m a -> NoTimingT m a

MonadIO m => MonadTiming (TimingT m)

Methods

timeGroup :: Tag -> TimingT m a -> TimingT m a

type TimingTree = Tree (Tag, NominalDiffTime)

A tree of timing events.

type Tag = String

Tags are strings.

TimingT, general timing handler

newtype TimingT m a

A monad transformer that records timing events.

Note that this module exports both _runTimingT and runTimingT.

• _runTimingT returns the timing events verbatim without sanitization.
• runTimingT combines trees with the same Tag and tags the duration of the entire computation with the special tag <all>.

Constructors

TimingT

Fields

• _runTimingT :: m (a, [TimingTree])

Instances

MonadTrans TimingT

Methods

lift :: Monad m => m a -> TimingT m a

MonadRWS r w s m => MonadRWS r w s (TimingT m)

MonadBase b m => MonadBase b (TimingT m)

Methods

liftBase :: b α -> TimingT m α

MonadBaseControl b m => MonadBaseControl b (TimingT m)

Associated Types

type StM (TimingT m :: * -> *) a :: *

Methods

liftBaseWith :: (RunInBase (TimingT m) b -> b a) -> TimingT m a

restoreM :: StM (TimingT m) a -> TimingT m a

MonadError e m => MonadError e (TimingT m)

Methods

throwError :: e -> TimingT m a

catchError :: TimingT m a -> (e -> TimingT m a) -> TimingT m a

MonadReader r m => MonadReader r (TimingT m)

Methods

ask :: TimingT m r

local :: (r -> r) -> TimingT m a -> TimingT m a

reader :: (r -> a) -> TimingT m a

MonadState s m => MonadState s (TimingT m)

Methods

get :: TimingT m s

put :: s -> TimingT m ()

state :: (s -> (a, s)) -> TimingT m a

MonadWriter w m => MonadWriter w (TimingT m)

Methods

writer :: (a, w) -> TimingT m a

tell :: w -> TimingT m ()

listen :: TimingT m a -> TimingT m (a, w)

pass :: TimingT m (a, w -> w) -> TimingT m a

Monad m => Monad (TimingT m)

Methods

(>>=) :: TimingT m a -> (a -> TimingT m b) -> TimingT m b

(>>) :: TimingT m a -> TimingT m b -> TimingT m b

return :: a -> TimingT m a

fail :: String -> TimingT m a

Functor m => Functor (TimingT m)

Methods

fmap :: (a -> b) -> TimingT m a -> TimingT m b

(<$) :: a -> TimingT m b -> TimingT m a

MonadFix m => MonadFix (TimingT m)

Methods

mfix :: (a -> TimingT m a) -> TimingT m a

Applicative m => Applicative (TimingT m)

Methods

pure :: a -> TimingT m a

(<*>) :: TimingT m (a -> b) -> TimingT m a -> TimingT m b

(*>) :: TimingT m a -> TimingT m b -> TimingT m b

(<*) :: TimingT m a -> TimingT m b -> TimingT m a

MonadIO m => MonadIO (TimingT m)

Methods

liftIO :: IO a -> TimingT m a

Alternative m => Alternative (TimingT m)

Methods

empty :: TimingT m a

(<|>) :: TimingT m a -> TimingT m a -> TimingT m a

some :: TimingT m a -> TimingT m [a]

many :: TimingT m a -> TimingT m [a]

MonadPlus m => MonadPlus (TimingT m)

Methods

mzero :: TimingT m a

mplus :: TimingT m a -> TimingT m a -> TimingT m a

MonadThrow m => MonadThrow (TimingT m)

Methods

throwM :: Exception e => e -> TimingT m a

MonadCatch m => MonadCatch (TimingT m)

Methods

catch :: Exception e => TimingT m a -> (e -> TimingT m a) -> TimingT m a

MonadMask m => MonadMask (TimingT m)

Methods

mask :: ((forall a. TimingT m a -> TimingT m a) -> TimingT m b) -> TimingT m b

uninterruptibleMask :: ((forall a. TimingT m a -> TimingT m a) -> TimingT m b) -> TimingT m b

MonadCont m => MonadCont (TimingT m)

Methods

callCC :: ((a -> TimingT m b) -> TimingT m a) -> TimingT m a

MonadIO m => MonadTiming (TimingT m)

Methods

timeGroup :: Tag -> TimingT m a -> TimingT m a

type StM (TimingT m) a

type StM (TimingT m) a = StM m a

runTimingT :: MonadIO m => TimingT m a -> m (a, TimingTree)

Run the giving TimingT computation, recording timing events.

execTimingT :: MonadIO m => TimingT m b -> m TimingTree

Run a TimingT computation, discarding the result.

NoTimingT, a no-timing handler

newtype NoTimingT m a

Run a computation without recording any timing data.

Constructors

NoTimingT

Fields

• runNoTimingT :: m a

Instances

MonadTrans NoTimingT

Methods

lift :: Monad m => m a -> NoTimingT m a

MonadRWS r w s m => MonadRWS r w s (NoTimingT m)

MonadBase b m => MonadBase b (NoTimingT m)

Methods

liftBase :: b α -> NoTimingT m α

MonadBaseControl b m => MonadBaseControl b (NoTimingT m)

Associated Types

type StM (NoTimingT m :: * -> *) a :: *

Methods

liftBaseWith :: (RunInBase (NoTimingT m) b -> b a) -> NoTimingT m a

restoreM :: StM (NoTimingT m) a -> NoTimingT m a

MonadError e m => MonadError e (NoTimingT m)

Methods

throwError :: e -> NoTimingT m a

catchError :: NoTimingT m a -> (e -> NoTimingT m a) -> NoTimingT m a

MonadReader r m => MonadReader r (NoTimingT m)

Methods

ask :: NoTimingT m r

local :: (r -> r) -> NoTimingT m a -> NoTimingT m a

reader :: (r -> a) -> NoTimingT m a

MonadState s m => MonadState s (NoTimingT m)

Methods

get :: NoTimingT m s

put :: s -> NoTimingT m ()

state :: (s -> (a, s)) -> NoTimingT m a

MonadWriter w m => MonadWriter w (NoTimingT m)

Methods

writer :: (a, w) -> NoTimingT m a

tell :: w -> NoTimingT m ()

listen :: NoTimingT m a -> NoTimingT m (a, w)

pass :: NoTimingT m (a, w -> w) -> NoTimingT m a

Monad m => Monad (NoTimingT m)

Methods

(>>=) :: NoTimingT m a -> (a -> NoTimingT m b) -> NoTimingT m b

(>>) :: NoTimingT m a -> NoTimingT m b -> NoTimingT m b

return :: a -> NoTimingT m a

fail :: String -> NoTimingT m a

Functor m => Functor (NoTimingT m)

Methods

fmap :: (a -> b) -> NoTimingT m a -> NoTimingT m b

(<$) :: a -> NoTimingT m b -> NoTimingT m a

MonadFix m => MonadFix (NoTimingT m)

Methods

mfix :: (a -> NoTimingT m a) -> NoTimingT m a

Applicative m => Applicative (NoTimingT m)

Methods

pure :: a -> NoTimingT m a

(<*>) :: NoTimingT m (a -> b) -> NoTimingT m a -> NoTimingT m b

(*>) :: NoTimingT m a -> NoTimingT m b -> NoTimingT m b

(<*) :: NoTimingT m a -> NoTimingT m b -> NoTimingT m a

MonadIO m => MonadIO (NoTimingT m)

Methods

liftIO :: IO a -> NoTimingT m a

Alternative m => Alternative (NoTimingT m)

Methods

empty :: NoTimingT m a

(<|>) :: NoTimingT m a -> NoTimingT m a -> NoTimingT m a

some :: NoTimingT m a -> NoTimingT m [a]

many :: NoTimingT m a -> NoTimingT m [a]

MonadPlus m => MonadPlus (NoTimingT m)

Methods

mzero :: NoTimingT m a

mplus :: NoTimingT m a -> NoTimingT m a -> NoTimingT m a

MonadThrow m => MonadThrow (NoTimingT m)

Methods

throwM :: Exception e => e -> NoTimingT m a

MonadCatch m => MonadCatch (NoTimingT m)

Methods

catch :: Exception e => NoTimingT m a -> (e -> NoTimingT m a) -> NoTimingT m a

MonadMask m => MonadMask (NoTimingT m)

Methods

mask :: ((forall a. NoTimingT m a -> NoTimingT m a) -> NoTimingT m b) -> NoTimingT m b

uninterruptibleMask :: ((forall a. NoTimingT m a -> NoTimingT m a) -> NoTimingT m b) -> NoTimingT m b

MonadCont m => MonadCont (NoTimingT m)

Methods

callCC :: ((a -> NoTimingT m b) -> NoTimingT m a) -> NoTimingT m a

MonadTiming (NoTimingT m)

Methods

timeGroup :: Tag -> NoTimingT m a -> NoTimingT m a

type StM (NoTimingT m) a

type StM (NoTimingT m) a = StM m a