| Copyright | (c) 2014 Bryan O'Sullivan |
|---|---|
| License | BSD-style |
| Maintainer | bos@serpentine.com |
| Stability | experimental |
| Portability | GHC |
| Safe Haskell | None |
| Language | Haskell2010 |
Criterion.Main.Options
Description
Benchmarking command-line configuration.
Documentation
Execution mode for a benchmark program.
Constructors
| List | List all benchmarks. |
| Version | Print the version. |
| RunIters Config Int64 MatchType [String] | Run the given benchmarks, without collecting or analysing performance numbers. |
| Run Config MatchType [String] | Run and analyse the given benchmarks. |
Instances
How to match a benchmark name.
Constructors
| Prefix | Match by prefix. For example, a prefix of
|
| Glob | Match by Unix-style glob pattern. When using this match
type, benchmark names are treated as if they were
file-paths. For example, the glob patterns |
| Pattern | Match by searching given substring in benchmark paths. |
| IPattern | Same as |
Instances
| Data MatchType Source # | |||||
Defined in Criterion.Main.Options Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> MatchType -> c MatchType Source # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c MatchType Source # toConstr :: MatchType -> Constr Source # dataTypeOf :: MatchType -> DataType Source # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c MatchType) Source # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c MatchType) Source # gmapT :: (forall b. Data b => b -> b) -> MatchType -> MatchType Source # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> MatchType -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> MatchType -> r Source # gmapQ :: (forall d. Data d => d -> u) -> MatchType -> [u] Source # gmapQi :: Int -> (forall d. Data d => d -> u) -> MatchType -> u Source # gmapM :: Monad m => (forall d. Data d => d -> m d) -> MatchType -> m MatchType Source # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> MatchType -> m MatchType Source # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> MatchType -> m MatchType Source # | |||||
| Bounded MatchType Source # | |||||
| Enum MatchType Source # | |||||
Defined in Criterion.Main.Options Methods succ :: MatchType -> MatchType Source # pred :: MatchType -> MatchType Source # toEnum :: Int -> MatchType Source # fromEnum :: MatchType -> Int Source # enumFrom :: MatchType -> [MatchType] Source # enumFromThen :: MatchType -> MatchType -> [MatchType] Source # enumFromTo :: MatchType -> MatchType -> [MatchType] Source # enumFromThenTo :: MatchType -> MatchType -> MatchType -> [MatchType] Source # | |||||
| Generic MatchType Source # | |||||
Defined in Criterion.Main.Options Associated Types
| |||||
| Read MatchType Source # | |||||
| Show MatchType Source # | |||||
| Eq MatchType Source # | |||||
| Ord MatchType Source # | |||||
Defined in Criterion.Main.Options | |||||
| type Rep MatchType Source # | |||||
Defined in Criterion.Main.Options type Rep MatchType = D1 ('MetaData "MatchType" "Criterion.Main.Options" "criterion-1.6.4.0-JzpFqVMGT88Jt9HLgKXS6" 'False) ((C1 ('MetaCons "Prefix" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Glob" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Pattern" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "IPattern" 'PrefixI 'False) (U1 :: Type -> Type))) | |||||
defaultConfig :: Config Source #
Default benchmarking configuration.
Arguments
| :: Config | Default configuration to use if options are not explicitly specified. |
| -> Parser Mode |
Parse a command line.
describeWith :: Parser a -> ParserInfo a Source #
Flesh out command-line information using a custom Parser.
versionInfo :: String Source #
A string describing the version of this benchmark (really, the version of criterion that was used to build it).