Copyright | (c) 2014 Bryan O'Sullivan |
---|---|
License | BSD-style |
Maintainer | bos@serpentine.com |
Stability | experimental |
Portability | GHC |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Criterion.Main.Options
Description
Benchmarking command-line configuration.
Synopsis
- data Mode
- data MatchType
- defaultConfig :: Config
- parseWith :: Config -> Parser Mode
- config :: Config -> Parser Config
- describe :: Config -> ParserInfo Mode
- describeWith :: Parser a -> ParserInfo a
- versionInfo :: String
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
Data Mode Source # | |
Defined in Criterion.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 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 :: forall r r'. (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 | |
Generic Mode Source # | |
Read Mode Source # | |
Defined in Criterion.Main.Options | |
Show Mode Source # | |
Eq Mode Source # | |
type Rep Mode Source # | |
Defined in Criterion.Main.Options type Rep Mode = D1 ('MetaData "Mode" "Criterion.Main.Options" "criterion-1.6.1.0-2h8jJxyb3zL8Vx5Ow7sziS" 'False) ((C1 ('MetaCons "List" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Version" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "RunIters" 'PrefixI 'False) ((S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Config) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int64)) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MatchType) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [String]))) :+: C1 ('MetaCons "Run" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Config) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MatchType) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [String]))))) |
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 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 :: forall r r'. (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 | |
Bounded MatchType Source # | |
Defined in Criterion.Main.Options | |
Enum MatchType Source # | |
Defined in Criterion.Main.Options | |
Generic MatchType Source # | |
Read MatchType Source # | |
Defined in Criterion.Main.Options | |
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.1.0-2h8jJxyb3zL8Vx5Ow7sziS" '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).