progression-0.1: Automates the recording and graphing of criterion benchmarksSource codeContentsIndex
Progression.Config
Description

A module exposing the configuration for progression.

Each item is either a Maybe type or a list. The values Nothing or the empty list indicate a lack of preference and will be over-ridden by the other setting in an mappend; settings can be joined together using their monoid instances.

Synopsis
data RunSettings = RunSettings {
runPrefixes :: [String]
runStoreAs :: Maybe String
}
data GraphSettings = GraphSettings {
graphCompareTo :: [String]
graphFilename :: Maybe String
}
data Mode
= JustRun
| RunAndGraph
| JustGraph
data Config = Config {
cfgMode :: Maybe Mode
cfgRun :: RunSettings
cfgGraph :: GraphSettings
}
processArgs :: Config -> [String] -> IO Config
Documentation
data RunSettings Source
The settings for running benchmarks; which prefixes to run (empty list means no preference, i.e. all -- not none) and where to put the result.
Constructors
RunSettings
runPrefixes :: [String]
runStoreAs :: Maybe String
show/hide Instances
data GraphSettings Source
The settings for plotting graphs; which labels (besides the one created by the current run, if applicable) to feature in the graph, and where to store the file (plot.png, by default).
Constructors
GraphSettings
graphCompareTo :: [String]
graphFilename :: Maybe String
show/hide Instances
data Mode Source
The mode; just running and recording a benchmark, just graphing existing results, or running a benchmark and produce a graph (the default).
Constructors
JustRun
RunAndGraph
JustGraph
show/hide Instances
data Config Source
The mode (RunAndGraph, by default), the run settings and the graph settings.
Constructors
Config
cfgMode :: Maybe Mode
cfgRun :: RunSettings
cfgGraph :: GraphSettings
show/hide Instances
processArgs :: Config -> [String] -> IO ConfigSource
Processes the given arguments (got from getArgs, typically) to adjust the given default configuration, returning the resulting configuration. Exits the whole program with an error if there is a problem, or if the user specified -h (in which case it exits after printing the options).
Produced by Haddock version 2.6.0