Agda.Utils.Benchmark

Tools for benchmarking and accumulating results. Nothing Agda-specific in here.

Benchmark trie

type Account a = [a]

Account we can bill computation time to.

type CurrentAccount a = Maybe (Account a, CPUTime)

Record when we started billing the current account.

type Timings a = Trie a CPUTime

data BenchmarkOn a

Constructors

BenchmarkOff

BenchmarkOn

BenchmarkSome (Account a -> Bool)

Instances

Generic (BenchmarkOn a)

Defined in Agda.Utils.Benchmark

Associated Types

type Rep (BenchmarkOn a) :: Type -> Type

Methods

from :: BenchmarkOn a -> Rep (BenchmarkOn a) x

to :: Rep (BenchmarkOn a) x -> BenchmarkOn a

NFData a => NFData (BenchmarkOn a)

Defined in Agda.Utils.Benchmark

Methods

rnf :: BenchmarkOn a -> ()

type Rep (BenchmarkOn a)

Defined in Agda.Utils.Benchmark

type Rep (BenchmarkOn a) = D1 ('MetaData "BenchmarkOn" "Agda.Utils.Benchmark" "Agda-2.6.3.20230930-inplace" 'False) (C1 ('MetaCons "BenchmarkOff" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "BenchmarkOn" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "BenchmarkSome" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Account a -> Bool)))))

isBenchmarkOn :: Account a -> BenchmarkOn a -> Bool

data Benchmark a

Benchmark structure is a trie, mapping accounts (phases and subphases) to CPU time spent on their performance.

Constructors

Benchmark

Fields

• benchmarkOn :: !(BenchmarkOn a)

  Are we benchmarking at all?

• currentAccount :: !(CurrentAccount a)

  What are we billing to currently?

• timings :: !(Timings a)

  The accounts and their accumulated timing bill.

Instances

(Ord a, Pretty a) => Pretty (Benchmark a)

Print benchmark as three-column table with totals.

Defined in Agda.Utils.Benchmark

Methods

pretty :: Benchmark a -> Doc

prettyPrec :: Int -> Benchmark a -> Doc

prettyList :: [Benchmark a] -> Doc

Null (Benchmark a)

Initial benchmark structure (empty).

Defined in Agda.Utils.Benchmark

Methods

empty :: Benchmark a

null :: Benchmark a -> Bool

Generic (Benchmark a)

Defined in Agda.Utils.Benchmark

Associated Types

type Rep (Benchmark a) :: Type -> Type

Methods

from :: Benchmark a -> Rep (Benchmark a) x

to :: Rep (Benchmark a) x -> Benchmark a

NFData a => NFData (Benchmark a)

Defined in Agda.Utils.Benchmark

Methods

rnf :: Benchmark a -> ()

type Rep (Benchmark a)

Defined in Agda.Utils.Benchmark

type Rep (Benchmark a) = D1 ('MetaData "Benchmark" "Agda.Utils.Benchmark" "Agda-2.6.3.20230930-inplace" 'False) (C1 ('MetaCons "Benchmark" 'PrefixI 'True) (S1 ('MetaSel ('Just "benchmarkOn") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (BenchmarkOn a)) :*: (S1 ('MetaSel ('Just "currentAccount") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (CurrentAccount a)) :*: S1 ('MetaSel ('Just "timings") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Timings a)))))

mapBenchmarkOn :: (BenchmarkOn a -> BenchmarkOn a) -> Benchmark a -> Benchmark a

Semantic editor combinator.

mapCurrentAccount :: (CurrentAccount a -> CurrentAccount a) -> Benchmark a -> Benchmark a

Semantic editor combinator.

mapTimings :: (Timings a -> Timings a) -> Benchmark a -> Benchmark a

Semantic editor combinator.

addCPUTime :: Ord a => Account a -> CPUTime -> Benchmark a -> Benchmark a

Add to specified CPU time account.

Benchmarking monad.

class (Ord (BenchPhase m), Functor m, MonadIO m) => MonadBench m where

Monad with access to benchmarking data.

Minimal complete definition

getBenchmark, finally

Associated Types

type BenchPhase m

Methods

getBenchmark :: m (Benchmark (BenchPhase m))

putBenchmark :: Benchmark (BenchPhase m) -> m ()

modifyBenchmark :: (Benchmark (BenchPhase m) -> Benchmark (BenchPhase m)) -> m ()

finally :: m b -> m c -> m b

We need to be able to terminate benchmarking in case of an exception.

Instances

MonadBench TerM

Defined in Agda.Termination.Monad

Associated Types

type BenchPhase TerM

Methods

getBenchmark :: TerM (Benchmark (BenchPhase TerM))

putBenchmark :: Benchmark (BenchPhase TerM) -> TerM ()

modifyBenchmark :: (Benchmark (BenchPhase TerM) -> Benchmark (BenchPhase TerM)) -> TerM ()

finally :: TerM b -> TerM c -> TerM b

MonadBench TCM

We store benchmark statistics in an IORef. This enables benchmarking pure computation, see Agda.Benchmarking.

Defined in Agda.TypeChecking.Monad.Base

Associated Types

type BenchPhase TCM

Methods

getBenchmark :: TCM (Benchmark (BenchPhase TCM))

putBenchmark :: Benchmark (BenchPhase TCM) -> TCM ()

modifyBenchmark :: (Benchmark (BenchPhase TCM) -> Benchmark (BenchPhase TCM)) -> TCM ()

finally :: TCM b -> TCM c -> TCM b

MonadBench IO

Defined in Agda.Benchmarking

Associated Types

type BenchPhase IO

Methods

getBenchmark :: IO (Benchmark (BenchPhase IO))

putBenchmark :: Benchmark (BenchPhase IO) -> IO ()

modifyBenchmark :: (Benchmark (BenchPhase IO) -> Benchmark (BenchPhase IO)) -> IO ()

finally :: IO b -> IO c -> IO b

MonadBench m => MonadBench (ListT m)

Defined in Agda.Utils.Benchmark

Associated Types

type BenchPhase (ListT m)

Methods

getBenchmark :: ListT m (Benchmark (BenchPhase (ListT m)))

putBenchmark :: Benchmark (BenchPhase (ListT m)) -> ListT m ()

modifyBenchmark :: (Benchmark (BenchPhase (ListT m)) -> Benchmark (BenchPhase (ListT m))) -> ListT m ()

finally :: ListT m b -> ListT m c -> ListT m b

MonadBench m => MonadBench (ExceptT e m)

Defined in Agda.Utils.Benchmark

Associated Types

type BenchPhase (ExceptT e m)

Methods

getBenchmark :: ExceptT e m (Benchmark (BenchPhase (ExceptT e m)))

putBenchmark :: Benchmark (BenchPhase (ExceptT e m)) -> ExceptT e m ()

modifyBenchmark :: (Benchmark (BenchPhase (ExceptT e m)) -> Benchmark (BenchPhase (ExceptT e m))) -> ExceptT e m ()

finally :: ExceptT e m b -> ExceptT e m c -> ExceptT e m b

MonadBench m => MonadBench (ReaderT r m)

Defined in Agda.Utils.Benchmark

Associated Types

type BenchPhase (ReaderT r m)

Methods

getBenchmark :: ReaderT r m (Benchmark (BenchPhase (ReaderT r m)))

putBenchmark :: Benchmark (BenchPhase (ReaderT r m)) -> ReaderT r m ()

modifyBenchmark :: (Benchmark (BenchPhase (ReaderT r m)) -> Benchmark (BenchPhase (ReaderT r m))) -> ReaderT r m ()

finally :: ReaderT r m b -> ReaderT r m c -> ReaderT r m b

MonadBench m => MonadBench (StateT r m)

Defined in Agda.Utils.Benchmark

Associated Types

type BenchPhase (StateT r m)

Methods

getBenchmark :: StateT r m (Benchmark (BenchPhase (StateT r m)))

putBenchmark :: Benchmark (BenchPhase (StateT r m)) -> StateT r m ()

modifyBenchmark :: (Benchmark (BenchPhase (StateT r m)) -> Benchmark (BenchPhase (StateT r m))) -> StateT r m ()

finally :: StateT r m b -> StateT r m c -> StateT r m b

(MonadBench m, Monoid w) => MonadBench (WriterT w m)

Defined in Agda.Utils.Benchmark

Associated Types

type BenchPhase (WriterT w m)

Methods

getBenchmark :: WriterT w m (Benchmark (BenchPhase (WriterT w m)))

putBenchmark :: Benchmark (BenchPhase (WriterT w m)) -> WriterT w m ()

modifyBenchmark :: (Benchmark (BenchPhase (WriterT w m)) -> Benchmark (BenchPhase (WriterT w m))) -> WriterT w m ()

finally :: WriterT w m b -> WriterT w m c -> WriterT w m b

getsBenchmark :: MonadBench m => (Benchmark (BenchPhase m) -> c) -> m c

setBenchmarking :: MonadBench m => BenchmarkOn (BenchPhase m) -> m ()

Turn benchmarking on/off.

switchBenchmarking

Arguments

:: MonadBench m

=> Maybe (Account (BenchPhase m))

Maybe new account.

-> m (Maybe (Account (BenchPhase m)))

Maybe old account.

Bill current account with time up to now. Switch to new account. Return old account (if any).

reset :: MonadBench m => m ()

Resets the account and the timing information.

billTo :: MonadBench m => Account (BenchPhase m) -> m c -> m c

Bill a computation to a specific account. Works even if the computation is aborted by an exception.

billToCPS :: MonadBench m => Account (BenchPhase m) -> ((b -> m c) -> m c) -> (b -> m c) -> m c

Bill a CPS function to an account. Can't handle exceptions.

billPureTo :: MonadBench m => Account (BenchPhase m) -> c -> m c

Bill a pure computation to a specific account.