Copyright | (c) Iago Abal, 2013-2015 (c) David Castro, 2013-2015 |
---|---|
License | BSD3 |
Maintainer | Iago Abal <mail@iagoabal.eu>, David Castro <david.castro.dcp@gmail.com> |
Safe Haskell | None |
Language | Haskell98 |
A simple monadic interface to Z3 API.
Examples: https://bitbucket.org/iago/z3-haskell/src/tip/examples/Example/Monad
- class (Applicative m, Monad m, MonadIO m) => MonadZ3 m where
- getSolver :: m Solver
- getContext :: m Context
- data Z3 a
- module Z3.Opts
- data Logic
- evalZ3 :: Z3 a -> IO a
- evalZ3With :: Maybe Logic -> Opts -> Z3 a -> IO a
- data Z3Env
- newEnv :: Maybe Logic -> Opts -> IO Z3Env
- evalZ3WithEnv :: Z3 a -> Z3Env -> IO a
- data Symbol
- data AST
- data Sort
- data FuncDecl
- data App
- data Pattern
- data Constructor
- data Model
- data Context
- data FuncInterp
- data FuncEntry
- data Params
- data Solver
- data ASTKind
- data Result
- mkParams :: MonadZ3 z3 => z3 Params
- paramsSetBool :: MonadZ3 z3 => Params -> Symbol -> Bool -> z3 ()
- paramsSetUInt :: MonadZ3 z3 => Params -> Symbol -> Word -> z3 ()
- paramsSetDouble :: MonadZ3 z3 => Params -> Symbol -> Double -> z3 ()
- paramsSetSymbol :: MonadZ3 z3 => Params -> Symbol -> Symbol -> z3 ()
- paramsToString :: MonadZ3 z3 => Params -> z3 String
- mkIntSymbol :: (MonadZ3 z3, Integral i) => i -> z3 Symbol
- mkStringSymbol :: MonadZ3 z3 => String -> z3 Symbol
- mkUninterpretedSort :: MonadZ3 z3 => Symbol -> z3 Sort
- mkBoolSort :: MonadZ3 z3 => z3 Sort
- mkIntSort :: MonadZ3 z3 => z3 Sort
- mkRealSort :: MonadZ3 z3 => z3 Sort
- mkBvSort :: MonadZ3 z3 => Int -> z3 Sort
- mkArraySort :: MonadZ3 z3 => Sort -> Sort -> z3 Sort
- mkTupleSort :: MonadZ3 z3 => Symbol -> [(Symbol, Sort)] -> z3 (Sort, FuncDecl, [FuncDecl])
- mkConstructor :: MonadZ3 z3 => Symbol -> Symbol -> [(Symbol, Maybe Sort, Int)] -> z3 Constructor
- mkDatatype :: MonadZ3 z3 => Symbol -> [Constructor] -> z3 Sort
- mkFuncDecl :: MonadZ3 z3 => Symbol -> [Sort] -> Sort -> z3 FuncDecl
- mkApp :: MonadZ3 z3 => FuncDecl -> [AST] -> z3 AST
- mkConst :: MonadZ3 z3 => Symbol -> Sort -> z3 AST
- mkFreshConst :: MonadZ3 z3 => String -> Sort -> z3 AST
- mkFreshFuncDecl :: MonadZ3 z3 => String -> [Sort] -> Sort -> z3 FuncDecl
- mkVar :: MonadZ3 z3 => Symbol -> Sort -> z3 AST
- mkBoolVar :: MonadZ3 z3 => Symbol -> z3 AST
- mkRealVar :: MonadZ3 z3 => Symbol -> z3 AST
- mkIntVar :: MonadZ3 z3 => Symbol -> z3 AST
- mkBvVar :: MonadZ3 z3 => Symbol -> Int -> z3 AST
- mkFreshVar :: MonadZ3 z3 => String -> Sort -> z3 AST
- mkFreshBoolVar :: MonadZ3 z3 => String -> z3 AST
- mkFreshRealVar :: MonadZ3 z3 => String -> z3 AST
- mkFreshIntVar :: MonadZ3 z3 => String -> z3 AST
- mkFreshBvVar :: MonadZ3 z3 => String -> Int -> z3 AST
- mkTrue :: MonadZ3 z3 => z3 AST
- mkFalse :: MonadZ3 z3 => z3 AST
- mkEq :: MonadZ3 z3 => AST -> AST -> z3 AST
- mkNot :: MonadZ3 z3 => AST -> z3 AST
- mkIte :: MonadZ3 z3 => AST -> AST -> AST -> z3 AST
- mkIff :: MonadZ3 z3 => AST -> AST -> z3 AST
- mkImplies :: MonadZ3 z3 => AST -> AST -> z3 AST
- mkXor :: MonadZ3 z3 => AST -> AST -> z3 AST
- mkAnd :: MonadZ3 z3 => [AST] -> z3 AST
- mkOr :: MonadZ3 z3 => [AST] -> z3 AST
- mkDistinct :: MonadZ3 z3 => [AST] -> z3 AST
- mkBool :: MonadZ3 z3 => Bool -> z3 AST
- mkAdd :: MonadZ3 z3 => [AST] -> z3 AST
- mkMul :: MonadZ3 z3 => [AST] -> z3 AST
- mkSub :: MonadZ3 z3 => [AST] -> z3 AST
- mkUnaryMinus :: MonadZ3 z3 => AST -> z3 AST
- mkDiv :: MonadZ3 z3 => AST -> AST -> z3 AST
- mkMod :: MonadZ3 z3 => AST -> AST -> z3 AST
- mkRem :: MonadZ3 z3 => AST -> AST -> z3 AST
- mkLt :: MonadZ3 z3 => AST -> AST -> z3 AST
- mkLe :: MonadZ3 z3 => AST -> AST -> z3 AST
- mkGt :: MonadZ3 z3 => AST -> AST -> z3 AST
- mkGe :: MonadZ3 z3 => AST -> AST -> z3 AST
- mkInt2Real :: MonadZ3 z3 => AST -> z3 AST
- mkReal2Int :: MonadZ3 z3 => AST -> z3 AST
- mkIsInt :: MonadZ3 z3 => AST -> z3 AST
- mkBvnot :: MonadZ3 z3 => AST -> z3 AST
- mkBvredand :: MonadZ3 z3 => AST -> z3 AST
- mkBvredor :: MonadZ3 z3 => AST -> z3 AST
- mkBvand :: MonadZ3 z3 => AST -> AST -> z3 AST
- mkBvor :: MonadZ3 z3 => AST -> AST -> z3 AST
- mkBvxor :: MonadZ3 z3 => AST -> AST -> z3 AST
- mkBvnand :: MonadZ3 z3 => AST -> AST -> z3 AST
- mkBvnor :: MonadZ3 z3 => AST -> AST -> z3 AST
- mkBvxnor :: MonadZ3 z3 => AST -> AST -> z3 AST
- mkBvneg :: MonadZ3 z3 => AST -> z3 AST
- mkBvadd :: MonadZ3 z3 => AST -> AST -> z3 AST
- mkBvsub :: MonadZ3 z3 => AST -> AST -> z3 AST
- mkBvmul :: MonadZ3 z3 => AST -> AST -> z3 AST
- mkBvudiv :: MonadZ3 z3 => AST -> AST -> z3 AST
- mkBvsdiv :: MonadZ3 z3 => AST -> AST -> z3 AST
- mkBvurem :: MonadZ3 z3 => AST -> AST -> z3 AST
- mkBvsrem :: MonadZ3 z3 => AST -> AST -> z3 AST
- mkBvsmod :: MonadZ3 z3 => AST -> AST -> z3 AST
- mkBvult :: MonadZ3 z3 => AST -> AST -> z3 AST
- mkBvslt :: MonadZ3 z3 => AST -> AST -> z3 AST
- mkBvule :: MonadZ3 z3 => AST -> AST -> z3 AST
- mkBvsle :: MonadZ3 z3 => AST -> AST -> z3 AST
- mkBvuge :: MonadZ3 z3 => AST -> AST -> z3 AST
- mkBvsge :: MonadZ3 z3 => AST -> AST -> z3 AST
- mkBvugt :: MonadZ3 z3 => AST -> AST -> z3 AST
- mkBvsgt :: MonadZ3 z3 => AST -> AST -> z3 AST
- mkConcat :: MonadZ3 z3 => AST -> AST -> z3 AST
- mkExtract :: MonadZ3 z3 => Int -> Int -> AST -> z3 AST
- mkSignExt :: MonadZ3 z3 => Int -> AST -> z3 AST
- mkZeroExt :: MonadZ3 z3 => Int -> AST -> z3 AST
- mkRepeat :: MonadZ3 z3 => Int -> AST -> z3 AST
- mkBvshl :: MonadZ3 z3 => AST -> AST -> z3 AST
- mkBvlshr :: MonadZ3 z3 => AST -> AST -> z3 AST
- mkBvashr :: MonadZ3 z3 => AST -> AST -> z3 AST
- mkRotateLeft :: MonadZ3 z3 => Int -> AST -> z3 AST
- mkRotateRight :: MonadZ3 z3 => Int -> AST -> z3 AST
- mkExtRotateLeft :: MonadZ3 z3 => AST -> AST -> z3 AST
- mkExtRotateRight :: MonadZ3 z3 => AST -> AST -> z3 AST
- mkInt2bv :: MonadZ3 z3 => Int -> AST -> z3 AST
- mkBv2int :: MonadZ3 z3 => AST -> Bool -> z3 AST
- mkBvnegNoOverflow :: MonadZ3 z3 => AST -> z3 AST
- mkBvaddNoOverflow :: MonadZ3 z3 => AST -> AST -> Bool -> z3 AST
- mkBvaddNoUnderflow :: MonadZ3 z3 => AST -> AST -> z3 AST
- mkBvsubNoOverflow :: MonadZ3 z3 => AST -> AST -> z3 AST
- mkBvsubNoUnderflow :: MonadZ3 z3 => AST -> AST -> z3 AST
- mkBvmulNoOverflow :: MonadZ3 z3 => AST -> AST -> Bool -> z3 AST
- mkBvmulNoUnderflow :: MonadZ3 z3 => AST -> AST -> z3 AST
- mkBvsdivNoOverflow :: MonadZ3 z3 => AST -> AST -> z3 AST
- mkSelect :: MonadZ3 z3 => AST -> AST -> z3 AST
- mkStore :: MonadZ3 z3 => AST -> AST -> AST -> z3 AST
- mkConstArray :: MonadZ3 z3 => Sort -> AST -> z3 AST
- mkMap :: MonadZ3 z3 => FuncDecl -> [AST] -> z3 AST
- mkArrayDefault :: MonadZ3 z3 => AST -> z3 AST
- mkNumeral :: MonadZ3 z3 => String -> Sort -> z3 AST
- mkInt :: MonadZ3 z3 => Int -> Sort -> z3 AST
- mkReal :: MonadZ3 z3 => Int -> Int -> z3 AST
- mkUnsignedInt :: MonadZ3 z3 => Word -> Sort -> z3 AST
- mkInt64 :: MonadZ3 z3 => Int64 -> Sort -> z3 AST
- mkUnsignedInt64 :: MonadZ3 z3 => Word64 -> Sort -> z3 AST
- mkIntegral :: (MonadZ3 z3, Integral a) => a -> Sort -> z3 AST
- mkRational :: MonadZ3 z3 => Rational -> z3 AST
- mkFixed :: (MonadZ3 z3, HasResolution a) => Fixed a -> z3 AST
- mkRealNum :: (MonadZ3 z3, Real r) => r -> z3 AST
- mkInteger :: MonadZ3 z3 => Integer -> z3 AST
- mkIntNum :: (MonadZ3 z3, Integral a) => a -> z3 AST
- mkBitvector :: MonadZ3 z3 => Int -> Integer -> z3 AST
- mkBvNum :: (MonadZ3 z3, Integral i) => Int -> i -> z3 AST
- mkPattern :: MonadZ3 z3 => [AST] -> z3 Pattern
- mkBound :: MonadZ3 z3 => Int -> Sort -> z3 AST
- mkForall :: MonadZ3 z3 => [Pattern] -> [Symbol] -> [Sort] -> AST -> z3 AST
- mkExists :: MonadZ3 z3 => [Pattern] -> [Symbol] -> [Sort] -> AST -> z3 AST
- mkForallConst :: MonadZ3 z3 => [Pattern] -> [App] -> AST -> z3 AST
- mkExistsConst :: MonadZ3 z3 => [Pattern] -> [App] -> AST -> z3 AST
- getSymbolString :: MonadZ3 z3 => Symbol -> z3 String
- getBvSortSize :: MonadZ3 z3 => Sort -> z3 Int
- getDatatypeSortConstructors :: MonadZ3 z3 => Sort -> z3 [FuncDecl]
- getDatatypeSortRecognizers :: MonadZ3 z3 => Sort -> z3 [FuncDecl]
- getDeclName :: MonadZ3 z3 => FuncDecl -> z3 Symbol
- getSort :: MonadZ3 z3 => AST -> z3 Sort
- getBoolValue :: MonadZ3 z3 => AST -> z3 (Maybe Bool)
- getAstKind :: MonadZ3 z3 => AST -> z3 ASTKind
- toApp :: MonadZ3 z3 => AST -> z3 App
- getNumeralString :: MonadZ3 z3 => AST -> z3 String
- getBool :: MonadZ3 z3 => AST -> z3 Bool
- getInt :: MonadZ3 z3 => AST -> z3 Integer
- getReal :: MonadZ3 z3 => AST -> z3 Rational
- getBv :: MonadZ3 z3 => AST -> Bool -> z3 Integer
- modelEval :: MonadZ3 z3 => Model -> AST -> z3 (Maybe AST)
- evalArray :: MonadZ3 z3 => Model -> AST -> z3 (Maybe FuncModel)
- getFuncInterp :: MonadZ3 z3 => Model -> FuncDecl -> z3 (Maybe FuncInterp)
- isAsArray :: MonadZ3 z3 => AST -> z3 Bool
- getAsArrayFuncDecl :: MonadZ3 z3 => AST -> z3 FuncDecl
- funcInterpGetNumEntries :: MonadZ3 z3 => FuncInterp -> z3 Int
- funcInterpGetEntry :: MonadZ3 z3 => FuncInterp -> Int -> z3 FuncEntry
- funcInterpGetElse :: MonadZ3 z3 => FuncInterp -> z3 AST
- funcInterpGetArity :: MonadZ3 z3 => FuncInterp -> z3 Int
- funcEntryGetValue :: MonadZ3 z3 => FuncEntry -> z3 AST
- funcEntryGetNumArgs :: MonadZ3 z3 => FuncEntry -> z3 Int
- funcEntryGetArg :: MonadZ3 z3 => FuncEntry -> Int -> z3 AST
- modelToString :: MonadZ3 z3 => Model -> z3 String
- showModel :: MonadZ3 z3 => Model -> z3 String
- type EvalAst m a = Model -> AST -> m (Maybe a)
- eval :: MonadZ3 z3 => EvalAst z3 AST
- evalBool :: MonadZ3 z3 => EvalAst z3 Bool
- evalInt :: MonadZ3 z3 => EvalAst z3 Integer
- evalReal :: MonadZ3 z3 => EvalAst z3 Rational
- evalBv :: MonadZ3 z3 => Bool -> EvalAst z3 Integer
- evalT :: (MonadZ3 z3, Traversable t) => Model -> t AST -> z3 (Maybe (t AST))
- mapEval :: (MonadZ3 z3, Traversable t) => EvalAst z3 a -> Model -> t AST -> z3 (Maybe (t a))
- data FuncModel = FuncModel {
- interpMap :: [([AST], AST)]
- interpElse :: AST
- evalFunc :: MonadZ3 z3 => Model -> FuncDecl -> z3 (Maybe FuncModel)
- data ASTPrintMode
- setASTPrintMode :: MonadZ3 z3 => ASTPrintMode -> z3 ()
- astToString :: MonadZ3 z3 => AST -> z3 String
- patternToString :: MonadZ3 z3 => Pattern -> z3 String
- sortToString :: MonadZ3 z3 => Sort -> z3 String
- funcDeclToString :: MonadZ3 z3 => FuncDecl -> z3 String
- benchmarkToSMTLibString :: MonadZ3 z3 => String -> String -> String -> String -> [AST] -> AST -> z3 String
- data Z3Error = Z3Error {
- errCode :: Z3ErrorCode
- errMsg :: String
- data Z3ErrorCode
- data Version = Version {}
- getVersion :: MonadZ3 z3 => z3 Version
- solverGetHelp :: MonadZ3 z3 => z3 String
- solverSetParams :: MonadZ3 z3 => Params -> z3 ()
- solverPush :: MonadZ3 z3 => z3 ()
- solverPop :: MonadZ3 z3 => Int -> z3 ()
- solverReset :: MonadZ3 z3 => z3 ()
- solverGetNumScopes :: MonadZ3 z3 => z3 Int
- solverAssertCnstr :: MonadZ3 z3 => AST -> z3 ()
- solverAssertAndTrack :: MonadZ3 z3 => AST -> AST -> z3 ()
- solverCheck :: MonadZ3 z3 => z3 Result
- solverCheckAssumptions :: MonadZ3 z3 => [AST] -> z3 Result
- solverGetModel :: MonadZ3 z3 => z3 Model
- solverGetUnsatCore :: MonadZ3 z3 => z3 [AST]
- solverGetReasonUnknown :: MonadZ3 z3 => z3 String
- solverToString :: MonadZ3 z3 => z3 String
- assert :: MonadZ3 z3 => AST -> z3 ()
- check :: MonadZ3 z3 => z3 Result
- checkAssumptions :: MonadZ3 z3 => [AST] -> z3 Result
- solverCheckAndGetModel :: MonadZ3 z3 => z3 (Result, Maybe Model)
- getModel :: MonadZ3 z3 => z3 (Result, Maybe Model)
- withModel :: (Applicative z3, MonadZ3 z3) => (Model -> z3 a) -> z3 (Result, Maybe a)
- getUnsatCore :: MonadZ3 z3 => z3 [AST]
- push :: MonadZ3 z3 => z3 ()
- pop :: MonadZ3 z3 => Int -> z3 ()
- local :: MonadZ3 z3 => z3 a -> z3 a
- reset :: MonadZ3 z3 => z3 ()
- getNumScopes :: MonadZ3 z3 => z3 Int
Z3 monad
class (Applicative m, Monad m, MonadIO m) => MonadZ3 m where Source
module Z3.Opts
Solvers available in Z3.
These are described at http://smtlib.cs.uiowa.edu/logics.html
AUFLIA | Closed formulas over the theory of linear integer arithmetic and arrays extended with free sort and function symbols but restricted to arrays with integer indices and values. |
AUFLIRA | Closed linear formulas with free sort and function symbols over one- and two-dimentional arrays of integer index and real value. |
AUFNIRA | Closed formulas with free function and predicate symbols over a theory of arrays of arrays of integer index and real value. |
LRA | Closed linear formulas in linear real arithmetic. |
QF_ABV | Closed quantifier-free formulas over the theory of bitvectors and bitvector arrays. |
QF_AUFBV | Closed quantifier-free formulas over the theory of bitvectors and bitvector arrays extended with free sort and function symbols. |
QF_AUFLIA | Closed quantifier-free linear formulas over the theory of integer arrays extended with free sort and function symbols. |
QF_AX | Closed quantifier-free formulas over the theory of arrays with extensionality. |
QF_BV | Closed quantifier-free formulas over the theory of fixed-size bitvectors. |
QF_IDL | Difference Logic over the integers. In essence, Boolean combinations of inequations of the form x - y < b where x and y are integer variables and b is an integer constant. |
QF_LIA | Unquantified linear integer arithmetic. In essence, Boolean combinations of inequations between linear polynomials over integer variables. |
QF_LRA | Unquantified linear real arithmetic. In essence, Boolean combinations of inequations between linear polynomials over real variables. |
QF_NIA | Quantifier-free integer arithmetic. |
QF_NRA | Quantifier-free real arithmetic. |
QF_RDL | Difference Logic over the reals. In essence, Boolean combinations of inequations of the form x - y < b where x and y are real variables and b is a rational constant. |
QF_UF | Unquantified formulas built over a signature of uninterpreted (i.e., free) sort and function symbols. |
QF_UFBV | Unquantified formulas over bitvectors with uninterpreted sort function and symbols. |
QF_UFIDL | Difference Logic over the integers (in essence) but with uninterpreted sort and function symbols. |
QF_UFLIA | Unquantified linear integer arithmetic with uninterpreted sort and function symbols. |
QF_UFLRA | Unquantified linear real arithmetic with uninterpreted sort and function symbols. |
QF_UFNRA | Unquantified non-linear real arithmetic with uninterpreted sort and function symbols. |
UFLRA | Linear real arithmetic with uninterpreted sort and function symbols. |
UFNIA | Non-linear integer arithmetic with uninterpreted sort and function symbols. |
Z3 enviroments
evalZ3WithEnv :: Z3 a -> Z3Env -> IO a Source
Eval a Z3 script with a given environment.
Environments may facilitate running many queries under the same logical context.
Note that an environment may change after each query.
If you want to preserve the same environment then use local
, as in
evalZ3WithEnv env (local query)
.
Types
A Z3 symbol.
Used to name types, constants and functions.
A Z3 AST node.
This is the data-structure used in Z3 to represent terms, formulas and types.
A kind of AST representing function symbols.
A kind of AST representing constant and function declarations.
A kind of AST representing pattern and multi-patterns to guide quantifier instantiation.
data Constructor Source
A type contructor for a (recursive) datatype.
Representation of the value of a Z3_func_interp
at a particular point.
A Z3 parameter set.
Starting at Z3 4.0, parameter sets are used to configure many components such as: simplifiers, tactics, solvers, etc.
A Z3 solver engine.
A(n) (incremental) solver, possibly specialized by a particular tactic or logic.
Different kinds of Z3 AST nodes.
Satisfiability result
Result of a satisfiability check.
This corresponds to the z3_lbool type in the C API.
Parameters
mkParams :: MonadZ3 z3 => z3 Params Source
Create a Z3 (empty) parameter set.
Starting at Z3 4.0, parameter sets are used to configure many components such as: simplifiers, tactics, solvers, etc.
paramsSetBool :: MonadZ3 z3 => Params -> Symbol -> Bool -> z3 () Source
Add a Boolean parameter k with value v to the parameter set p.
paramsSetUInt :: MonadZ3 z3 => Params -> Symbol -> Word -> z3 () Source
Add a unsigned parameter k with value v to the parameter set p.
paramsSetDouble :: MonadZ3 z3 => Params -> Symbol -> Double -> z3 () Source
Add a double parameter k with value v to the parameter set p.
paramsSetSymbol :: MonadZ3 z3 => Params -> Symbol -> Symbol -> z3 () Source
Add a symbol parameter k with value v to the parameter set p.
paramsToString :: MonadZ3 z3 => Params -> z3 String Source
Convert a parameter set into a string.
This function is mainly used for printing the contents of a parameter set.
Symbols
mkIntSymbol :: (MonadZ3 z3, Integral i) => i -> z3 Symbol Source
Create a Z3 symbol using an integer.
mkStringSymbol :: MonadZ3 z3 => String -> z3 Symbol Source
Create a Z3 symbol using a string.
Sorts
mkUninterpretedSort :: MonadZ3 z3 => Symbol -> z3 Sort Source
Create a free (uninterpreted) type using the given name (symbol).
mkBoolSort :: MonadZ3 z3 => z3 Sort Source
Create the boolean type.
mkRealSort :: MonadZ3 z3 => z3 Sort Source
Create the real type.
mkBvSort :: MonadZ3 z3 => Int -> z3 Sort Source
Create a bit-vector type of the given size.
This type can also be seen as a machine integer.
:: MonadZ3 z3 | |
=> Symbol | Name of the sort |
-> [(Symbol, Sort)] | Name and sort of each field |
-> z3 (Sort, FuncDecl, [FuncDecl]) | Resulting sort, and function declarations for the constructor and projections. |
Create a tuple type
:: MonadZ3 z3 | |
=> Symbol | Name of the sonstructor |
-> Symbol | Name of recognizer function |
-> [(Symbol, Maybe Sort, Int)] | Name, sort option, and sortRefs |
-> z3 Constructor |
Create a contructor
mkDatatype :: MonadZ3 z3 => Symbol -> [Constructor] -> z3 Sort Source
Create datatype, such as lists, trees, records, enumerations or unions of records. The datatype may be recursive. Return the datatype sort.
Constants and Applications
mkFreshFuncDecl :: MonadZ3 z3 => String -> [Sort] -> Sort -> z3 FuncDecl Source
Declare a fresh constant or function.
Helpers
mkVar :: MonadZ3 z3 => Symbol -> Sort -> z3 AST Source
Declare and create a variable (aka constant).
An alias for mkConst
.
mkBoolVar :: MonadZ3 z3 => Symbol -> z3 AST Source
Declarate and create a variable of sort bool.
See mkVar
.
mkRealVar :: MonadZ3 z3 => Symbol -> z3 AST Source
Declarate and create a variable of sort real.
See mkVar
.
mkIntVar :: MonadZ3 z3 => Symbol -> z3 AST Source
Declarate and create a variable of sort int.
See mkVar
.
Declarate and create a variable of sort bit-vector.
See mkVar
.
mkFreshVar :: MonadZ3 z3 => String -> Sort -> z3 AST Source
Declare and create a fresh variable (aka constant).
An alias for mkFreshConst
.
mkFreshBoolVar :: MonadZ3 z3 => String -> z3 AST Source
Declarate and create a fresh variable of sort bool.
See mkFreshVar
.
mkFreshRealVar :: MonadZ3 z3 => String -> z3 AST Source
Declarate and create a fresh variable of sort real.
See mkFreshVar
.
mkFreshIntVar :: MonadZ3 z3 => String -> z3 AST Source
Declarate and create a fresh variable of sort int.
See mkFreshVar
.
Declarate and create a fresh variable of sort bit-vector.
See mkFreshVar
.
Propositional Logic and Equality
mkIte :: MonadZ3 z3 => AST -> AST -> AST -> z3 AST Source
Create an AST node representing an if-then-else: ite(t1, t2, t3).
mkImplies :: MonadZ3 z3 => AST -> AST -> z3 AST Source
Create an AST node representing t1 implies t2.
mkAnd :: MonadZ3 z3 => [AST] -> z3 AST Source
Create an AST node representing args[0] and ... and args[num_args-1].
mkOr :: MonadZ3 z3 => [AST] -> z3 AST Source
Create an AST node representing args[0] or ... or args[num_args-1].
mkDistinct :: MonadZ3 z3 => [AST] -> z3 AST Source
The distinct construct is used for declaring the arguments pairwise distinct.
Helpers
Arithmetic: Integers and Reals
mkAdd :: MonadZ3 z3 => [AST] -> z3 AST Source
Create an AST node representing args[0] + ... + args[num_args-1].
mkMul :: MonadZ3 z3 => [AST] -> z3 AST Source
Create an AST node representing args[0] * ... * args[num_args-1].
mkSub :: MonadZ3 z3 => [AST] -> z3 AST Source
Create an AST node representing args[0] - ... - args[num_args - 1].
mkUnaryMinus :: MonadZ3 z3 => AST -> z3 AST Source
Create an AST node representing -arg.
mkInt2Real :: MonadZ3 z3 => AST -> z3 AST Source
Coerce an integer to a real.
mkReal2Int :: MonadZ3 z3 => AST -> z3 AST Source
Coerce a real to an integer.
Bit-vectors
mkBvredand :: MonadZ3 z3 => AST -> z3 AST Source
Take conjunction of bits in vector, return vector of length 1.
mkBvredor :: MonadZ3 z3 => AST -> z3 AST Source
Take disjunction of bits in vector, return vector of length 1.
mkBvsrem :: MonadZ3 z3 => AST -> AST -> z3 AST Source
Two's complement signed remainder (sign follows dividend).
mkBvsmod :: MonadZ3 z3 => AST -> AST -> z3 AST Source
Two's complement signed remainder (sign follows divisor).
mkBvsge :: MonadZ3 z3 => AST -> AST -> z3 AST Source
Two's complement signed greater than or equal to.
mkExtract :: MonadZ3 z3 => Int -> Int -> AST -> z3 AST Source
Extract the bits high down to low from a bitvector of size m to yield a new bitvector of size n, where n = high - low + 1.
mkSignExt :: MonadZ3 z3 => Int -> AST -> z3 AST Source
Sign-extend of the given bit-vector to the (signed) equivalent bitvector of size m+i, where m is the size of the given bit-vector.
mkZeroExt :: MonadZ3 z3 => Int -> AST -> z3 AST Source
Extend the given bit-vector with zeros to the (unsigned) equivalent bitvector of size m+i, where m is the size of the given bit-vector.
mkExtRotateRight :: MonadZ3 z3 => AST -> AST -> z3 AST Source
Rotate bits of t1 to the right t2 times.
mkInt2bv :: MonadZ3 z3 => Int -> AST -> z3 AST Source
Create an n bit bit-vector from the integer argument t1.
mkBv2int :: MonadZ3 z3 => AST -> Bool -> z3 AST Source
Create an integer from the bit-vector argument t1. If is_signed is false, then the bit-vector t1 is treated as unsigned. So the result is non-negative and in the range [0..2^N-1], where N are the number of bits in t1. If is_signed is true, t1 is treated as a signed bit-vector.
mkBvnegNoOverflow :: MonadZ3 z3 => AST -> z3 AST Source
Check that bit-wise negation does not overflow when t1 is interpreted as a signed bit-vector.
mkBvaddNoOverflow :: MonadZ3 z3 => AST -> AST -> Bool -> z3 AST Source
Create a predicate that checks that the bit-wise addition of t1 and t2 does not overflow.
mkBvaddNoUnderflow :: MonadZ3 z3 => AST -> AST -> z3 AST Source
Create a predicate that checks that the bit-wise signed addition of t1 and t2 does not underflow.
mkBvsubNoOverflow :: MonadZ3 z3 => AST -> AST -> z3 AST Source
Create a predicate that checks that the bit-wise signed subtraction of t1 and t2 does not overflow.
mkBvsubNoUnderflow :: MonadZ3 z3 => AST -> AST -> z3 AST Source
Create a predicate that checks that the bit-wise subtraction of t1 and t2 does not underflow.
mkBvmulNoOverflow :: MonadZ3 z3 => AST -> AST -> Bool -> z3 AST Source
Create a predicate that checks that the bit-wise multiplication of t1 and t2 does not overflow.
mkBvmulNoUnderflow :: MonadZ3 z3 => AST -> AST -> z3 AST Source
Create a predicate that checks that the bit-wise signed multiplication of t1 and t2 does not underflow.
mkBvsdivNoOverflow :: MonadZ3 z3 => AST -> AST -> z3 AST Source
Create a predicate that checks that the bit-wise signed division of t1 and t2 does not overflow.
Arrays
mkSelect :: MonadZ3 z3 => AST -> AST -> z3 AST Source
Array read. The argument a is the array and i is the index of the array that gets read.
mkArrayDefault :: MonadZ3 z3 => AST -> z3 AST Source
Access the array default value. Produces the default range value, for arrays that can be represented as finite maps with a default range value.
Numerals
mkInt :: MonadZ3 z3 => Int -> Sort -> z3 AST Source
Create a numeral of an int, bit-vector, or finite-domain sort.
This function can be use to create numerals that fit in a
machine integer.
It is slightly faster than mkNumeral
since it is not necessary
to parse a string.
mkUnsignedInt :: MonadZ3 z3 => Word -> Sort -> z3 AST Source
Create a numeral of an int, bit-vector, or finite-domain sort.
This function can be use to create numerals that fit in a
machine unsigned integer.
It is slightly faster than mkNumeral
since it is not necessary
to parse a string.
mkInt64 :: MonadZ3 z3 => Int64 -> Sort -> z3 AST Source
Create a numeral of an int, bit-vector, or finite-domain sort.
This function can be use to create numerals that fit in a
machine 64-bit integer.
It is slightly faster than mkNumeral
since it is not necessary
to parse a string.
mkUnsignedInt64 :: MonadZ3 z3 => Word64 -> Sort -> z3 AST Source
Create a numeral of an int, bit-vector, or finite-domain sort.
This function can be use to create numerals that fit in a
machine unsigned 64-bit integer.
It is slightly faster than mkNumeral
since it is not necessary
to parse a string.
Helpers
mkIntegral :: (MonadZ3 z3, Integral a) => a -> Sort -> z3 AST Source
Create a numeral of an int, bit-vector, or finite-domain sort.
mkFixed :: (MonadZ3 z3, HasResolution a) => Fixed a -> z3 AST Source
Create a numeral of sort real from a Fixed
.
mkIntNum :: (MonadZ3 z3, Integral a) => a -> z3 AST Source
Create a numeral of sort int from an Integral
.
Create a numeral of sort Bit-vector from an Integer
.
Create a numeral of sort Bit-vector from an Integral
.
Quantifiers
Accessors
getSymbolString :: MonadZ3 z3 => Symbol -> z3 String Source
Return the symbol name.
getBvSortSize :: MonadZ3 z3 => Sort -> z3 Int Source
Return the size of the given bit-vector sort.
getDatatypeSortConstructors Source
Get list of constructors for datatype.
getDatatypeSortRecognizers Source
Get list of recognizers for datatype.
getDeclName :: MonadZ3 z3 => FuncDecl -> z3 Symbol Source
Return the constant declaration name as a symbol.
getBoolValue :: MonadZ3 z3 => AST -> z3 (Maybe Bool) Source
Returns Just True
, Just False
, or Nothing
for undefined.
getAstKind :: MonadZ3 z3 => AST -> z3 ASTKind Source
Return the kind of the given AST.
getNumeralString :: MonadZ3 z3 => AST -> z3 String Source
Return numeral value, as a string of a numeric constant term.
Helpers
Models
modelEval :: MonadZ3 z3 => Model -> AST -> z3 (Maybe AST) Source
Evaluate an AST node in the given model.
The evaluation may fail for the following reasons:
- t contains a quantifier.
- the model m is partial.
- t is type incorrect.
evalArray :: MonadZ3 z3 => Model -> AST -> z3 (Maybe FuncModel) Source
Get array as a list of argument/value pairs, if it is represented as a function (ie, using as-array).
getFuncInterp :: MonadZ3 z3 => Model -> FuncDecl -> z3 (Maybe FuncInterp) Source
Return the interpretation of the function f in the model m. Return NULL, if the model does not assign an interpretation for f. That should be interpreted as: the f does not matter.
isAsArray :: MonadZ3 z3 => AST -> z3 Bool Source
The (_ as-array f) AST node is a construct for assigning interpretations for arrays in Z3. It is the array such that forall indices i we have that (select (_ as-array f) i) is equal to (f i). This procedure returns Z3_TRUE if the a is an as-array AST node.
getAsArrayFuncDecl :: MonadZ3 z3 => AST -> z3 FuncDecl Source
Return the function declaration f associated with a (_ as_array f) node.
funcInterpGetNumEntries :: MonadZ3 z3 => FuncInterp -> z3 Int Source
Return the number of entries in the given function interpretation.
funcInterpGetEntry :: MonadZ3 z3 => FuncInterp -> Int -> z3 FuncEntry Source
Return a "point" of the given function intepretation. It represents the value of f in a particular point.
funcInterpGetElse :: MonadZ3 z3 => FuncInterp -> z3 AST Source
Return the 'else' value of the given function interpretation.
funcInterpGetArity :: MonadZ3 z3 => FuncInterp -> z3 Int Source
Return the arity (number of arguments) of the given function interpretation.
funcEntryGetValue :: MonadZ3 z3 => FuncEntry -> z3 AST Source
Return the value of this point.
funcEntryGetNumArgs :: MonadZ3 z3 => FuncEntry -> z3 Int Source
Return the number of arguments in a Z3_func_entry object.
funcEntryGetArg :: MonadZ3 z3 => FuncEntry -> Int -> z3 AST Source
Return an argument of a Z3_func_entry object.
modelToString :: MonadZ3 z3 => Model -> z3 String Source
Convert the given model into a string.
Helpers
evalT :: (MonadZ3 z3, Traversable t) => Model -> t AST -> z3 (Maybe (t AST)) Source
Evaluate a collection of AST nodes in the given model.
mapEval :: (MonadZ3 z3, Traversable t) => EvalAst z3 a -> Model -> t AST -> z3 (Maybe (t a)) Source
Run a evaluation function on a Traversable
data structure of AST
s
(e.g. [AST]
, Vector AST
, Maybe AST
, etc).
This a generic version of evalT
which can be used in combination with
other helpers. For instance, mapEval evalInt
can be used to obtain
the Integer
interpretation of a list of AST
of sort int.
The interpretation of a function.
evalFunc :: MonadZ3 z3 => Model -> FuncDecl -> z3 (Maybe FuncModel) Source
Get function as a list of argument/value pairs.
String Conversion
data ASTPrintMode Source
Pretty-printing mode for converting ASTs to strings. The mode can be one of the following:
- Z3_PRINT_SMTLIB_FULL: Print AST nodes in SMTLIB verbose format.
- Z3_PRINT_LOW_LEVEL: Print AST nodes using a low-level format.
- Z3_PRINT_SMTLIB_COMPLIANT: Print AST nodes in SMTLIB 1.x compliant format.
- Z3_PRINT_SMTLIB2_COMPLIANT: Print AST nodes in SMTLIB 2.x compliant format.
setASTPrintMode :: MonadZ3 z3 => ASTPrintMode -> z3 () Source
Set the mode for converting expressions to strings.
astToString :: MonadZ3 z3 => AST -> z3 String Source
Convert an AST to a string.
patternToString :: MonadZ3 z3 => Pattern -> z3 String Source
Convert a pattern to a string.
sortToString :: MonadZ3 z3 => Sort -> z3 String Source
Convert a sort to a string.
funcDeclToString :: MonadZ3 z3 => FuncDecl -> z3 String Source
Convert a FuncDecl to a string.
benchmarkToSMTLibString Source
:: MonadZ3 z3 | |
=> String | name |
-> String | logic |
-> String | status |
-> String | attributes |
-> [AST] | assumptions1 |
-> AST | formula |
-> z3 String |
Convert the given benchmark into SMT-LIB formatted string.
The output format can be configured via setASTPrintMode
.
Error Handling
Z3Error | |
|
data Z3ErrorCode Source
Z3 error codes.
Miscellaneous
getVersion :: MonadZ3 z3 => z3 Version Source
Return Z3 version number information.
Solvers
solverGetHelp :: MonadZ3 z3 => z3 String Source
Return a string describing all solver available parameters.
solverSetParams :: MonadZ3 z3 => Params -> z3 () Source
Set the solver using the given parameters.
solverPush :: MonadZ3 z3 => z3 () Source
Create a backtracking point.
solverReset :: MonadZ3 z3 => z3 () Source
solverGetNumScopes :: MonadZ3 z3 => z3 Int Source
Number of backtracking points.
solverAssertCnstr :: MonadZ3 z3 => AST -> z3 () Source
Assert a constraing into the logical context.
solverAssertAndTrack :: MonadZ3 z3 => AST -> AST -> z3 () Source
Assert a constraint a into the solver, and track it (in the unsat) core using the Boolean constant p.
This API is an alternative to Z3_solver_check_assumptions for extracting unsat cores. Both APIs can be used in the same solver. The unsat core will contain a combination of the Boolean variables provided using Z3_solver_assert_and_track and the Boolean literals provided using Z3_solver_check_assumptions.
solverCheck :: MonadZ3 z3 => z3 Result Source
Check whether the assertions in a given solver are consistent or not.
solverCheckAssumptions :: MonadZ3 z3 => [AST] -> z3 Result Source
Check whether the assertions in the given solver and optional assumptions are consistent or not.
solverGetModel :: MonadZ3 z3 => z3 Model Source
Retrieve the model for the last solverCheck
.
The error handler is invoked if a model is not available because
the commands above were not invoked for the given solver,
or if the result was Unsat
.
solverGetUnsatCore :: MonadZ3 z3 => z3 [AST] Source
Retrieve the unsat core for the last solverCheckAssumptions
; the unsat core is a subset of the assumptions
solverGetReasonUnknown :: MonadZ3 z3 => z3 String Source
Return a brief justification for an Unknown
result for the commands solverCheck
and solverCheckAssumptions
.
solverToString :: MonadZ3 z3 => z3 String Source
Convert the given solver into a string.
Helpers
check :: MonadZ3 z3 => z3 Result Source
Check whether the given logical context is consistent or not.
checkAssumptions :: MonadZ3 z3 => [AST] -> z3 Result Source
Check whether the assertions in the given solver and optional assumptions are consistent or not.
withModel :: (Applicative z3, MonadZ3 z3) => (Model -> z3 a) -> z3 (Result, Maybe a) Source
Check satisfiability and, if sat, compute a value from the given model.
E.g.
withModel $ \m ->
fromJust <$> evalInt m x
getUnsatCore :: MonadZ3 z3 => z3 [AST] Source
Retrieve the unsat core for the last checkAssumptions
; the unsat core is a subset of the assumptions.
pop :: MonadZ3 z3 => Int -> z3 () Source
Backtrack n backtracking points.
Contrary to solverPop
this funtion checks whether n is within
the size of the solver scope stack.
getNumScopes :: MonadZ3 z3 => z3 Int Source
Get number of backtracking points.