Test.Speculate.Args

This module is part o Speculate.

Arguments to the speculate function and parsing of command line arguments.

Documentation

data Args

Arguments to Speculate

Constructors

Args

Fields

• maxSize :: Int

  maximum size of considered expressions

• maxTests :: Int

  maximum number of test for each law

• constants :: [Expr]

  constants considered when generating expressions

• instances :: [Instances]

  typeclass instance information for Eq, Ord and Listable

• maxSemiSize :: Int

  maximum size of inqualities RHS/LHS

• maxCondSize :: Int

  maximum size of considered condition

• maxVars :: Int

  maximum number of variables allowed in inequalities and conditional equations

• showConstants :: Bool

  repeat constants on output

• showEquations :: Bool

  whether to show equations

• showSemiequations :: Bool

  whether to show inequalties

• showConditions :: Bool

  whether to show conditional equations

• showConstantLaws :: Bool

  whether to show laws with no variables

• autoConstants :: Bool

  automatically include constants taken from tiers of values

• minTests :: Int -> Int

  (intermediary) minimum number of tests for passing postconditions in function of maximum number of tests

• maxConstants :: Maybe Int

  (intermediary) maximum nubmer of constants allowed when considering expressions

• maxDepth :: Maybe Int

  (intermediary) maximum depth of considered expressions

• showCounts :: Bool

  (intermediary) show counts of equations, inequalities and conditional equations

• showTheory :: Bool

  (debug) whether to show raw theory

• showArgs :: Bool

  (debug) show _this_ args before running

• showHelp :: Bool

  (advanced) whether to show the command line help

• evalTimeout :: Maybe Double

  (advanced) timeout when evaluating ground expressions

• force :: Bool

  (advanced) ignore errors

• extra :: [String]

  (advanced) unused, user-defined meaning

• exclude :: [String]

  (advanced) exclude this symbols from signature before running

• onlyTypes :: [String]

  (advanced) only allow those types at top-level equations / semi-equations

• showClassesFor :: [Int]

  (advanced) show equivalence classes of expressions

• showDot :: Bool

  (advanced) whether to show a Graphviz dotfile with an Ord lattice

• quietDot :: Bool

  (advanced) whether to show a Graphviz dotfiel with an Ord lattice (less verbose)

args :: Args

Default arguments to Speculate

constant :: Typeable a => String -> a -> Expr

showConstant :: (Typeable a, Show a) => a -> Expr

foreground :: Expr

A special Expr value. When provided on the constants list, makes all the following constants foreground constants.

background :: Expr

A special Expr value. When provided on the constants list, makes all the following constants background constants. Background constants can appear in laws about other constants, but not by themselves.

getArgs :: Args -> IO Args

computeMaxSemiSize :: Args -> Int

computeMaxCondSize :: Args -> Int

computeInstances :: Args -> Instances

types :: Args -> [TypeRep]

atoms :: Args -> [[Expr]]

compareExpr :: Args -> Expr -> Expr -> Ordering

keepExpr :: Args -> Expr -> Bool

timeout :: Args -> Bool -> Bool

shouldShowEquation :: Args -> (Expr, Expr) -> Bool

shouldShowConditionalEquation :: Args -> (Expr, Expr, Expr) -> Bool

reallyShowConditions :: Args -> Bool

foregroundConstants :: Args -> [Expr]

backgroundConstants :: Args -> [Expr]

about :: Expr -> [Expr] -> Bool

allAbout :: Expr -> [Expr] -> Bool

Are all constants in an expression about a list of constants? Examples in pseudo-Haskell:

x + y `allAbout` [(+)] == True
x + y == z `allAbout` [(+)] == False
x + y == z `allAbout` [(+),(==)] == True

prepareArgs :: Args -> Mode Args