Copyright	(c) 2014 Bryan O'Sullivan
License	BSD-style
Maintainer	bos@serpentine.com
Stability	experimental
Portability	GHC
Safe Haskell	None
Language	Haskell2010

Gauge.Main.Options

Description

Benchmarking command-line configuration.

Synopsis

defaultConfig :: Config
makeSelector :: MatchType -> [String] -> String -> Bool
parseWith :: Config -> [String] -> (Config, [String])
describe :: String
versionInfo :: String
data Config = Config {
- confInterval :: Maybe Double
- forceGC :: Bool
- timeLimit :: Maybe Double
- minSamples :: Maybe Int
- minDuration :: MilliSeconds
- includeFirstIter :: Bool
- quickMode :: Bool
- measureOnly :: Maybe FilePath
- measureWith :: Maybe FilePath
- resamples :: Int
- regressions :: [([String], String)]
- rawDataFile :: Maybe FilePath
- reportFile :: Maybe FilePath
- csvFile :: Maybe FilePath
- csvRawFile :: Maybe FilePath
- jsonFile :: Maybe FilePath
- junitFile :: Maybe FilePath
- verbosity :: Verbosity
- template :: FilePath
- iters :: Maybe Int64
- match :: MatchType
- mode :: Mode
- displayMode :: DisplayMode
}
data Verbosity
- = Quiet
- | Normal
- | Verbose
data DisplayMode
- = Condensed
- | StatsTable
data MatchType
- = Exact
- | Prefix
- | Pattern
- | IPattern
data Mode
- = List
- | Version
- | Help
- | DefaultMode

Documentation

defaultConfig :: Config #

Default benchmarking configuration.

makeSelector #

Arguments

:: MatchType
-> [String]	Command line arguments.
-> String -> Bool

Create a benchmark selector function that can tell if a name given on the command line matches a defined benchmark.

parseWith #

Arguments

:: Config	Default configuration to use
-> [String]	Program Argument
-> (Config, [String])

describe :: String #

versionInfo :: String #

A string describing the version of this benchmark (really, the version of gauge that was used to build it).

data Config #

Top-level benchmarking configuration.

Constructors

Config

Fields

confInterval :: Maybe Double
Confidence interval for bootstrap estimation (greater than 0, less than 1).
forceGC :: Bool
Obsolete, unused. This option used to force garbage collection between every benchmark run, but it no longer has an effect (we now unconditionally force garbage collection). This option remains solely for backwards API compatibility.
timeLimit :: Maybe Double
Number of seconds to run a single benchmark. In practice, execution time may exceed this limit to honor minimum number of samples or minimum duration of each sample. Increased time limit allows us to take more samples. Use 0 for a single sample benchmark.
minSamples :: Maybe Int
Minimum number of samples to be taken.
minDuration :: MilliSeconds
Minimum duration of each sample, increased duration allows us to perform more iterations in each sample. To enforce a single iteration in a sample use duration 0.
includeFirstIter :: Bool
Discard the very first iteration of a benchmark. The first iteration includes the potentially extra cost of one time evaluations introducing large variance.
quickMode :: Bool
Quickly measure and report raw measurements.
measureOnly :: Maybe FilePath
Just measure the given benchmark and place the raw output in this file, do not analyse and generate a report.
measureWith :: Maybe FilePath
Specify the path of the benchmarking program to use (this program itself) for measuring the benchmarks in a separate process.
resamples :: Int
Number of resamples to perform when bootstrapping.
regressions :: [([String], String)]
Regressions to perform.
rawDataFile :: Maybe FilePath
File to write binary measurement and analysis data to. If not specified, this will be a temporary file.
reportFile :: Maybe FilePath
File to write report output to, with template expanded.
csvFile :: Maybe FilePath
File to write CSV summary to.
csvRawFile :: Maybe FilePath
File to write CSV measurements to.
jsonFile :: Maybe FilePath
File to write JSON-formatted results to.
junitFile :: Maybe FilePath
File to write JUnit-compatible XML results to.
verbosity :: Verbosity
Verbosity level to use when running and analysing benchmarks.
template :: FilePath
Template file to use if writing a report.
iters :: Maybe Int64
Number of iterations
match :: MatchType
Type of matching to use, if any
mode :: Mode
Mode of operation
displayMode :: DisplayMode

Instances

Eq Config #
Instance details Defined in Gauge.Main.Options Methods (==) :: Config -> Config -> Bool # (/=) :: Config -> Config -> Bool #
Data Config #
Instance details Defined in Gauge.Main.Options Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Config -> c Config # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Config # toConstr :: Config -> Constr # dataTypeOf :: Config -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Config) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Config) # gmapT :: (forall b. Data b => b -> b) -> Config -> Config # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Config -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Config -> r # gmapQ :: (forall d. Data d => d -> u) -> Config -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Config -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Config -> m Config # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Config -> m Config # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Config -> m Config #
Read Config #
Instance details Defined in Gauge.Main.Options Methods readsPrec :: Int -> ReadS Config # readList :: ReadS [Config] # readPrec :: ReadPrec Config # readListPrec :: ReadPrec [Config] #
Show Config #
Instance details Defined in Gauge.Main.Options Methods showsPrec :: Int -> Config -> ShowS # show :: Config -> String # showList :: [Config] -> ShowS #
Generic Config #
Instance details Defined in Gauge.Main.Options Associated Types type Rep Config :: Type -> Type # Methods from :: Config -> Rep Config x # to :: Rep Config x -> Config #
type Rep Config #
Instance details Defined in Gauge.Main.Options type Rep Config

data Verbosity #

Control the amount of information displayed.

Constructors

Quiet
Normal
Verbose

Instances

Bounded Verbosity #
Instance details Defined in Gauge.Main.Options Methods minBound :: Verbosity # maxBound :: Verbosity #
Enum Verbosity #
Instance details Defined in Gauge.Main.Options Methods succ :: Verbosity -> Verbosity # pred :: Verbosity -> Verbosity # toEnum :: Int -> Verbosity # fromEnum :: Verbosity -> Int # enumFrom :: Verbosity -> [Verbosity] # enumFromThen :: Verbosity -> Verbosity -> [Verbosity] # enumFromTo :: Verbosity -> Verbosity -> [Verbosity] # enumFromThenTo :: Verbosity -> Verbosity -> Verbosity -> [Verbosity] #
Eq Verbosity #
Instance details Defined in Gauge.Main.Options Methods (==) :: Verbosity -> Verbosity -> Bool # (/=) :: Verbosity -> Verbosity -> Bool #
Data Verbosity #
Instance details Defined in Gauge.Main.Options Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Verbosity -> c Verbosity # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Verbosity # toConstr :: Verbosity -> Constr # dataTypeOf :: Verbosity -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Verbosity) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Verbosity) # gmapT :: (forall b. Data b => b -> b) -> Verbosity -> Verbosity # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Verbosity -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Verbosity -> r # gmapQ :: (forall d. Data d => d -> u) -> Verbosity -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Verbosity -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Verbosity -> m Verbosity # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Verbosity -> m Verbosity # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Verbosity -> m Verbosity #
Ord Verbosity #
Instance details Defined in Gauge.Main.Options Methods compare :: Verbosity -> Verbosity -> Ordering # (<) :: Verbosity -> Verbosity -> Bool # (<=) :: Verbosity -> Verbosity -> Bool # (>) :: Verbosity -> Verbosity -> Bool # (>=) :: Verbosity -> Verbosity -> Bool # max :: Verbosity -> Verbosity -> Verbosity # min :: Verbosity -> Verbosity -> Verbosity #
Read Verbosity #
Instance details Defined in Gauge.Main.Options Methods readsPrec :: Int -> ReadS Verbosity # readList :: ReadS [Verbosity] # readPrec :: ReadPrec Verbosity # readListPrec :: ReadPrec [Verbosity] #
Show Verbosity #
Instance details Defined in Gauge.Main.Options Methods showsPrec :: Int -> Verbosity -> ShowS # show :: Verbosity -> String # showList :: [Verbosity] -> ShowS #
Generic Verbosity #
Instance details Defined in Gauge.Main.Options Associated Types type Rep Verbosity :: Type -> Type # Methods from :: Verbosity -> Rep Verbosity x # to :: Rep Verbosity x -> Verbosity #
type Rep Verbosity #
Instance details Defined in Gauge.Main.Options type Rep Verbosity = D1 (MetaData "Verbosity" "Gauge.Main.Options" "gauge-0.2.4-56QOhBnne7rKBZs55ojtRD" False) (C1 (MetaCons "Quiet" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "Normal" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "Verbose" PrefixI False) (U1 :: Type -> Type)))

data DisplayMode #

Constructors

Condensed
StatsTable

Instances

Eq DisplayMode #
Instance details Defined in Gauge.Main.Options Methods (==) :: DisplayMode -> DisplayMode -> Bool # (/=) :: DisplayMode -> DisplayMode -> Bool #
Data DisplayMode #
Instance details Defined in Gauge.Main.Options Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DisplayMode -> c DisplayMode # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DisplayMode # toConstr :: DisplayMode -> Constr # dataTypeOf :: DisplayMode -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DisplayMode) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DisplayMode) # gmapT :: (forall b. Data b => b -> b) -> DisplayMode -> DisplayMode # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DisplayMode -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DisplayMode -> r # gmapQ :: (forall d. Data d => d -> u) -> DisplayMode -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> DisplayMode -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> DisplayMode -> m DisplayMode # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DisplayMode -> m DisplayMode # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DisplayMode -> m DisplayMode #
Read DisplayMode #
Instance details Defined in Gauge.Main.Options Methods readsPrec :: Int -> ReadS DisplayMode # readList :: ReadS [DisplayMode] # readPrec :: ReadPrec DisplayMode # readListPrec :: ReadPrec [DisplayMode] #
Show DisplayMode #
Instance details Defined in Gauge.Main.Options Methods showsPrec :: Int -> DisplayMode -> ShowS # show :: DisplayMode -> String # showList :: [DisplayMode] -> ShowS #
Generic DisplayMode #
Instance details Defined in Gauge.Main.Options Associated Types type Rep DisplayMode :: Type -> Type # Methods from :: DisplayMode -> Rep DisplayMode x # to :: Rep DisplayMode x -> DisplayMode #
type Rep DisplayMode #
Instance details Defined in Gauge.Main.Options type Rep DisplayMode = D1 (MetaData "DisplayMode" "Gauge.Main.Options" "gauge-0.2.4-56QOhBnne7rKBZs55ojtRD" False) (C1 (MetaCons "Condensed" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "StatsTable" PrefixI False) (U1 :: Type -> Type))

data MatchType #

How to match a benchmark name.

Constructors

Exact	Match the exact benchmark name
Prefix	Match by prefix. For example, a prefix of `"foo"` will match `"foobar"`.
Pattern	Match by searching given substring in benchmark paths.
IPattern	Same as `Pattern`, but case insensitive.

Instances

Bounded MatchType #
Instance details Defined in Gauge.Main.Options Methods minBound :: MatchType # maxBound :: MatchType #
Enum MatchType #
Instance details Defined in Gauge.Main.Options Methods succ :: MatchType -> MatchType # pred :: MatchType -> MatchType # toEnum :: Int -> MatchType # fromEnum :: MatchType -> Int # enumFrom :: MatchType -> [MatchType] # enumFromThen :: MatchType -> MatchType -> [MatchType] # enumFromTo :: MatchType -> MatchType -> [MatchType] # enumFromThenTo :: MatchType -> MatchType -> MatchType -> [MatchType] #
Eq MatchType #
Instance details Defined in Gauge.Main.Options Methods (==) :: MatchType -> MatchType -> Bool # (/=) :: MatchType -> MatchType -> Bool #
Data MatchType #
Instance details Defined in Gauge.Main.Options Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> MatchType -> c MatchType # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c MatchType # toConstr :: MatchType -> Constr # dataTypeOf :: MatchType -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c MatchType) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c MatchType) # gmapT :: (forall b. Data b => b -> b) -> MatchType -> MatchType # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> MatchType -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> MatchType -> r # gmapQ :: (forall d. Data d => d -> u) -> MatchType -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> MatchType -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> MatchType -> m MatchType # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> MatchType -> m MatchType # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> MatchType -> m MatchType #
Ord MatchType #
Instance details Defined in Gauge.Main.Options Methods compare :: MatchType -> MatchType -> Ordering # (<) :: MatchType -> MatchType -> Bool # (<=) :: MatchType -> MatchType -> Bool # (>) :: MatchType -> MatchType -> Bool # (>=) :: MatchType -> MatchType -> Bool # max :: MatchType -> MatchType -> MatchType # min :: MatchType -> MatchType -> MatchType #
Read MatchType #
Instance details Defined in Gauge.Main.Options Methods readsPrec :: Int -> ReadS MatchType # readList :: ReadS [MatchType] # readPrec :: ReadPrec MatchType # readListPrec :: ReadPrec [MatchType] #
Show MatchType #
Instance details Defined in Gauge.Main.Options Methods showsPrec :: Int -> MatchType -> ShowS # show :: MatchType -> String # showList :: [MatchType] -> ShowS #
Generic MatchType #
Instance details Defined in Gauge.Main.Options Associated Types type Rep MatchType :: Type -> Type # Methods from :: MatchType -> Rep MatchType x # to :: Rep MatchType x -> MatchType #
type Rep MatchType #
Instance details Defined in Gauge.Main.Options type Rep MatchType = D1 (MetaData "MatchType" "Gauge.Main.Options" "gauge-0.2.4-56QOhBnne7rKBZs55ojtRD" False) ((C1 (MetaCons "Exact" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "Prefix" PrefixI False) (U1 :: Type -> Type)) :+: (C1 (MetaCons "Pattern" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "IPattern" PrefixI False) (U1 :: Type -> Type)))

data Mode #

Execution mode for a benchmark program.

Constructors

List	List all benchmarks.
Version	Print the version.
Help	Print help
DefaultMode	Default Benchmark mode

Instances

Eq Mode #
Instance details Defined in Gauge.Main.Options Methods (==) :: Mode -> Mode -> Bool # (/=) :: Mode -> Mode -> Bool #
Data Mode #
Instance details Defined in Gauge.Main.Options Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Mode -> c Mode # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Mode # toConstr :: Mode -> Constr # dataTypeOf :: Mode -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Mode) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Mode) # gmapT :: (forall b. Data b => b -> b) -> Mode -> Mode # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Mode -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Mode -> r # gmapQ :: (forall d. Data d => d -> u) -> Mode -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Mode -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Mode -> m Mode # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Mode -> m Mode # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Mode -> m Mode #
Read Mode #
Instance details Defined in Gauge.Main.Options Methods readsPrec :: Int -> ReadS Mode # readList :: ReadS [Mode] # readPrec :: ReadPrec Mode # readListPrec :: ReadPrec [Mode] #
Show Mode #
Instance details Defined in Gauge.Main.Options Methods showsPrec :: Int -> Mode -> ShowS # show :: Mode -> String # showList :: [Mode] -> ShowS #
Generic Mode #
Instance details Defined in Gauge.Main.Options Associated Types type Rep Mode :: Type -> Type # Methods from :: Mode -> Rep Mode x # to :: Rep Mode x -> Mode #
type Rep Mode #
Instance details Defined in Gauge.Main.Options type Rep Mode = D1 (MetaData "Mode" "Gauge.Main.Options" "gauge-0.2.4-56QOhBnne7rKBZs55ojtRD" False) ((C1 (MetaCons "List" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "Version" PrefixI False) (U1 :: Type -> Type)) :+: (C1 (MetaCons "Help" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "DefaultMode" PrefixI False) (U1 :: Type -> Type)))