mirrors/z3
3
0
Fork 0
mirror of https://github.com/Z3Prover/z3 synced 2025-04-06 09:34:08 +00:00
Code Activity
z3/src/api/z3_api.h
Nikolaj Bjorner b08ccc7816 added missing Copyright forms 
Signed-off-by: Nikolaj Bjorner <nbjorner@microsoft.com>
2015-06-10 11:54:02 -07:00

8119 lines
287 KiB
C
Raw Blame History

/*++
Copyright (c) 2015 Microsoft Corporation
--*/
#ifndef _Z3_API_H_
#define _Z3_API_H_
#ifdef CAMLIDL
#ifdef MLAPIV3
#define ML3only
#define CorML3
#else
#define ML4only
#define CorML4
#endif
#else
#define Conly
#define CorML3
#define CorML4
#endif
#ifdef CorML3
DEFINE_TYPE(Z3_symbol);
DEFINE_TYPE(Z3_literals);
DEFINE_TYPE(Z3_theory);
DEFINE_TYPE(Z3_config);
DEFINE_TYPE(Z3_context);
DEFINE_TYPE(Z3_sort);
#define Z3_sort_opt Z3_sort
DEFINE_TYPE(Z3_func_decl);
DEFINE_TYPE(Z3_ast);
#define Z3_ast_opt Z3_ast
DEFINE_TYPE(Z3_app);
DEFINE_TYPE(Z3_pattern);
DEFINE_TYPE(Z3_model);
DEFINE_TYPE(Z3_constructor);
DEFINE_TYPE(Z3_constructor_list);
#endif
#ifdef Conly
DEFINE_TYPE(Z3_params);
DEFINE_TYPE(Z3_param_descrs);
DEFINE_TYPE(Z3_goal);
DEFINE_TYPE(Z3_tactic);
DEFINE_TYPE(Z3_probe);
DEFINE_TYPE(Z3_stats);
DEFINE_TYPE(Z3_solver);
DEFINE_TYPE(Z3_ast_vector);
DEFINE_TYPE(Z3_ast_map);
DEFINE_TYPE(Z3_apply_result);
DEFINE_TYPE(Z3_func_interp);
#define Z3_func_interp_opt Z3_func_interp
DEFINE_TYPE(Z3_func_entry);
DEFINE_TYPE(Z3_fixedpoint);
DEFINE_TYPE(Z3_optimize);
DEFINE_TYPE(Z3_rcf_num);
DEFINE_VOID(Z3_theory_data);
#endif
#ifndef __int64
#define __int64 long long
#endif
#ifndef __uint64
#define __uint64 unsigned long long
#endif
/**
\defgroup capi C API
*/
/*@{*/
/**
@name Types
\conly Most of the types in the C API are opaque pointers.
\mlonly Most of the types in the API are abstract. \endmlonly
\conly - \c Z3_config: configuration object used to initialize logical contexts.
- \c Z3_context: manager of all other Z3 objects, global configuration options, etc.
- \c Z3_symbol: Lisp-like symbol used to name types, constants, and functions. A symbol can be created using string or integers.
- \c Z3_ast: abstract syntax tree node. That is, the data-structure used in Z3 to represent terms, formulas and types.
- \c Z3_sort: kind of AST used to represent types.
- \c Z3_func_decl: kind of AST used to represent function symbols.
- \c Z3_app: kind of AST used to represent function applications.
- \c Z3_pattern: kind of AST used to represent pattern and multi-patterns used to guide quantifier instantiation.
\conly - \c Z3_constructor: type constructor for a (recursive) datatype.
- \c Z3_params: parameter set used to configure many components such as: simplifiers, tactics, solvers, etc.
- \c Z3_model: model for the constraints asserted into the logical context.
- \c Z3_func_interp: interpretation of a function in a model.
- \c Z3_func_entry: representation of the value of a \c Z3_func_interp at a particular point.
- \c Z3_fixedpoint: context for the recursive predicate solver.
- \c Z3_optimize: context for solving optimization queries.
- \c Z3_ast_vector: vector of \c Z3_ast objects.
- \c Z3_ast_map: mapping from \c Z3_ast to \c Z3_ast objects.
- \c Z3_goal: set of formulas that can be solved and/or transformed using tactics and solvers.
- \c Z3_tactic: basic building block for creating custom solvers for specific problem domains.
- \c Z3_probe: function/predicate used to inspect a goal and collect information that may be used to decide which solver and/or preprocessing step will be used.
- \c Z3_apply_result: collection of subgoals resulting from applying of a tactic to a goal.
- \c Z3_solver: (incremental) solver, possibly specialized by a particular tactic or logic.
- \c Z3_stats: statistical data for a solver.
*/
#ifdef Conly
/**
\brief Z3 Boolean type. It is just an alias for \c int.
*/
typedef int Z3_bool;
#else
#define Z3_bool boolean
#endif
#ifdef Conly
/**
\brief Z3 string type. It is just an alias for <tt>const char *</tt>.
*/
typedef const char * Z3_string;
typedef Z3_string * Z3_string_ptr;
#else
typedef [string] const char * Z3_string;
#define Z3_string_ptr Z3_string *
#endif
#ifdef Conly
/**
\brief True value. It is just an alias for \c 1.
*/
#define Z3_TRUE 1
/**
\brief False value. It is just an alias for \c 0.
*/
#define Z3_FALSE 0
#endif
/**
\mlonly {!lbool} \endmlonly \conly \brief
Lifted Boolean type: \c false, \c undefined, \c true.
*/
typedef enum
{
Z3_L_FALSE = -1,
Z3_L_UNDEF,
Z3_L_TRUE
} Z3_lbool;
/**
\mlonly {!symbol_kind} \endmlonly \conly \brief
The different kinds of symbol.
In Z3, a symbol can be represented using integers and strings (See #Z3_get_symbol_kind).
\sa Z3_mk_int_symbol
\sa Z3_mk_string_symbol
*/
typedef enum
{
Z3_INT_SYMBOL,
Z3_STRING_SYMBOL
} Z3_symbol_kind;
/**
\mlonly {!parameter_kind} \endmlonly \conly \brief
The different kinds of parameters that can be associated with function symbols.
\sa Z3_get_decl_num_parameters
\sa Z3_get_decl_parameter_kind
- Z3_PARAMETER_INT is used for integer parameters.
- Z3_PARAMETER_DOUBLE is used for double parameters.
- Z3_PARAMETER_RATIONAL is used for parameters that are rational numbers.
- Z3_PARAMETER_SYMBOL is used for parameters that are symbols.
- Z3_PARAMETER_SORT is used for sort parameters.
- Z3_PARAMETER_AST is used for expression parameters.
- Z3_PARAMETER_FUNC_DECL is used for function declaration parameters.
*/
typedef enum
{
Z3_PARAMETER_INT,
Z3_PARAMETER_DOUBLE,
Z3_PARAMETER_RATIONAL,
Z3_PARAMETER_SYMBOL,
Z3_PARAMETER_SORT,
Z3_PARAMETER_AST,
Z3_PARAMETER_FUNC_DECL,
} Z3_parameter_kind;
/**
\mlonly {!sort_kind} \endmlonly \conly \brief
The different kinds of Z3 types (See #Z3_get_sort_kind).
*/
typedef enum
{
Z3_UNINTERPRETED_SORT,
Z3_BOOL_SORT,
Z3_INT_SORT,
Z3_REAL_SORT,
Z3_BV_SORT,
Z3_ARRAY_SORT,
Z3_DATATYPE_SORT,
Z3_RELATION_SORT,
Z3_FINITE_DOMAIN_SORT,
Z3_FLOATING_POINT_SORT,
Z3_ROUNDING_MODE_SORT,
Z3_UNKNOWN_SORT = 1000
} Z3_sort_kind;
/**
\mlonly {!ast_kind} \endmlonly \conly \brief
The different kinds of Z3 AST (abstract syntax trees). That is, terms, formulas and types.
- Z3_APP_AST: constant and applications
- Z3_NUMERAL_AST: numeral constants
- Z3_VAR_AST: bound variables
- Z3_QUANTIFIER_AST: quantifiers
- Z3_SORT_AST: sort
- Z3_FUNC_DECL_AST: function declaration
- Z3_UNKNOWN_AST: internal
*/
typedef enum
{
Z3_NUMERAL_AST,
Z3_APP_AST,
Z3_VAR_AST,
Z3_QUANTIFIER_AST,
Z3_SORT_AST,
Z3_FUNC_DECL_AST,
Z3_UNKNOWN_AST = 1000
} Z3_ast_kind;
/**
\mlonly {!decl_kind} \endmlonly \conly \brief
The different kinds of interpreted function kinds.
- Z3_OP_TRUE The constant true.
- Z3_OP_FALSE The constant false.
- Z3_OP_EQ The equality predicate.
- Z3_OP_DISTINCT The n-ary distinct predicate (every argument is mutually distinct).
- Z3_OP_ITE The ternary if-then-else term.
- Z3_OP_AND n-ary conjunction.
- Z3_OP_OR n-ary disjunction.
- Z3_OP_IFF equivalence (binary).
- Z3_OP_XOR Exclusive or.
- Z3_OP_NOT Negation.
- Z3_OP_IMPLIES Implication.
- Z3_OP_OEQ Binary equivalence modulo namings. This binary predicate is used in proof terms.
It captures equisatisfiability and equivalence modulo renamings.
- Z3_OP_INTERP Marks a sub-formula for interpolation.
- Z3_OP_ANUM Arithmetic numeral.
- Z3_OP_AGNUM Arithmetic algebraic numeral. Algebraic numbers are used to represent irrational numbers in Z3.
- Z3_OP_LE <=.
- Z3_OP_GE >=.
- Z3_OP_LT <.
- Z3_OP_GT >.
- Z3_OP_ADD Addition - Binary.
- Z3_OP_SUB Binary subtraction.
- Z3_OP_UMINUS Unary minus.
- Z3_OP_MUL Multiplication - Binary.
- Z3_OP_DIV Division - Binary.
- Z3_OP_IDIV Integer division - Binary.
- Z3_OP_REM Remainder - Binary.
- Z3_OP_MOD Modulus - Binary.
- Z3_OP_TO_REAL Coercion of integer to real - Unary.
- Z3_OP_TO_INT Coercion of real to integer - Unary.
- Z3_OP_IS_INT Check if real is also an integer - Unary.
- Z3_OP_POWER Power operator x^y.
- Z3_OP_STORE Array store. It satisfies select(store(a,i,v),j) = if i = j then v else select(a,j).
Array store takes at least 3 arguments.
- Z3_OP_SELECT Array select.
- Z3_OP_CONST_ARRAY The constant array. For example, select(const(v),i) = v holds for every v and i. The function is unary.
- Z3_OP_ARRAY_DEFAULT Default value of arrays. For example default(const(v)) = v. The function is unary.
- Z3_OP_ARRAY_MAP Array map operator.
It satisfies map[f](a1,..,a_n)[i] = f(a1[i],...,a_n[i]) for every i.
- Z3_OP_SET_UNION Set union between two Booelan arrays (two arrays whose range type is Boolean). The function is binary.
- Z3_OP_SET_INTERSECT Set intersection between two Boolean arrays. The function is binary.
- Z3_OP_SET_DIFFERENCE Set difference between two Boolean arrays. The function is binary.
- Z3_OP_SET_COMPLEMENT Set complement of a Boolean array. The function is unary.
- Z3_OP_SET_SUBSET Subset predicate between two Boolean arrays. The relation is binary.
- Z3_OP_AS_ARRAY An array value that behaves as the function graph of the
function passed as parameter.
- Z3_OP_BNUM Bit-vector numeral.
- Z3_OP_BIT1 One bit bit-vector.
- Z3_OP_BIT0 Zero bit bit-vector.
- Z3_OP_BNEG Unary minus.
- Z3_OP_BADD Binary addition.
- Z3_OP_BSUB Binary subtraction.
- Z3_OP_BMUL Binary multiplication.
- Z3_OP_BSDIV Binary signed division.
- Z3_OP_BUDIV Binary unsigned division.
- Z3_OP_BSREM Binary signed remainder.
- Z3_OP_BUREM Binary unsigned remainder.
- Z3_OP_BSMOD Binary signed modulus.
- Z3_OP_BSDIV0 Unary function. bsdiv(x,0) is congruent to bsdiv0(x).
- Z3_OP_BUDIV0 Unary function. budiv(x,0) is congruent to budiv0(x).
- Z3_OP_BSREM0 Unary function. bsrem(x,0) is congruent to bsrem0(x).
- Z3_OP_BUREM0 Unary function. burem(x,0) is congruent to burem0(x).
- Z3_OP_BSMOD0 Unary function. bsmod(x,0) is congruent to bsmod0(x).
- Z3_OP_ULEQ Unsigned bit-vector <= - Binary relation.
- Z3_OP_SLEQ Signed bit-vector <= - Binary relation.
- Z3_OP_UGEQ Unsigned bit-vector >= - Binary relation.
- Z3_OP_SGEQ Signed bit-vector >= - Binary relation.
- Z3_OP_ULT Unsigned bit-vector < - Binary relation.
- Z3_OP_SLT Signed bit-vector < - Binary relation.
- Z3_OP_UGT Unsigned bit-vector > - Binary relation.
- Z3_OP_SGT Signed bit-vector > - Binary relation.
- Z3_OP_BAND Bit-wise and - Binary.
- Z3_OP_BOR Bit-wise or - Binary.
- Z3_OP_BNOT Bit-wise not - Unary.
- Z3_OP_BXOR Bit-wise xor - Binary.
- Z3_OP_BNAND Bit-wise nand - Binary.
- Z3_OP_BNOR Bit-wise nor - Binary.
- Z3_OP_BXNOR Bit-wise xnor - Binary.
- Z3_OP_CONCAT Bit-vector concatenation - Binary.
- Z3_OP_SIGN_EXT Bit-vector sign extension.
- Z3_OP_ZERO_EXT Bit-vector zero extension.
- Z3_OP_EXTRACT Bit-vector extraction.
- Z3_OP_REPEAT Repeat bit-vector n times.
- Z3_OP_BREDOR Bit-vector reduce or - Unary.
- Z3_OP_BREDAND Bit-vector reduce and - Unary.
- Z3_OP_BCOMP .
- Z3_OP_BSHL Shift left.
- Z3_OP_BLSHR Logical shift right.
- Z3_OP_BASHR Arithmetical shift right.
- Z3_OP_ROTATE_LEFT Left rotation.
- Z3_OP_ROTATE_RIGHT Right rotation.
- Z3_OP_EXT_ROTATE_LEFT (extended) Left rotation. Similar to Z3_OP_ROTATE_LEFT, but it is a binary operator instead of a parametric one.
- Z3_OP_EXT_ROTATE_RIGHT (extended) Right rotation. Similar to Z3_OP_ROTATE_RIGHT, but it is a binary operator instead of a parametric one.
- Z3_OP_INT2BV Coerce integer to bit-vector. NB. This function
is not supported by the decision procedures. Only the most
rudimentary simplification rules are applied to this function.
- Z3_OP_BV2INT Coerce bit-vector to integer. NB. This function
is not supported by the decision procedures. Only the most
rudimentary simplification rules are applied to this function.
- Z3_OP_CARRY Compute the carry bit in a full-adder.
The meaning is given by the equivalence
(carry l1 l2 l3) <=> (or (and l1 l2) (and l1 l3) (and l2 l3)))
- Z3_OP_XOR3 Compute ternary XOR.
The meaning is given by the equivalence
(xor3 l1 l2 l3) <=> (xor (xor l1 l2) l3)
- Z3_OP_PR_UNDEF: Undef/Null proof object.
- Z3_OP_PR_TRUE: Proof for the expression 'true'.
- Z3_OP_PR_ASSERTED: Proof for a fact asserted by the user.
- Z3_OP_PR_GOAL: Proof for a fact (tagged as goal) asserted by the user.
- Z3_OP_PR_MODUS_PONENS: Given a proof for p and a proof for (implies p q), produces a proof for q.
\nicebox{
T1: p
T2: (implies p q)
[mp T1 T2]: q
}
The second antecedents may also be a proof for (iff p q).
- Z3_OP_PR_REFLEXIVITY: A proof for (R t t), where R is a reflexive relation. This proof object has no antecedents.
The only reflexive relations that are used are
equivalence modulo namings, equality and equivalence.
That is, R is either '~', '=' or 'iff'.
- Z3_OP_PR_SYMMETRY: Given an symmetric relation R and a proof for (R t s), produces a proof for (R s t).
\nicebox{
T1: (R t s)
[symmetry T1]: (R s t)
}
T1 is the antecedent of this proof object.
- Z3_OP_PR_TRANSITIVITY: Given a transitive relation R, and proofs for (R t s) and (R s u), produces a proof
for (R t u).
\nicebox{
T1: (R t s)
T2: (R s u)
[trans T1 T2]: (R t u)
}
- Z3_OP_PR_TRANSITIVITY_STAR: Condensed transitivity proof. This proof object is only used if the parameter PROOF_MODE is 1.
It combines several symmetry and transitivity proofs.
Example:
\nicebox{
T1: (R a b)
T2: (R c b)
T3: (R c d)
[trans* T1 T2 T3]: (R a d)
}
R must be a symmetric and transitive relation.
Assuming that this proof object is a proof for (R s t), then
a proof checker must check if it is possible to prove (R s t)
using the antecedents, symmetry and transitivity. That is,
if there is a path from s to t, if we view every
antecedent (R a b) as an edge between a and b.
- Z3_OP_PR_MONOTONICITY: Monotonicity proof object.
\nicebox{
T1: (R t_1 s_1)
...
Tn: (R t_n s_n)
[monotonicity T1 ... Tn]: (R (f t_1 ... t_n) (f s_1 ... s_n))
}
Remark: if t_i == s_i, then the antecedent Ti is suppressed.
That is, reflexivity proofs are supressed to save space.
- Z3_OP_PR_QUANT_INTRO: Given a proof for (~ p q), produces a proof for (~ (forall (x) p) (forall (x) q)).
T1: (~ p q)
[quant-intro T1]: (~ (forall (x) p) (forall (x) q))
- Z3_OP_PR_DISTRIBUTIVITY: Distributivity proof object.
Given that f (= or) distributes over g (= and), produces a proof for
(= (f a (g c d))
(g (f a c) (f a d)))
If f and g are associative, this proof also justifies the following equality:
(= (f (g a b) (g c d))
(g (f a c) (f a d) (f b c) (f b d)))
where each f and g can have arbitrary number of arguments.
This proof object has no antecedents.
Remark. This rule is used by the CNF conversion pass and
instantiated by f = or, and g = and.
- Z3_OP_PR_AND_ELIM: Given a proof for (and l_1 ... l_n), produces a proof for l_i
\nicebox{
T1: (and l_1 ... l_n)
[and-elim T1]: l_i
}
- Z3_OP_PR_NOT_OR_ELIM: Given a proof for (not (or l_1 ... l_n)), produces a proof for (not l_i).
\nicebox{
T1: (not (or l_1 ... l_n))
[not-or-elim T1]: (not l_i)
}
- Z3_OP_PR_REWRITE: A proof for a local rewriting step (= t s).
The head function symbol of t is interpreted.
This proof object has no antecedents.
The conclusion of a rewrite rule is either an equality (= t s),
an equivalence (iff t s), or equi-satisfiability (~ t s).
Remark: if f is bool, then = is iff.
Examples:
\nicebox{
(= (+ x 0) x)
(= (+ x 1 2) (+ 3 x))
(iff (or x false) x)
}
- Z3_OP_PR_REWRITE_STAR: A proof for rewriting an expression t into an expression s.
This proof object is used if the parameter PROOF_MODE is 1.
This proof object can have n antecedents.
The antecedents are proofs for equalities used as substitution rules.
The object is also used in a few cases if the parameter PROOF_MODE is 2.
The cases are:
- When applying contextual simplification (CONTEXT_SIMPLIFIER=true)
- When converting bit-vectors to Booleans (BIT2BOOL=true)
- When pulling ite expression up (PULL_CHEAP_ITE_TREES=true)
- Z3_OP_PR_PULL_QUANT: A proof for (iff (f (forall (x) q(x)) r) (forall (x) (f (q x) r))). This proof object has no antecedents.
- Z3_OP_PR_PULL_QUANT_STAR: A proof for (iff P Q) where Q is in prenex normal form.
This proof object is only used if the parameter PROOF_MODE is 1.
This proof object has no antecedents.
- Z3_OP_PR_PUSH_QUANT: A proof for:
\nicebox{
(iff (forall (x_1 ... x_m) (and p_1[x_1 ... x_m] ... p_n[x_1 ... x_m]))
(and (forall (x_1 ... x_m) p_1[x_1 ... x_m])
...
(forall (x_1 ... x_m) p_n[x_1 ... x_m])))
}
This proof object has no antecedents.
- Z3_OP_PR_ELIM_UNUSED_VARS:
A proof for (iff (forall (x_1 ... x_n y_1 ... y_m) p[x_1 ... x_n])
(forall (x_1 ... x_n) p[x_1 ... x_n]))
It is used to justify the elimination of unused variables.
This proof object has no antecedents.
- Z3_OP_PR_DER: A proof for destructive equality resolution:
(iff (forall (x) (or (not (= x t)) P[x])) P[t])
if x does not occur in t.
This proof object has no antecedents.
Several variables can be eliminated simultaneously.
- Z3_OP_PR_QUANT_INST: A proof of (or (not (forall (x) (P x))) (P a))
- Z3_OP_PR_HYPOTHESIS: Mark a hypothesis in a natural deduction style proof.
- Z3_OP_PR_LEMMA:
\nicebox{
T1: false
[lemma T1]: (or (not l_1) ... (not l_n))
}
This proof object has one antecedent: a hypothetical proof for false.
It converts the proof in a proof for (or (not l_1) ... (not l_n)),
when T1 contains the open hypotheses: l_1, ..., l_n.
The hypotheses are closed after an application of a lemma.
Furthermore, there are no other open hypotheses in the subtree covered by
the lemma.
- Z3_OP_PR_UNIT_RESOLUTION:
\nicebox{
T1: (or l_1 ... l_n l_1' ... l_m')
T2: (not l_1)
...
T(n+1): (not l_n)
[unit-resolution T1 ... T(n+1)]: (or l_1' ... l_m')
}
- Z3_OP_PR_IFF_TRUE:
\nicebox{
T1: p
[iff-true T1]: (iff p true)
}
- Z3_OP_PR_IFF_FALSE:
\nicebox{
T1: (not p)
[iff-false T1]: (iff p false)
}
- Z3_OP_PR_COMMUTATIVITY:
[comm]: (= (f a b) (f b a))
f is a commutative operator.
This proof object has no antecedents.
Remark: if f is bool, then = is iff.
- Z3_OP_PR_DEF_AXIOM: Proof object used to justify Tseitin's like axioms:
\nicebox{
(or (not (and p q)) p)
(or (not (and p q)) q)
(or (not (and p q r)) p)
(or (not (and p q r)) q)
(or (not (and p q r)) r)
...
(or (and p q) (not p) (not q))
(or (not (or p q)) p q)
(or (or p q) (not p))
(or (or p q) (not q))
(or (not (iff p q)) (not p) q)
(or (not (iff p q)) p (not q))
(or (iff p q) (not p) (not q))
(or (iff p q) p q)
(or (not (ite a b c)) (not a) b)
(or (not (ite a b c)) a c)
(or (ite a b c) (not a) (not b))
(or (ite a b c) a (not c))
(or (not (not a)) (not a))
(or (not a) a)
}
This proof object has no antecedents.
Note: all axioms are propositional tautologies.
Note also that 'and' and 'or' can take multiple arguments.
You can recover the propositional tautologies by
unfolding the Boolean connectives in the axioms a small
bounded number of steps (=3).
- Z3_OP_PR_DEF_INTRO: Introduces a name for a formula/term.
Suppose e is an expression with free variables x, and def-intro
introduces the name n(x). The possible cases are:
When e is of Boolean type:
[def-intro]: (and (or n (not e)) (or (not n) e))
or:
[def-intro]: (or (not n) e)
when e only occurs positively.
When e is of the form (ite cond th el):
[def-intro]: (and (or (not cond) (= n th)) (or cond (= n el)))
Otherwise:
[def-intro]: (= n e)
- Z3_OP_PR_APPLY_DEF:
[apply-def T1]: F ~ n
F is 'equivalent' to n, given that T1 is a proof that
n is a name for F.
- Z3_OP_PR_IFF_OEQ:
T1: (iff p q)
[iff~ T1]: (~ p q)
- Z3_OP_PR_NNF_POS: Proof for a (positive) NNF step. Example:
\nicebox{
T1: (not s_1) ~ r_1
T2: (not s_2) ~ r_2
T3: s_1 ~ r_1'
T4: s_2 ~ r_2'
[nnf-pos T1 T2 T3 T4]: (~ (iff s_1 s_2)
(and (or r_1 r_2') (or r_1' r_2)))
}
The negation normal form steps NNF_POS and NNF_NEG are used in the following cases:
(a) When creating the NNF of a positive force quantifier.
The quantifier is retained (unless the bound variables are eliminated).
Example
\nicebox{
T1: q ~ q_new
[nnf-pos T1]: (~ (forall (x T) q) (forall (x T) q_new))
}
(b) When recursively creating NNF over Boolean formulas, where the top-level
connective is changed during NNF conversion. The relevant Boolean connectives
for NNF_POS are 'implies', 'iff', 'xor', 'ite'.
NNF_NEG furthermore handles the case where negation is pushed
over Boolean connectives 'and' and 'or'.
- Z3_OP_PR_NNF_NEG: Proof for a (negative) NNF step. Examples:
\nicebox{
T1: (not s_1) ~ r_1
...
Tn: (not s_n) ~ r_n
[nnf-neg T1 ... Tn]: (not (and s_1 ... s_n)) ~ (or r_1 ... r_n)
and
T1: (not s_1) ~ r_1
...
Tn: (not s_n) ~ r_n
[nnf-neg T1 ... Tn]: (not (or s_1 ... s_n)) ~ (and r_1 ... r_n)
and
T1: (not s_1) ~ r_1
T2: (not s_2) ~ r_2
T3: s_1 ~ r_1'
T4: s_2 ~ r_2'
[nnf-neg T1 T2 T3 T4]: (~ (not (iff s_1 s_2))
(and (or r_1 r_2) (or r_1' r_2')))
}
- Z3_OP_PR_NNF_STAR: A proof for (~ P Q) where Q is in negation normal form.
This proof object is only used if the parameter PROOF_MODE is 1.
This proof object may have n antecedents. Each antecedent is a PR_DEF_INTRO.
- Z3_OP_PR_CNF_STAR: A proof for (~ P Q) where Q is in conjunctive normal form.
This proof object is only used if the parameter PROOF_MODE is 1.
This proof object may have n antecedents. Each antecedent is a PR_DEF_INTRO.
- Z3_OP_PR_SKOLEMIZE: Proof for:
\nicebox{
[sk]: (~ (not (forall x (p x y))) (not (p (sk y) y)))
[sk]: (~ (exists x (p x y)) (p (sk y) y))
}
This proof object has no antecedents.
- Z3_OP_PR_MODUS_PONENS_OEQ: Modus ponens style rule for equi-satisfiability.
\nicebox{
T1: p
T2: (~ p q)
[mp~ T1 T2]: q
}
- Z3_OP_PR_TH_LEMMA: Generic proof for theory lemmas.
The theory lemma function comes with one or more parameters.
The first parameter indicates the name of the theory.
For the theory of arithmetic, additional parameters provide hints for
checking the theory lemma.
The hints for arithmetic are:
- farkas - followed by rational coefficients. Multiply the coefficients to the
inequalities in the lemma, add the (negated) inequalities and obtain a contradiction.
- triangle-eq - Indicates a lemma related to the equivalence:
\nicebox{
(iff (= t1 t2) (and (<= t1 t2) (<= t2 t1)))
}
- gcd-test - Indicates an integer linear arithmetic lemma that uses a gcd test.
- Z3_OP_PR_HYPER_RESOLVE: Hyper-resolution rule.
The premises of the rules is a sequence of clauses.
The first clause argument is the main clause of the rule.
with a literal from the first (main) clause.
Premises of the rules are of the form
\nicebox{
(or l0 l1 l2 .. ln)
}
or
\nicebox{
(=> (and l1 l2 .. ln) l0)
}
or in the most general (ground) form:
\nicebox{
(=> (and ln+1 ln+2 .. ln+m) (or l0 l1 .. ln))
}
In other words we use the following (Prolog style) convention for Horn
implications:
The head of a Horn implication is position 0,
the first conjunct in the body of an implication is position 1
the second conjunct in the body of an implication is position 2
For general implications where the head is a disjunction, the
first n positions correspond to the n disjuncts in the head.
The next m positions correspond to the m conjuncts in the body.
The premises can be universally quantified so that the most
general non-ground form is:
\nicebox{
(forall (vars) (=> (and ln+1 ln+2 .. ln+m) (or l0 l1 .. ln)))
}
The hyper-resolution rule takes a sequence of parameters.
The parameters are substitutions of bound variables separated by pairs
of literal positions from the main clause and side clause.
- Z3_OP_RA_STORE: Insert a record into a relation.
The function takes \c n+1 arguments, where the first argument is the relation and the remaining \c n elements
correspond to the \c n columns of the relation.
- Z3_OP_RA_EMPTY: Creates the empty relation.
- Z3_OP_RA_IS_EMPTY: Tests if the relation is empty.
- Z3_OP_RA_JOIN: Create the relational join.
- Z3_OP_RA_UNION: Create the union or convex hull of two relations.
The function takes two arguments.
- Z3_OP_RA_WIDEN: Widen two relations.
The function takes two arguments.
- Z3_OP_RA_PROJECT: Project the columns (provided as numbers in the parameters).
The function takes one argument.
- Z3_OP_RA_FILTER: Filter (restrict) a relation with respect to a predicate.
The first argument is a relation.
The second argument is a predicate with free de-Brujin indices
corresponding to the columns of the relation.
So the first column in the relation has index 0.
- Z3_OP_RA_NEGATION_FILTER: Intersect the first relation with respect to negation
of the second relation (the function takes two arguments).
Logically, the specification can be described by a function
target = filter_by_negation(pos, neg, columns)
where columns are pairs c1, d1, .., cN, dN of columns from pos and neg, such that
target are elements in x in pos, such that there is no y in neg that agrees with
x on the columns c1, d1, .., cN, dN.
- Z3_OP_RA_RENAME: rename columns in the relation.
The function takes one argument.
The parameters contain the renaming as a cycle.
- Z3_OP_RA_COMPLEMENT: Complement the relation.
- Z3_OP_RA_SELECT: Check if a record is an element of the relation.
The function takes \c n+1 arguments, where the first argument is a relation,
and the remaining \c n arguments correspond to a record.
- Z3_OP_RA_CLONE: Create a fresh copy (clone) of a relation.
The function is logically the identity, but
in the context of a register machine allows
for \mlonly [OP_RA_UNION] \endmlonly \conly #Z3_OP_RA_UNION
to perform destructive updates to the first argument.
- Z3_OP_FD_LT: A less than predicate over the finite domain Z3_FINITE_DOMAIN_SORT.
- Z3_OP_LABEL: A label (used by the Boogie Verification condition generator).
The label has two parameters, a string and a Boolean polarity.
It takes one argument, a formula.
- Z3_OP_LABEL_LIT: A label literal (used by the Boogie Verification condition generator).
A label literal has a set of string parameters. It takes no arguments.
- Z3_OP_DT_CONSTRUCTOR: datatype constructor.
- Z3_OP_DT_RECOGNISER: datatype recognizer.
- Z3_OP_DT_ACCESSOR: datatype accessor.
- Z3_OP_DT_UPDATE_FIELD: datatype field update.
- Z3_OP_PB_AT_MOST: Cardinality constraint.
E.g., x + y + z <= 2
- Z3_OP_PB_LE: Generalized Pseudo-Boolean cardinality constraint.
Example 2*x + 3*y <= 4
- Z3_OP_PB_GE: Generalized Pseudo-Boolean cardinality constraint.
Example 2*x + 3*y + 2*z >= 4
- Z3_OP_FPA_RM_NEAREST_TIES_TO_EVEN: Floating-point rounding mode RNE
- Z3_OP_FPA_RM_NEAREST_TIES_TO_AWAY: Floating-point rounding mode RNA
- Z3_OP_FPA_RM_TOWARD_POSITIVE: Floating-point rounding mode RTP
- Z3_OP_FPA_RM_TOWARD_NEGATIVE: Floating-point rounding mode RTN
- Z3_OP_FPA_RM_TOWARD_ZERO: Floating-point rounding mode RTZ
- Z3_OP_FPA_NUM: Floating-point value
- Z3_OP_FPA_PLUS_INF: Floating-point +oo
- Z3_OP_FPA_MINUS_INF: Floating-point -oo
- Z3_OP_FPA_NAN: Floating-point NaN
- Z3_OP_FPA_PLUS_ZERO: Floating-point +zero
- Z3_OP_FPA_MINUS_ZERO: Floating-point -zero
- Z3_OP_FPA_ADD: Floating-point addition
- Z3_OP_FPA_SUB: Floating-point subtraction
- Z3_OP_FPA_NEG: Floating-point negation
- Z3_OP_FPA_MUL: Floating-point multiplication
- Z3_OP_FPA_DIV: Floating-point division
- Z3_OP_FPA_REM: Floating-point remainder
- Z3_OP_FPA_ABS: Floating-point absolute value
- Z3_OP_FPA_MIN: Floating-point minimum
- Z3_OP_FPA_MAX: Floating-point maximum
- Z3_OP_FPA_FMA: Floating-point fused multiply-add
- Z3_OP_FPA_SQRT: Floating-point square root
- Z3_OP_FPA_ROUND_TO_INTEGRAL: Floating-point round to integral
- Z3_OP_FPA_EQ: Floating-point equality
- Z3_OP_FPA_LT: Floating-point less than
- Z3_OP_FPA_GT: Floating-point greater than
- Z3_OP_FPA_LE: Floating-point less than or equal
- Z3_OP_FPA_GE: Floating-point greater than or equal
- Z3_OP_FPA_IS_NAN: Floating-point isNaN
- Z3_OP_FPA_IS_INF: Floating-point isInfinite
- Z3_OP_FPA_IS_ZERO: Floating-point isZero
- Z3_OP_FPA_IS_NORMAL: Floating-point isNormal
- Z3_OP_FPA_IS_SUBNORMAL: Floating-point isSubnormal
- Z3_OP_FPA_IS_NEGATIVE: Floating-point isNegative
- Z3_OP_FPA_IS_POSITIVE: Floating-point isPositive
- Z3_OP_FPA_FP: Floating-point constructor from 3 bit-vectors
- Z3_OP_FPA_TO_FP: Floating-point conversion (various)
- Z3_OP_FPA_TO_FP_UNSIGNED: Floating-point conversion from unsigend bit-vector
- Z3_OP_FPA_TO_UBV: Floating-point conversion to unsigned bit-vector
- Z3_OP_FPA_TO_SBV: Floating-point conversion to signed bit-vector
- Z3_OP_FPA_TO_REAL: Floating-point conversion to real number
- Z3_OP_FPA_TO_IEEE_BV: Floating-point conversion to IEEE-754 bit-vector
- Z3_OP_UNINTERPRETED: kind used for uninterpreted symbols.
*/
typedef enum {
// Basic
Z3_OP_TRUE = 0x100,
Z3_OP_FALSE,
Z3_OP_EQ,
Z3_OP_DISTINCT,
Z3_OP_ITE,
Z3_OP_AND,
Z3_OP_OR,
Z3_OP_IFF,
Z3_OP_XOR,
Z3_OP_NOT,
Z3_OP_IMPLIES,
Z3_OP_OEQ,
Z3_OP_INTERP,
// Arithmetic
Z3_OP_ANUM = 0x200,
Z3_OP_AGNUM,
Z3_OP_LE,
Z3_OP_GE,
Z3_OP_LT,
Z3_OP_GT,
Z3_OP_ADD,
Z3_OP_SUB,
Z3_OP_UMINUS,
Z3_OP_MUL,
Z3_OP_DIV,
Z3_OP_IDIV,
Z3_OP_REM,
Z3_OP_MOD,
Z3_OP_TO_REAL,
Z3_OP_TO_INT,
Z3_OP_IS_INT,
Z3_OP_POWER,
// Arrays & Sets
Z3_OP_STORE = 0x300,
Z3_OP_SELECT,
Z3_OP_CONST_ARRAY,
Z3_OP_ARRAY_MAP,
Z3_OP_ARRAY_DEFAULT,
Z3_OP_SET_UNION,
Z3_OP_SET_INTERSECT,
Z3_OP_SET_DIFFERENCE,
Z3_OP_SET_COMPLEMENT,
Z3_OP_SET_SUBSET,
Z3_OP_AS_ARRAY,
// Bit-vectors
Z3_OP_BNUM = 0x400,
Z3_OP_BIT1,
Z3_OP_BIT0,
Z3_OP_BNEG,
Z3_OP_BADD,
Z3_OP_BSUB,
Z3_OP_BMUL,
Z3_OP_BSDIV,
Z3_OP_BUDIV,
Z3_OP_BSREM,
Z3_OP_BUREM,
Z3_OP_BSMOD,
// special functions to record the division by 0 cases
// these are internal functions
Z3_OP_BSDIV0,
Z3_OP_BUDIV0,
Z3_OP_BSREM0,
Z3_OP_BUREM0,
Z3_OP_BSMOD0,
Z3_OP_ULEQ,
Z3_OP_SLEQ,
Z3_OP_UGEQ,
Z3_OP_SGEQ,
Z3_OP_ULT,
Z3_OP_SLT,
Z3_OP_UGT,
Z3_OP_SGT,
Z3_OP_BAND,
Z3_OP_BOR,
Z3_OP_BNOT,
Z3_OP_BXOR,
Z3_OP_BNAND,
Z3_OP_BNOR,
Z3_OP_BXNOR,
Z3_OP_CONCAT,
Z3_OP_SIGN_EXT,
Z3_OP_ZERO_EXT,
Z3_OP_EXTRACT,
Z3_OP_REPEAT,
Z3_OP_BREDOR,
Z3_OP_BREDAND,
Z3_OP_BCOMP,
Z3_OP_BSHL,
Z3_OP_BLSHR,
Z3_OP_BASHR,
Z3_OP_ROTATE_LEFT,
Z3_OP_ROTATE_RIGHT,
Z3_OP_EXT_ROTATE_LEFT,
Z3_OP_EXT_ROTATE_RIGHT,
Z3_OP_INT2BV,
Z3_OP_BV2INT,
Z3_OP_CARRY,
Z3_OP_XOR3,
// Proofs
Z3_OP_PR_UNDEF = 0x500,
Z3_OP_PR_TRUE,
Z3_OP_PR_ASSERTED,
Z3_OP_PR_GOAL,
Z3_OP_PR_MODUS_PONENS,
Z3_OP_PR_REFLEXIVITY,
Z3_OP_PR_SYMMETRY,
Z3_OP_PR_TRANSITIVITY,
Z3_OP_PR_TRANSITIVITY_STAR,
Z3_OP_PR_MONOTONICITY,
Z3_OP_PR_QUANT_INTRO,
Z3_OP_PR_DISTRIBUTIVITY,
Z3_OP_PR_AND_ELIM,
Z3_OP_PR_NOT_OR_ELIM,
Z3_OP_PR_REWRITE,
Z3_OP_PR_REWRITE_STAR,
Z3_OP_PR_PULL_QUANT,
Z3_OP_PR_PULL_QUANT_STAR,
Z3_OP_PR_PUSH_QUANT,
Z3_OP_PR_ELIM_UNUSED_VARS,
Z3_OP_PR_DER,
Z3_OP_PR_QUANT_INST,
Z3_OP_PR_HYPOTHESIS,
Z3_OP_PR_LEMMA,
Z3_OP_PR_UNIT_RESOLUTION,
Z3_OP_PR_IFF_TRUE,
Z3_OP_PR_IFF_FALSE,
Z3_OP_PR_COMMUTATIVITY,
Z3_OP_PR_DEF_AXIOM,
Z3_OP_PR_DEF_INTRO,
Z3_OP_PR_APPLY_DEF,
Z3_OP_PR_IFF_OEQ,
Z3_OP_PR_NNF_POS,
Z3_OP_PR_NNF_NEG,
Z3_OP_PR_NNF_STAR,
Z3_OP_PR_CNF_STAR,
Z3_OP_PR_SKOLEMIZE,
Z3_OP_PR_MODUS_PONENS_OEQ,
Z3_OP_PR_TH_LEMMA,
Z3_OP_PR_HYPER_RESOLVE,
// Sequences
Z3_OP_RA_STORE = 0x600,
Z3_OP_RA_EMPTY,
Z3_OP_RA_IS_EMPTY,
Z3_OP_RA_JOIN,
Z3_OP_RA_UNION,
Z3_OP_RA_WIDEN,
Z3_OP_RA_PROJECT,
Z3_OP_RA_FILTER,
Z3_OP_RA_NEGATION_FILTER,
Z3_OP_RA_RENAME,
Z3_OP_RA_COMPLEMENT,
Z3_OP_RA_SELECT,
Z3_OP_RA_CLONE,
Z3_OP_FD_LT,
// Auxiliary
Z3_OP_LABEL = 0x700,
Z3_OP_LABEL_LIT,
// Datatypes
Z3_OP_DT_CONSTRUCTOR=0x800,
Z3_OP_DT_RECOGNISER,
Z3_OP_DT_ACCESSOR,
Z3_OP_DT_UPDATE_FIELD,
// Pseudo Booleans
Z3_OP_PB_AT_MOST=0x900,
Z3_OP_PB_LE,
Z3_OP_PB_GE,
// Floating-Point Arithmetic
Z3_OP_FPA_RM_NEAREST_TIES_TO_EVEN,
Z3_OP_FPA_RM_NEAREST_TIES_TO_AWAY,
Z3_OP_FPA_RM_TOWARD_POSITIVE,
Z3_OP_FPA_RM_TOWARD_NEGATIVE,
Z3_OP_FPA_RM_TOWARD_ZERO,
Z3_OP_FPA_NUM,
Z3_OP_FPA_PLUS_INF,
Z3_OP_FPA_MINUS_INF,
Z3_OP_FPA_NAN,
Z3_OP_FPA_PLUS_ZERO,
Z3_OP_FPA_MINUS_ZERO,
Z3_OP_FPA_ADD,
Z3_OP_FPA_SUB,
Z3_OP_FPA_NEG,
Z3_OP_FPA_MUL,
Z3_OP_FPA_DIV,
Z3_OP_FPA_REM,
Z3_OP_FPA_ABS,
Z3_OP_FPA_MIN,
Z3_OP_FPA_MAX,
Z3_OP_FPA_FMA,
Z3_OP_FPA_SQRT,
Z3_OP_FPA_ROUND_TO_INTEGRAL,
Z3_OP_FPA_EQ,
Z3_OP_FPA_LT,
Z3_OP_FPA_GT,
Z3_OP_FPA_LE,
Z3_OP_FPA_GE,
Z3_OP_FPA_IS_NAN,
Z3_OP_FPA_IS_INF,
Z3_OP_FPA_IS_ZERO,
Z3_OP_FPA_IS_NORMAL,
Z3_OP_FPA_IS_SUBNORMAL,
Z3_OP_FPA_IS_NEGATIVE,
Z3_OP_FPA_IS_POSITIVE,
Z3_OP_FPA_FP,
Z3_OP_FPA_TO_FP,
Z3_OP_FPA_TO_FP_UNSIGNED,
Z3_OP_FPA_TO_UBV,
Z3_OP_FPA_TO_SBV,
Z3_OP_FPA_TO_REAL,
Z3_OP_FPA_TO_IEEE_BV,
Z3_OP_UNINTERPRETED
} Z3_decl_kind;
/**
\mlonly {!param_kind} \endmlonly \conly \brief
The different kinds of parameters that can be associated with parameter sets.
(see #Z3_mk_params).
- Z3_PK_UINT integer parameters.
- Z3_PK_BOOL boolean parameters.
- Z3_PK_DOUBLE double parameters.
- Z3_PK_SYMBOL symbol parameters.
- Z3_PK_STRING string parameters.
- Z3_PK_OTHER all internal parameter kinds which are not exposed in the API.
- Z3_PK_INVALID invalid parameter.
*/
typedef enum {
Z3_PK_UINT,
Z3_PK_BOOL,
Z3_PK_DOUBLE,
Z3_PK_SYMBOL,
Z3_PK_STRING,
Z3_PK_OTHER,
Z3_PK_INVALID
} Z3_param_kind;
#ifdef CorML3
/**
\mlonly {!search_failure} \endmlonly \conly \brief
The different kinds of search failure types.
- Z3_NO_FAILURE: The last search was successful
- Z3_UNKNOWN: Undocumented failure reason
- Z3_TIMEOUT: Timeout
- Z3_MEMOUT_WATERMAK: Search hit a memory high-watermak limit
- Z3_CANCELED: External cancel flag was set
- Z3_NUM_CONFLICTS: Maximum number of conflicts was reached
- Z3_THEORY: Theory is incomplete
- Z3_QUANTIFIERS: Logical context contains universal quantifiers
*/
typedef enum {
Z3_NO_FAILURE,
Z3_UNKNOWN,
Z3_TIMEOUT,
Z3_MEMOUT_WATERMARK,
Z3_CANCELED,
Z3_NUM_CONFLICTS,
Z3_THEORY,
Z3_QUANTIFIERS
} Z3_search_failure;
#endif
/**
\mlonly {!ast_print_mode} \endmlonly \conly \brief
Z3 pretty printing modes (See #Z3_set_ast_print_mode).
- 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.
*/
typedef enum {
Z3_PRINT_SMTLIB_FULL,
Z3_PRINT_LOW_LEVEL,
Z3_PRINT_SMTLIB_COMPLIANT,
Z3_PRINT_SMTLIB2_COMPLIANT
} Z3_ast_print_mode;
#ifdef CorML4
/**
\mlonly {!error_code} \endmlonly \conly \brief
Z3 error codes \conly (See #Z3_get_error_code).
- Z3_OK: No error.
- Z3_SORT_ERROR: User tried to build an invalid (type incorrect) AST.
- Z3_IOB: Index out of bounds.
- Z3_INVALID_ARG: Invalid argument was provided.
- Z3_PARSER_ERROR: An error occurred when parsing a string or file.
- Z3_NO_PARSER: Parser output is not available, that is, user didn't invoke #Z3_parse_smtlib_string or #Z3_parse_smtlib_file.
- Z3_INVALID_PATTERN: Invalid pattern was used to build a quantifier.
- Z3_MEMOUT_FAIL: A memory allocation failure was encountered.
- Z3_FILE_ACCESS_ERRROR: A file could not be accessed.
- Z3_INVALID_USAGE: API call is invalid in the current state.
- Z3_INTERNAL_FATAL: An error internal to Z3 occurred.
- Z3_DEC_REF_ERROR: Trying to decrement the reference counter of an AST that was deleted or the reference counter was not initialized \mlonly.\endmlonly \conly with #Z3_inc_ref.
- Z3_EXCEPTION: Internal Z3 exception. Additional details can be retrieved using #Z3_get_error_msg.
*/
typedef enum
{
Z3_OK,
Z3_SORT_ERROR,
Z3_IOB,
Z3_INVALID_ARG,
Z3_PARSER_ERROR,
Z3_NO_PARSER,
Z3_INVALID_PATTERN,
Z3_MEMOUT_FAIL,
Z3_FILE_ACCESS_ERROR,
Z3_INTERNAL_FATAL,
Z3_INVALID_USAGE,
Z3_DEC_REF_ERROR,
Z3_EXCEPTION
} Z3_error_code;
#endif
/**
Definitions for update_api.py
def_Type('CONFIG', 'Z3_config', 'Config')
def_Type('CONTEXT', 'Z3_context', 'ContextObj')
def_Type('AST', 'Z3_ast', 'Ast')
def_Type('APP', 'Z3_app', 'Ast')
def_Type('SORT', 'Z3_sort', 'Sort')
def_Type('FUNC_DECL', 'Z3_func_decl', 'FuncDecl')
def_Type('PATTERN', 'Z3_pattern', 'Pattern')
def_Type('MODEL', 'Z3_model', 'Model')
def_Type('LITERALS', 'Z3_literals', 'Literals')
def_Type('CONSTRUCTOR', 'Z3_constructor', 'Constructor')
def_Type('CONSTRUCTOR_LIST', 'Z3_constructor_list', 'ConstructorList')
def_Type('THEORY', 'Z3_theory', 'ctypes.c_void_p')
def_Type('THEORY_DATA', 'Z3_theory_data', 'ctypes.c_void_p')
def_Type('SOLVER', 'Z3_solver', 'SolverObj')
def_Type('GOAL', 'Z3_goal', 'GoalObj')
def_Type('TACTIC', 'Z3_tactic', 'TacticObj')
def_Type('PARAMS', 'Z3_params', 'Params')
def_Type('PROBE', 'Z3_probe', 'ProbeObj')
def_Type('STATS', 'Z3_stats', 'StatsObj')
def_Type('AST_VECTOR', 'Z3_ast_vector', 'AstVectorObj')
def_Type('AST_MAP', 'Z3_ast_map', 'AstMapObj')
def_Type('APPLY_RESULT', 'Z3_apply_result', 'ApplyResultObj')
def_Type('FUNC_INTERP', 'Z3_func_interp', 'FuncInterpObj')
def_Type('FUNC_ENTRY', 'Z3_func_entry', 'FuncEntryObj')
def_Type('FIXEDPOINT', 'Z3_fixedpoint', 'FixedpointObj')
def_Type('OPTIMIZE', 'Z3_optimize', 'OptimizeObj')
def_Type('PARAM_DESCRS', 'Z3_param_descrs', 'ParamDescrs')
def_Type('RCF_NUM', 'Z3_rcf_num', 'RCFNumObj')
*/
#ifdef Conly
/**
\brief Z3 custom error handler (See #Z3_set_error_handler).
*/
typedef void Z3_error_handler(Z3_context c, Z3_error_code e);
#endif
#ifdef ML4only
#include <error_handling.idl>
#endif
#ifdef CorML4
/**
\mlonly {!goal_prec} \endmlonly \conly \brief
A Goal is essentially a set of formulas. Z3 provide APIs for building strategies/tactics for solving and transforming Goals. Some of these transformations apply under/over approximations.
- Z3_GOAL_PRECISE: Approximations/Relaxations were not applied on the goal (sat and unsat answers were preserved).
- Z3_GOAL_UNDER: Goal is the product of a under-approximation (sat answers are preserved).
- Z3_GOAL_OVER: Goal is the product of an over-approximation (unsat answers are preserved).
- Z3_GOAL_UNDER_OVER: Goal is garbage (it is the product of over- and under-approximations, sat and unsat answers are not preserved).
*/
typedef enum
{
Z3_GOAL_PRECISE,
Z3_GOAL_UNDER,
Z3_GOAL_OVER,
Z3_GOAL_UNDER_OVER
} Z3_goal_prec;
#endif
/*@}*/
#ifndef CAMLIDL
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
#else
[pointer_default(ref)] interface Z3 {
#endif // CAMLIDL
#ifdef CorML3
/**
@name Configuration
*/
/*@{*/
/**
\brief Set a global (or module) parameter.
This setting is shared by all Z3 contexts.
When a Z3 module is initialized it will use the value of these parameters
when Z3_params objects are not provided.
The name of parameter can be composed of characters [a-z][A-Z], digits [0-9], '-' and '_'.
The character '.' is a delimiter (more later).
The parameter names are case-insensitive. The character '-' should be viewed as an "alias" for '_'.
Thus, the following parameter names are considered equivalent: "pp.decimal-precision" and "PP.DECIMAL_PRECISION".
This function can be used to set parameters for a specific Z3 module.
This can be done by using <module-name>.<parameter-name>.
For example:
Z3_global_param_set('pp.decimal', 'true')
will set the parameter "decimal" in the module "pp" to true.
def_API('Z3_global_param_set', VOID, (_in(STRING), _in(STRING)))
*/
void Z3_API Z3_global_param_set(__in Z3_string param_id, __in Z3_string param_value);
/**
\brief Restore the value of all global (and module) parameters.
This command will not affect already created objects (such as tactics and solvers).
\sa Z3_global_param_set
def_API('Z3_global_param_reset_all', VOID, ())
*/
void Z3_API Z3_global_param_reset_all(void);
/**
\brief Get a global (or module) parameter.
Returns \mlonly \c None \endmlonly \conly \c Z3_FALSE
if the parameter value does not exist.
\sa Z3_global_param_set
\remark This function cannot be invoked simultaneously from different threads without synchronization.
The result string stored in param_value is stored in shared location.
def_API('Z3_global_param_get', BOOL, (_in(STRING), _out(STRING)))
*/
Z3_bool_opt Z3_API Z3_global_param_get(__in Z3_string param_id, __out_opt Z3_string_ptr param_value);
/*@}*/
/**
@name Create configuration
*/
/*@{*/
/**
\brief Create a configuration object for the Z3 context object.
Configurations are created in order to assign parameters prior to creating
contexts for Z3 interaction. For example, if the users wishes to use proof
generation, then call:
\ccode{Z3_set_param_value(cfg\, "proof"\, "true")}
\mlonly \remark Consider using {!mk_context_x} instead of using
explicit configuration objects. The function {!mk_context_x}
receives an array of string pairs. This array represents the
configuration options. \endmlonly
\remark In previous versions of Z3, the \c Z3_config was used to store
global and module configurations. Now, we should use \c Z3_global_param_set.
The following parameters can be set:
- proof (Boolean) Enable proof generation
- debug_ref_count (Boolean) Enable debug support for Z3_ast reference counting
- trace (Boolean) Tracing support for VCC
- trace_file_name (String) Trace out file for VCC traces
- timeout (unsigned) default timeout (in milliseconds) used for solvers
- well_sorted_check type checker
- auto_config use heuristics to automatically select solver and configure it
- model model generation for solvers, this parameter can be overwritten when creating a solver
- model_validate validate models produced by solvers
- unsat_core unsat-core generation for solvers, this parameter can be overwritten when creating a solver
\sa Z3_set_param_value
\sa Z3_del_config
def_API('Z3_mk_config', CONFIG, ())
*/
Z3_config Z3_API Z3_mk_config(void);
/**
\brief Delete the given configuration object.
\sa Z3_mk_config
def_API('Z3_del_config', VOID, (_in(CONFIG),))
*/
void Z3_API Z3_del_config(__in Z3_config c);
/**
\brief Set a configuration parameter.
The following parameters can be set for
\sa Z3_mk_config
def_API('Z3_set_param_value', VOID, (_in(CONFIG), _in(STRING), _in(STRING)))
*/
void Z3_API Z3_set_param_value(__in Z3_config c, __in Z3_string param_id, __in Z3_string param_value);
/*@}*/
#endif
/**
@name Create context
*/
/*@{*/
/**
\brief Create a context using the given configuration.
After a context is created, the configuration cannot be changed,
although some parameters can be changed using #Z3_update_param_value.
All main interaction with Z3 happens in the context of a \c Z3_context.
In contrast to #Z3_mk_context_rc, the life time of Z3_ast objects
are determined by the scope level of #Z3_push and #Z3_pop.
In other words, a Z3_ast object remains valid until there is a
call to Z3_pop that takes the current scope below the level where
the object was created.
Note that all other reference counted objects, including Z3_model,
Z3_solver, Z3_func_interp have to be managed by the caller.
Their reference counts are not handled by the context.
\conly \sa Z3_del_context
\conly \deprecated Use #Z3_mk_context_rc
def_API('Z3_mk_context', CONTEXT, (_in(CONFIG),))
*/
#ifdef CorML3
Z3_context Z3_API Z3_mk_context(__in Z3_config c);
#endif
#ifdef ML4only
#include <mlx_mk_context_x.idl>
#endif
#ifdef Conly
/**
\brief Create a context using the given configuration.
This function is similar to #Z3_mk_context. However,
in the context returned by this function, the user
is responsible for managing Z3_ast reference counters.
Managing reference counters is a burden and error-prone,
but allows the user to use the memory more efficiently.
The user must invoke #Z3_inc_ref for any Z3_ast returned
by Z3, and #Z3_dec_ref whenever the Z3_ast is not needed
anymore. This idiom is similar to the one used in
BDD (binary decision diagrams) packages such as CUDD.
Remark: Z3_sort, Z3_func_decl, Z3_app, Z3_pattern are
Z3_ast's.
After a context is created, the configuration cannot be changed.
All main interaction with Z3 happens in the context of a \c Z3_context.
def_API('Z3_mk_context_rc', CONTEXT, (_in(CONFIG),))
*/
Z3_context Z3_API Z3_mk_context_rc(__in Z3_config c);
#endif
#ifdef CorML3
/**
\brief Delete the given logical context.
\sa Z3_mk_context
def_API('Z3_del_context', VOID, (_in(CONTEXT),))
*/
void Z3_API Z3_del_context(__in Z3_context c);
#endif
#ifdef Conly
/**
\brief Increment the reference counter of the given AST.
The context \c c should have been created using #Z3_mk_context_rc.
This function is a NOOP if \c c was created using #Z3_mk_context.
def_API('Z3_inc_ref', VOID, (_in(CONTEXT), _in(AST)))
*/
void Z3_API Z3_inc_ref(__in Z3_context c, __in Z3_ast a);
/**
\brief Decrement the reference counter of the given AST.
The context \c c should have been created using #Z3_mk_context_rc.
This function is a NOOP if \c c was created using #Z3_mk_context.
def_API('Z3_dec_ref', VOID, (_in(CONTEXT), _in(AST)))
*/
void Z3_API Z3_dec_ref(__in Z3_context c, __in Z3_ast a);
#endif
/**
\brief Set a value of a context parameter.
\sa Z3_global_param_set
def_API('Z3_update_param_value', VOID, (_in(CONTEXT), _in(STRING), _in(STRING)))
*/
void Z3_API Z3_update_param_value(__in Z3_context c, __in Z3_string param_id, __in Z3_string param_value);
#ifdef CorML4
/**
\brief Interrupt the execution of a Z3 procedure.
This procedure can be used to interrupt: solvers, simplifiers and tactics.
def_API('Z3_interrupt', VOID, (_in(CONTEXT),))
*/
void Z3_API Z3_interrupt(__in Z3_context c);
#endif
/*@}*/
#ifdef CorML4
/**
@name Parameters
*/
/*@{*/
/**
\brief 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.
\conly \remark Reference counting must be used to manage parameter sets, even when the Z3_context was
\conly created using #Z3_mk_context instead of #Z3_mk_context_rc.
def_API('Z3_mk_params', PARAMS, (_in(CONTEXT),))
*/
Z3_params Z3_API Z3_mk_params(__in Z3_context c);
#ifdef Conly
/**
\brief Increment the reference counter of the given parameter set.
def_API('Z3_params_inc_ref', VOID, (_in(CONTEXT), _in(PARAMS)))
*/
void Z3_API Z3_params_inc_ref(__in Z3_context c, __in Z3_params p);
/**
\brief Decrement the reference counter of the given parameter set.
def_API('Z3_params_dec_ref', VOID, (_in(CONTEXT), _in(PARAMS)))
*/
void Z3_API Z3_params_dec_ref(__in Z3_context c, __in Z3_params p);
#endif
/**
\brief Add a Boolean parameter \c k with value \c v to the parameter set \c p.
def_API('Z3_params_set_bool', VOID, (_in(CONTEXT), _in(PARAMS), _in(SYMBOL), _in(BOOL)))
*/
void Z3_API Z3_params_set_bool(__in Z3_context c, __in Z3_params p, __in Z3_symbol k, __in Z3_bool v);
/**
\brief Add a unsigned parameter \c k with value \c v to the parameter set \c p.
def_API('Z3_params_set_uint', VOID, (_in(CONTEXT), _in(PARAMS), _in(SYMBOL), _in(UINT)))
*/
void Z3_API Z3_params_set_uint(__in Z3_context c, __in Z3_params p, __in Z3_symbol k, __in unsigned v);
/**
\brief Add a double parameter \c k with value \c v to the parameter set \c p.
def_API('Z3_params_set_double', VOID, (_in(CONTEXT), _in(PARAMS), _in(SYMBOL), _in(DOUBLE)))
*/
void Z3_API Z3_params_set_double(__in Z3_context c, __in Z3_params p, __in Z3_symbol k, __in double v);
/**
\brief Add a symbol parameter \c k with value \c v to the parameter set \c p.
def_API('Z3_params_set_symbol', VOID, (_in(CONTEXT), _in(PARAMS), _in(SYMBOL), _in(SYMBOL)))
*/
void Z3_API Z3_params_set_symbol(__in Z3_context c, __in Z3_params p, __in Z3_symbol k, __in Z3_symbol v);
/**
\brief Convert a parameter set into a string. This function is mainly used for printing the
contents of a parameter set.
def_API('Z3_params_to_string', STRING, (_in(CONTEXT), _in(PARAMS)))
*/
Z3_string Z3_API Z3_params_to_string(__in Z3_context c, __in Z3_params p);
/**
\brief Validate the parameter set \c p against the parameter description set \c d.
The procedure invokes the error handler if \c p is invalid.
def_API('Z3_params_validate', VOID, (_in(CONTEXT), _in(PARAMS), _in(PARAM_DESCRS)))
*/
void Z3_API Z3_params_validate(__in Z3_context c, __in Z3_params p, __in Z3_param_descrs d);
#endif
/*@}*/
#ifdef CorML4
/**
@name Parameter Descriptions
*/
/*@{*/
#ifdef Conly
/**
\brief Increment the reference counter of the given parameter description set.
def_API('Z3_param_descrs_inc_ref', VOID, (_in(CONTEXT), _in(PARAM_DESCRS)))
*/
void Z3_API Z3_param_descrs_inc_ref(__in Z3_context c, __in Z3_param_descrs p);
/**
\brief Decrement the reference counter of the given parameter description set.
def_API('Z3_param_descrs_dec_ref', VOID, (_in(CONTEXT), _in(PARAM_DESCRS)))
*/
void Z3_API Z3_param_descrs_dec_ref(__in Z3_context c, __in Z3_param_descrs p);
#endif
/**
\brief Return the kind associated with the given parameter name \c n.
def_API('Z3_param_descrs_get_kind', UINT, (_in(CONTEXT), _in(PARAM_DESCRS), _in(SYMBOL)))
*/
Z3_param_kind Z3_API Z3_param_descrs_get_kind(__in Z3_context c, __in Z3_param_descrs p, __in Z3_symbol n);
/**
\brief Return the number of parameters in the given parameter description set.
def_API('Z3_param_descrs_size', UINT, (_in(CONTEXT), _in(PARAM_DESCRS)))
*/
unsigned Z3_API Z3_param_descrs_size(__in Z3_context c, __in Z3_param_descrs p);
/**
\brief Return the number of parameters in the given parameter description set.
\pre i < Z3_param_descrs_size(c, p)
def_API('Z3_param_descrs_get_name', SYMBOL, (_in(CONTEXT), _in(PARAM_DESCRS), _in(UINT)))
*/
Z3_symbol Z3_API Z3_param_descrs_get_name(__in Z3_context c, __in Z3_param_descrs p, __in unsigned i);
/**
\brief Convert a parameter description set into a string. This function is mainly used for printing the
contents of a parameter description set.
def_API('Z3_param_descrs_to_string', STRING, (_in(CONTEXT), _in(PARAM_DESCRS)))
*/
Z3_string Z3_API Z3_param_descrs_to_string(__in Z3_context c, __in Z3_param_descrs p);
/*@}*/
#endif
/**
@name Symbols
*/
/*@{*/
#ifdef ML4only
#include <mlx_mk_symbol.idl>
#endif
/**
\mlonly {4 {L Redundant low-level API}} \endmlonly
*/
/**
\brief Create a Z3 symbol using an integer.
Symbols are used to name several term and type constructors.
NB. Not all integers can be passed to this function.
The legal range of unsigned integers is 0 to 2^30-1.
\sa Z3_mk_string_symbol
def_API('Z3_mk_int_symbol', SYMBOL, (_in(CONTEXT), _in(INT)))
*/
Z3_symbol Z3_API Z3_mk_int_symbol(__in Z3_context c, __in int i);
/**
\brief Create a Z3 symbol using a C string.
Symbols are used to name several term and type constructors.
\sa Z3_mk_int_symbol
def_API('Z3_mk_string_symbol', SYMBOL, (_in(CONTEXT), _in(STRING)))
*/
Z3_symbol Z3_API Z3_mk_string_symbol(__in Z3_context c, __in Z3_string s);
/*@}*/
/**
@name Sorts
*/
/*@{*/
#ifdef ML4only
#include <mlx_mk_sort.idl>
#endif
/**
\mlonly {4 {L Redundant low-level API}} \endmlonly
*/
/**
\brief Create a free (uninterpreted) type using the given name (symbol).
Two free types are considered the same iff the have the same name.
def_API('Z3_mk_uninterpreted_sort', SORT, (_in(CONTEXT), _in(SYMBOL)))
*/
Z3_sort Z3_API Z3_mk_uninterpreted_sort(__in Z3_context c, __in Z3_symbol s);
/**
\brief Create the Boolean type.
This type is used to create propositional variables and predicates.
def_API('Z3_mk_bool_sort', SORT, (_in(CONTEXT), ))
*/
Z3_sort Z3_API Z3_mk_bool_sort(__in Z3_context c);
/**
\brief Create the integer type.
This type is not the int type found in programming languages.
A machine integer can be represented using bit-vectors. The function
#Z3_mk_bv_sort creates a bit-vector type.
\sa Z3_mk_bv_sort
def_API('Z3_mk_int_sort', SORT, (_in(CONTEXT), ))
*/
Z3_sort Z3_API Z3_mk_int_sort(__in Z3_context c);
/**
\brief Create the real type.
Note that this type is not a floating point number.
def_API('Z3_mk_real_sort', SORT, (_in(CONTEXT), ))
*/
Z3_sort Z3_API Z3_mk_real_sort(__in Z3_context c);
/**
\brief Create a bit-vector type of the given size.
This type can also be seen as a machine integer.
\remark The size of the bitvector type must be greater than zero.
def_API('Z3_mk_bv_sort', SORT, (_in(CONTEXT), _in(UINT)))
*/
Z3_sort Z3_API Z3_mk_bv_sort(__in Z3_context c, __in unsigned sz);
/**
\brief Create a named finite domain sort.
To create constants that belong to the finite domain,
use the APIs for creating numerals and pass a numeric
constant together with the sort returned by this call.
The numeric constant should be between 0 and the less
than the size of the domain.
\sa Z3_get_finite_domain_sort_size
def_API('Z3_mk_finite_domain_sort', SORT, (_in(CONTEXT), _in(SYMBOL), _in(UINT64)))
*/
Z3_sort Z3_API Z3_mk_finite_domain_sort(__in Z3_context c, __in Z3_symbol name, __in unsigned __int64 size);
/**
\brief Create an array type.
We usually represent the array type as: <tt>[domain -> range]</tt>.
Arrays are usually used to model the heap/memory in software verification.
\sa Z3_mk_select
\sa Z3_mk_store
def_API('Z3_mk_array_sort', SORT, (_in(CONTEXT), _in(SORT), _in(SORT)))
*/
Z3_sort Z3_API Z3_mk_array_sort(__in Z3_context c, __in Z3_sort domain, __in Z3_sort range);
/**
\brief Create a tuple type.
\mlonly [mk_tuple_sort c name field_names field_sorts] creates a tuple with a constructor named [name],
a [n] fields, where [n] is the size of the arrays [field_names] and [field_sorts].
\endmlonly
\conly A tuple with \c n fields has a constructor and \c n projections.
\conly This function will also declare the constructor and projection functions.
\param c logical context
\param mk_tuple_name name of the constructor function associated with the tuple type.
\param num_fields number of fields in the tuple type.
\param field_names name of the projection functions.
\param field_sorts type of the tuple fields.
\param mk_tuple_decl output parameter that will contain the constructor declaration.
\param proj_decl output parameter that will contain the projection function declarations. This field must be a buffer of size \c num_fields allocated by the user.
def_API('Z3_mk_tuple_sort', SORT, (_in(CONTEXT), _in(SYMBOL), _in(UINT), _in_array(2, SYMBOL), _in_array(2, SORT), _out(FUNC_DECL), _out_array(2, FUNC_DECL)))
*/
Z3_sort Z3_API Z3_mk_tuple_sort(__in Z3_context c,
__in Z3_symbol mk_tuple_name,
__in unsigned num_fields,
__in_ecount(num_fields) Z3_symbol const field_names[],
__in_ecount(num_fields) Z3_sort const field_sorts[],
__out Z3_func_decl * mk_tuple_decl,
__out_ecount(num_fields) Z3_func_decl proj_decl[]);
/**
\brief Create a enumeration sort.
\mlonly [mk_enumeration_sort c enums] creates an enumeration sort with enumeration names [enums],
it also returns [n] predicates, where [n] is the number of [enums] corresponding
to testing whether an element is one of the enumerants.
\endmlonly
\conly An enumeration sort with \c n elements.
\conly This function will also declare the functions corresponding to the enumerations.
\param c logical context
\param name name of the enumeration sort.
\param n number of elemenets in enumeration sort.
\param enum_names names of the enumerated elements.
\param enum_consts constants corresponding to the enumerated elements.
\param enum_testers predicates testing if terms of the enumeration sort correspond to an enumeration.
For example, if this function is called with three symbols A, B, C and the name S, then
\c s is a sort whose name is S, and the function returns three terms corresponding to A, B, C in
\c enum_consts. The array \c enum_testers has three predicates of type <tt>(s -> Bool)</tt>.
The first predicate (corresponding to A) is true when applied to A, and false otherwise.
Similarly for the other predicates.
def_API('Z3_mk_enumeration_sort', SORT, (_in(CONTEXT), _in(SYMBOL), _in(UINT), _in_array(2, SYMBOL), _out_array(2, FUNC_DECL), _out_array(2, FUNC_DECL)))
*/
Z3_sort Z3_API Z3_mk_enumeration_sort(__in Z3_context c,
__in Z3_symbol name,
__in unsigned n,
__in_ecount(n) Z3_symbol const enum_names[],
__out_ecount(n) Z3_func_decl enum_consts[],
__out_ecount(n) Z3_func_decl enum_testers[]);
/**
\brief Create a list sort
\mlonly [mk_list_sort c name elem_sort] creates a list sort of [name], over elements of sort [elem_sort].
\endmlonly
\conly A list sort over \c elem_sort
\conly This function declares the corresponding constructors and testers for lists.
\param c logical context
\param name name of the list sort.
\param elem_sort sort of list elements.
\param nil_decl declaration for the empty list.
\param is_nil_decl test for the empty list.
\param cons_decl declaration for a cons cell.
\param is_cons_decl cons cell test.
\param head_decl list head.
\param tail_decl list tail.
def_API('Z3_mk_list_sort', SORT, (_in(CONTEXT), _in(SYMBOL), _in(SORT), _out(FUNC_DECL), _out(FUNC_DECL), _out(FUNC_DECL), _out(FUNC_DECL), _out(FUNC_DECL), _out(FUNC_DECL)))
*/
Z3_sort Z3_API Z3_mk_list_sort(__in Z3_context c,
__in Z3_symbol name,
__in Z3_sort elem_sort,
__out Z3_func_decl* nil_decl,
__out Z3_func_decl* is_nil_decl,
__out Z3_func_decl* cons_decl,
__out Z3_func_decl* is_cons_decl,
__out Z3_func_decl* head_decl,
__out Z3_func_decl* tail_decl
);
BEGIN_MLAPI_EXCLUDE
/**
\brief Create a constructor.
\param c logical context.
\param name constructor name.
\param recognizer name of recognizer function.
\param num_fields number of fields in constructor.
\param field_names names of the constructor fields.
\param sorts field sorts, \mlonly [None] \endmlonly \conly 0
if the field sort refers to a recursive sort.
\param sort_refs reference to datatype sort that is an argument to the constructor; if the corresponding
sort reference is \mlonly [None], \endmlonly \conly 0,
then the value in sort_refs should be an index referring to
one of the recursive datatypes that is declared.
def_API('Z3_mk_constructor', CONSTRUCTOR, (_in(CONTEXT), _in(SYMBOL), _in(SYMBOL), _in(UINT), _in_array(3, SYMBOL), _in_array(3, SORT), _in_array(3, UINT)))
*/
Z3_constructor Z3_API Z3_mk_constructor(__in Z3_context c,
__in Z3_symbol name,
__in Z3_symbol recognizer,
__in unsigned num_fields,
__in_ecount(num_fields) Z3_symbol const field_names[],
__in_ecount(num_fields) Z3_sort_opt const sorts[],
__in_ecount(num_fields) unsigned sort_refs[]
);
/**
\brief Reclaim memory allocated to constructor.
\param c logical context.
\param constr constructor.
def_API('Z3_del_constructor', VOID, (_in(CONTEXT), _in(CONSTRUCTOR)))
*/
void Z3_API Z3_del_constructor(__in Z3_context c, __in Z3_constructor constr);
/**
\brief Create datatype, such as lists, trees, records, enumerations or unions of records.
The datatype may be recursive. Return the datatype sort.
\param c logical context.
\param name name of datatype.
\param num_constructors number of constructors passed in.
\param constructors array of constructor containers.
def_API('Z3_mk_datatype', SORT, (_in(CONTEXT), _in(SYMBOL), _in(UINT), _inout_array(2, CONSTRUCTOR)))
*/
Z3_sort Z3_API Z3_mk_datatype(__in Z3_context c,
__in Z3_symbol name,
__in unsigned num_constructors,
__inout_ecount(num_constructors) Z3_constructor constructors[]);
/**
\brief Create list of constructors.
\param c logical context.
\param num_constructors number of constructors in list.
\param constructors list of constructors.
def_API('Z3_mk_constructor_list', CONSTRUCTOR_LIST, (_in(CONTEXT), _in(UINT), _in_array(1, CONSTRUCTOR)))
*/
Z3_constructor_list Z3_API Z3_mk_constructor_list(__in Z3_context c,
__in unsigned num_constructors,
__in_ecount(num_constructors) Z3_constructor const constructors[]);
/**
\brief Reclaim memory allocated for constructor list.
Each constructor inside the constructor list must be independently reclaimed using #Z3_del_constructor.
\param c logical context.
\param clist constructor list container.
def_API('Z3_del_constructor_list', VOID, (_in(CONTEXT), _in(CONSTRUCTOR_LIST)))
*/
void Z3_API Z3_del_constructor_list(__in Z3_context c, __in Z3_constructor_list clist);
/**
\brief Create mutually recursive datatypes.
\param c logical context.
\param num_sorts number of datatype sorts.
\param sort_names names of datatype sorts.
\param sorts array of datatype sorts.
\param constructor_lists list of constructors, one list per sort.
def_API('Z3_mk_datatypes', VOID, (_in(CONTEXT), _in(UINT), _in_array(1, SYMBOL), _out_array(1, SORT), _inout_array(1, CONSTRUCTOR_LIST)))
*/
void Z3_API Z3_mk_datatypes(__in Z3_context c,
__in unsigned num_sorts,
__in_ecount(num_sorts) Z3_symbol const sort_names[],
__out_ecount(num_sorts) Z3_sort sorts[],
__inout_ecount(num_sorts) Z3_constructor_list constructor_lists[]);
/**
\brief Query constructor for declared functions.
\param c logical context.
\param constr constructor container. The container must have been passed in to a #Z3_mk_datatype call.
\param num_fields number of accessor fields in the constructor.
\param constructor constructor function declaration.
\param tester constructor test function declaration.
\param accessors array of accessor function declarations.
def_API('Z3_query_constructor', VOID, (_in(CONTEXT), _in(CONSTRUCTOR), _in(UINT), _out(FUNC_DECL), _out(FUNC_DECL), _out_array(2, FUNC_DECL)))
*/
void Z3_API Z3_query_constructor(__in Z3_context c,
__in Z3_constructor constr,
__in unsigned num_fields,
__out Z3_func_decl* constructor,
__out Z3_func_decl* tester,
__out_ecount(num_fields) Z3_func_decl accessors[]);
END_MLAPI_EXCLUDE
/*@}*/
/**
@name Constants and Applications
*/
/*@{*/
/**
\brief Declare a constant or function.
\mlonly [mk_func_decl c n d r] creates a function with name [n], domain [d], and range [r].
The arity of the function is the size of the array [d]. \endmlonly
\param c logical context.
\param s name of the constant or function.
\param domain_size number of arguments. It is 0 when declaring a constant.
\param domain array containing the sort of each argument. The array must contain domain_size elements. It is 0 when declaring a constant.
\param range sort of the constant or the return sort of the function.
After declaring a constant or function, the function
#Z3_mk_app can be used to create a constant or function
application.
\sa Z3_mk_app
def_API('Z3_mk_func_decl', FUNC_DECL, (_in(CONTEXT), _in(SYMBOL), _in(UINT), _in_array(2, SORT), _in(SORT)))
*/
Z3_func_decl Z3_API Z3_mk_func_decl(__in Z3_context c, __in Z3_symbol s,
__in unsigned domain_size, __in_ecount(domain_size) Z3_sort const domain[],
__in Z3_sort range);
/**
\brief Create a constant or function application.
\sa Z3_mk_func_decl
def_API('Z3_mk_app', AST, (_in(CONTEXT), _in(FUNC_DECL), _in(UINT), _in_array(2, AST)))
*/
Z3_ast Z3_API Z3_mk_app(
__in Z3_context c,
__in Z3_func_decl d,
__in unsigned num_args,
__in_ecount(num_args) Z3_ast const args[]);
/**
\brief Declare and create a constant.
\conly This function is a shorthand for:
\conly \code
\conly Z3_func_decl d = Z3_mk_func_decl(c, s, 0, 0, ty);
\conly Z3_ast n = Z3_mk_app(c, d, 0, 0);
\conly \endcode
\mlonly [mk_const c s t] is a shorthand for [mk_app c (mk_func_decl c s [||] t) [||]] \endmlonly
\sa Z3_mk_func_decl
\sa Z3_mk_app
def_API('Z3_mk_const', AST, (_in(CONTEXT), _in(SYMBOL), _in(SORT)))
*/
Z3_ast Z3_API Z3_mk_const(__in Z3_context c, __in Z3_symbol s, __in Z3_sort ty);
/**
\brief Declare a fresh constant or function.
Z3 will generate an unique name for this function declaration.
\conly If prefix is different from \c NULL, then the name generate by Z3 will start with \c prefix.
\conly \remark If \c prefix is \c NULL, then it is assumed to be the empty string.
\sa Z3_mk_func_decl
def_API('Z3_mk_fresh_func_decl', FUNC_DECL, (_in(CONTEXT), _in(STRING), _in(UINT), _in_array(2, SORT), _in(SORT)))
*/
Z3_func_decl Z3_API Z3_mk_fresh_func_decl(__in Z3_context c, __in Z3_string prefix,
__in unsigned domain_size, __in_ecount(domain_size) Z3_sort const domain[],
__in Z3_sort range);
/**
\brief Declare and create a fresh constant.
\conly This function is a shorthand for:
\conly \code Z3_func_decl d = Z3_mk_fresh_func_decl(c, prefix, 0, 0, ty); Z3_ast n = Z3_mk_app(c, d, 0, 0); \endcode
\mlonly [mk_fresh_const c p t] is a shorthand for [mk_app c (mk_fresh_func_decl c p [||] t) [||]]. \endmlonly
\conly \remark If \c prefix is \c NULL, then it is assumed to be the empty string.
\sa Z3_mk_func_decl
\sa Z3_mk_app
def_API('Z3_mk_fresh_const', AST, (_in(CONTEXT), _in(STRING), _in(SORT)))
*/
Z3_ast Z3_API Z3_mk_fresh_const(__in Z3_context c, __in Z3_string prefix, __in Z3_sort ty);
/*@}*/
/**
@name Propositional Logic and Equality
*/
/*@{*/
/**
\brief Create an AST node representing \c true.
def_API('Z3_mk_true', AST, (_in(CONTEXT), ))
*/
Z3_ast Z3_API Z3_mk_true(__in Z3_context c);
/**
\brief Create an AST node representing \c false.
def_API('Z3_mk_false', AST, (_in(CONTEXT), ))
*/
Z3_ast Z3_API Z3_mk_false(__in Z3_context c);
/**
\brief \mlh mk_eq c l r \endmlh
Create an AST node representing <tt>l = r</tt>.
The nodes \c l and \c r must have the same type.
def_API('Z3_mk_eq', AST, (_in(CONTEXT), _in(AST), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_eq(__in Z3_context c, __in Z3_ast l, __in Z3_ast r);
/**
\conly \brief Create an AST node representing <tt>distinct(args[0], ..., args[num_args-1])</tt>.
\mlonly \brief \[ [mk_distinct c [| t_1; ...; t_n |]] \] Create an AST
node represeting a distinct construct. It is used for declaring
the arguments t_i pairwise distinct. \endmlonly
The \c distinct construct is used for declaring the arguments pairwise distinct.
That is, <tt>Forall 0 <= i < j < num_args. not args[i] = args[j]</tt>.
All arguments must have the same sort.
\remark The number of arguments of a distinct construct must be greater than one.
def_API('Z3_mk_distinct', AST, (_in(CONTEXT), _in(UINT), _in_array(1, AST)))
*/
Z3_ast Z3_API Z3_mk_distinct(__in Z3_context c, __in unsigned num_args, __in_ecount(num_args) Z3_ast const args[]);
/**
\brief \mlh mk_not c a \endmlh
Create an AST node representing <tt>not(a)</tt>.
The node \c a must have Boolean sort.
def_API('Z3_mk_not', AST, (_in(CONTEXT), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_not(__in Z3_context c, __in Z3_ast a);
/**
\brief \mlh mk_ite c t1 t2 t2 \endmlh
Create an AST node representing an if-then-else: <tt>ite(t1, t2,
t3)</tt>.
The node \c t1 must have Boolean sort, \c t2 and \c t3 must have the same sort.
The sort of the new node is equal to the sort of \c t2 and \c t3.
def_API('Z3_mk_ite', AST, (_in(CONTEXT), _in(AST), _in(AST), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_ite(__in Z3_context c, __in Z3_ast t1, __in Z3_ast t2, __in Z3_ast t3);
/**
\brief \mlh mk_iff c t1 t2 \endmlh
Create an AST node representing <tt>t1 iff t2</tt>.
The nodes \c t1 and \c t2 must have Boolean sort.
def_API('Z3_mk_iff', AST, (_in(CONTEXT), _in(AST), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_iff(__in Z3_context c, __in Z3_ast t1, __in Z3_ast t2);
/**
\brief \mlh mk_implies c t1 t2 \endmlh
Create an AST node representing <tt>t1 implies t2</tt>.
The nodes \c t1 and \c t2 must have Boolean sort.
def_API('Z3_mk_implies', AST, (_in(CONTEXT), _in(AST), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_implies(__in Z3_context c, __in Z3_ast t1, __in Z3_ast t2);
/**
\brief \mlh mk_xor c t1 t2 \endmlh
Create an AST node representing <tt>t1 xor t2</tt>.
The nodes \c t1 and \c t2 must have Boolean sort.
def_API('Z3_mk_xor', AST, (_in(CONTEXT), _in(AST), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_xor(__in Z3_context c, __in Z3_ast t1, __in Z3_ast t2);
/**
\conly \brief Create an AST node representing <tt>args[0] and ... and args[num_args-1]</tt>.
\mlonly \brief \[ [mk_and c [| t_1; ...; t_n |]] \] Create the conjunction: {e t_1 and ... and t_n}. \endmlonly
\conly The array \c args must have \c num_args elements.
All arguments must have Boolean sort.
\remark The number of arguments must be greater than zero.
def_API('Z3_mk_and', AST, (_in(CONTEXT), _in(UINT), _in_array(1, AST)))
*/
Z3_ast Z3_API Z3_mk_and(__in Z3_context c, __in unsigned num_args, __in_ecount(num_args) Z3_ast const args[]);
/**
\conly \brief Create an AST node representing <tt>args[0] or ... or args[num_args-1]</tt>.
\mlonly \brief \[ [mk_or c [| t_1; ...; t_n |]] \] Create the disjunction: {e t_1 or ... or t_n}. \endmlonly
\conly The array \c args must have \c num_args elements.
All arguments must have Boolean sort.
\remark The number of arguments must be greater than zero.
def_API('Z3_mk_or', AST, (_in(CONTEXT), _in(UINT), _in_array(1, AST)))
*/
Z3_ast Z3_API Z3_mk_or(__in Z3_context c, __in unsigned num_args, __in_ecount(num_args) Z3_ast const args[]);
/*@}*/
/**
@name Arithmetic: Integers and Reals
*/
/*@{*/
/**
\conly \brief Create an AST node representing <tt>args[0] + ... + args[num_args-1]</tt>.
\mlonly \brief \[ [mk_add c [| t_1; ...; t_n |]] \] Create the term: {e t_1 + ... + t_n}. \endmlonly
\conly The array \c args must have \c num_args elements.
All arguments must have int or real sort.
\remark The number of arguments must be greater than zero.
def_API('Z3_mk_add', AST, (_in(CONTEXT), _in(UINT), _in_array(1, AST)))
*/
Z3_ast Z3_API Z3_mk_add(__in Z3_context c, __in unsigned num_args, __in_ecount(num_args) Z3_ast const args[]);
/**
\conly \brief Create an AST node representing <tt>args[0] * ... * args[num_args-1]</tt>.
\mlonly \brief \[ [mk_mul c [| t_1; ...; t_n |]] \] Create the term: {e t_1 * ... * t_n}. \endmlonly
\conly The array \c args must have \c num_args elements.
All arguments must have int or real sort.
\remark Z3 has limited support for non-linear arithmetic.
\remark The number of arguments must be greater than zero.
def_API('Z3_mk_mul', AST, (_in(CONTEXT), _in(UINT), _in_array(1, AST)))
*/
Z3_ast Z3_API Z3_mk_mul(__in Z3_context c, __in unsigned num_args, __in_ecount(num_args) Z3_ast const args[]);
/**
\conly \brief Create an AST node representing <tt>args[0] - ... - args[num_args - 1]</tt>.
\mlonly \brief \[ [mk_sub c [| t_1; ...; t_n |]] \] Create the term: {e t_1 - ... - t_n}. \endmlonly
\conly The array \c args must have \c num_args elements.
All arguments must have int or real sort.
\remark The number of arguments must be greater than zero.
def_API('Z3_mk_sub', AST, (_in(CONTEXT), _in(UINT), _in_array(1, AST)))
*/
Z3_ast Z3_API Z3_mk_sub(__in Z3_context c, __in unsigned num_args, __in_ecount(num_args) Z3_ast const args[]);
/**
\conly \brief Create an AST node representing <tt>-arg</tt>.
\mlonly \brief \[ [mk_unary_minus c arg] \] Create the term: {e - arg}. \endmlonly
The arguments must have int or real type.
def_API('Z3_mk_unary_minus', AST, (_in(CONTEXT), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_unary_minus(__in Z3_context c, __in Z3_ast arg);
/**
\conly \brief Create an AST node representing <tt>arg1 div arg2</tt>.
\mlonly \brief \[ [mk_div c t_1 t_2] \] Create the term: {e t_1 div t_2}. \endmlonly
The arguments must either both have int type or both have real type.
If the arguments have int type, then the result type is an int type, otherwise the
the result type is real.
def_API('Z3_mk_div', AST, (_in(CONTEXT), _in(AST), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_div(__in Z3_context c, __in Z3_ast arg1, __in Z3_ast arg2);
/**
\conly \brief Create an AST node representing <tt>arg1 mod arg2</tt>.
\mlonly \brief \[ [mk_mod c t_1 t_2] \] Create the term: {e t_1 mod t_2}. \endmlonly
The arguments must have int type.
def_API('Z3_mk_mod', AST, (_in(CONTEXT), _in(AST), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_mod(__in Z3_context c, __in Z3_ast arg1, __in Z3_ast arg2);
/**
\conly \brief Create an AST node representing <tt>arg1 rem arg2</tt>.
\mlonly \brief \[ [mk_rem c t_1 t_2] \] Create the term: {e t_1 rem t_2}. \endmlonly
The arguments must have int type.
def_API('Z3_mk_rem', AST, (_in(CONTEXT), _in(AST), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_rem(__in Z3_context c, __in Z3_ast arg1, __in Z3_ast arg2);
/**
\conly \brief Create an AST node representing <tt>arg1^arg2</tt>.
The arguments must have int or real type.
def_API('Z3_mk_power', AST, (_in(CONTEXT), _in(AST), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_power(__in Z3_context c, __in Z3_ast arg1, __in Z3_ast arg2);
/**
\brief \mlh mk_lt c t1 t2 \endmlh
Create less than.
The nodes \c t1 and \c t2 must have the same sort, and must be int or real.
def_API('Z3_mk_lt', AST, (_in(CONTEXT), _in(AST), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_lt(__in Z3_context c, __in Z3_ast t1, __in Z3_ast t2);
/**
\brief \mlh mk_le c t1 t2 \endmlh
Create less than or equal to.
The nodes \c t1 and \c t2 must have the same sort, and must be int or real.
def_API('Z3_mk_le', AST, (_in(CONTEXT), _in(AST), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_le(__in Z3_context c, __in Z3_ast t1, __in Z3_ast t2);
/**
\brief \mlh mk_gt c t1 t2 \endmlh
Create greater than.
The nodes \c t1 and \c t2 must have the same sort, and must be int or real.
def_API('Z3_mk_gt', AST, (_in(CONTEXT), _in(AST), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_gt(__in Z3_context c, __in Z3_ast t1, __in Z3_ast t2);
/**
\brief \mlh mk_ge c t1 t2 \endmlh
Create greater than or equal to.
The nodes \c t1 and \c t2 must have the same sort, and must be int or real.
def_API('Z3_mk_ge', AST, (_in(CONTEXT), _in(AST), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_ge(__in Z3_context c, __in Z3_ast t1, __in Z3_ast t2);
/**
\brief \mlh mk_int2real c t1 \endmlh
Coerce an integer to a real.
There is also a converse operation exposed.
It follows the semantics prescribed by the SMT-LIB standard.
You can take the floor of a real by
creating an auxiliary integer constant \c k and
and asserting <tt> mk_int2real(k) <= t1 < mk_int2real(k)+1</tt>.
The node \c t1 must have sort integer.
\sa Z3_mk_real2int
\sa Z3_mk_is_int
def_API('Z3_mk_int2real', AST, (_in(CONTEXT), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_int2real(__in Z3_context c, __in Z3_ast t1);
/**
\brief \mlh mk_real2int c t1 \endmlh
Coerce a real to an integer.
The semantics of this function follows the SMT-LIB standard
for the function to_int
\sa Z3_mk_int2real
\sa Z3_mk_is_int
def_API('Z3_mk_real2int', AST, (_in(CONTEXT), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_real2int(__in Z3_context c, __in Z3_ast t1);
/**
\brief \mlh mk_is_int c t1 \endmlh
Check if a real number is an integer.
\sa Z3_mk_int2real
\sa Z3_mk_real2int
def_API('Z3_mk_is_int', AST, (_in(CONTEXT), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_is_int(__in Z3_context c, __in Z3_ast t1);
/*@}*/
/**
@name Bit-vectors
*/
/*@{*/
/**
\brief \mlh mk_bvnot c t1 \endmlh
Bitwise negation.
The node \c t1 must have a bit-vector sort.
def_API('Z3_mk_bvnot', AST, (_in(CONTEXT), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_bvnot(__in Z3_context c, __in Z3_ast t1);
/**
\brief \mlh mk_bvredand c t1 \endmlh
Take conjunction of bits in vector, return vector of length 1.
The node \c t1 must have a bit-vector sort.
def_API('Z3_mk_bvredand', AST, (_in(CONTEXT), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_bvredand(__in Z3_context c, __in Z3_ast t1);
/**
\brief \mlh mk_bvredor c t1 \endmlh
Take disjunction of bits in vector, return vector of length 1.
The node \c t1 must have a bit-vector sort.
def_API('Z3_mk_bvredor', AST, (_in(CONTEXT), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_bvredor(__in Z3_context c, __in Z3_ast t1);
/**
\brief \mlh mk_bvand c t1 t2 \endmlh
Bitwise and.
The nodes \c t1 and \c t2 must have the same bit-vector sort.
def_API('Z3_mk_bvand', AST, (_in(CONTEXT), _in(AST), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_bvand(__in Z3_context c, __in Z3_ast t1, __in Z3_ast t2);
/**
\brief \mlh mk_bvor c t1 t2 \endmlh
Bitwise or.
The nodes \c t1 and \c t2 must have the same bit-vector sort.
def_API('Z3_mk_bvor', AST, (_in(CONTEXT), _in(AST), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_bvor(__in Z3_context c, __in Z3_ast t1, __in Z3_ast t2);
/**
\brief \mlh mk_bvxor c t1 t2 \endmlh
Bitwise exclusive-or.
The nodes \c t1 and \c t2 must have the same bit-vector sort.
def_API('Z3_mk_bvxor', AST, (_in(CONTEXT), _in(AST), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_bvxor(__in Z3_context c, __in Z3_ast t1, __in Z3_ast t2);
/**
\brief \mlh mk_bvnand c t1 t2 \endmlh
Bitwise nand.
The nodes \c t1 and \c t2 must have the same bit-vector sort.
def_API('Z3_mk_bvnand', AST, (_in(CONTEXT), _in(AST), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_bvnand(__in Z3_context c, __in Z3_ast t1, __in Z3_ast t2);
/**
\brief \mlh mk_bvnor c t1 t2 \endmlh
Bitwise nor.
The nodes \c t1 and \c t2 must have the same bit-vector sort.
def_API('Z3_mk_bvnor', AST, (_in(CONTEXT), _in(AST), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_bvnor(__in Z3_context c, __in Z3_ast t1, __in Z3_ast t2);
/**
\brief \mlh mk_bvxnor c t1 t2 \endmlh
Bitwise xnor.
The nodes \c t1 and \c t2 must have the same bit-vector sort.
def_API('Z3_mk_bvxnor', AST, (_in(CONTEXT), _in(AST), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_bvxnor(__in Z3_context c, __in Z3_ast t1, __in Z3_ast t2);
/**
\brief \mlh mk_bvneg c t1 \endmlh
Standard two's complement unary minus.
The node \c t1 must have bit-vector sort.
def_API('Z3_mk_bvneg', AST, (_in(CONTEXT), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_bvneg(__in Z3_context c, __in Z3_ast t1);
/**
\brief \mlh mk_bvadd c t1 t2 \endmlh
Standard two's complement addition.
The nodes \c t1 and \c t2 must have the same bit-vector sort.
def_API('Z3_mk_bvadd', AST, (_in(CONTEXT), _in(AST), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_bvadd(__in Z3_context c, __in Z3_ast t1, __in Z3_ast t2);
/**
\brief \mlh mk_bvsub c t1 t2 \endmlh
Standard two's complement subtraction.
The nodes \c t1 and \c t2 must have the same bit-vector sort.
def_API('Z3_mk_bvsub', AST, (_in(CONTEXT), _in(AST), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_bvsub(__in Z3_context c, __in Z3_ast t1, __in Z3_ast t2);
/**
\brief \mlh mk_bvmul c t1 t2 \endmlh
Standard two's complement multiplication.
The nodes \c t1 and \c t2 must have the same bit-vector sort.
def_API('Z3_mk_bvmul', AST, (_in(CONTEXT), _in(AST), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_bvmul(__in Z3_context c, __in Z3_ast t1, __in Z3_ast t2);
/**
\brief \mlh mk_bvudiv c t1 t2 \endmlh
Unsigned division.
It is defined as the \c floor of <tt>t1/t2</tt> if \c t2 is
different from zero. If <tt>t2</tt> is zero, then the result
is undefined.
The nodes \c t1 and \c t2 must have the same bit-vector sort.
def_API('Z3_mk_bvudiv', AST, (_in(CONTEXT), _in(AST), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_bvudiv(__in Z3_context c, __in Z3_ast t1, __in Z3_ast t2);
/**
\brief \mlh mk_bvsdiv c t1 t2 \endmlh
Two's complement signed division.
It is defined in the following way:
- The \c floor of <tt>t1/t2</tt> if \c t2 is different from zero, and <tt>t1*t2 >= 0</tt>.
- The \c ceiling of <tt>t1/t2</tt> if \c t2 is different from zero, and <tt>t1*t2 < 0</tt>.
If <tt>t2</tt> is zero, then the result is undefined.
The nodes \c t1 and \c t2 must have the same bit-vector sort.
def_API('Z3_mk_bvsdiv', AST, (_in(CONTEXT), _in(AST), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_bvsdiv(__in Z3_context c, __in Z3_ast t1, __in Z3_ast t2);
/**
\brief \mlh mk_bvurem c t1 t2 \endmlh
Unsigned remainder.
It is defined as <tt>t1 - (t1 /u t2) * t2</tt>, where <tt>/u</tt> represents unsigned division.
If <tt>t2</tt> is zero, then the result is undefined.
The nodes \c t1 and \c t2 must have the same bit-vector sort.
def_API('Z3_mk_bvurem', AST, (_in(CONTEXT), _in(AST), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_bvurem(__in Z3_context c, __in Z3_ast t1, __in Z3_ast t2);
/**
\brief \mlh mk_bvsrem c t1 t2 \endmlh
Two's complement signed remainder (sign follows dividend).
It is defined as <tt>t1 - (t1 /s t2) * t2</tt>, where <tt>/s</tt> represents signed division.
The most significant bit (sign) of the result is equal to the most significant bit of \c t1.
If <tt>t2</tt> is zero, then the result is undefined.
The nodes \c t1 and \c t2 must have the same bit-vector sort.
\sa Z3_mk_bvsmod
def_API('Z3_mk_bvsrem', AST, (_in(CONTEXT), _in(AST), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_bvsrem(__in Z3_context c, __in Z3_ast t1, __in Z3_ast t2);
/**
\brief \mlh mk_bvsmod c t1 t2 \endmlh
Two's complement signed remainder (sign follows divisor).
If <tt>t2</tt> is zero, then the result is undefined.
The nodes \c t1 and \c t2 must have the same bit-vector sort.
\sa Z3_mk_bvsrem
def_API('Z3_mk_bvsmod', AST, (_in(CONTEXT), _in(AST), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_bvsmod(__in Z3_context c, __in Z3_ast t1, __in Z3_ast t2);
/**
\brief \mlh mk_bvult c t1 t2 \endmlh
Unsigned less than.
The nodes \c t1 and \c t2 must have the same bit-vector sort.
def_API('Z3_mk_bvult', AST, (_in(CONTEXT), _in(AST), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_bvult(__in Z3_context c, __in Z3_ast t1, __in Z3_ast t2);
/**
\brief \mlh mk_bvslt c t1 t2 \endmlh
Two's complement signed less than.
It abbreviates:
\code
(or (and (= (extract[|m-1|:|m-1|] t1) bit1)
(= (extract[|m-1|:|m-1|] t2) bit0))
(and (= (extract[|m-1|:|m-1|] t1) (extract[|m-1|:|m-1|] t2))
(bvult t1 t2)))
\endcode
The nodes \c t1 and \c t2 must have the same bit-vector sort.
def_API('Z3_mk_bvslt', AST, (_in(CONTEXT), _in(AST), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_bvslt(__in Z3_context c, __in Z3_ast t1, __in Z3_ast t2);
/**
\brief \mlh mk_bvule c t1 t2 \endmlh
Unsigned less than or equal to.
The nodes \c t1 and \c t2 must have the same bit-vector sort.
def_API('Z3_mk_bvule', AST, (_in(CONTEXT), _in(AST), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_bvule(__in Z3_context c, __in Z3_ast t1, __in Z3_ast t2);
/**
\brief \mlh mk_bvsle c t1 t2 \endmlh
Two's complement signed less than or equal to.
The nodes \c t1 and \c t2 must have the same bit-vector sort.
def_API('Z3_mk_bvsle', AST, (_in(CONTEXT), _in(AST), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_bvsle(__in Z3_context c, __in Z3_ast t1, __in Z3_ast t2);
/**
\brief \mlh mk_bvuge c t1 t2 \endmlh
Unsigned greater than or equal to.
The nodes \c t1 and \c t2 must have the same bit-vector sort.
def_API('Z3_mk_bvuge', AST, (_in(CONTEXT), _in(AST), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_bvuge(__in Z3_context c, __in Z3_ast t1, __in Z3_ast t2);
/**
\brief \mlh mk_bvsge c t1 t2 \endmlh
Two's complement signed greater than or equal to.
The nodes \c t1 and \c t2 must have the same bit-vector sort.
def_API('Z3_mk_bvsge', AST, (_in(CONTEXT), _in(AST), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_bvsge(__in Z3_context c, __in Z3_ast t1, __in Z3_ast t2);
/**
\brief \mlh mk_bvugt c t1 t2 \endmlh
Unsigned greater than.
The nodes \c t1 and \c t2 must have the same bit-vector sort.
def_API('Z3_mk_bvugt', AST, (_in(CONTEXT), _in(AST), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_bvugt(__in Z3_context c, __in Z3_ast t1, __in Z3_ast t2);
/**
\brief \mlh mk_bvsgt c t1 t2 \endmlh
Two's complement signed greater than.
The nodes \c t1 and \c t2 must have the same bit-vector sort.
def_API('Z3_mk_bvsgt', AST, (_in(CONTEXT), _in(AST), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_bvsgt(__in Z3_context c, __in Z3_ast t1, __in Z3_ast t2);
/**
\brief \mlh mk_concat c t1 t2 \endmlh
Concatenate the given bit-vectors.
The nodes \c t1 and \c t2 must have (possibly different) bit-vector sorts
The result is a bit-vector of size <tt>n1+n2</tt>, where \c n1 (\c n2) is the size
of \c t1 (\c t2).
def_API('Z3_mk_concat', AST, (_in(CONTEXT), _in(AST), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_concat(__in Z3_context c, __in Z3_ast t1, __in Z3_ast t2);
/**
\brief \mlh mk_extract c high low t1 \endmlh
Extract the bits \c high down to \c low from a bitvector of
size \c m to yield a new bitvector of size \c n, where <tt>n =
high - low + 1</tt>.
The node \c t1 must have a bit-vector sort.
def_API('Z3_mk_extract', AST, (_in(CONTEXT), _in(UINT), _in(UINT), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_extract(__in Z3_context c, __in unsigned high, __in unsigned low, __in Z3_ast t1);
/**
\brief \mlh mk_sign_ext c i t1 \endmlh
Sign-extend of the given bit-vector to the (signed) equivalent bitvector of
size <tt>m+i</tt>, where \c m is the size of the given
bit-vector.
The node \c t1 must have a bit-vector sort.
def_API('Z3_mk_sign_ext', AST, (_in(CONTEXT), _in(UINT), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_sign_ext(__in Z3_context c, __in unsigned i, __in Z3_ast t1);
/**
\brief \mlh mk_zero_ext c i t1 \endmlh
Extend the given bit-vector with zeros to the (unsigned) equivalent
bitvector of size <tt>m+i</tt>, where \c m is the size of the
given bit-vector.
The node \c t1 must have a bit-vector sort.
def_API('Z3_mk_zero_ext', AST, (_in(CONTEXT), _in(UINT), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_zero_ext(__in Z3_context c, __in unsigned i, __in Z3_ast t1);
/**
\brief \mlh mk_repeat c i t1 \endmlh
Repeat the given bit-vector up length <tt>i</tt>.
The node \c t1 must have a bit-vector sort.
def_API('Z3_mk_repeat', AST, (_in(CONTEXT), _in(UINT), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_repeat(__in Z3_context c, __in unsigned i, __in Z3_ast t1);
/**
\brief \mlh mk_bvshl c t1 t2 \endmlh
Shift left.
It is equivalent to multiplication by <tt>2^x</tt> where \c x is the value of the
third argument.
NB. The semantics of shift operations varies between environments. This
definition does not necessarily capture directly the semantics of the
programming language or assembly architecture you are modeling.
The nodes \c t1 and \c t2 must have the same bit-vector sort.
def_API('Z3_mk_bvshl', AST, (_in(CONTEXT), _in(AST), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_bvshl(__in Z3_context c, __in Z3_ast t1, __in Z3_ast t2);
/**
\brief \mlh mk_bvlshr c t1 t2 \endmlh
Logical shift right.
It is equivalent to unsigned division by <tt>2^x</tt> where \c x is the
value of the third argument.
NB. The semantics of shift operations varies between environments. This
definition does not necessarily capture directly the semantics of the
programming language or assembly architecture you are modeling.
The nodes \c t1 and \c t2 must have the same bit-vector sort.
def_API('Z3_mk_bvlshr', AST, (_in(CONTEXT), _in(AST), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_bvlshr(__in Z3_context c, __in Z3_ast t1, __in Z3_ast t2);
/**
\brief \mlh mk_bvashr c t1 t2 \endmlh
Arithmetic shift right.
It is like logical shift right except that the most significant
bits of the result always copy the most significant bit of the
second argument.
The semantics of shift operations varies between environments. This
definition does not necessarily capture directly the semantics of the
programming language or assembly architecture you are modeling.
The nodes \c t1 and \c t2 must have the same bit-vector sort.
def_API('Z3_mk_bvashr', AST, (_in(CONTEXT), _in(AST), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_bvashr(__in Z3_context c, __in Z3_ast t1, __in Z3_ast t2);
/**
\brief \mlh mk_rotate_left c i t1 \endmlh
Rotate bits of \c t1 to the left \c i times.
The node \c t1 must have a bit-vector sort.
def_API('Z3_mk_rotate_left', AST, (_in(CONTEXT), _in(UINT), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_rotate_left(__in Z3_context c, __in unsigned i, __in Z3_ast t1);
/**
\brief \mlh mk_rotate_right c i t1 \endmlh
Rotate bits of \c t1 to the right \c i times.
The node \c t1 must have a bit-vector sort.
def_API('Z3_mk_rotate_right', AST, (_in(CONTEXT), _in(UINT), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_rotate_right(__in Z3_context c, __in unsigned i, __in Z3_ast t1);
/**
\brief \mlh mk_ext_rotate_left c t1 t2 \endmlh
Rotate bits of \c t1 to the left \c t2 times.
The nodes \c t1 and \c t2 must have the same bit-vector sort.
def_API('Z3_mk_ext_rotate_left', AST, (_in(CONTEXT), _in(AST), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_ext_rotate_left(__in Z3_context c, __in Z3_ast t1, __in Z3_ast t2);
/**
\brief \mlh mk_ext_rotate_right c t1 t2 \endmlh
Rotate bits of \c t1 to the right \c t2 times.
The nodes \c t1 and \c t2 must have the same bit-vector sort.
def_API('Z3_mk_ext_rotate_right', AST, (_in(CONTEXT), _in(AST), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_ext_rotate_right(__in Z3_context c, __in Z3_ast t1, __in Z3_ast t2);
/**
\brief \mlh mk_int2bv c n t1 \endmlh
Create an \c n bit bit-vector from the integer argument \c t1.
NB. This function is essentially treated as uninterpreted.
So you cannot expect Z3 to precisely reflect the semantics of this function
when solving constraints with this function.
The node \c t1 must have integer sort.
def_API('Z3_mk_int2bv', AST, (_in(CONTEXT), _in(UINT), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_int2bv(__in Z3_context c, __in unsigned n, __in Z3_ast t1);
/**
\brief \mlh mk_bv2int c t1 is_signed \endmlh
Create an integer from the bit-vector argument \c t1.
If \c is_signed is false, then the bit-vector \c t1 is treated as unsigned.
So the result is non-negative
and in the range <tt>[0..2^N-1]</tt>, where N are the number of bits in \c t1.
If \c is_signed is true, \c t1 is treated as a signed bit-vector.
This function is essentially treated as uninterpreted.
So you cannot expect Z3 to precisely reflect the semantics of this function
when solving constraints with this function.
The node \c t1 must have a bit-vector sort.
def_API('Z3_mk_bv2int', AST, (_in(CONTEXT), _in(AST), _in(BOOL)))
*/
Z3_ast Z3_API Z3_mk_bv2int(__in Z3_context c,__in Z3_ast t1, Z3_bool is_signed);
/**
\brief \mlh mk_bvadd_no_overflow c t1 t2 is_signed \endmlh
Create a predicate that checks that the bit-wise addition
of \c t1 and \c t2 does not overflow.
The nodes \c t1 and \c t2 must have the same bit-vector sort.
def_API('Z3_mk_bvadd_no_overflow', AST, (_in(CONTEXT), _in(AST), _in(AST), _in(BOOL)))
*/
Z3_ast Z3_API Z3_mk_bvadd_no_overflow(__in Z3_context c, __in Z3_ast t1, __in Z3_ast t2, Z3_bool is_signed);
/**
\brief \mlh mk_bvadd_no_underflow c t1 t2 \endmlh
Create a predicate that checks that the bit-wise signed addition
of \c t1 and \c t2 does not underflow.
The nodes \c t1 and \c t2 must have the same bit-vector sort.
def_API('Z3_mk_bvadd_no_underflow', AST, (_in(CONTEXT), _in(AST), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_bvadd_no_underflow(__in Z3_context c, __in Z3_ast t1, __in Z3_ast t2);
/**
\brief \mlh mk_bvsub_no_overflow c t1 t2 \endmlh
Create a predicate that checks that the bit-wise signed subtraction
of \c t1 and \c t2 does not overflow.
The nodes \c t1 and \c t2 must have the same bit-vector sort.
def_API('Z3_mk_bvsub_no_overflow', AST, (_in(CONTEXT), _in(AST), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_bvsub_no_overflow(__in Z3_context c, __in Z3_ast t1, __in Z3_ast t2);
/**
\brief \mlh mk_bvsub_no_underflow c t1 t2 is_signed \endmlh
Create a predicate that checks that the bit-wise subtraction
of \c t1 and \c t2 does not underflow.
The nodes \c t1 and \c t2 must have the same bit-vector sort.
def_API('Z3_mk_bvsub_no_underflow', AST, (_in(CONTEXT), _in(AST), _in(AST), _in(BOOL)))
*/
Z3_ast Z3_API Z3_mk_bvsub_no_underflow(__in Z3_context c, __in Z3_ast t1, __in Z3_ast t2, Z3_bool is_signed);
/**
\brief \mlh mk_bvsdiv_no_overflow c t1 t2 \endmlh
Create a predicate that checks that the bit-wise signed division
of \c t1 and \c t2 does not overflow.
The nodes \c t1 and \c t2 must have the same bit-vector sort.
def_API('Z3_mk_bvsdiv_no_overflow', AST, (_in(CONTEXT), _in(AST), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_bvsdiv_no_overflow(__in Z3_context c, __in Z3_ast t1, __in Z3_ast t2);
/**
\brief \mlh mk_bvneg_no_overflow c t1 \endmlh
Check that bit-wise negation does not overflow when
\c t1 is interpreted as a signed bit-vector.
The node \c t1 must have bit-vector sort.
def_API('Z3_mk_bvneg_no_overflow', AST, (_in(CONTEXT), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_bvneg_no_overflow(__in Z3_context c, __in Z3_ast t1);
/**
\brief \mlh mk_bvmul_no_overflow c t1 t2 is_signed \endmlh
Create a predicate that checks that the bit-wise multiplication
of \c t1 and \c t2 does not overflow.
The nodes \c t1 and \c t2 must have the same bit-vector sort.
def_API('Z3_mk_bvmul_no_overflow', AST, (_in(CONTEXT), _in(AST), _in(AST), _in(BOOL)))
*/
Z3_ast Z3_API Z3_mk_bvmul_no_overflow(__in Z3_context c, __in Z3_ast t1, __in Z3_ast t2, Z3_bool is_signed);
/**
\brief \mlh mk_bvmul_no_underflow c t1 t2 \endmlh
Create a predicate that checks that the bit-wise signed multiplication
of \c t1 and \c t2 does not underflow.
The nodes \c t1 and \c t2 must have the same bit-vector sort.
def_API('Z3_mk_bvmul_no_underflow', AST, (_in(CONTEXT), _in(AST), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_bvmul_no_underflow(__in Z3_context c, __in Z3_ast t1, __in Z3_ast t2);
/*@}*/
/**
@name Arrays
*/
/*@{*/
/**
\brief \mlh mk_select c a i \endmlh
Array read.
The argument \c a is the array and \c i is the index of the array that gets read.
The node \c a must have an array sort <tt>[domain -> range]</tt>,
and \c i must have the sort \c domain.
The sort of the result is \c range.
\sa Z3_mk_array_sort
\sa Z3_mk_store
def_API('Z3_mk_select', AST, (_in(CONTEXT), _in(AST), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_select(__in Z3_context c, __in Z3_ast a, __in Z3_ast i);
/**
\brief \mlh mk_store c a i v \endmlh
Array update.
The node \c a must have an array sort <tt>[domain -> range]</tt>, \c i must have sort \c domain,
\c v must have sort range. The sort of the result is <tt>[domain -> range]</tt>.
The semantics of this function is given by the theory of arrays described in the SMT-LIB
standard. See http://smtlib.org for more details.
The result of this function is an array that is equal to \c a (with respect to \c select)
on all indices except for \c i, where it maps to \c v (and the \c select of \c a with
respect to \c i may be a different value).
\sa Z3_mk_array_sort
\sa Z3_mk_select
def_API('Z3_mk_store', AST, (_in(CONTEXT), _in(AST), _in(AST), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_store(__in Z3_context c, __in Z3_ast a, __in Z3_ast i, __in Z3_ast v);
/**
\brief Create the constant array.
The resulting term is an array, such that a \c select on an arbitrary index
produces the value \c v.
\param c logical context.
\param domain domain sort for the array.
\param v value that the array maps to.
def_API('Z3_mk_const_array', AST, (_in(CONTEXT), _in(SORT), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_const_array(__in Z3_context c, __in Z3_sort domain, __in Z3_ast v);
/**
\brief \mlh mk_map f n args \endmlh
map f on the the argument arrays.
The \c n nodes \c args must be of array sorts <tt>[domain_i -> range_i]</tt>.
The function declaration \c f must have type <tt> range_1 .. range_n -> range</tt>.
\c v must have sort range. The sort of the result is <tt>[domain_i -> range]</tt>.
\sa Z3_mk_array_sort
\sa Z3_mk_store
\sa Z3_mk_select
def_API('Z3_mk_map', AST, (_in(CONTEXT), _in(FUNC_DECL), _in(UINT), _in_array(2, AST)))
*/
Z3_ast Z3_API Z3_mk_map(__in Z3_context c, __in Z3_func_decl f, unsigned n, __in Z3_ast const* args);
/**
\brief Access the array default value.
Produces the default range value, for arrays that can be represented as
finite maps with a default range value.
\param c logical context.
\param array array value whose default range value is accessed.
def_API('Z3_mk_array_default', AST, (_in(CONTEXT), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_array_default(__in Z3_context c, __in Z3_ast array);
/*@}*/
/**
@name Sets
*/
/*@{*/
/**
\brief Create Set type.
def_API('Z3_mk_set_sort', SORT, (_in(CONTEXT), _in(SORT)))
*/
Z3_sort Z3_API Z3_mk_set_sort(__in Z3_context c, __in Z3_sort ty);
/**
\brief Create the empty set.
def_API('Z3_mk_empty_set', AST, (_in(CONTEXT), _in(SORT)))
*/
Z3_ast Z3_API Z3_mk_empty_set(__in Z3_context c, __in Z3_sort domain);
/**
\brief Create the full set.
def_API('Z3_mk_full_set', AST, (_in(CONTEXT), _in(SORT)))
*/
Z3_ast Z3_API Z3_mk_full_set(__in Z3_context c, __in Z3_sort domain);
/**
\brief Add an element to a set.
The first argument must be a set, the second an element.
def_API('Z3_mk_set_add', AST, (_in(CONTEXT), _in(AST), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_set_add(__in Z3_context c, __in Z3_ast set, __in Z3_ast elem);
/**
\brief Remove an element to a set.
The first argument must be a set, the second an element.
def_API('Z3_mk_set_del', AST, (_in(CONTEXT), _in(AST), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_set_del(__in Z3_context c, __in Z3_ast set, __in Z3_ast elem);
/**
\brief Take the union of a list of sets.
def_API('Z3_mk_set_union', AST, (_in(CONTEXT), _in(UINT), _in_array(1, AST)))
*/
Z3_ast Z3_API Z3_mk_set_union(__in Z3_context c, __in unsigned num_args, __in_ecount(num_args) Z3_ast const args[]);
/**
\brief Take the intersection of a list of sets.
def_API('Z3_mk_set_intersect', AST, (_in(CONTEXT), _in(UINT), _in_array(1, AST)))
*/
Z3_ast Z3_API Z3_mk_set_intersect(__in Z3_context c, __in unsigned num_args, __in_ecount(num_args) Z3_ast const args[]);
/**
\brief Take the set difference between two sets.
def_API('Z3_mk_set_difference', AST, (_in(CONTEXT), _in(AST), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_set_difference(__in Z3_context c, __in Z3_ast arg1, __in Z3_ast arg2);
/**
\brief Take the complement of a set.
def_API('Z3_mk_set_complement', AST, (_in(CONTEXT), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_set_complement(__in Z3_context c, __in Z3_ast arg);
/**
\brief Check for set membership.
The first argument should be an element type of the set.
def_API('Z3_mk_set_member', AST, (_in(CONTEXT), _in(AST), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_set_member(__in Z3_context c, __in Z3_ast elem, __in Z3_ast set);
/**
\brief Check for subsetness of sets.
def_API('Z3_mk_set_subset', AST, (_in(CONTEXT), _in(AST), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_set_subset(__in Z3_context c, __in Z3_ast arg1, __in Z3_ast arg2);
/*@}*/
/**
@name Numerals
*/
/*@{*/
#ifdef ML4only
#include <mlx_mk_numeral.idl>
#endif
/**
\mlonly {4 {L Redundant low-level API}} \endmlonly
*/
/**
\brief Create a numeral of a given sort.
\param c logical context.
\param numeral A string representing the numeral value in decimal notation. If the given sort is a real, then the numeral can be a rational, that is, a string of the form <tt>[num]* / [num]*</tt>.
\param ty The sort of the numeral. In the current implementation, the given sort can be an int, real, finite-domain, or bit-vectors of arbitrary size.
\sa Z3_mk_int
\conly \sa Z3_mk_unsigned_int
def_API('Z3_mk_numeral', AST, (_in(CONTEXT), _in(STRING), _in(SORT)))
*/
Z3_ast Z3_API Z3_mk_numeral(__in Z3_context c, __in Z3_string numeral, __in Z3_sort ty);
/**
\brief Create a real from a fraction.
\param c logical context.
\param num numerator of rational.
\param den denomerator of rational.
\pre den != 0
\sa Z3_mk_numeral
\sa Z3_mk_int
\conly \sa Z3_mk_unsigned_int
def_API('Z3_mk_real', AST, (_in(CONTEXT), _in(INT), _in(INT)))
*/
Z3_ast Z3_API Z3_mk_real(__in Z3_context c, __in int num, __in int den);
/**
\brief 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 #Z3_mk_numeral since it is not necessary to parse a string.
\sa Z3_mk_numeral
def_API('Z3_mk_int', AST, (_in(CONTEXT), _in(INT), _in(SORT)))
*/
Z3_ast Z3_API Z3_mk_int(__in Z3_context c, __in int v, __in Z3_sort ty);
#ifdef Conly
/**
\brief Create a numeral of a int, bit-vector, or finite-domain sort.
This function can be use to create numerals that fit in a machine unsinged integer.
It is slightly faster than #Z3_mk_numeral since it is not necessary to parse a string.
\sa Z3_mk_numeral
def_API('Z3_mk_unsigned_int', AST, (_in(CONTEXT), _in(UINT), _in(SORT)))
*/
Z3_ast Z3_API Z3_mk_unsigned_int(__in Z3_context c, __in unsigned v, __in Z3_sort ty);
#endif
/**
\brief Create a numeral of a int, bit-vector, or finite-domain sort.
This function can be use to create numerals that fit in a machine __int64 integer.
It is slightly faster than #Z3_mk_numeral since it is not necessary to parse a string.
\sa Z3_mk_numeral
def_API('Z3_mk_int64', AST, (_in(CONTEXT), _in(INT64), _in(SORT)))
*/
Z3_ast Z3_API Z3_mk_int64(__in Z3_context c, __in __int64 v, __in Z3_sort ty);
#ifdef Conly
/**
\brief Create a numeral of a int, bit-vector, or finite-domain sort.
This function can be use to create numerals that fit in a machine unsigned __int64 integer.
It is slightly faster than #Z3_mk_numeral since it is not necessary to parse a string.
\sa Z3_mk_numeral
def_API('Z3_mk_unsigned_int64', AST, (_in(CONTEXT), _in(UINT64), _in(SORT)))
*/
Z3_ast Z3_API Z3_mk_unsigned_int64(__in Z3_context c, __in unsigned __int64 v, __in Z3_sort ty);
#endif
/*@}*/
/**
@name Quantifiers
*/
/*@{*/
/**
\brief Create a pattern for quantifier instantiation.
Z3 uses pattern matching to instantiate quantifiers. If a
pattern is not provided for a quantifier, then Z3 will
automatically compute a set of patterns for it. However, for
optimal performance, the user should provide the patterns.
Patterns comprise a list of terms. The list should be
non-empty. If the list comprises of more than one term, it is
a called a multi-pattern.
In general, one can pass in a list of (multi-)patterns in the
quantifier constructor.
\sa Z3_mk_forall
\sa Z3_mk_exists
def_API('Z3_mk_pattern', PATTERN, (_in(CONTEXT), _in(UINT), _in_array(1, AST)))
*/
Z3_pattern Z3_API Z3_mk_pattern(
__in Z3_context c,
__in unsigned num_patterns, __in_ecount(num_patterns) Z3_ast const terms[]);
/**
\brief Create a bound variable.
Bound variables are indexed by de-Bruijn indices. It is perhaps easiest to explain
the meaning of de-Bruijn indices by indicating the compilation process from
non-de-Bruijn formulas to de-Bruijn format.
\verbatim
abs(forall (x1) phi) = forall (x1) abs1(phi, x1, 0)
abs(forall (x1, x2) phi) = abs(forall (x1) abs(forall (x2) phi))
abs1(x, x, n) = b_n
abs1(y, x, n) = y
abs1(f(t1,...,tn), x, n) = f(abs1(t1,x,n), ..., abs1(tn,x,n))
abs1(forall (x1) phi, x, n) = forall (x1) (abs1(phi, x, n+1))
\endverbatim
The last line is significant: the index of a bound variable is different depending
on the scope in which it appears. The deeper x appears, the higher is its
index.
\param c logical context
\param index de-Bruijn index
\param ty sort of the bound variable
\sa Z3_mk_forall
\sa Z3_mk_exists
def_API('Z3_mk_bound', AST, (_in(CONTEXT), _in(UINT), _in(SORT)))
*/
Z3_ast Z3_API Z3_mk_bound(__in Z3_context c, __in unsigned index, __in Z3_sort ty);
/**
\brief Create a forall formula. It takes an expression \c body that contains bound variables
of the same sorts as the sorts listed in the array \c sorts. The bound variables are de-Bruijn indices created
using #Z3_mk_bound. The array \c decl_names contains the names that the quantified formula uses for the
bound variables. Z3 applies the convention that the last element in the \c decl_names and \c sorts array
refers to the variable with index 0, the second to last element of \c decl_names and \c sorts refers
to the variable with index 1, etc.
\mlonly [mk_forall c w p t n b] creates a forall formula, where
[w] is the weight, [p] is an array of patterns, [t] is an array
with the sorts of the bound variables, [n] is an array with the
'names' of the bound variables, and [b] is the body of the
quantifier. Quantifiers are associated with weights indicating
the importance of using the quantifier during
instantiation. \endmlonly
\param c logical context.
\param weight quantifiers are associated with weights indicating the importance of using the quantifier during instantiation. By default, pass the weight 0.
\param num_patterns number of patterns.
\param patterns array containing the patterns created using #Z3_mk_pattern.
\param num_decls number of variables to be bound.
\param sorts the sorts of the bound variables.
\param decl_names names of the bound variables
\param body the body of the quantifier.
\sa Z3_mk_pattern
\sa Z3_mk_bound
\sa Z3_mk_exists
def_API('Z3_mk_forall', AST, (_in(CONTEXT), _in(UINT), _in(UINT), _in_array(2, PATTERN), _in(UINT), _in_array(4, SORT), _in_array(4, SYMBOL), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_forall(__in Z3_context c, __in unsigned weight,
__in unsigned num_patterns, __in_ecount(num_patterns) Z3_pattern const patterns[],
__in unsigned num_decls, __in_ecount(num_decls) Z3_sort const sorts[],
__in_ecount(num_decls) Z3_symbol const decl_names[],
__in Z3_ast body);
/**
\brief Create an exists formula. Similar to #Z3_mk_forall.
\sa Z3_mk_pattern
\sa Z3_mk_bound
\sa Z3_mk_forall
\sa Z3_mk_quantifier
def_API('Z3_mk_exists', AST, (_in(CONTEXT), _in(UINT), _in(UINT), _in_array(2, PATTERN), _in(UINT), _in_array(4, SORT), _in_array(4, SYMBOL), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_exists(__in Z3_context c, __in unsigned weight,
__in unsigned num_patterns, __in_ecount(num_patterns) Z3_pattern const patterns[],
__in unsigned num_decls, __in_ecount(num_decls) Z3_sort const sorts[],
__in_ecount(num_decls) Z3_symbol const decl_names[],
__in Z3_ast body);
/**
\brief Create a quantifier - universal or existential, with pattern hints.
See the documentation for #Z3_mk_forall for an explanation of the parameters.
\param c logical context.
\param is_forall flag to indicate if this is a universal or existential quantifier.
\param weight quantifiers are associated with weights indicating the importance of using the quantifier during instantiation. By default, pass the weight 0.
\param num_patterns number of patterns.
\param patterns array containing the patterns created using #Z3_mk_pattern.
\param num_decls number of variables to be bound.
\param sorts array of sorts of the bound variables.
\param decl_names names of the bound variables.
\param body the body of the quantifier.
\sa Z3_mk_pattern
\sa Z3_mk_bound
\sa Z3_mk_forall
\sa Z3_mk_exists
def_API('Z3_mk_quantifier', AST, (_in(CONTEXT), _in(BOOL), _in(UINT), _in(UINT), _in_array(3, PATTERN), _in(UINT), _in_array(5, SORT), _in_array(5, SYMBOL), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_quantifier(
__in Z3_context c,
__in Z3_bool is_forall,
__in unsigned weight,
__in unsigned num_patterns, __in_ecount(num_patterns) Z3_pattern const patterns[],
__in unsigned num_decls, __in_ecount(num_decls) Z3_sort const sorts[],
__in_ecount(num_decls) Z3_symbol const decl_names[],
__in Z3_ast body);
/**
\brief Create a quantifier - universal or existential, with pattern hints, no patterns, and attributes
\param c logical context.
\param is_forall flag to indicate if this is a universal or existential quantifier.
\param quantifier_id identifier to identify quantifier
\param skolem_id identifier to identify skolem constants introduced by quantifier.
\param weight quantifiers are associated with weights indicating the importance of using the quantifier during instantiation. By default, pass the weight 0.
\param num_patterns number of patterns.
\param patterns array containing the patterns created using #Z3_mk_pattern.
\param num_no_patterns number of no_patterns.
\param no_patterns array containing subexpressions to be excluded from inferred patterns.
\param num_decls number of variables to be bound.
\param sorts array of sorts of the bound variables.
\param decl_names names of the bound variables.
\param body the body of the quantifier.
\sa Z3_mk_pattern
\sa Z3_mk_bound
\sa Z3_mk_forall
\sa Z3_mk_exists
def_API('Z3_mk_quantifier_ex', AST, (_in(CONTEXT), _in(BOOL), _in(UINT), _in(SYMBOL), _in(SYMBOL), _in(UINT), _in_array(5, PATTERN), _in(UINT), _in_array(7, AST), _in(UINT), _in_array(9, SORT), _in_array(9, SYMBOL), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_quantifier_ex(
__in Z3_context c,
__in Z3_bool is_forall,
__in unsigned weight,
__in Z3_symbol quantifier_id,
__in Z3_symbol skolem_id,
__in unsigned num_patterns, __in_ecount(num_patterns) Z3_pattern const patterns[],
__in unsigned num_no_patterns, __in_ecount(num_no_patterns) Z3_ast const no_patterns[],
__in unsigned num_decls, __in_ecount(num_decls) Z3_sort const sorts[],
__in_ecount(num_decls) Z3_symbol const decl_names[],
__in Z3_ast body);
/**
\brief Create a universal quantifier using a list of constants that
will form the set of bound variables.
\param c logical context.
\param weight quantifiers are associated with weights indicating the importance of using
the quantifier during instantiation. By default, pass the weight 0.
\param num_bound number of constants to be abstracted into bound variables.
\param bound array of constants to be abstracted into bound variables.
\param num_patterns number of patterns.
\param patterns array containing the patterns created using #Z3_mk_pattern.
\param body the body of the quantifier.
\sa Z3_mk_pattern
\sa Z3_mk_exists_const
def_API('Z3_mk_forall_const', AST, (_in(CONTEXT), _in(UINT), _in(UINT), _in_array(2, APP), _in(UINT), _in_array(4, PATTERN), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_forall_const(
__in Z3_context c,
unsigned weight,
unsigned num_bound,
__in_ecount(num_bound) Z3_app const bound[],
unsigned num_patterns,
__in_ecount(num_patterns) Z3_pattern const patterns[],
__in Z3_ast body
);
/**
\brief Similar to #Z3_mk_forall_const.
\brief Create an existential quantifier using a list of constants that
will form the set of bound variables.
\param c logical context.
\param weight quantifiers are associated with weights indicating the importance of using
the quantifier during instantiation. By default, pass the weight 0.
\param num_bound number of constants to be abstracted into bound variables.
\param bound array of constants to be abstracted into bound variables.
\param num_patterns number of patterns.
\param patterns array containing the patterns created using #Z3_mk_pattern.
\param body the body of the quantifier.
\sa Z3_mk_pattern
\sa Z3_mk_forall_const
def_API('Z3_mk_exists_const', AST, (_in(CONTEXT), _in(UINT), _in(UINT), _in_array(2, APP), _in(UINT), _in_array(4, PATTERN), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_exists_const(
__in Z3_context c,
unsigned weight,
unsigned num_bound,
__in_ecount(num_bound) Z3_app const bound[],
unsigned num_patterns,
__in_ecount(num_patterns) Z3_pattern const patterns[],
__in Z3_ast body
);
/**
\brief Create a universal or existential
quantifier using a list of constants that
will form the set of bound variables.
def_API('Z3_mk_quantifier_const', AST, (_in(CONTEXT), _in(BOOL), _in(UINT), _in(UINT), _in_array(3, APP), _in(UINT), _in_array(5, PATTERN), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_quantifier_const(
__in Z3_context c,
Z3_bool is_forall,
unsigned weight,
unsigned num_bound, __in_ecount(num_bound) Z3_app const bound[],
unsigned num_patterns, __in_ecount(num_patterns) Z3_pattern const patterns[],
__in Z3_ast body
);
/**
\brief Create a universal or existential
quantifier using a list of constants that
will form the set of bound variables.
def_API('Z3_mk_quantifier_const_ex', AST, (_in(CONTEXT), _in(BOOL), _in(UINT), _in(SYMBOL), _in(SYMBOL), _in(UINT), _in_array(5, APP), _in(UINT), _in_array(7, PATTERN), _in(UINT), _in_array(9, AST), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_quantifier_const_ex(
__in Z3_context c,
Z3_bool is_forall,
unsigned weight,
__in Z3_symbol quantifier_id,
__in Z3_symbol skolem_id,
unsigned num_bound, __in_ecount(num_bound) Z3_app const bound[],
unsigned num_patterns, __in_ecount(num_patterns) Z3_pattern const patterns[],
unsigned num_no_patterns, __in_ecount(num_no_patterns) Z3_ast const no_patterns[],
__in Z3_ast body
);
/*@}*/
/**
@name Accessors
*/
/*@{*/
/**
\mlonly {3 {L Symbols}} \endmlonly
*/
#ifdef ML4only
#include <mlx_symbol_refine.idl>
#endif
/**
\mlonly {4 {L Redundant low-level API}} \endmlonly
*/
/**
\brief Return \c Z3_INT_SYMBOL if the symbol was constructed
using #Z3_mk_int_symbol, and \c Z3_STRING_SYMBOL if the symbol
was constructed using #Z3_mk_string_symbol.
def_API('Z3_get_symbol_kind', UINT, (_in(CONTEXT), _in(SYMBOL)))
*/
Z3_symbol_kind Z3_API Z3_get_symbol_kind(__in Z3_context c, __in Z3_symbol s);
/**
\brief \mlh get_symbol_int c s \endmlh
Return the symbol int value.
\pre Z3_get_symbol_kind(s) == Z3_INT_SYMBOL
\sa Z3_mk_int_symbol
def_API('Z3_get_symbol_int', INT, (_in(CONTEXT), _in(SYMBOL)))
*/
int Z3_API Z3_get_symbol_int(__in Z3_context c, __in Z3_symbol s);
/**
\brief \mlh get_symbol_string c s \endmlh
Return the symbol name.
\pre Z3_get_symbol_string(s) == Z3_STRING_SYMBOL
\conly \warning The returned buffer is statically allocated by Z3. It will
\conly be automatically deallocated when #Z3_del_context is invoked.
\conly So, the buffer is invalidated in the next call to \c Z3_get_symbol_string.
\sa Z3_mk_string_symbol
def_API('Z3_get_symbol_string', STRING, (_in(CONTEXT), _in(SYMBOL)))
*/
Z3_string Z3_API Z3_get_symbol_string(__in Z3_context c, __in Z3_symbol s);
/**
\mlonly {3 {L Sorts}} \endmlonly
*/
#ifdef ML4only
#include <mlx_sort_refine.idl>
#endif
/**
\brief Return the sort name as a symbol.
def_API('Z3_get_sort_name', SYMBOL, (_in(CONTEXT), _in(SORT)))
*/
Z3_symbol Z3_API Z3_get_sort_name(__in Z3_context c, __in Z3_sort d);
/**
\brief Return a unique identifier for \c s.
\mlonly \remark Implicitly used by [Pervasives.( = )] and [Pervasives.compare]. \endmlonly
def_API('Z3_get_sort_id', UINT, (_in(CONTEXT), _in(SORT)))
*/
unsigned Z3_API Z3_get_sort_id(__in Z3_context c, Z3_sort s);
/**
\mlonly {4 {L Redundant low-level API}} \endmlonly
*/
/**
\brief Convert a \c Z3_sort into \c Z3_ast. \conly This is just type casting.
\mlonly \remark [sort_to_ast c s] can be replaced by [(s :> ast)]. \endmlonly
def_API('Z3_sort_to_ast', AST, (_in(CONTEXT), _in(SORT)))
*/
Z3_ast Z3_API Z3_sort_to_ast(__in Z3_context c, __in Z3_sort s);
/**
\brief compare sorts.
\mlonly \remark [Pervasives.( = )] or [Pervasives.compare] can also be used. \endmlonly
def_API('Z3_is_eq_sort', BOOL, (_in(CONTEXT), _in(SORT), _in(SORT)))
*/
Z3_bool Z3_API Z3_is_eq_sort(__in Z3_context c, __in Z3_sort s1, __in Z3_sort s2);
/**
\brief Return the sort kind (e.g., array, tuple, int, bool, etc).
\sa Z3_sort_kind
def_API('Z3_get_sort_kind', UINT, (_in(CONTEXT), _in(SORT)))
*/
Z3_sort_kind Z3_API Z3_get_sort_kind(__in Z3_context c, __in Z3_sort t);
/**
\brief \mlh get_bv_sort_size c t \endmlh
Return the size of the given bit-vector sort.
\pre Z3_get_sort_kind(c, t) == Z3_BV_SORT
\sa Z3_mk_bv_sort
\sa Z3_get_sort_kind
def_API('Z3_get_bv_sort_size', UINT, (_in(CONTEXT), _in(SORT)))
*/
unsigned Z3_API Z3_get_bv_sort_size(__in Z3_context c, __in Z3_sort t);
/**
\conly \brief Store the size of the sort in \c r. Return Z3_FALSE if the call failed.
\mlonly \brief Return the size of the sort in \c r. Return \c None if the call failed. \endmlonly
That is, Z3_get_sort_kind(s) == Z3_FINITE_DOMAIN_SORT
def_API('Z3_get_finite_domain_sort_size', BOOL, (_in(CONTEXT), _in(SORT), _out(UINT64)))
*/
Z3_bool_opt Z3_API Z3_get_finite_domain_sort_size(__in Z3_context c, __in Z3_sort s, __out_opt unsigned __int64* r);
/**
\brief \mlh get_array_sort_domain c t \endmlh
Return the domain of the given array sort.
\pre Z3_get_sort_kind(c, t) == Z3_ARRAY_SORT
\sa Z3_mk_array_sort
\sa Z3_get_sort_kind
def_API('Z3_get_array_sort_domain', SORT, (_in(CONTEXT), _in(SORT)))
*/
Z3_sort Z3_API Z3_get_array_sort_domain(__in Z3_context c, __in Z3_sort t);
/**
\brief \mlh get_array_sort_range c t \endmlh
Return the range of the given array sort.
\pre Z3_get_sort_kind(c, t) == Z3_ARRAY_SORT
\sa Z3_mk_array_sort
\sa Z3_get_sort_kind
def_API('Z3_get_array_sort_range', SORT, (_in(CONTEXT), _in(SORT)))
*/
Z3_sort Z3_API Z3_get_array_sort_range(__in Z3_context c, __in Z3_sort t);
/**
\brief \mlh get_tuple_sort_mk_decl c t \endmlh
Return the constructor declaration of the given tuple
sort.
\pre Z3_get_sort_kind(c, t) == Z3_DATATYPE_SORT
\sa Z3_mk_tuple_sort
\sa Z3_get_sort_kind
def_API('Z3_get_tuple_sort_mk_decl', FUNC_DECL, (_in(CONTEXT), _in(SORT)))
*/
Z3_func_decl Z3_API Z3_get_tuple_sort_mk_decl(__in Z3_context c, __in Z3_sort t);
/**
\brief \mlh get_tuple_sort_num_fields c t \endmlh
Return the number of fields of the given tuple sort.
\pre Z3_get_sort_kind(c, t) == Z3_DATATYPE_SORT
\sa Z3_mk_tuple_sort
\sa Z3_get_sort_kind
def_API('Z3_get_tuple_sort_num_fields', UINT, (_in(CONTEXT), _in(SORT)))
*/
unsigned Z3_API Z3_get_tuple_sort_num_fields(__in Z3_context c, __in Z3_sort t);
/**
\brief \mlh get_tuple_sort_field_decl c t i \endmlh
Return the i-th field declaration (i.e., projection function declaration)
of the given tuple sort.
\pre Z3_get_sort_kind(t) == Z3_DATATYPE_SORT
\pre i < Z3_get_tuple_sort_num_fields(c, t)
\sa Z3_mk_tuple_sort
\sa Z3_get_sort_kind
def_API('Z3_get_tuple_sort_field_decl', FUNC_DECL, (_in(CONTEXT), _in(SORT), _in(UINT)))
*/
Z3_func_decl Z3_API Z3_get_tuple_sort_field_decl(__in Z3_context c, __in Z3_sort t, __in unsigned i);
/**
\brief Return number of constructors for datatype.
\pre Z3_get_sort_kind(t) == Z3_DATATYPE_SORT
\sa Z3_get_datatype_sort_constructor
\sa Z3_get_datatype_sort_recognizer
\sa Z3_get_datatype_sort_constructor_accessor
def_API('Z3_get_datatype_sort_num_constructors', UINT, (_in(CONTEXT), _in(SORT)))
*/
unsigned Z3_API Z3_get_datatype_sort_num_constructors(
__in Z3_context c, __in Z3_sort t);
/**
\brief Return idx'th constructor.
\pre Z3_get_sort_kind(t) == Z3_DATATYPE_SORT
\pre idx < Z3_get_datatype_sort_num_constructors(c, t)
\sa Z3_get_datatype_sort_num_constructors
\sa Z3_get_datatype_sort_recognizer
\sa Z3_get_datatype_sort_constructor_accessor
def_API('Z3_get_datatype_sort_constructor', FUNC_DECL, (_in(CONTEXT), _in(SORT), _in(UINT)))
*/
Z3_func_decl Z3_API Z3_get_datatype_sort_constructor(
__in Z3_context c, __in Z3_sort t, unsigned idx);
/**
\brief Return idx'th recognizer.
\pre Z3_get_sort_kind(t) == Z3_DATATYPE_SORT
\pre idx < Z3_get_datatype_sort_num_constructors(c, t)
\sa Z3_get_datatype_sort_num_constructors
\sa Z3_get_datatype_sort_constructor
\sa Z3_get_datatype_sort_constructor_accessor
def_API('Z3_get_datatype_sort_recognizer', FUNC_DECL, (_in(CONTEXT), _in(SORT), _in(UINT)))
*/
Z3_func_decl Z3_API Z3_get_datatype_sort_recognizer(
__in Z3_context c, __in Z3_sort t, unsigned idx);
/**
\brief Return idx_a'th accessor for the idx_c'th constructor.
\pre Z3_get_sort_kind(t) == Z3_DATATYPE_SORT
\pre idx_c < Z3_get_datatype_sort_num_constructors(c, t)
\pre idx_a < Z3_get_domain_size(c, Z3_get_datatype_sort_constructor(c, idx_c))
\sa Z3_get_datatype_sort_num_constructors
\sa Z3_get_datatype_sort_constructor
\sa Z3_get_datatype_sort_recognizer
def_API('Z3_get_datatype_sort_constructor_accessor', FUNC_DECL, (_in(CONTEXT), _in(SORT), _in(UINT), _in(UINT)))
*/
Z3_func_decl Z3_API Z3_get_datatype_sort_constructor_accessor(
__in Z3_context c, __in Z3_sort t, unsigned idx_c, unsigned idx_a);
/**
\brief Update record field with a value.
This corresponds to the 'with' construct in OCaml.
It has the effect of updating a record field with a given value.
The remaining fields are left unchanged. It is the record
equivalent of an array store (see \sa Z3_mk_store).
If the datatype has more than one constructor, then the update function
behaves as identity if there is a miss-match between the accessor and
constructor. For example ((_ update-field car) nil 1) is nil,
while ((_ update-field car) (cons 2 nil) 1) is (cons 1 nil).
\pre Z3_get_sort_kind(Z3_get_sort(c, t)) == Z3_get_domain(c, field_access, 1) == Z3_DATATYPE_SORT
\pre Z3_get_sort(c, value) == Z3_get_range(c, field_access)
def_API('Z3_datatype_update_field', AST, (_in(CONTEXT), _in(FUNC_DECL), _in(AST), _in(AST)))
*/
Z3_ast Z3_API Z3_datatype_update_field(
__in Z3_context c, __in Z3_func_decl field_access,
__in Z3_ast t, __in Z3_ast value);
/**
\brief Return arity of relation.
\pre Z3_get_sort_kind(s) == Z3_RELATION_SORT
\sa Z3_get_relation_column
def_API('Z3_get_relation_arity', UINT, (_in(CONTEXT), _in(SORT)))
*/
unsigned Z3_API Z3_get_relation_arity(__in Z3_context c, __in Z3_sort s);
/**
\brief Return sort at i'th column of relation sort.
\pre Z3_get_sort_kind(c, s) == Z3_RELATION_SORT
\pre col < Z3_get_relation_arity(c, s)
\sa Z3_get_relation_arity
def_API('Z3_get_relation_column', SORT, (_in(CONTEXT), _in(SORT), _in(UINT)))
*/
Z3_sort Z3_API Z3_get_relation_column(__in Z3_context c, __in Z3_sort s, unsigned col);
/**
\brief Pseudo-Boolean relations.
Encode p1 + p2 + ... + pn <= k
def_API('Z3_mk_atmost', AST, (_in(CONTEXT), _in(UINT), _in_array(1,AST), _in(UINT)))
*/
Z3_ast Z3_API Z3_mk_atmost(__in Z3_context c, __in unsigned num_args,
__in_ecount(num_args) Z3_ast const args[], __in unsigned k);
/**
\brief Pseudo-Boolean relations.
Encode k1*p1 + k2*p2 + ... + kn*pn <= k
def_API('Z3_mk_pble', AST, (_in(CONTEXT), _in(UINT), _in_array(1,AST), _in_array(1,INT), _in(INT)))
*/
Z3_ast Z3_API Z3_mk_pble(__in Z3_context c, __in unsigned num_args,
__in_ecount(num_args) Z3_ast const args[], __in_ecount(num_args) int coeffs[],
__in int k);
/**
\mlonly {3 {L Function Declarations}} \endmlonly
*/
/**
\brief Convert a \c Z3_func_decl into \c Z3_ast. \conly This is just type casting.
\mlonly \remark [func_decl_to_ast c f] can be replaced by [(f :> ast)]. \endmlonly
def_API('Z3_func_decl_to_ast', AST, (_in(CONTEXT), _in(FUNC_DECL)))
*/
Z3_ast Z3_API Z3_func_decl_to_ast(__in Z3_context c, __in Z3_func_decl f);
/**
\brief compare terms.
\mlonly \remark [Pervasives.( = )] or [Pervasives.compare] can also be used. \endmlonly
def_API('Z3_is_eq_func_decl', BOOL, (_in(CONTEXT), _in(FUNC_DECL), _in(FUNC_DECL)))
*/
Z3_bool Z3_API Z3_is_eq_func_decl(__in Z3_context c, __in Z3_func_decl f1, Z3_func_decl f2);
/**
\brief Return a unique identifier for \c f.
\mlonly \remark Implicitly used by [Pervasives.( = )] and [Pervasives.compare]. \endmlonly
def_API('Z3_get_func_decl_id', UINT, (_in(CONTEXT), _in(FUNC_DECL)))
*/
unsigned Z3_API Z3_get_func_decl_id(__in Z3_context c, Z3_func_decl f);
/**
\brief Return the constant declaration name as a symbol.
def_API('Z3_get_decl_name', SYMBOL, (_in(CONTEXT), _in(FUNC_DECL)))
*/
Z3_symbol Z3_API Z3_get_decl_name(__in Z3_context c, __in Z3_func_decl d);
/**
\brief Return declaration kind corresponding to declaration.
def_API('Z3_get_decl_kind', UINT, (_in(CONTEXT), _in(FUNC_DECL)))
*/
Z3_decl_kind Z3_API Z3_get_decl_kind(__in Z3_context c, __in Z3_func_decl d);
/**
\brief Return the number of parameters of the given declaration.
\sa Z3_get_arity
def_API('Z3_get_domain_size', UINT, (_in(CONTEXT), _in(FUNC_DECL)))
*/
unsigned Z3_API Z3_get_domain_size(__in Z3_context c, __in Z3_func_decl d);
/**
\brief Alias for \c Z3_get_domain_size.
\sa Z3_get_domain_size
def_API('Z3_get_arity', UINT, (_in(CONTEXT), _in(FUNC_DECL)))
*/
unsigned Z3_API Z3_get_arity(__in Z3_context c, __in Z3_func_decl d);
/**
\brief \mlh get_domain c d i \endmlh
Return the sort of the i-th parameter of the given function declaration.
\pre i < Z3_get_domain_size(d)
\sa Z3_get_domain_size
def_API('Z3_get_domain', SORT, (_in(CONTEXT), _in(FUNC_DECL), _in(UINT)))
*/
Z3_sort Z3_API Z3_get_domain(__in Z3_context c, __in Z3_func_decl d, __in unsigned i);
#ifdef ML4only
#include <mlx_get_domains.idl>
#endif
/**
\brief \mlh get_range c d \endmlh
Return the range of the given declaration.
If \c d is a constant (i.e., has zero arguments), then this
function returns the sort of the constant.
def_API('Z3_get_range', SORT, (_in(CONTEXT), _in(FUNC_DECL)))
*/
Z3_sort Z3_API Z3_get_range(__in Z3_context c, __in Z3_func_decl d);
/**
\brief Return the number of parameters associated with a declaration.
def_API('Z3_get_decl_num_parameters', UINT, (_in(CONTEXT), _in(FUNC_DECL)))
*/
unsigned Z3_API Z3_get_decl_num_parameters(__in Z3_context c, __in Z3_func_decl d);
/**
\brief Return the parameter type associated with a declaration.
\param c the context
\param d the function declaration
\param idx is the index of the named parameter it should be between 0 and the number of parameters.
def_API('Z3_get_decl_parameter_kind', UINT, (_in(CONTEXT), _in(FUNC_DECL), _in(UINT)))
*/
Z3_parameter_kind Z3_API Z3_get_decl_parameter_kind(__in Z3_context c, __in Z3_func_decl d, unsigned idx);
/**
\brief Return the integer value associated with an integer parameter.
\pre Z3_get_decl_parameter_kind(c, d, idx) == Z3_PARAMETER_INT
def_API('Z3_get_decl_int_parameter', INT, (_in(CONTEXT), _in(FUNC_DECL), _in(UINT)))
*/
int Z3_API Z3_get_decl_int_parameter(__in Z3_context c, __in Z3_func_decl d, unsigned idx);
/**
\brief Return the double value associated with an double parameter.
\pre Z3_get_decl_parameter_kind(c, d, idx) == Z3_PARAMETER_DOUBLE
def_API('Z3_get_decl_double_parameter', DOUBLE, (_in(CONTEXT), _in(FUNC_DECL), _in(UINT)))
*/
double Z3_API Z3_get_decl_double_parameter(__in Z3_context c, __in Z3_func_decl d, unsigned idx);
/**
\brief Return the double value associated with an double parameter.
\pre Z3_get_decl_parameter_kind(c, d, idx) == Z3_PARAMETER_SYMBOL
def_API('Z3_get_decl_symbol_parameter', SYMBOL, (_in(CONTEXT), _in(FUNC_DECL), _in(UINT)))
*/
Z3_symbol Z3_API Z3_get_decl_symbol_parameter(__in Z3_context c, __in Z3_func_decl d, unsigned idx);
/**
\brief Return the sort value associated with a sort parameter.
\pre Z3_get_decl_parameter_kind(c, d, idx) == Z3_PARAMETER_SORT
def_API('Z3_get_decl_sort_parameter', SORT, (_in(CONTEXT), _in(FUNC_DECL), _in(UINT)))
*/
Z3_sort Z3_API Z3_get_decl_sort_parameter(__in Z3_context c, __in Z3_func_decl d, unsigned idx);
/**
\brief Return the expresson value associated with an expression parameter.
\pre Z3_get_decl_parameter_kind(c, d, idx) == Z3_PARAMETER_AST
def_API('Z3_get_decl_ast_parameter', AST, (_in(CONTEXT), _in(FUNC_DECL), _in(UINT)))
*/
Z3_ast Z3_API Z3_get_decl_ast_parameter(__in Z3_context c, __in Z3_func_decl d, unsigned idx);
/**
\brief Return the expresson value associated with an expression parameter.
\pre Z3_get_decl_parameter_kind(c, d, idx) == Z3_PARAMETER_FUNC_DECL
def_API('Z3_get_decl_func_decl_parameter', FUNC_DECL, (_in(CONTEXT), _in(FUNC_DECL), _in(UINT)))
*/
Z3_func_decl Z3_API Z3_get_decl_func_decl_parameter(__in Z3_context c, __in Z3_func_decl d, unsigned idx);
/**
\brief Return the rational value, as a string, associated with a rational parameter.
\pre Z3_get_decl_parameter_kind(c, d, idx) == Z3_PARAMETER_RATIONAL
def_API('Z3_get_decl_rational_parameter', STRING, (_in(CONTEXT), _in(FUNC_DECL), _in(UINT)))
*/
Z3_string Z3_API Z3_get_decl_rational_parameter(__in Z3_context c, __in Z3_func_decl d, unsigned idx);
/**
\mlonly {3 {L Applications}} \endmlonly
*/
/**
\brief Convert a \c Z3_app into \c Z3_ast. \conly This is just type casting.
\mlonly \remark [app_to_ast c a] can be replaced by [(a :> ast)]. \endmlonly
def_API('Z3_app_to_ast', AST, (_in(CONTEXT), _in(APP)))
*/
Z3_ast Z3_API Z3_app_to_ast(__in Z3_context c, __in Z3_app a);
/**
\brief Return the declaration of a constant or function application.
def_API('Z3_get_app_decl', FUNC_DECL, (_in(CONTEXT), _in(APP)))
*/
Z3_func_decl Z3_API Z3_get_app_decl(__in Z3_context c, __in Z3_app a);
/**
\brief \mlh get_app_num_args c a \endmlh
Return the number of argument of an application. If \c t
is an constant, then the number of arguments is 0.
def_API('Z3_get_app_num_args', UINT, (_in(CONTEXT), _in(APP)))
*/
unsigned Z3_API Z3_get_app_num_args(__in Z3_context c, __in Z3_app a);
/**
\brief \mlh get_app_arg c a i \endmlh
Return the i-th argument of the given application.
\pre i < Z3_get_num_args(c, a)
def_API('Z3_get_app_arg', AST, (_in(CONTEXT), _in(APP), _in(UINT)))
*/
Z3_ast Z3_API Z3_get_app_arg(__in Z3_context c, __in Z3_app a, __in unsigned i);
#ifdef ML4only
#include <mlx_get_app_args.idl>
#endif
/**
\mlonly {3 {L Terms}} \endmlonly
*/
#ifdef ML4only
#include <mlx_term_refine.idl>
#endif
/**
\brief compare terms.
\mlonly \remark [Pervasives.( = )] or [Pervasives.compare] can also be used. \endmlonly
def_API('Z3_is_eq_ast', BOOL, (_in(CONTEXT), _in(AST), _in(AST)))
*/
Z3_bool Z3_API Z3_is_eq_ast(__in Z3_context c, __in Z3_ast t1, Z3_ast t2);
/**
\brief Return a unique identifier for \c t.
The identifier is unique up to structural equality. Thus, two ast nodes
created by the same context and having the same children and same function symbols
have the same identifiers. Ast nodes created in the same context, but having
different children or different functions have different identifiers.
Variables and quantifiers are also assigned different identifiers according to
their structure.
\mlonly \remark Implicitly used by [Pervasives.compare] for values of type [ast], [app], [sort], [func_decl], and [pattern]. \endmlonly
def_API('Z3_get_ast_id', UINT, (_in(CONTEXT), _in(AST)))
*/
unsigned Z3_API Z3_get_ast_id(__in Z3_context c, Z3_ast t);
/**
\brief Return a hash code for the given AST.
The hash code is structural. You can use Z3_get_ast_id interchangably with
this function.
\mlonly \remark Implicitly used by [Hashtbl.hash] for values of type [ast], [app], [sort], [func_decl], and [pattern]. \endmlonly
def_API('Z3_get_ast_hash', UINT, (_in(CONTEXT), _in(AST)))
*/
unsigned Z3_API Z3_get_ast_hash(__in Z3_context c, __in Z3_ast a);
/**
\brief Return the sort of an AST node.
The AST node must be a constant, application, numeral, bound variable, or quantifier.
def_API('Z3_get_sort', SORT, (_in(CONTEXT), _in(AST)))
*/
Z3_sort Z3_API Z3_get_sort(__in Z3_context c, __in Z3_ast a);
/**
\brief Return true if the given expression \c t is well sorted.
def_API('Z3_is_well_sorted', BOOL, (_in(CONTEXT), _in(AST)))
*/
Z3_bool Z3_API Z3_is_well_sorted(__in Z3_context c, __in Z3_ast t);
/**
\brief Return Z3_L_TRUE if \c a is true, Z3_L_FALSE if it is false, and Z3_L_UNDEF otherwise.
def_API('Z3_get_bool_value', UINT, (_in(CONTEXT), _in(AST)))
*/
Z3_lbool Z3_API Z3_get_bool_value(__in Z3_context c, __in Z3_ast a);
/**
\brief Return the kind of the given AST.
def_API('Z3_get_ast_kind', UINT, (_in(CONTEXT), _in(AST)))
*/
Z3_ast_kind Z3_API Z3_get_ast_kind(__in Z3_context c, __in Z3_ast a);
/**
def_API('Z3_is_app', BOOL, (_in(CONTEXT), _in(AST)))
*/
Z3_bool Z3_API Z3_is_app(__in Z3_context c, __in Z3_ast a);
/**
def_API('Z3_is_numeral_ast', BOOL, (_in(CONTEXT), _in(AST)))
*/
Z3_bool Z3_API Z3_is_numeral_ast(__in Z3_context c, __in Z3_ast a);
/**
\brief Return true if the give AST is a real algebraic number.
def_API('Z3_is_algebraic_number', BOOL, (_in(CONTEXT), _in(AST)))
*/
Z3_bool Z3_API Z3_is_algebraic_number(__in Z3_context c, __in Z3_ast a);
/**
\brief Convert an \c ast into an \c APP_AST. \conly This is just type casting.
\pre \code Z3_get_ast_kind(c, a) == \c Z3_APP_AST \endcode
def_API('Z3_to_app', APP, (_in(CONTEXT), _in(AST)))
*/
Z3_app Z3_API Z3_to_app(__in Z3_context c, __in Z3_ast a);
/**
\brief Convert an AST into a FUNC_DECL_AST. This is just type casting.
\pre \code Z3_get_ast_kind(c, a) == Z3_FUNC_DECL_AST \endcode
def_API('Z3_to_func_decl', FUNC_DECL, (_in(CONTEXT), _in(AST)))
*/
Z3_func_decl Z3_API Z3_to_func_decl(__in Z3_context c, __in Z3_ast a);
/**
\mlonly {4 {L Numerals}} \endmlonly
*/
#ifdef ML4only
#include <mlx_numeral_refine.idl>
#endif
/**
\mlonly {5 {L Low-level API}} \endmlonly
*/
/**
\brief Return numeral value, as a string of a numeric constant term
\pre Z3_get_ast_kind(c, a) == Z3_NUMERAL_AST
def_API('Z3_get_numeral_string', STRING, (_in(CONTEXT), _in(AST)))
*/
Z3_string Z3_API Z3_get_numeral_string(__in Z3_context c, __in Z3_ast a);
/**
\brief Return numeral as a string in decimal notation.
The result has at most \c precision decimal places.
\pre Z3_get_ast_kind(c, a) == Z3_NUMERAL_AST || Z3_is_algebraic_number(c, a)
def_API('Z3_get_numeral_decimal_string', STRING, (_in(CONTEXT), _in(AST), _in(UINT)))
*/
Z3_string Z3_API Z3_get_numeral_decimal_string(__in Z3_context c, __in Z3_ast a, __in unsigned precision);
/**
\brief Return the numerator (as a numeral AST) of a numeral AST of sort Real.
\pre Z3_get_ast_kind(c, a) == Z3_NUMERAL_AST
def_API('Z3_get_numerator', AST, (_in(CONTEXT), _in(AST)))
*/
Z3_ast Z3_API Z3_get_numerator(__in Z3_context c, __in Z3_ast a);
/**
\brief Return the denominator (as a numeral AST) of a numeral AST of sort Real.
\pre Z3_get_ast_kind(c, a) == Z3_NUMERAL_AST
def_API('Z3_get_denominator', AST, (_in(CONTEXT), _in(AST)))
*/
Z3_ast Z3_API Z3_get_denominator(__in Z3_context c, __in Z3_ast a);
/**
\brief Return numeral value, as a pair of 64 bit numbers if the representation fits.
\param c logical context.
\param a term.
\param num numerator.
\param den denominator.
Return \c Z3_TRUE if the numeral value fits in 64 bit numerals, \c Z3_FALSE otherwise.
\pre Z3_get_ast_kind(a) == Z3_NUMERAL_AST
def_API('Z3_get_numeral_small', BOOL, (_in(CONTEXT), _in(AST), _out(INT64), _out(INT64)))
*/
Z3_bool Z3_API Z3_get_numeral_small(__in Z3_context c, __in Z3_ast a, __out __int64* num, __out __int64* den);
/**
\brief \mlh get_numeral_int c v \endmlh
Similar to #Z3_get_numeral_string, but only succeeds if
the value can fit in a machine int. Return Z3_TRUE if the call succeeded.
\pre Z3_get_ast_kind(c, v) == Z3_NUMERAL_AST
\sa Z3_get_numeral_string
def_API('Z3_get_numeral_int', BOOL, (_in(CONTEXT), _in(AST), _out(INT)))
*/
Z3_bool Z3_API Z3_get_numeral_int(__in Z3_context c, __in Z3_ast v, __out int* i);
#ifdef Conly
/**
\brief \mlh get_numeral_uint c v \endmlh
Similar to #Z3_get_numeral_string, but only succeeds if
the value can fit in a machine unsigned int. Return Z3_TRUE if the call succeeded.
\pre Z3_get_ast_kind(c, v) == Z3_NUMERAL_AST
\sa Z3_get_numeral_string
def_API('Z3_get_numeral_uint', BOOL, (_in(CONTEXT), _in(AST), _out(UINT)))
*/
Z3_bool Z3_API Z3_get_numeral_uint(__in Z3_context c, __in Z3_ast v, __out unsigned* u);
#endif
#ifdef Conly
/**
\brief \mlh get_numeral_uint64 c v \endmlh
Similar to #Z3_get_numeral_string, but only succeeds if
the value can fit in a machine unsigned __int64 int. Return Z3_TRUE if the call succeeded.
\pre Z3_get_ast_kind(c, v) == Z3_NUMERAL_AST
\sa Z3_get_numeral_string
def_API('Z3_get_numeral_uint64', BOOL, (_in(CONTEXT), _in(AST), _out(UINT64)))
*/
Z3_bool Z3_API Z3_get_numeral_uint64(__in Z3_context c, __in Z3_ast v, __out unsigned __int64* u);
#endif
/**
\brief \mlh get_numeral_int64 c v \endmlh
Similar to #Z3_get_numeral_string, but only succeeds if
the value can fit in a machine __int64 int. Return Z3_TRUE if the call succeeded.
\pre Z3_get_ast_kind(c, v) == Z3_NUMERAL_AST
\sa Z3_get_numeral_string
def_API('Z3_get_numeral_int64', BOOL, (_in(CONTEXT), _in(AST), _out(INT64)))
*/
Z3_bool Z3_API Z3_get_numeral_int64(__in Z3_context c, __in Z3_ast v, __out __int64* i);
/**
\brief \mlh get_numeral_rational_int64 c x y\endmlh
Similar to #Z3_get_numeral_string, but only succeeds if
the value can fit as a rational number as machine __int64 int. Return Z3_TRUE if the call succeeded.
\pre Z3_get_ast_kind(c, v) == Z3_NUMERAL_AST
\sa Z3_get_numeral_string
def_API('Z3_get_numeral_rational_int64', BOOL, (_in(CONTEXT), _in(AST), _out(INT64), _out(INT64)))
*/
Z3_bool Z3_API Z3_get_numeral_rational_int64(__in Z3_context c, __in Z3_ast v, __out __int64* num, __out __int64* den);
/**
\brief Return a lower bound for the given real algebraic number.
The interval isolating the number is smaller than 1/10^precision.
The result is a numeral AST of sort Real.
\pre Z3_is_algebraic_number(c, a)
def_API('Z3_get_algebraic_number_lower', AST, (_in(CONTEXT), _in(AST), _in(UINT)))
*/
Z3_ast Z3_API Z3_get_algebraic_number_lower(__in Z3_context c, __in Z3_ast a, __in unsigned precision);
/**
\brief Return a upper bound for the given real algebraic number.
The interval isolating the number is smaller than 1/10^precision.
The result is a numeral AST of sort Real.
\pre Z3_is_algebraic_number(c, a)
def_API('Z3_get_algebraic_number_upper', AST, (_in(CONTEXT), _in(AST), _in(UINT)))
*/
Z3_ast Z3_API Z3_get_algebraic_number_upper(Z3_context c, Z3_ast a, unsigned precision);
/**
\mlonly {4 {L Patterns}} \endmlonly
*/
/**
\brief Convert a Z3_pattern into Z3_ast. \conly This is just type casting.
\mlonly \remark [pattern_to_ast c p] can be replaced by [(p :> ast)]. \endmlonly
def_API('Z3_pattern_to_ast', AST, (_in(CONTEXT), _in(PATTERN)))
*/
Z3_ast Z3_API Z3_pattern_to_ast(__in Z3_context c, __in Z3_pattern p);
#ifdef ML4only
#include <mlx_get_pattern_terms.idl>
#endif
/**
\brief Return number of terms in pattern.
def_API('Z3_get_pattern_num_terms', UINT, (_in(CONTEXT), _in(PATTERN)))
*/
unsigned Z3_API Z3_get_pattern_num_terms(__in Z3_context c, __in Z3_pattern p);
/**
\brief Return i'th ast in pattern.
def_API('Z3_get_pattern', AST, (_in(CONTEXT), _in(PATTERN), _in(UINT)))
*/
Z3_ast Z3_API Z3_get_pattern(__in Z3_context c, __in Z3_pattern p, __in unsigned idx);
/**
\mlonly {4 {L Quantifiers}} \endmlonly
*/
/**
\brief Return index of de-Brujin bound variable.
\pre Z3_get_ast_kind(a) == Z3_VAR_AST
def_API('Z3_get_index_value', UINT, (_in(CONTEXT), _in(AST)))
*/
unsigned Z3_API Z3_get_index_value(__in Z3_context c, __in Z3_ast a);
/**
\brief Determine if quantifier is universal.
\pre Z3_get_ast_kind(a) == Z3_QUANTIFIER_AST
def_API('Z3_is_quantifier_forall', BOOL, (_in(CONTEXT), _in(AST)))
*/
Z3_bool Z3_API Z3_is_quantifier_forall(__in Z3_context c, __in Z3_ast a);
/**
\brief Obtain weight of quantifier.
\pre Z3_get_ast_kind(a) == Z3_QUANTIFIER_AST
def_API('Z3_get_quantifier_weight', UINT, (_in(CONTEXT), _in(AST)))
*/
unsigned Z3_API Z3_get_quantifier_weight(__in Z3_context c, __in Z3_ast a);
/**
\brief Return number of patterns used in quantifier.
\pre Z3_get_ast_kind(a) == Z3_QUANTIFIER_AST
def_API('Z3_get_quantifier_num_patterns', UINT, (_in(CONTEXT), _in(AST)))
*/
unsigned Z3_API Z3_get_quantifier_num_patterns(__in Z3_context c, __in Z3_ast a);
/**
\brief Return i'th pattern.
\pre Z3_get_ast_kind(a) == Z3_QUANTIFIER_AST
def_API('Z3_get_quantifier_pattern_ast', PATTERN, (_in(CONTEXT), _in(AST), _in(UINT)))
*/
Z3_pattern Z3_API Z3_get_quantifier_pattern_ast(__in Z3_context c, __in Z3_ast a, unsigned i);
/**
\brief Return number of no_patterns used in quantifier.
\pre Z3_get_ast_kind(a) == Z3_QUANTIFIER_AST
def_API('Z3_get_quantifier_num_no_patterns', UINT, (_in(CONTEXT), _in(AST)))
*/
unsigned Z3_API Z3_get_quantifier_num_no_patterns(__in Z3_context c, __in Z3_ast a);
/**
\brief Return i'th no_pattern.
\pre Z3_get_ast_kind(a) == Z3_QUANTIFIER_AST
def_API('Z3_get_quantifier_no_pattern_ast', AST, (_in(CONTEXT), _in(AST), _in(UINT)))
*/
Z3_ast Z3_API Z3_get_quantifier_no_pattern_ast(__in Z3_context c, __in Z3_ast a, unsigned i);
/**
\brief Return number of bound variables of quantifier.
\pre Z3_get_ast_kind(a) == Z3_QUANTIFIER_AST
def_API('Z3_get_quantifier_num_bound', UINT, (_in(CONTEXT), _in(AST)))
*/
unsigned Z3_API Z3_get_quantifier_num_bound(__in Z3_context c, __in Z3_ast a);
/**
\brief Return symbol of the i'th bound variable.
\pre Z3_get_ast_kind(a) == Z3_QUANTIFIER_AST
def_API('Z3_get_quantifier_bound_name', SYMBOL, (_in(CONTEXT), _in(AST), _in(UINT)))
*/
Z3_symbol Z3_API Z3_get_quantifier_bound_name(__in Z3_context c, __in Z3_ast a, unsigned i);
/**
\brief Return sort of the i'th bound variable.
\pre Z3_get_ast_kind(a) == Z3_QUANTIFIER_AST
def_API('Z3_get_quantifier_bound_sort', SORT, (_in(CONTEXT), _in(AST), _in(UINT)))
*/
Z3_sort Z3_API Z3_get_quantifier_bound_sort(__in Z3_context c, __in Z3_ast a, unsigned i);
/**
\brief Return body of quantifier.
\pre Z3_get_ast_kind(a) == Z3_QUANTIFIER_AST
def_API('Z3_get_quantifier_body', AST, (_in(CONTEXT), _in(AST)))
*/
Z3_ast Z3_API Z3_get_quantifier_body(__in Z3_context c, __in Z3_ast a);
/**
\mlonly {3 {L Simplification}} \endmlonly
*/
/**
\brief Interface to simplifier.
Provides an interface to the AST simplifier used by Z3.
def_API('Z3_simplify', AST, (_in(CONTEXT), _in(AST)))
*/
Z3_ast Z3_API Z3_simplify(__in Z3_context c, __in Z3_ast a);
#ifdef CorML4
/**
\brief Interface to simplifier.
Provides an interface to the AST simplifier used by Z3.
This procedure is similar to #Z3_simplify, but the behavior of the simplifier
can be configured using the given parameter set.
def_API('Z3_simplify_ex', AST, (_in(CONTEXT), _in(AST), _in(PARAMS)))
*/
Z3_ast Z3_API Z3_simplify_ex(__in Z3_context c, __in Z3_ast a, __in Z3_params p);
/**
\brief Return a string describing all available parameters.
def_API('Z3_simplify_get_help', STRING, (_in(CONTEXT),))
*/
Z3_string Z3_API Z3_simplify_get_help(__in Z3_context c);
/**
\brief Return the parameter description set for the simplify procedure.
def_API('Z3_simplify_get_param_descrs', PARAM_DESCRS, (_in(CONTEXT),))
*/
Z3_param_descrs Z3_API Z3_simplify_get_param_descrs(__in Z3_context c);
#endif
/*@}*/
/**
@name Modifiers
*/
/*@{*/
/**
\brief Update the arguments of term \c a using the arguments \c args.
The number of arguments \c num_args should coincide
with the number of arguments to \c a.
If \c a is a quantifier, then num_args has to be 1.
def_API('Z3_update_term', AST, (_in(CONTEXT), _in(AST), _in(UINT), _in_array(2, AST)))
*/
Z3_ast Z3_API Z3_update_term(__in Z3_context c, __in Z3_ast a, __in unsigned num_args, __in_ecount(num_args) Z3_ast const args[]);
/**
\brief Substitute every occurrence of <tt>from[i]</tt> in \c a with <tt>to[i]</tt>, for \c i smaller than \c num_exprs.
The result is the new AST. The arrays \c from and \c to must have size \c num_exprs.
For every \c i smaller than \c num_exprs, we must have that sort of <tt>from[i]</tt> must be equal to sort of <tt>to[i]</tt>.
def_API('Z3_substitute', AST, (_in(CONTEXT), _in(AST), _in(UINT), _in_array(2, AST), _in_array(2, AST)))
*/
Z3_ast Z3_API Z3_substitute(__in Z3_context c,
__in Z3_ast a,
__in unsigned num_exprs,
__in_ecount(num_exprs) Z3_ast const from[],
__in_ecount(num_exprs) Z3_ast const to[]);
/**
\brief Substitute the free variables in \c a with the expressions in \c to.
For every \c i smaller than \c num_exprs, the variable with de-Bruijn index \c i is replaced with term <tt>to[i]</tt>.
def_API('Z3_substitute_vars', AST, (_in(CONTEXT), _in(AST), _in(UINT), _in_array(2, AST)))
*/
Z3_ast Z3_API Z3_substitute_vars(__in Z3_context c,
__in Z3_ast a,
__in unsigned num_exprs,
__in_ecount(num_exprs) Z3_ast const to[]);
#ifdef CorML4
/**
\brief Translate/Copy the AST \c a from context \c source to context \c target.
AST \c a must have been created using context \c source.
\pre source != target
def_API('Z3_translate', AST, (_in(CONTEXT), _in(AST), _in(CONTEXT)))
*/
Z3_ast Z3_API Z3_translate(__in Z3_context source, __in Z3_ast a, __in Z3_context target);
#endif
/*@}*/
#ifdef CorML4
/**
@name Models
*/
/*@{*/
#ifdef ML4only
#include <mlx_model.idl>
#endif
#ifdef Conly
/**
\brief Increment the reference counter of the given model.
def_API('Z3_model_inc_ref', VOID, (_in(CONTEXT), _in(MODEL)))
*/
void Z3_API Z3_model_inc_ref(__in Z3_context c, __in Z3_model m);
/**
\brief Decrement the reference counter of the given model.
def_API('Z3_model_dec_ref', VOID, (_in(CONTEXT), _in(MODEL)))
*/
void Z3_API Z3_model_dec_ref(__in Z3_context c, __in Z3_model m);
#endif
/**
\brief \mlh model_eval c m t \endmlh
Evaluate the AST node \c t in the given model.
\conly Return \c Z3_TRUE if succeeded, and store the result in \c v.
\mlonly Return \c None if the term was not successfully evaluated. \endmlonly
If \c model_completion is Z3_TRUE, then Z3 will assign an interpretation for any constant or function that does
not have an interpretation in \c m. These constants and functions were essentially don't cares.
The evaluation may fail for the following reasons:
- \c t contains a quantifier.
- the model \c m is partial, that is, it doesn't have a complete interpretation for uninterpreted functions.
That is, the option <tt>MODEL_PARTIAL=true</tt> was used.
- \c t is type incorrect.
def_API('Z3_model_eval', BOOL, (_in(CONTEXT), _in(MODEL), _in(AST), _in(BOOL), _out(AST)))
*/
Z3_bool_opt Z3_API Z3_model_eval(__in Z3_context c, __in Z3_model m, __in Z3_ast t, __in Z3_bool model_completion, __out_opt Z3_ast * v);
/**
\mlonly {4 {L Low-level API}} \endmlonly
*/
/**
\brief Return the interpretation (i.e., assignment) of constant \c a in the model \c m.
Return \mlonly [None], \endmlonly \conly \c NULL,
if the model does not assign an interpretation for \c a.
That should be interpreted as: the value of \c a does not matter.
\pre Z3_get_arity(c, a) == 0
def_API('Z3_model_get_const_interp', AST, (_in(CONTEXT), _in(MODEL), _in(FUNC_DECL)))
*/
Z3_ast_opt Z3_API Z3_model_get_const_interp(__in Z3_context c, __in Z3_model m, __in Z3_func_decl a);
/**
\brief Test if there exists an interpretation (i.e., assignment) for \c a in the model \c m.
def_API('Z3_model_has_interp', BOOL, (_in(CONTEXT), _in(MODEL), _in(FUNC_DECL)))
*/
Z3_bool Z3_API Z3_model_has_interp(__in Z3_context c, __in Z3_model m, __in Z3_func_decl a);
/**
\brief Return the interpretation of the function \c f in the model \c m.
Return \mlonly [None], \endmlonly \conly \c NULL,
if the model does not assign an interpretation for \c f.
That should be interpreted as: the \c f does not matter.
\pre Z3_get_arity(c, f) > 0
\conly \remark Reference counting must be used to manage Z3_func_interp objects, even when the Z3_context was
\conly created using #Z3_mk_context instead of #Z3_mk_context_rc.
def_API('Z3_model_get_func_interp', FUNC_INTERP, (_in(CONTEXT), _in(MODEL), _in(FUNC_DECL)))
*/
Z3_func_interp_opt Z3_API Z3_model_get_func_interp(__in Z3_context c, __in Z3_model m, __in Z3_func_decl f);
/**
\brief Return the number of constants assigned by the given model.
\sa Z3_model_get_const_decl
def_API('Z3_model_get_num_consts', UINT, (_in(CONTEXT), _in(MODEL)))
*/
unsigned Z3_API Z3_model_get_num_consts(__in Z3_context c, __in Z3_model m);
/**
\brief \mlh model_get_const_decl c m i \endmlh
Return the i-th constant in the given model.
\pre i < Z3_model_get_num_consts(c, m)
\sa Z3_model_eval
def_API('Z3_model_get_const_decl', FUNC_DECL, (_in(CONTEXT), _in(MODEL), _in(UINT)))
*/
Z3_func_decl Z3_API Z3_model_get_const_decl(__in Z3_context c, __in Z3_model m, __in unsigned i);
/**
\brief Return the number of function interpretations in the given model.
A function interpretation is represented as a finite map and an 'else' value.
Each entry in the finite map represents the value of a function given a set of arguments.
def_API('Z3_model_get_num_funcs', UINT, (_in(CONTEXT), _in(MODEL)))
*/
unsigned Z3_API Z3_model_get_num_funcs(__in Z3_context c, __in Z3_model m);
/**
\brief \mlh model_get_func_decl c m i \endmlh
Return the declaration of the i-th function in the given model.
\pre i < Z3_model_get_num_funcs(c, m)
\sa Z3_model_get_num_funcs
def_API('Z3_model_get_func_decl', FUNC_DECL, (_in(CONTEXT), _in(MODEL), _in(UINT)))
*/
Z3_func_decl Z3_API Z3_model_get_func_decl(__in Z3_context c, __in Z3_model m, __in unsigned i);
/**
\brief Return the number of uninterpreted sorts that \c m assigs an interpretation to.
Z3 also provides an intepretation for uninterpreted sorts used in a formua.
The interpretation for a sort \c s is a finite set of distinct values. We say this finite set is
the "universe" of \c s.
\sa Z3_model_get_sort
\sa Z3_model_get_sort_universe
def_API('Z3_model_get_num_sorts', UINT, (_in(CONTEXT), _in(MODEL)))
*/
unsigned Z3_API Z3_model_get_num_sorts(__in Z3_context c, __in Z3_model m);
/**
\brief Return a uninterpreted sort that \c m assigns an interpretation.
\pre i < Z3_model_get_num_sorts(c, m)
\sa Z3_model_get_num_sorts
\sa Z3_model_get_sort_universe
def_API('Z3_model_get_sort', SORT, (_in(CONTEXT), _in(MODEL), _in(UINT)))
*/
Z3_sort Z3_API Z3_model_get_sort(__in Z3_context c, __in Z3_model m, __in unsigned i);
/**
\brief Return the finite set of distinct values that represent the interpretation for sort \c s.
\sa Z3_model_get_num_sorts
\sa Z3_model_get_sort
def_API('Z3_model_get_sort_universe', AST_VECTOR, (_in(CONTEXT), _in(MODEL), _in(SORT)))
*/
Z3_ast_vector Z3_API Z3_model_get_sort_universe(__in Z3_context c, __in Z3_model m, __in Z3_sort s);
/**
\brief The <tt>(_ as-array f)</tt> AST node is a construct for assigning interpretations for arrays in Z3.
It is the array such that forall indices \c i we have that <tt>(select (_ as-array f) i)</tt> is equal to <tt>(f i)</tt>.
This procedure returns Z3_TRUE if the \c a is an \c as-array AST node.
Z3 current solvers have minimal support for \c as_array nodes.
\sa Z3_get_as_array_func_decl
def_API('Z3_is_as_array', BOOL, (_in(CONTEXT), _in(AST)))
*/
Z3_bool Z3_API Z3_is_as_array(__in Z3_context c, __in Z3_ast a);
/**
\brief Return the function declaration \c f associated with a <tt>(_ as_array f)</tt> node.
\sa Z3_is_as_array
def_API('Z3_get_as_array_func_decl', FUNC_DECL, (_in(CONTEXT), _in(AST)))
*/
Z3_func_decl Z3_API Z3_get_as_array_func_decl(__in Z3_context c, __in Z3_ast a);
#ifdef Conly
/**
\brief Increment the reference counter of the given Z3_func_interp object.
def_API('Z3_func_interp_inc_ref', VOID, (_in(CONTEXT), _in(FUNC_INTERP)))
*/
void Z3_API Z3_func_interp_inc_ref(__in Z3_context c, __in Z3_func_interp f);
/**
\brief Decrement the reference counter of the given Z3_func_interp object.
def_API('Z3_func_interp_dec_ref', VOID, (_in(CONTEXT), _in(FUNC_INTERP)))
*/
void Z3_API Z3_func_interp_dec_ref(__in Z3_context c, __in Z3_func_interp f);
#endif
/**
\brief Return the number of entries in the given function interpretation.
A function interpretation is represented as a finite map and an 'else' value.
Each entry in the finite map represents the value of a function given a set of arguments.
This procedure return the number of element in the finite map of \c f.
def_API('Z3_func_interp_get_num_entries', UINT, (_in(CONTEXT), _in(FUNC_INTERP)))
*/
unsigned Z3_API Z3_func_interp_get_num_entries(__in Z3_context c, __in Z3_func_interp f);
/**
\brief Return a "point" of the given function intepretation. It represents the
value of \c f in a particular point.
\pre i < Z3_func_interp_get_num_entries(c, f)
\sa Z3_func_interp_get_num_entries
def_API('Z3_func_interp_get_entry', FUNC_ENTRY, (_in(CONTEXT), _in(FUNC_INTERP), _in(UINT)))
*/
Z3_func_entry Z3_API Z3_func_interp_get_entry(__in Z3_context c, __in Z3_func_interp f, unsigned i);
/**
\brief Return the 'else' value of the given function interpretation.
A function interpretation is represented as a finite map and an 'else' value.
This procedure returns the 'else' value.
def_API('Z3_func_interp_get_else', AST, (_in(CONTEXT), _in(FUNC_INTERP)))
*/
Z3_ast Z3_API Z3_func_interp_get_else(__in Z3_context c, __in Z3_func_interp f);
/**
\brief Return the arity (number of arguments) of the given function interpretation.
def_API('Z3_func_interp_get_arity', UINT, (_in(CONTEXT), _in(FUNC_INTERP)))
*/
unsigned Z3_API Z3_func_interp_get_arity(__in Z3_context c, __in Z3_func_interp f);
#ifdef Conly
/**
\brief Increment the reference counter of the given Z3_func_entry object.
def_API('Z3_func_entry_inc_ref', VOID, (_in(CONTEXT), _in(FUNC_ENTRY)))
*/
void Z3_API Z3_func_entry_inc_ref(__in Z3_context c, __in Z3_func_entry e);
/**
\brief Decrement the reference counter of the given Z3_func_entry object.
def_API('Z3_func_entry_dec_ref', VOID, (_in(CONTEXT), _in(FUNC_ENTRY)))
*/
void Z3_API Z3_func_entry_dec_ref(__in Z3_context c, __in Z3_func_entry e);
#endif
/**
\brief Return the value of this point.
A Z3_func_entry object represents an element in the finite map used to encode
a function interpretation.
\sa Z3_func_interp_get_entry
def_API('Z3_func_entry_get_value', AST, (_in(CONTEXT), _in(FUNC_ENTRY)))
*/
Z3_ast Z3_API Z3_func_entry_get_value(__in Z3_context c, __in Z3_func_entry e);
/**
\brief Return the number of arguments in a Z3_func_entry object.
\sa Z3_func_interp_get_entry
def_API('Z3_func_entry_get_num_args', UINT, (_in(CONTEXT), _in(FUNC_ENTRY)))
*/
unsigned Z3_API Z3_func_entry_get_num_args(__in Z3_context c, __in Z3_func_entry e);
/**
\brief Return an argument of a Z3_func_entry object.
\pre i < Z3_func_entry_get_num_args(c, e)
\sa Z3_func_interp_get_entry
def_API('Z3_func_entry_get_arg', AST, (_in(CONTEXT), _in(FUNC_ENTRY), _in(UINT)))
*/
Z3_ast Z3_API Z3_func_entry_get_arg(__in Z3_context c, __in Z3_func_entry e, __in unsigned i);
/*@}*/
#endif // CorML4
/**
@name Interaction logging.
*/
/*@{*/
/**
\brief Log interaction to a file.
extra_API('Z3_open_log', INT, (_in(STRING),))
*/
Z3_bool Z3_API Z3_open_log(__in Z3_string filename);
/**
\brief Append user-defined string to interaction log.
The interaction log is opened using Z3_open_log.
It contains the formulas that are checked using Z3.
You can use this command to append comments, for instance.
extra_API('Z3_append_log', VOID, (_in(STRING),))
*/
void Z3_API Z3_append_log(__in Z3_string string);
/**
\brief Close interaction log.
extra_API('Z3_close_log', VOID, ())
*/
void Z3_API Z3_close_log(void);
/**
\brief Enable/disable printing warning messages to the console.
Warnings are printed after passing \c true, warning messages are
suppressed after calling this method with \c false.
def_API('Z3_toggle_warning_messages', VOID, (_in(BOOL),))
*/
void Z3_API Z3_toggle_warning_messages(__in Z3_bool enabled);
/*@}*/
/**
@name String conversion
*/
/*@{*/
/**
\brief Select mode for the format used for pretty-printing AST nodes.
The default mode for pretty printing AST nodes is to produce
SMT-LIB style output where common subexpressions are printed
at each occurrence. The mode is called Z3_PRINT_SMTLIB_FULL.
To print shared common subexpressions only once,
use the Z3_PRINT_LOW_LEVEL mode.
To print in way that conforms to SMT-LIB standards and uses let
expressions to share common sub-expressions use Z3_PRINT_SMTLIB_COMPLIANT.
\sa Z3_ast_to_string
\sa Z3_pattern_to_string
\sa Z3_func_decl_to_string
def_API('Z3_set_ast_print_mode', VOID, (_in(CONTEXT), _in(PRINT_MODE)))
*/
void Z3_API Z3_set_ast_print_mode(__in Z3_context c, __in Z3_ast_print_mode mode);
/**
\brief Convert the given AST node into a string.
\conly \warning The result buffer is statically allocated by Z3. It will
\conly be automatically deallocated when #Z3_del_context is invoked.
\conly So, the buffer is invalidated in the next call to \c Z3_ast_to_string.
\sa Z3_pattern_to_string
\sa Z3_sort_to_string
def_API('Z3_ast_to_string', STRING, (_in(CONTEXT), _in(AST)))
*/
Z3_string Z3_API Z3_ast_to_string(__in Z3_context c, __in Z3_ast a);
/**
def_API('Z3_pattern_to_string', STRING, (_in(CONTEXT), _in(PATTERN)))
*/
Z3_string Z3_API Z3_pattern_to_string(__in Z3_context c, __in Z3_pattern p);
/**
def_API('Z3_sort_to_string', STRING, (_in(CONTEXT), _in(SORT)))
*/
Z3_string Z3_API Z3_sort_to_string(__in Z3_context c, __in Z3_sort s);
/**
def_API('Z3_func_decl_to_string', STRING, (_in(CONTEXT), _in(FUNC_DECL)))
*/
Z3_string Z3_API Z3_func_decl_to_string(__in Z3_context c, __in Z3_func_decl d);
/**
\brief Convert the given model into a string.
\conly \warning The result buffer is statically allocated by Z3. It will
\conly be automatically deallocated when #Z3_del_context is invoked.
\conly So, the buffer is invalidated in the next call to \c Z3_model_to_string.
def_API('Z3_model_to_string', STRING, (_in(CONTEXT), _in(MODEL)))
*/
Z3_string Z3_API Z3_model_to_string(__in Z3_context c, __in Z3_model m);
/**
\brief Convert the given benchmark into SMT-LIB formatted string.
\conly \warning The result buffer is statically allocated by Z3. It will
\conly be automatically deallocated when #Z3_del_context is invoked.
\conly So, the buffer is invalidated in the next call to \c Z3_benchmark_to_smtlib_string.
\param c - context.
\param name - name of benchmark. The argument is optional.
\param logic - the benchmark logic.
\param status - the status string (sat, unsat, or unknown)
\param attributes - other attributes, such as source, difficulty or category.
\param num_assumptions - number of assumptions.
\param assumptions - auxiliary assumptions.
\param formula - formula to be checked for consistency in conjunction with assumptions.
def_API('Z3_benchmark_to_smtlib_string', STRING, (_in(CONTEXT), _in(STRING), _in(STRING), _in(STRING), _in(STRING), _in(UINT), _in_array(5, AST), _in(AST)))
*/
Z3_string Z3_API Z3_benchmark_to_smtlib_string(__in Z3_context c,
__in Z3_string name,
__in Z3_string logic,
__in Z3_string status,
__in Z3_string attributes,
__in unsigned num_assumptions,
__in_ecount(num_assumptions) Z3_ast const assumptions[],
__in Z3_ast formula);
/*@}*/
/**
@name Parser interface
*/
/*@{*/
/**
\brief \mlh parse_smtlib2_string c str \endmlh
Parse the given string using the SMT-LIB2 parser.
It returns a formula comprising of the conjunction of assertions in the scope
(up to push/pop) at the end of the string.
def_API('Z3_parse_smtlib2_string', AST, (_in(CONTEXT), _in(STRING), _in(UINT), _in_array(2, SYMBOL), _in_array(2, SORT), _in(UINT), _in_array(5, SYMBOL), _in_array(5, FUNC_DECL)))
*/
Z3_ast Z3_API Z3_parse_smtlib2_string(__in Z3_context c,
__in Z3_string str,
__in unsigned num_sorts,
__in_ecount(num_sorts) Z3_symbol const sort_names[],
__in_ecount(num_sorts) Z3_sort const sorts[],
__in unsigned num_decls,
__in_ecount(num_decls) Z3_symbol const decl_names[],
__in_ecount(num_decls) Z3_func_decl const decls[]);
/**
\brief Similar to #Z3_parse_smtlib2_string, but reads the benchmark from a file.
def_API('Z3_parse_smtlib2_file', AST, (_in(CONTEXT), _in(STRING), _in(UINT), _in_array(2, SYMBOL), _in_array(2, SORT), _in(UINT), _in_array(5, SYMBOL), _in_array(5, FUNC_DECL)))
*/
Z3_ast Z3_API Z3_parse_smtlib2_file(__in Z3_context c,
__in Z3_string file_name,
__in unsigned num_sorts,
__in_ecount(num_sorts) Z3_symbol const sort_names[],
__in_ecount(num_sorts) Z3_sort const sorts[],
__in unsigned num_decls,
__in_ecount(num_decls) Z3_symbol const decl_names[],
__in_ecount(num_decls) Z3_func_decl const decls[]);
#ifdef ML4only
#include <mlx_parse_smtlib.idl>
#endif
/**
\mlonly {4 {L Low-level API}} \endmlonly
*/
/**
\brief \mlh parse_smtlib_string c str sort_names sorts decl_names decls \endmlh
Parse the given string using the SMT-LIB parser.
The symbol table of the parser can be initialized using the given sorts and declarations.
The symbols in the arrays \c sort_names and \c decl_names don't need to match the names
of the sorts and declarations in the arrays \c sorts and \c decls. This is an useful feature
since we can use arbitrary names to reference sorts and declarations defined using the C API.
The formulas, assumptions and declarations defined in \c str can be extracted using the functions:
#Z3_get_smtlib_num_formulas, #Z3_get_smtlib_formula, #Z3_get_smtlib_num_assumptions, #Z3_get_smtlib_assumption,
#Z3_get_smtlib_num_decls, and #Z3_get_smtlib_decl.
def_API('Z3_parse_smtlib_string', VOID, (_in(CONTEXT), _in(STRING), _in(UINT), _in_array(2, SYMBOL), _in_array(2, SORT), _in(UINT), _in_array(5, SYMBOL), _in_array(5, FUNC_DECL)))
*/
void Z3_API Z3_parse_smtlib_string(__in Z3_context c,
__in Z3_string str,
__in unsigned num_sorts,
__in_ecount(num_sorts) Z3_symbol const sort_names[],
__in_ecount(num_sorts) Z3_sort const sorts[],
__in unsigned num_decls,
__in_ecount(num_decls) Z3_symbol const decl_names[],
__in_ecount(num_decls) Z3_func_decl const decls[]
);
/**
\brief Similar to #Z3_parse_smtlib_string, but reads the benchmark from a file.
def_API('Z3_parse_smtlib_file', VOID, (_in(CONTEXT), _in(STRING), _in(UINT), _in_array(2, SYMBOL), _in_array(2, SORT), _in(UINT), _in_array(5, SYMBOL), _in_array(5, FUNC_DECL)))
*/
void Z3_API Z3_parse_smtlib_file(__in Z3_context c,
__in Z3_string file_name,
__in unsigned num_sorts,
__in_ecount(num_sorts) Z3_symbol const sort_names[],
__in_ecount(num_sorts) Z3_sort const sorts[],
__in unsigned num_decls,
__in_ecount(num_decls) Z3_symbol const decl_names[],
__in_ecount(num_decls) Z3_func_decl const decls[]
);
/**
\brief Return the number of SMTLIB formulas parsed by the last call to #Z3_parse_smtlib_string or #Z3_parse_smtlib_file.
def_API('Z3_get_smtlib_num_formulas', UINT, (_in(CONTEXT), ))
*/
unsigned Z3_API Z3_get_smtlib_num_formulas(__in Z3_context c);
/**
\brief \mlh get_smtlib_formula c i \endmlh
Return the i-th formula parsed by the last call to #Z3_parse_smtlib_string or #Z3_parse_smtlib_file.
\pre i < Z3_get_smtlib_num_formulas(c)
def_API('Z3_get_smtlib_formula', AST, (_in(CONTEXT), _in(UINT)))
*/
Z3_ast Z3_API Z3_get_smtlib_formula(__in Z3_context c, __in unsigned i);
/**
\brief Return the number of SMTLIB assumptions parsed by #Z3_parse_smtlib_string or #Z3_parse_smtlib_file.
def_API('Z3_get_smtlib_num_assumptions', UINT, (_in(CONTEXT), ))
*/
unsigned Z3_API Z3_get_smtlib_num_assumptions(__in Z3_context c);
/**
\brief \mlh get_smtlib_assumption c i \endmlh
Return the i-th assumption parsed by the last call to #Z3_parse_smtlib_string or #Z3_parse_smtlib_file.
\pre i < Z3_get_smtlib_num_assumptions(c)
def_API('Z3_get_smtlib_assumption', AST, (_in(CONTEXT), _in(UINT)))
*/
Z3_ast Z3_API Z3_get_smtlib_assumption(__in Z3_context c, __in unsigned i);
/**
\brief Return the number of declarations parsed by #Z3_parse_smtlib_string or #Z3_parse_smtlib_file.
def_API('Z3_get_smtlib_num_decls', UINT, (_in(CONTEXT), ))
*/
unsigned Z3_API Z3_get_smtlib_num_decls(__in Z3_context c);
/**
\brief \mlh get_smtlib_decl c i \endmlh
Return the i-th declaration parsed by the last call to #Z3_parse_smtlib_string or #Z3_parse_smtlib_file.
\pre i < Z3_get_smtlib_num_decls(c)
def_API('Z3_get_smtlib_decl', FUNC_DECL, (_in(CONTEXT), _in(UINT)))
*/
Z3_func_decl Z3_API Z3_get_smtlib_decl(__in Z3_context c, __in unsigned i);
/**
\brief Return the number of sorts parsed by #Z3_parse_smtlib_string or #Z3_parse_smtlib_file.
def_API('Z3_get_smtlib_num_sorts', UINT, (_in(CONTEXT), ))
*/
unsigned Z3_API Z3_get_smtlib_num_sorts(__in Z3_context c);
/**
\brief \mlh get_smtlib_sort c i \endmlh
Return the i-th sort parsed by the last call to #Z3_parse_smtlib_string or #Z3_parse_smtlib_file.
\pre i < Z3_get_smtlib_num_sorts(c)
def_API('Z3_get_smtlib_sort', SORT, (_in(CONTEXT), _in(UINT)))
*/
Z3_sort Z3_API Z3_get_smtlib_sort(__in Z3_context c, __in unsigned i);
BEGIN_MLAPI_EXCLUDE
/**
\brief \mlh get_smtlib_error c \endmlh
Retrieve that last error message information generated from parsing.
def_API('Z3_get_smtlib_error', STRING, (_in(CONTEXT), ))
*/
Z3_string Z3_API Z3_get_smtlib_error(__in Z3_context c);
END_MLAPI_EXCLUDE
/*@}*/
#ifdef CorML4
/**
@name Error Handling
*/
/*@{*/
#ifndef SAFE_ERRORS
/**
\brief Return the error code for the last API call.
A call to a Z3 function may return a non Z3_OK error code,
when it is not used correctly.
\sa Z3_set_error_handler
def_API('Z3_get_error_code', UINT, (_in(CONTEXT), ))
*/
Z3_error_code Z3_API Z3_get_error_code(__in Z3_context c);
/**
\brief Register a Z3 error handler.
A call to a Z3 function may return a non Z3_OK error code, when
it is not used correctly. An error handler can be registered
and will be called in this case. \conly To disable the use of the
error handler, simply register with \c h=NULL.
\warning Log files, created using #Z3_open_log, may be potentially incomplete/incorrect if error handlers are used.
\sa Z3_get_error_code
*/
void Z3_API Z3_set_error_handler(__in Z3_context c, __in Z3_error_handler h);
#endif
/**
\brief Set an error.
def_API('Z3_set_error', VOID, (_in(CONTEXT), _in(ERROR_CODE)))
*/
void Z3_API Z3_set_error(__in Z3_context c, __in Z3_error_code e);
#ifdef Conly
/**
\brief Return a string describing the given error code.
\deprecated Use #Z3_get_error_msg_ex instead.
def_API('Z3_get_error_msg', STRING, (_in(ERROR_CODE),))
*/
Z3_string Z3_API Z3_get_error_msg(__in Z3_error_code err);
#endif
BEGIN_MLAPI_EXCLUDE
/**
\brief Return a string describing the given error code.
def_API('Z3_get_error_msg_ex', STRING, (_in(CONTEXT), _in(ERROR_CODE)))
*/
Z3_string Z3_API Z3_get_error_msg_ex(__in Z3_context c, __in Z3_error_code err);
END_MLAPI_EXCLUDE
#ifdef ML4only
#include <mlx_get_error_msg.idl>
#endif
/*@}*/
#endif
/**
@name Miscellaneous
*/
/*@{*/
/**
\brief Return Z3 version number information.
def_API('Z3_get_version', VOID, (_out(UINT), _out(UINT), _out(UINT), _out(UINT)))
*/
void Z3_API Z3_get_version(__out unsigned * major, __out unsigned * minor, __out unsigned * build_number, __out unsigned * revision_number);
/**
\brief Enable tracing messages tagged as \c tag when Z3 is compiled in debug mode.
It is a NOOP otherwise
def_API('Z3_enable_trace', VOID, (_in(STRING),))
*/
void Z3_API Z3_enable_trace(__in Z3_string tag);
/**
\brief Disable tracing messages tagged as \c tag when Z3 is compiled in debug mode.
It is a NOOP otherwise
def_API('Z3_disable_trace', VOID, (_in(STRING),))
*/
void Z3_API Z3_disable_trace(__in Z3_string tag);
#ifdef CorML3
/**
\brief Reset all allocated resources.
Use this facility on out-of memory errors.
It allows discharging the previous state and resuming afresh.
Any pointers previously returned by the API
become invalid.
def_API('Z3_reset_memory', VOID, ())
*/
void Z3_API Z3_reset_memory(void);
#endif
#ifdef CorML3
/**
\brief Destroy all allocated resources.
Any pointers previously returned by the API become invalid.
Can be used for memory leak detection.
def_API('Z3_finalize_memory', VOID, ())
*/
void Z3_API Z3_finalize_memory(void);
#endif
/*@}*/
#ifdef CorML3
/**
@name External Theory Plugins
*/
/*@{*/
#ifdef Conly
//
// callbacks and void* don't work with CAMLIDL.
//
typedef Z3_bool Z3_reduce_eq_callback_fptr(__in Z3_theory t, __in Z3_ast a, __in Z3_ast b, __out Z3_ast * r);
typedef Z3_bool Z3_reduce_app_callback_fptr(__in Z3_theory, __in Z3_func_decl, __in unsigned, __in Z3_ast const [], __out Z3_ast *);
typedef Z3_bool Z3_reduce_distinct_callback_fptr(__in Z3_theory, __in unsigned, __in Z3_ast const [], __out Z3_ast *);
typedef void Z3_theory_callback_fptr(__in Z3_theory t);
typedef Z3_bool Z3_theory_final_check_callback_fptr(__in Z3_theory);
typedef void Z3_theory_ast_callback_fptr(__in Z3_theory, __in Z3_ast);
typedef void Z3_theory_ast_bool_callback_fptr(__in Z3_theory, __in Z3_ast, __in Z3_bool);
typedef void Z3_theory_ast_ast_callback_fptr(__in Z3_theory, __in Z3_ast, __in Z3_ast);
#endif
#ifdef Conly
/**
\brief Create a new user defined theory. The new theory will be identified by the name \c th_name.
A theory must be created before asserting any assertion to the given context.
\conly Return \c NULL in case of failure.
\conly \c data is a pointer to an external data-structure that may be used to store
\conly theory specific additional data.
*/
Z3_theory Z3_API Z3_mk_theory(__in Z3_context c, __in Z3_string th_name, __in Z3_theory_data data);
/**
\brief Return a pointer to the external data-structure supplied to the function #Z3_mk_theory.
\see Z3_mk_theory
*/
Z3_theory_data Z3_API Z3_theory_get_ext_data(__in Z3_theory t);
#endif
/**
\brief Create an interpreted theory sort.
*/
Z3_sort Z3_API Z3_theory_mk_sort(__in Z3_context c, __in Z3_theory t, __in Z3_symbol s);
/**
\brief Create an interpreted theory constant value. Values are assumed to be different from each other.
*/
Z3_ast Z3_API Z3_theory_mk_value(__in Z3_context c, __in Z3_theory t, __in Z3_symbol n, __in Z3_sort s);
/**
\brief Create an interpreted constant for the given theory.
*/
Z3_ast Z3_API Z3_theory_mk_constant(__in Z3_context c, __in Z3_theory t, __in Z3_symbol n, __in Z3_sort s);
/**
\brief Create an interpreted function declaration for the given theory.
*/
Z3_func_decl Z3_API Z3_theory_mk_func_decl(__in Z3_context c, __in Z3_theory t, __in Z3_symbol n,
__in unsigned domain_size, __in_ecount(domain_size) Z3_sort const domain[],
__in Z3_sort range);
/**
\brief Return the context where the given theory is installed.
*/
Z3_context Z3_API Z3_theory_get_context(__in Z3_theory t);
#ifdef Conly
/**
\brief Set a callback that is invoked when theory \c t is deleted.
This callback should be used to delete external data-structures associated with the given theory.
\conly The callback has the form <tt>f(t)</tt>, where
\conly - \c t is the given theory
\see Z3_mk_theory
\conly \see Z3_theory_get_ext_data
*/
void Z3_API Z3_set_delete_callback(__in Z3_theory t, __in Z3_theory_callback_fptr f);
/**
\brief Set a callback for simplifying operators of the given theory.
The callback \c f is invoked by Z3's simplifier.
\conly It is of the form <tt>f(t, d, n, args, r)</tt>, where:
\conly - \c t is the given theory
\conly - \c d is the declaration of the theory operator
\conly - \c n is the number of arguments in the array \c args
\conly - \c args are arguments for the theory operator
\conly - \c r should contain the result: an expression equivalent to <tt>d(args[0], ..., args[n-1])</tt>.
\conly If <tt>f(t, d, n, args, r)</tt> returns false, then \c r is ignored, and Z3 assumes that no simplification was performed.
*/
void Z3_API Z3_set_reduce_app_callback(__in Z3_theory t, __in Z3_reduce_app_callback_fptr f);
/**
\brief Set a callback for simplifying the atom <tt>s_1 = s_2</tt>, when the
sort of \c s_1 and \c s_2 is an interpreted sort of the given theory.
The callback \c f is invoked by Z3's simplifier.
\conly It has the form <tt>f(t, s_1, s_2, r)</tt>, where:
\conly - \c t is the given theory
\conly - \c s_1 is the left-hand-side
\conly - \c s_2 is the right-hand-side
\conly - \c r should contain the result: an expression equivalent to <tt>s_1 = s_2</tt>.
\conly If <tt>f(t, s_1, s_2, r)</tt> returns false, then \c r is ignored, and Z3 assumes that no simplification was performed.
*/
void Z3_API Z3_set_reduce_eq_callback(__in Z3_theory t, __in Z3_reduce_eq_callback_fptr f);
/**
\brief Set a callback for simplifying the atom <tt>distinct(s_1, ..., s_n)</tt>, when the
sort of \c s_1, ..., \c s_n is an interpreted sort of the given theory.
The callback \c f is invoked by Z3's simplifier.
\conly It has the form <tt>f(t, n, args, r)</tt>, where:
\conly - \c t is the given theory
\conly - \c n is the number of arguments in the array \c args
\conly - \c args are arguments for distinct.
\conly - \c r should contain the result: an expression equivalent to <tt>distinct(s_1, ..., s_n)</tt>.
\conly If <tt>f(t, n, args, r)</tt> returns false, then \c r is ignored, and Z3 assumes that no simplification was performed.
*/
void Z3_API Z3_set_reduce_distinct_callback(__in Z3_theory t, __in Z3_reduce_distinct_callback_fptr f);
/**
\brief Set a callback that is invoked when a theory application
is finally added into the logical context. Note that, not every
application contained in an asserted expression is actually
added into the logical context because it may be simplified
during a preprocessing step.
\conly The callback has the form <tt>f(t, n)</tt>, where
\conly - \c t is the given theory
\conly - \c n is a theory application, that is, an expression of the form <tt>g(...)</tt> where \c g is a theory operator.
\remark An expression \c n added to the logical context at search level \c n,
will remain in the logical context until this level is backtracked.
*/
void Z3_API Z3_set_new_app_callback(__in Z3_theory t, __in Z3_theory_ast_callback_fptr f);
/**
\brief Set a callback that is invoked when an expression of
sort \c s, where \c s is an interpreted sort of the theory \c
t, is finally added into the logical context. Note that, not
every expression contained in an asserted expression is
actually added into the logical context because it may be
simplified during a preprocessing step.
\conly The callback has the form <tt>f(t, n)</tt>, where
\conly - \c t is the given theory
\conly - \c n is an expression of sort \c s, where \c s is an interpreted sort of \c t.
\remark An expression \c n added to the logical context at search level \c n,
will remain in the logical context until this level is backtracked.
*/
void Z3_API Z3_set_new_elem_callback(__in Z3_theory t, __in Z3_theory_ast_callback_fptr f);
/**
\brief Set a callback that is invoked when Z3 starts searching for a
satisfying assignment.
\conly The callback has the form <tt>f(t)</tt>, where
\conly - \c t is the given theory
*/
void Z3_API Z3_set_init_search_callback(__in Z3_theory t, __in Z3_theory_callback_fptr f);
/**
\brief Set a callback that is invoked when Z3 creates a
case-split (aka backtracking point).
When a case-split is created we say the search level is increased.
\conly The callback has the form <tt>f(t)</tt>, where
\conly - \c t is the given theory
*/
void Z3_API Z3_set_push_callback(__in Z3_theory t, __in Z3_theory_callback_fptr f);
/**
\brief Set a callback that is invoked when Z3 backtracks a
case-split.
When a case-split is backtracked we say the search level is decreased.
\conly The callback has the form <tt>f(t)</tt>, where
\conly - \c t is the given theory
*/
void Z3_API Z3_set_pop_callback(__in Z3_theory t, __in Z3_theory_callback_fptr f);
/**
\brief Set a callback that is invoked when Z3 restarts the
search for a satisfying assignment.
\conly The callback has the form <tt>f(t)</tt>, where
\conly - \c t is the given theory
*/
void Z3_API Z3_set_restart_callback(__in Z3_theory t, __in Z3_theory_callback_fptr f);
/**
\brief Set a callback that is invoked when the logical context
is reset by the user. This callback is useful for reseting any
data-structure maintained by the user theory solver.
\conly The callback has the form <tt>f(t)</tt>, where
\conly - \c t is the given theory
*/
void Z3_API Z3_set_reset_callback(__in Z3_theory t, __in Z3_theory_callback_fptr f);
/**
\brief Set a callback that is invoked before Z3 starts building a model.
A theory may use this callback to perform expensive operations.
\conly The callback has the form <tt>f(t)</tt>, where
\conly - \c t is the given theory
If the theory returns \mlonly \c false, \endmlonly \conly \c Z3_false,
Z3 will assume that theory is giving up,
and it will assume that it was not possible to decide if the asserted constraints
are satisfiable or not.
*/
void Z3_API Z3_set_final_check_callback(__in Z3_theory t, __in Z3_theory_final_check_callback_fptr f);
/**
\brief Set a callback that is invoked when an equality <tt>s_1 = s_2</tt>
is found by the logical context.
\conly The callback has the form <tt>f(t, s_1, s_2)</tt>, where:
\conly - \c t is the given theory
\conly - \c s_1 is the left-hand-side
\conly - \c s_2 is the right-hand-side
*/
void Z3_API Z3_set_new_eq_callback(__in Z3_theory t, __in Z3_theory_ast_ast_callback_fptr f);
/**
\brief Set a callback that is invoked when a disequality <tt>s_1 != s_2</tt>
is found by the logical context.
\conly The callback has the form <tt>f(t, s_1, s_2)</tt>, where:
\conly - \c t is the given theory
\conly - \c s_1 is the left-hand-side
\conly - \c s_2 is the right-hand-side
*/
void Z3_API Z3_set_new_diseq_callback(__in Z3_theory t, __in Z3_theory_ast_ast_callback_fptr f);
/**
\brief Set a callback that is invoked when a theory predicate is assigned to true/false by Z3.
\conly The callback has the form <tt>f(t, p, v)</tt>, where:
\conly - \c t is the given theory
\conly - \c p is the assigned predicate.
\conly - \c v is the value (true/false) assigned to \c p.
*/
void Z3_API Z3_set_new_assignment_callback(__in Z3_theory t, __in Z3_theory_ast_bool_callback_fptr f);
/**
\brief Set a callback that is invoked when an expression is
marked as relevant during the search. This callback is only
invoked when relevancy propagation is enabled.
\conly The callback has the form <tt>f(t, n)</tt>, where:
\conly - \c t is the given theory
\conly - \c n is the relevant expression
*/
void Z3_API Z3_set_new_relevant_callback(__in Z3_theory t, __in Z3_theory_ast_callback_fptr f);
#endif
/**
\brief Assert a theory axiom/lemmas during the search.
An axiom added at search level \c n will remain in the logical context until
level \c n is backtracked.
The callbacks for push (#Z3_set_push_callback) and pop
(#Z3_set_pop_callback) can be used to track when the search
level is increased (i.e., new case-split) and decreased (i.e.,
case-split is backtracked).
Z3 tracks the theory axioms asserted. So, multiple assertions of the same axiom are
ignored.
*/
void Z3_API Z3_theory_assert_axiom(__in Z3_theory t, __in Z3_ast ax);
/**
\brief Inform to the logical context that \c lhs and \c rhs have the same interpretation
in the model being built by theory \c t. If lhs = rhs is inconsistent with other theories,
then the logical context will backtrack.
For more information, see the paper "Model-Based Theory Combination" in the Z3 website.
*/
void Z3_API Z3_theory_assume_eq(__in Z3_theory t, __in Z3_ast lhs, __in Z3_ast rhs);
/**
\brief Enable/disable the simplification of theory axioms asserted using #Z3_theory_assert_axiom.
By default, the simplification of theory specific operators is disabled.
That is, the reduce theory callbacks are not invoked for theory axioms.
The default behavior is useful when asserting axioms stating properties of theory operators.
*/
void Z3_API Z3_theory_enable_axiom_simplification(__in Z3_theory t, __in Z3_bool flag);
/**
\brief Return the root of the equivalence class containing \c n.
*/
Z3_ast Z3_API Z3_theory_get_eqc_root(__in Z3_theory t, __in Z3_ast n);
/**
\brief Return the next element in the equivalence class containing \c n.
The elements in an equivalence class are organized in a circular list.
You can traverse the list by calling this function multiple times
using the result from the previous call. This is illustrated in the
code snippet below.
\code
Z3_ast curr = n;
do
curr = Z3_theory_get_eqc_next(theory, curr);
while (curr != n);
\endcode
*/
Z3_ast Z3_API Z3_theory_get_eqc_next(__in Z3_theory t, __in Z3_ast n);
/**
\brief Return the number of parents of \c n that are operators of the given theory.
*/
unsigned Z3_API Z3_theory_get_num_parents(__in Z3_theory t, __in Z3_ast n);
/**
\brief Return the i-th parent of \c n.
See #Z3_theory_get_num_parents.
*/
Z3_ast Z3_API Z3_theory_get_parent(__in Z3_theory t, __in Z3_ast n, __in unsigned i);
/**
\brief Return \c Z3_TRUE if \c n is an interpreted theory value.
*/
Z3_bool Z3_API Z3_theory_is_value(__in Z3_theory t, __in Z3_ast n);
/**
\brief Return \c Z3_TRUE if \c d is an interpreted theory declaration.
*/
Z3_bool Z3_API Z3_theory_is_decl(__in Z3_theory t, __in Z3_func_decl d);
/**
\brief Return the number of expressions of the given theory in
the logical context. These are the expressions notified using the
callback #Z3_set_new_elem_callback.
*/
unsigned Z3_API Z3_theory_get_num_elems(__in Z3_theory t);
/**
\brief Return the i-th elem of the given theory in the logical context.
\see Z3_theory_get_num_elems
*/
Z3_ast Z3_API Z3_theory_get_elem(__in Z3_theory t, __in unsigned i);
/**
\brief Return the number of theory applications in the logical
context. These are the expressions notified using the callback
#Z3_set_new_app_callback.
*/
unsigned Z3_API Z3_theory_get_num_apps(__in Z3_theory t);
/**
\brief Return the i-th application of the given theory in the logical context.
\see Z3_theory_get_num_apps
*/
Z3_ast Z3_API Z3_theory_get_app(__in Z3_theory t, __in unsigned i);
/*@}*/
#endif
#ifdef CorML4
/**
@name Fixedpoint facilities
*/
/*@{*/
/**
\brief Create a new fixedpoint context.
\conly \remark User must use #Z3_fixedpoint_inc_ref and #Z3_fixedpoint_dec_ref to manage fixedpoint objects.
\conly Even if the context was created using #Z3_mk_context instead of #Z3_mk_context_rc.
def_API('Z3_mk_fixedpoint', FIXEDPOINT, (_in(CONTEXT), ))
*/
Z3_fixedpoint Z3_API Z3_mk_fixedpoint(__in Z3_context c);
#ifdef Conly
/**
\brief Increment the reference counter of the given fixedpoint context
def_API('Z3_fixedpoint_inc_ref', VOID, (_in(CONTEXT), _in(FIXEDPOINT)))
*/
void Z3_API Z3_fixedpoint_inc_ref(__in Z3_context c,__in Z3_fixedpoint d);
/**
\brief Decrement the reference counter of the given fixedpoint context.
def_API('Z3_fixedpoint_dec_ref', VOID, (_in(CONTEXT), _in(FIXEDPOINT)))
*/
void Z3_API Z3_fixedpoint_dec_ref(__in Z3_context c,__in Z3_fixedpoint d);
#endif
/**
\brief Add a universal Horn clause as a named rule.
The \c horn_rule should be of the form:
\code
horn_rule ::= (forall (bound-vars) horn_rule)
| (=> atoms horn_rule)
| atom
\endcode
def_API('Z3_fixedpoint_add_rule', VOID, (_in(CONTEXT), _in(FIXEDPOINT), _in(AST), _in(SYMBOL)))
*/
void Z3_API Z3_fixedpoint_add_rule(__in Z3_context c,__in Z3_fixedpoint d, __in Z3_ast rule, __in Z3_symbol name);
/**
\brief Add a Database fact.
\param c - context
\param d - fixed point context
\param r - relation signature for the row.
\param num_args - number of columns for the given row.
\param args - array of the row elements.
The number of arguments \c num_args should be equal to the number
of sorts in the domain of \c r. Each sort in the domain should be an integral
(bit-vector, Boolean or or finite domain sort).
The call has the same effect as adding a rule where \c r is applied to the arguments.
def_API('Z3_fixedpoint_add_fact', VOID, (_in(CONTEXT), _in(FIXEDPOINT), _in(FUNC_DECL), _in(UINT), _in_array(3, UINT)))
*/
void Z3_API Z3_fixedpoint_add_fact(__in Z3_context c,__in Z3_fixedpoint d,
__in Z3_func_decl r,
__in unsigned num_args, __in_ecount(num_args) unsigned args[]);
/**
\brief Assert a constraint to the fixedpoint context.
The constraints are used as background axioms when the fixedpoint engine uses the PDR mode.
They are ignored for standard Datalog mode.
def_API('Z3_fixedpoint_assert', VOID, (_in(CONTEXT), _in(FIXEDPOINT), _in(AST)))
*/
void Z3_API Z3_fixedpoint_assert(__in Z3_context c,__in Z3_fixedpoint d, __in Z3_ast axiom);
/**
\brief Pose a query against the asserted rules.
\code
query ::= (exists (bound-vars) query)
| literals
\endcode
query returns
- Z3_L_FALSE if the query is unsatisfiable.
- Z3_L_TRUE if the query is satisfiable. Obtain the answer by calling #Z3_fixedpoint_get_answer.
- Z3_L_UNDEF if the query was interrupted, timed out or otherwise failed.
def_API('Z3_fixedpoint_query', INT, (_in(CONTEXT), _in(FIXEDPOINT), _in(AST)))
*/
Z3_lbool Z3_API Z3_fixedpoint_query(__in Z3_context c,__in Z3_fixedpoint d, __in Z3_ast query);
/**
\brief Pose multiple queries against the asserted rules.
The queries are encoded as relations (function declarations).
query returns
- Z3_L_FALSE if the query is unsatisfiable.
- Z3_L_TRUE if the query is satisfiable. Obtain the answer by calling #Z3_fixedpoint_get_answer.
- Z3_L_UNDEF if the query was interrupted, timed out or otherwise failed.
def_API('Z3_fixedpoint_query_relations', INT, (_in(CONTEXT), _in(FIXEDPOINT), _in(UINT), _in_array(2, FUNC_DECL)))
*/
Z3_lbool Z3_API Z3_fixedpoint_query_relations(
__in Z3_context c,__in Z3_fixedpoint d,
__in unsigned num_relations, __in_ecount(num_relations) Z3_func_decl const relations[]);
/**
\brief Retrieve a formula that encodes satisfying answers to the query.
When used in Datalog mode, the returned answer is a disjunction of conjuncts.
Each conjunct encodes values of the bound variables of the query that are satisfied.
In PDR mode, the returned answer is a single conjunction.
When used in Datalog mode the previous call to Z3_fixedpoint_query must have returned Z3_L_TRUE.
When used with the PDR engine, the previous call must have been either Z3_L_TRUE or Z3_L_FALSE.
def_API('Z3_fixedpoint_get_answer', AST, (_in(CONTEXT), _in(FIXEDPOINT)))
*/
Z3_ast Z3_API Z3_fixedpoint_get_answer(__in Z3_context c,__in Z3_fixedpoint d);
/**
\brief Retrieve a string that describes the last status returned by #Z3_fixedpoint_query.
Use this method when #Z3_fixedpoint_query returns Z3_L_UNDEF.
def_API('Z3_fixedpoint_get_reason_unknown', STRING, (_in(CONTEXT), _in(FIXEDPOINT) ))
*/
Z3_string Z3_API Z3_fixedpoint_get_reason_unknown(__in Z3_context c,__in Z3_fixedpoint d);
/**
\brief Update a named rule.
A rule with the same name must have been previously created.
def_API('Z3_fixedpoint_update_rule', VOID, (_in(CONTEXT), _in(FIXEDPOINT), _in(AST), _in(SYMBOL)))
*/
void Z3_API Z3_fixedpoint_update_rule(__in Z3_context c, __in Z3_fixedpoint d, __in Z3_ast a, __in Z3_symbol name);
/**
\brief Query the PDR engine for the maximal levels properties are known about predicate.
This call retrieves the maximal number of relevant unfoldings
of \c pred with respect to the current exploration state.
Note: this functionality is PDR specific.
def_API('Z3_fixedpoint_get_num_levels', UINT, (_in(CONTEXT), _in(FIXEDPOINT), _in(FUNC_DECL)))
*/
unsigned Z3_API Z3_fixedpoint_get_num_levels(Z3_context c, Z3_fixedpoint d, Z3_func_decl pred);
/**
Retrieve the current cover of \c pred up to \c level unfoldings.
Return just the delta that is known at \c level. To
obtain the full set of properties of \c pred one should query
at \c level+1 , \c level+2 etc, and include \c level=-1.
Note: this functionality is PDR specific.
def_API('Z3_fixedpoint_get_cover_delta', AST, (_in(CONTEXT), _in(FIXEDPOINT), _in(INT), _in(FUNC_DECL)))
*/
Z3_ast Z3_API Z3_fixedpoint_get_cover_delta(Z3_context c, Z3_fixedpoint d, int level, Z3_func_decl pred);
/**
\brief Add property about the predicate \c pred.
Add a property of predicate \c pred at \c level.
It gets pushed forward when possible.
Note: level = -1 is treated as the fixedpoint. So passing -1 for the \c level
means that the property is true of the fixed-point unfolding with respect to \c pred.
Note: this functionality is PDR specific.
def_API('Z3_fixedpoint_add_cover', VOID, (_in(CONTEXT), _in(FIXEDPOINT), _in(INT), _in(FUNC_DECL), _in(AST)))
*/
void Z3_API Z3_fixedpoint_add_cover(Z3_context c, Z3_fixedpoint d, int level, Z3_func_decl pred, Z3_ast property);
/**
\brief Retrieve statistics information from the last call to #Z3_fixedpoint_query.
def_API('Z3_fixedpoint_get_statistics', STATS, (_in(CONTEXT), _in(FIXEDPOINT)))
*/
Z3_stats Z3_API Z3_fixedpoint_get_statistics(__in Z3_context c,__in Z3_fixedpoint d);
/**
\brief Register relation as Fixedpoint defined.
Fixedpoint defined relations have least-fixedpoint semantics.
For example, the relation is empty if it does not occur
in a head or a fact.
def_API('Z3_fixedpoint_register_relation', VOID, (_in(CONTEXT), _in(FIXEDPOINT), _in(FUNC_DECL)))
*/
void Z3_API Z3_fixedpoint_register_relation(__in Z3_context c,__in Z3_fixedpoint d, __in Z3_func_decl f);
/**
\brief Configure the predicate representation.
It sets the predicate to use a set of domains given by the list of symbols.
The domains given by the list of symbols must belong to a set
of built-in domains.
def_API('Z3_fixedpoint_set_predicate_representation', VOID, (_in(CONTEXT), _in(FIXEDPOINT), _in(FUNC_DECL), _in(UINT), _in_array(3, SYMBOL)))
*/
void Z3_API Z3_fixedpoint_set_predicate_representation(
__in Z3_context c,
__in Z3_fixedpoint d,
__in Z3_func_decl f,
__in unsigned num_relations,
__in_ecount(num_relations) Z3_symbol const relation_kinds[]);
/**
\brief Retrieve set of rules from fixedpoint context.
def_API('Z3_fixedpoint_get_rules', AST_VECTOR, (_in(CONTEXT),_in(FIXEDPOINT)))
*/
Z3_ast_vector Z3_API Z3_fixedpoint_get_rules(
__in Z3_context c,
__in Z3_fixedpoint f);
/**
\brief Retrieve set of background assertions from fixedpoint context.
def_API('Z3_fixedpoint_get_assertions', AST_VECTOR, (_in(CONTEXT),_in(FIXEDPOINT)))
*/
Z3_ast_vector Z3_API Z3_fixedpoint_get_assertions(
__in Z3_context c,
__in Z3_fixedpoint f);
/**
\brief Set parameters on fixedpoint context.
def_API('Z3_fixedpoint_set_params', VOID, (_in(CONTEXT), _in(FIXEDPOINT), _in(PARAMS)))
*/
void Z3_API Z3_fixedpoint_set_params(__in Z3_context c, __in Z3_fixedpoint f, __in Z3_params p);
/**
\brief Return a string describing all fixedpoint available parameters.
def_API('Z3_fixedpoint_get_help', STRING, (_in(CONTEXT), _in(FIXEDPOINT)))
*/
Z3_string Z3_API Z3_fixedpoint_get_help(__in Z3_context c, __in Z3_fixedpoint f);
/**
\brief Return the parameter description set for the given fixedpoint object.
def_API('Z3_fixedpoint_get_param_descrs', PARAM_DESCRS, (_in(CONTEXT), _in(FIXEDPOINT)))
*/
Z3_param_descrs Z3_API Z3_fixedpoint_get_param_descrs(__in Z3_context c, __in Z3_fixedpoint f);
/**
\brief Print the current rules and background axioms as a string.
\param c - context.
\param f - fixedpoint context.
\param num_queries - number of additional queries to print.
\param queries - additional queries.
def_API('Z3_fixedpoint_to_string', STRING, (_in(CONTEXT), _in(FIXEDPOINT), _in(UINT), _in_array(2, AST)))
*/
Z3_string Z3_API Z3_fixedpoint_to_string(
__in Z3_context c,
__in Z3_fixedpoint f,
__in unsigned num_queries,
__in_ecount(num_queries) Z3_ast queries[]);
/**
\brief Parse an SMT-LIB2 string with fixedpoint rules.
Add the rules to the current fixedpoint context.
Return the set of queries in the string.
\param c - context.
\param f - fixedpoint context.
\param s - string containing SMT2 specification.
def_API('Z3_fixedpoint_from_string', AST_VECTOR, (_in(CONTEXT), _in(FIXEDPOINT), _in(STRING)))
*/
Z3_ast_vector Z3_API Z3_fixedpoint_from_string(
__in Z3_context c,
__in Z3_fixedpoint f,
__in Z3_string s);
/**
\brief Parse an SMT-LIB2 file with fixedpoint rules.
Add the rules to the current fixedpoint context.
Return the set of queries in the file.
\param c - context.
\param f - fixedpoint context.
\param s - string containing SMT2 specification.
def_API('Z3_fixedpoint_from_file', AST_VECTOR, (_in(CONTEXT), _in(FIXEDPOINT), _in(STRING)))
*/
Z3_ast_vector Z3_API Z3_fixedpoint_from_file(
__in Z3_context c,
__in Z3_fixedpoint f,
__in Z3_string s);
/**
\brief Create a backtracking point.
The fixedpoint solver contains a set of rules, added facts and assertions.
The set of rules, facts and assertions are restored upon calling #Z3_fixedpoint_pop.
\sa Z3_fixedpoint_pop
def_API('Z3_fixedpoint_push', VOID, (_in(CONTEXT), _in(FIXEDPOINT)))
*/
void Z3_API Z3_fixedpoint_push(Z3_context c,Z3_fixedpoint d);
/**
\brief Backtrack one backtracking point.
\sa Z3_fixedpoint_push
\pre The number of calls to pop cannot exceed calls to push.
def_API('Z3_fixedpoint_pop', VOID, (_in(CONTEXT), _in(FIXEDPOINT)))
*/
void Z3_API Z3_fixedpoint_pop(Z3_context c,Z3_fixedpoint d);
#ifdef Conly
/**
\brief The following utilities allows adding user-defined domains.
*/
typedef void Z3_fixedpoint_reduce_assign_callback_fptr(
__in void*, __in Z3_func_decl,
__in unsigned, __in Z3_ast const [],
__in unsigned, __in Z3_ast const []);
typedef void Z3_fixedpoint_reduce_app_callback_fptr(
__in void*, __in Z3_func_decl,
__in unsigned, __in Z3_ast const [],
__out Z3_ast*);
/**
\brief Initialize the context with a user-defined state.
*/
void Z3_API Z3_fixedpoint_init(__in Z3_context c,__in Z3_fixedpoint d, __in void* state);
/**
\brief Register a callback to destructive updates.
Registers are identified with terms encoded as fresh constants,
*/
void Z3_API Z3_fixedpoint_set_reduce_assign_callback(
__in Z3_context c,__in Z3_fixedpoint d, __in Z3_fixedpoint_reduce_assign_callback_fptr cb);
/**
\brief Register a callback for buildling terms based on
the relational operators.
*/
void Z3_API Z3_fixedpoint_set_reduce_app_callback(
__in Z3_context c,__in Z3_fixedpoint d, __in Z3_fixedpoint_reduce_app_callback_fptr cb);
#endif
#endif
#ifdef CorML4
/**
@name Optimize facilities
*/
/*@{*/
/**
\brief Create a new optimize context.
\conly \remark User must use #Z3_optimize_inc_ref and #Z3_optimize_dec_ref to manage optimize objects.
\conly Even if the context was created using #Z3_mk_context instead of #Z3_mk_context_rc.
def_API('Z3_mk_optimize', OPTIMIZE, (_in(CONTEXT), ))
*/
Z3_optimize Z3_API Z3_mk_optimize(__in Z3_context c);
#ifdef Conly
/**
\brief Increment the reference counter of the given optimize context
def_API('Z3_optimize_inc_ref', VOID, (_in(CONTEXT), _in(OPTIMIZE)))
*/
void Z3_API Z3_optimize_inc_ref(__in Z3_context c,__in Z3_optimize d);
/**
\brief Decrement the reference counter of the given optimize context.
def_API('Z3_optimize_dec_ref', VOID, (_in(CONTEXT), _in(OPTIMIZE)))
*/
void Z3_API Z3_optimize_dec_ref(__in Z3_context c,__in Z3_optimize d);
#endif
/**
\brief Assert hard constraint to the optimization context.
def_API('Z3_optimize_assert', VOID, (_in(CONTEXT), _in(OPTIMIZE), _in(AST)))
*/
void Z3_API Z3_optimize_assert(Z3_context c, Z3_optimize o, Z3_ast a);
/**
\brief Assert soft constraint to the optimization context.
\param c - context
\param o - optimization context
\param a - formula
\param weight - a positive weight, penalty for violating soft constraint
\param id - optional identifier to group soft constraints
def_API('Z3_optimize_assert_soft', UINT, (_in(CONTEXT), _in(OPTIMIZE), _in(AST), _in(STRING), _in(SYMBOL)))
*/
unsigned Z3_API Z3_optimize_assert_soft(Z3_context c, Z3_optimize o, Z3_ast a, Z3_string weight, Z3_symbol id);
/**
\brief Add a maximization constraint.
\param c - context
\param o - optimization context
\param a - arithmetical term
def_API('Z3_optimize_maximize', UINT, (_in(CONTEXT), _in(OPTIMIZE), _in(AST)))
*/
unsigned Z3_API Z3_optimize_maximize(Z3_context c, Z3_optimize o, Z3_ast t);
/**
\brief Add a minimization constraint.
\param c - context
\param o - optimization context
\param a - arithmetical term
def_API('Z3_optimize_minimize', UINT, (_in(CONTEXT), _in(OPTIMIZE), _in(AST)))
*/
unsigned Z3_API Z3_optimize_minimize(Z3_context c, Z3_optimize o, Z3_ast t);
/**
\brief Create a backtracking point.
The optimize solver contains a set of rules, added facts and assertions.
The set of rules, facts and assertions are restored upon calling #Z3_optimize_pop.
\sa Z3_optimize_pop
def_API('Z3_optimize_push', VOID, (_in(CONTEXT), _in(OPTIMIZE)))
*/
void Z3_API Z3_optimize_push(Z3_context c,Z3_optimize d);
/**
\brief Backtrack one level.
\sa Z3_optimize_push
\pre The number of calls to pop cannot exceed calls to push.
def_API('Z3_optimize_pop', VOID, (_in(CONTEXT), _in(OPTIMIZE)))
*/
void Z3_API Z3_optimize_pop(Z3_context c,Z3_optimize d);
/**
\brief Check consistency and produce optimal values.
\param c - context
\param o - optimization context
def_API('Z3_optimize_check', INT, (_in(CONTEXT), _in(OPTIMIZE)))
*/
Z3_lbool Z3_API Z3_optimize_check(Z3_context c, Z3_optimize o);
/**
\brief Retrieve the model for the last #Z3_optimize_check
The error handler is invoked if a model is not available because
the commands above were not invoked for the given optimization
solver, or if the result was \c Z3_L_FALSE.
def_API('Z3_optimize_get_model', MODEL, (_in(CONTEXT), _in(OPTIMIZE)))
*/
Z3_model Z3_API Z3_optimize_get_model(Z3_context c, Z3_optimize o);
/**
\brief Set parameters on optimization context.
\param c - context
\param o - optimization context
\param p - parameters
def_API('Z3_optimize_set_params', VOID, (_in(CONTEXT), _in(OPTIMIZE), _in(PARAMS)))
*/
void Z3_API Z3_optimize_set_params(Z3_context c, Z3_optimize o, Z3_params p);
/**
\brief Return the parameter description set for the given optimize object.
\param c - context
\param o - optimization context
def_API('Z3_optimize_get_param_descrs', PARAM_DESCRS, (_in(CONTEXT), _in(OPTIMIZE)))
*/
Z3_param_descrs Z3_API Z3_optimize_get_param_descrs(Z3_context c, Z3_optimize o);
/**
\brief Retrieve lower bound value or approximation for the i'th optimization objective.
\param c - context
\param o - optimization context
\param idx - index of optimization objective
def_API('Z3_optimize_get_lower', AST, (_in(CONTEXT), _in(OPTIMIZE), _in(UINT)))
*/
Z3_ast Z3_API Z3_optimize_get_lower(Z3_context c, Z3_optimize o, unsigned idx);
/**
\brief Retrieve upper bound value or approximation for the i'th optimization objective.
\param c - context
\param o - optimization context
\param idx - index of optimization objective
def_API('Z3_optimize_get_upper', AST, (_in(CONTEXT), _in(OPTIMIZE), _in(UINT)))
*/
Z3_ast Z3_API Z3_optimize_get_upper(Z3_context c, Z3_optimize o, unsigned idx);
/**
\brief Print the current context as a string.
\param c - context.
\param o - optimization context.
def_API('Z3_optimize_to_string', STRING, (_in(CONTEXT), _in(OPTIMIZE)))
*/
Z3_string Z3_API Z3_optimize_to_string(
__in Z3_context c,
__in Z3_optimize o);
/**
\brief Return a string containing a description of parameters accepted by optimize.
def_API('Z3_optimize_get_help', STRING, (_in(CONTEXT), _in(OPTIMIZE)))
*/
Z3_string Z3_API Z3_optimize_get_help(__in Z3_context c, __in Z3_optimize t);
/**
\brief Retrieve statistics information from the last call to #Z3_optimize_check
def_API('Z3_optimize_get_statistics', STATS, (_in(CONTEXT), _in(OPTIMIZE)))
*/
Z3_stats Z3_API Z3_optimize_get_statistics(__in Z3_context c,__in Z3_optimize d);
#endif
#ifdef CorML4
/*@}*/
/**
@name AST vectors
*/
/*@{*/
/**
\brief Return an empty AST vector.
\conly \remark Reference counting must be used to manage AST vectors, even when the Z3_context was
\conly created using #Z3_mk_context instead of #Z3_mk_context_rc.
def_API('Z3_mk_ast_vector', AST_VECTOR, (_in(CONTEXT),))
*/
Z3_ast_vector Z3_API Z3_mk_ast_vector(__in Z3_context c);
#ifdef Conly
/**
\brief Increment the reference counter of the given AST vector.
def_API('Z3_ast_vector_inc_ref', VOID, (_in(CONTEXT), _in(AST_VECTOR)))
*/
void Z3_API Z3_ast_vector_inc_ref(__in Z3_context c, __in Z3_ast_vector v);
/**
\brief Decrement the reference counter of the given AST vector.
def_API('Z3_ast_vector_dec_ref', VOID, (_in(CONTEXT), _in(AST_VECTOR)))
*/
void Z3_API Z3_ast_vector_dec_ref(__in Z3_context c, __in Z3_ast_vector v);
#endif
/**
\brief Return the size of the given AST vector.
def_API('Z3_ast_vector_size', UINT, (_in(CONTEXT), _in(AST_VECTOR)))
*/
unsigned Z3_API Z3_ast_vector_size(__in Z3_context c, __in Z3_ast_vector v);
/**
\brief Return the AST at position \c i in the AST vector \c v.
\pre i < Z3_ast_vector_size(c, v)
def_API('Z3_ast_vector_get', AST, (_in(CONTEXT), _in(AST_VECTOR), _in(UINT)))
*/
Z3_ast Z3_API Z3_ast_vector_get(__in Z3_context c, __in Z3_ast_vector v, __in unsigned i);
/**
\brief Update position \c i of the AST vector \c v with the AST \c a.
\pre i < Z3_ast_vector_size(c, v)
def_API('Z3_ast_vector_set', VOID, (_in(CONTEXT), _in(AST_VECTOR), _in(UINT), _in(AST)))
*/
void Z3_API Z3_ast_vector_set(__in Z3_context c, __in Z3_ast_vector v, __in unsigned i, __in Z3_ast a);
/**
\brief Resize the AST vector \c v.
def_API('Z3_ast_vector_resize', VOID, (_in(CONTEXT), _in(AST_VECTOR), _in(UINT)))
*/
void Z3_API Z3_ast_vector_resize(__in Z3_context c, __in Z3_ast_vector v, __in unsigned n);
/**
\brief Add the AST \c a in the end of the AST vector \c v. The size of \c v is increased by one.
def_API('Z3_ast_vector_push', VOID, (_in(CONTEXT), _in(AST_VECTOR), _in(AST)))
*/
void Z3_API Z3_ast_vector_push(__in Z3_context c, __in Z3_ast_vector v, __in Z3_ast a);
/**
\brief Translate the AST vector \c v from context \c s into an AST vector in context \c t.
def_API('Z3_ast_vector_translate', AST_VECTOR, (_in(CONTEXT), _in(AST_VECTOR), _in(CONTEXT)))
*/
Z3_ast_vector Z3_API Z3_ast_vector_translate(__in Z3_context s, __in Z3_ast_vector v, __in Z3_context t);
/**
\brief Convert AST vector into a string.
def_API('Z3_ast_vector_to_string', STRING, (_in(CONTEXT), _in(AST_VECTOR)))
*/
Z3_string Z3_API Z3_ast_vector_to_string(__in Z3_context c, __in Z3_ast_vector v);
/*@}*/
/**
@name AST maps
*/
/*@{*/
/**
\brief Return an empty mapping from AST to AST
\conly \remark Reference counting must be used to manage AST maps, even when the Z3_context was
\conly created using #Z3_mk_context instead of #Z3_mk_context_rc.
def_API('Z3_mk_ast_map', AST_MAP, (_in(CONTEXT),) )
*/
Z3_ast_map Z3_API Z3_mk_ast_map(__in Z3_context c);
#ifdef Conly
/**
\brief Increment the reference counter of the given AST map.
def_API('Z3_ast_map_inc_ref', VOID, (_in(CONTEXT), _in(AST_MAP)))
*/
void Z3_API Z3_ast_map_inc_ref(__in Z3_context c, __in Z3_ast_map m);
/**
\brief Decrement the reference counter of the given AST map.
def_API('Z3_ast_map_dec_ref', VOID, (_in(CONTEXT), _in(AST_MAP)))
*/
void Z3_API Z3_ast_map_dec_ref(__in Z3_context c, __in Z3_ast_map m);
#endif
/**
\brief Return true if the map \c m contains the AST key \c k.
def_API('Z3_ast_map_contains', BOOL, (_in(CONTEXT), _in(AST_MAP), _in(AST)))
*/
Z3_bool Z3_API Z3_ast_map_contains(__in Z3_context c, __in Z3_ast_map m, __in Z3_ast k);
/**
\brief Return the value associated with the key \c k.
The procedure invokes the error handler if \c k is not in the map.
def_API('Z3_ast_map_find', AST, (_in(CONTEXT), _in(AST_MAP), _in(AST)))
*/
Z3_ast Z3_API Z3_ast_map_find(__in Z3_context c, __in Z3_ast_map m, __in Z3_ast k);
/**
\brief Store/Replace a new key, value pair in the given map.
def_API('Z3_ast_map_insert', VOID, (_in(CONTEXT), _in(AST_MAP), _in(AST), _in(AST)))
*/
void Z3_API Z3_ast_map_insert(__in Z3_context c, __in Z3_ast_map m, __in Z3_ast k, __in Z3_ast v);
/**
\brief Erase a key from the map.
def_API('Z3_ast_map_erase', VOID, (_in(CONTEXT), _in(AST_MAP), _in(AST)))
*/
void Z3_API Z3_ast_map_erase(__in Z3_context c, __in Z3_ast_map m, __in Z3_ast k);
/**
\brief Remove all keys from the given map.
def_API('Z3_ast_map_reset', VOID, (_in(CONTEXT), _in(AST_MAP)))
*/
void Z3_API Z3_ast_map_reset(__in Z3_context c, __in Z3_ast_map m);
/**
\brief Return the size of the given map.
def_API('Z3_ast_map_size', UINT, (_in(CONTEXT), _in(AST_MAP)))
*/
unsigned Z3_API Z3_ast_map_size(__in Z3_context c, __in Z3_ast_map m);
/**
\brief Return the keys stored in the given map.
def_API('Z3_ast_map_keys', AST_VECTOR, (_in(CONTEXT), _in(AST_MAP)))
*/
Z3_ast_vector Z3_API Z3_ast_map_keys(__in Z3_context c, __in Z3_ast_map m);
/**
\brief Convert the given map into a string.
def_API('Z3_ast_map_to_string', STRING, (_in(CONTEXT), _in(AST_MAP)))
*/
Z3_string Z3_API Z3_ast_map_to_string(__in Z3_context c, __in Z3_ast_map m);
/*@}*/
/**
@name Goals
*/
/*@{*/
/**
\brief Create a goal (aka problem). A goal is essentially a set
of formulas, that can be solved and/or transformed using
tactics and solvers.
If models == true, then model generation is enabled for the new goal.
If unsat_cores == true, then unsat core generation is enabled for the new goal.
If proofs == true, then proof generation is enabled for the new goal. Remark, the
Z3 context c must have been created with proof generation support.
\conly \remark Reference counting must be used to manage goals, even when the Z3_context was
\conly created using #Z3_mk_context instead of #Z3_mk_context_rc.
def_API('Z3_mk_goal', GOAL, (_in(CONTEXT), _in(BOOL), _in(BOOL), _in(BOOL)))
*/
Z3_goal Z3_API Z3_mk_goal(__in Z3_context c, __in Z3_bool models, __in Z3_bool unsat_cores, __in Z3_bool proofs);
#ifdef Conly
/**
\brief Increment the reference counter of the given goal.
def_API('Z3_goal_inc_ref', VOID, (_in(CONTEXT), _in(GOAL)))
*/
void Z3_API Z3_goal_inc_ref(__in Z3_context c, __in Z3_goal g);
/**
\brief Decrement the reference counter of the given goal.
def_API('Z3_goal_dec_ref', VOID, (_in(CONTEXT), _in(GOAL)))
*/
void Z3_API Z3_goal_dec_ref(__in Z3_context c, __in Z3_goal g);
#endif
/**
\brief Return the "precision" of the given goal. Goals can be transformed using over and under approximations.
A under approximation is applied when the objective is to find a model for a given goal.
An over approximation is applied when the objective is to find a proof for a given goal.
def_API('Z3_goal_precision', UINT, (_in(CONTEXT), _in(GOAL)))
*/
Z3_goal_prec Z3_API Z3_goal_precision(__in Z3_context c, __in Z3_goal g);
/**
\brief Add a new formula \c a to the given goal.
def_API('Z3_goal_assert', VOID, (_in(CONTEXT), _in(GOAL), _in(AST)))
*/
void Z3_API Z3_goal_assert(__in Z3_context c, __in Z3_goal g, __in Z3_ast a);
/**
\brief Return true if the given goal contains the formula \c false.
def_API('Z3_goal_inconsistent', BOOL, (_in(CONTEXT), _in(GOAL)))
*/
Z3_bool Z3_API Z3_goal_inconsistent(__in Z3_context c, __in Z3_goal g);
/**
\brief Return the depth of the given goal. It tracks how many transformations were applied to it.
def_API('Z3_goal_depth', UINT, (_in(CONTEXT), _in(GOAL)))
*/
unsigned Z3_API Z3_goal_depth(__in Z3_context c, __in Z3_goal g);
/**
\brief Erase all formulas from the given goal.
def_API('Z3_goal_reset', VOID, (_in(CONTEXT), _in(GOAL)))
*/
void Z3_API Z3_goal_reset(__in Z3_context c, __in Z3_goal g);
/**
\brief Return the number of formulas in the given goal.
def_API('Z3_goal_size', UINT, (_in(CONTEXT), _in(GOAL)))
*/
unsigned Z3_API Z3_goal_size(__in Z3_context c, __in Z3_goal g);
/**
\brief Return a formula from the given goal.
\pre idx < Z3_goal_size(c, g)
def_API('Z3_goal_formula', AST, (_in(CONTEXT), _in(GOAL), _in(UINT)))
*/
Z3_ast Z3_API Z3_goal_formula(__in Z3_context c, __in Z3_goal g, __in unsigned idx);
/**
\brief Return the number of formulas, subformulas and terms in the given goal.
def_API('Z3_goal_num_exprs', UINT, (_in(CONTEXT), _in(GOAL)))
*/
unsigned Z3_API Z3_goal_num_exprs(__in Z3_context c, __in Z3_goal g);
/**
\brief Return true if the goal is empty, and it is precise or the product of a under approximation.
def_API('Z3_goal_is_decided_sat', BOOL, (_in(CONTEXT), _in(GOAL)))
*/
Z3_bool Z3_API Z3_goal_is_decided_sat(__in Z3_context c, __in Z3_goal g);
/**
\brief Return true if the goal contains false, and it is precise or the product of an over approximation.
def_API('Z3_goal_is_decided_unsat', BOOL, (_in(CONTEXT), _in(GOAL)))
*/
Z3_bool Z3_API Z3_goal_is_decided_unsat(__in Z3_context c, __in Z3_goal g);
/**
\brief Copy a goal \c g from the context \c source to a the context \c target.
def_API('Z3_goal_translate', GOAL, (_in(CONTEXT), _in(GOAL), _in(CONTEXT)))
*/
Z3_goal Z3_API Z3_goal_translate(__in Z3_context source, __in Z3_goal g, __in Z3_context target);
/**
\brief Convert a goal into a string.
def_API('Z3_goal_to_string', STRING, (_in(CONTEXT), _in(GOAL)))
*/
Z3_string Z3_API Z3_goal_to_string(__in Z3_context c, __in Z3_goal g);
/*@}*/
/**
@name Tactics and Probes
*/
/*@{*/
/**
\brief Return a tactic associated with the given name.
The complete list of tactics may be obtained using the procedures #Z3_get_num_tactics and #Z3_get_tactic_name.
It may also be obtained using the command <tt>(help-tactics)</tt> in the SMT 2.0 front-end.
Tactics are the basic building block for creating custom solvers for specific problem domains.
def_API('Z3_mk_tactic', TACTIC, (_in(CONTEXT), _in(STRING)))
*/
Z3_tactic Z3_API Z3_mk_tactic(__in Z3_context c, __in Z3_string name);
#ifdef Conly
/**
\brief Increment the reference counter of the given tactic.
def_API('Z3_tactic_inc_ref', VOID, (_in(CONTEXT), _in(TACTIC)))
*/
void Z3_API Z3_tactic_inc_ref(__in Z3_context c, __in Z3_tactic t);
/**
\brief Decrement the reference counter of the given tactic.
def_API('Z3_tactic_dec_ref', VOID, (_in(CONTEXT), _in(TACTIC)))
*/
void Z3_API Z3_tactic_dec_ref(__in Z3_context c, __in Z3_tactic g);
#endif
/**
\brief Return a probe associated with the given name.
The complete list of probes may be obtained using the procedures #Z3_get_num_probes and #Z3_get_probe_name.
It may also be obtained using the command <tt>(help-tactics)</tt> in the SMT 2.0 front-end.
Probes are used to inspect a goal (aka problem) and collect information that may be used to decide
which solver and/or preprocessing step will be used.
def_API('Z3_mk_probe', PROBE, (_in(CONTEXT), _in(STRING)))
*/
Z3_probe Z3_API Z3_mk_probe(__in Z3_context c, __in Z3_string name);
#ifdef Conly
/**
\brief Increment the reference counter of the given probe.
def_API('Z3_probe_inc_ref', VOID, (_in(CONTEXT), _in(PROBE)))
*/
void Z3_API Z3_probe_inc_ref(__in Z3_context c, __in Z3_probe p);
/**
\brief Decrement the reference counter of the given probe.
def_API('Z3_probe_dec_ref', VOID, (_in(CONTEXT), _in(PROBE)))
*/
void Z3_API Z3_probe_dec_ref(__in Z3_context c, __in Z3_probe p);
#endif
/**
\brief Return a tactic that applies \c t1 to a given goal and \c t2
to every subgoal produced by t1.
def_API('Z3_tactic_and_then', TACTIC, (_in(CONTEXT), _in(TACTIC), _in(TACTIC)))
*/
Z3_tactic Z3_API Z3_tactic_and_then(__in Z3_context c, __in Z3_tactic t1, __in Z3_tactic t2);
/**
\brief Return a tactic that first applies \c t1 to a given goal,
if it fails then returns the result of \c t2 applied to the given goal.
def_API('Z3_tactic_or_else', TACTIC, (_in(CONTEXT), _in(TACTIC), _in(TACTIC)))
*/
Z3_tactic Z3_API Z3_tactic_or_else(__in Z3_context c, __in Z3_tactic t1, __in Z3_tactic t2);
/**
\brief Return a tactic that applies the given tactics in parallel.
def_API('Z3_tactic_par_or', TACTIC, (_in(CONTEXT), _in(UINT), _in_array(1, TACTIC)))
*/
Z3_tactic Z3_API Z3_tactic_par_or(__in Z3_context c, __in unsigned num, __in_ecount(num) Z3_tactic const ts[]);
/**
\brief Return a tactic that applies \c t1 to a given goal and then \c t2
to every subgoal produced by t1. The subgoals are processed in parallel.
def_API('Z3_tactic_par_and_then', TACTIC, (_in(CONTEXT), _in(TACTIC), _in(TACTIC)))
*/
Z3_tactic Z3_API Z3_tactic_par_and_then(__in Z3_context c, __in Z3_tactic t1, __in Z3_tactic t2);
/**
\brief Return a tactic that applies \c t to a given goal for \c ms milliseconds.
If \c t does not terminate in \c ms milliseconds, then it fails.
def_API('Z3_tactic_try_for', TACTIC, (_in(CONTEXT), _in(TACTIC), _in(UINT)))
*/
Z3_tactic Z3_API Z3_tactic_try_for(__in Z3_context c, __in Z3_tactic t, __in unsigned ms);
/**
\brief Return a tactic that applies \c t to a given goal is the probe \c p evaluates to true.
If \c p evaluates to false, then the new tactic behaves like the skip tactic.
def_API('Z3_tactic_when', TACTIC, (_in(CONTEXT), _in(PROBE), _in(TACTIC)))
*/
Z3_tactic Z3_API Z3_tactic_when(__in Z3_context c, __in Z3_probe p, __in Z3_tactic t);
/**
\brief Return a tactic that applies \c t1 to a given goal if the probe \c p evaluates to true,
and \c t2 if \c p evaluates to false.
def_API('Z3_tactic_cond', TACTIC, (_in(CONTEXT), _in(PROBE), _in(TACTIC), _in(TACTIC)))
*/
Z3_tactic Z3_API Z3_tactic_cond(__in Z3_context c, __in Z3_probe p, __in Z3_tactic t1, __in Z3_tactic t2);
/**
\brief Return a tactic that keeps applying \c t until the goal is not modified anymore or the maximum
number of iterations \c max is reached.
def_API('Z3_tactic_repeat', TACTIC, (_in(CONTEXT), _in(TACTIC), _in(UINT)))
*/
Z3_tactic Z3_API Z3_tactic_repeat(__in Z3_context c, __in Z3_tactic t, unsigned max);
/**
\brief Return a tactic that just return the given goal.
def_API('Z3_tactic_skip', TACTIC, (_in(CONTEXT),))
*/
Z3_tactic Z3_API Z3_tactic_skip(__in Z3_context c);
/**
\brief Return a tactic that always fails.
def_API('Z3_tactic_fail', TACTIC, (_in(CONTEXT),))
*/
Z3_tactic Z3_API Z3_tactic_fail(__in Z3_context c);
/**
\brief Return a tactic that fails if the probe \c p evaluates to false.
def_API('Z3_tactic_fail_if', TACTIC, (_in(CONTEXT), _in(PROBE)))
*/
Z3_tactic Z3_API Z3_tactic_fail_if(__in Z3_context c, __in Z3_probe p);
/**
\brief Return a tactic that fails if the goal is not trivially satisfiable (i.e., empty) or
trivially unsatisfiable (i.e., contains false).
def_API('Z3_tactic_fail_if_not_decided', TACTIC, (_in(CONTEXT),))
*/
Z3_tactic Z3_API Z3_tactic_fail_if_not_decided(__in Z3_context c);
/**
\brief Return a tactic that applies \c t using the given set of parameters.
def_API('Z3_tactic_using_params', TACTIC, (_in(CONTEXT), _in(TACTIC), _in(PARAMS)))
*/
Z3_tactic Z3_API Z3_tactic_using_params(__in Z3_context c, __in Z3_tactic t, __in Z3_params p);
/**
\brief Return a probe that always evaluates to val.
def_API('Z3_probe_const', PROBE, (_in(CONTEXT), _in(DOUBLE)))
*/
Z3_probe Z3_API Z3_probe_const(__in Z3_context x, __in double val);
/**
\brief Return a probe that evaluates to "true" when the value returned by \c p1 is less than the value returned by \c p2.
\remark For probes, "true" is any value different from 0.0.
def_API('Z3_probe_lt', PROBE, (_in(CONTEXT), _in(PROBE), _in(PROBE)))
*/
Z3_probe Z3_API Z3_probe_lt(__in Z3_context x, __in Z3_probe p1, __in Z3_probe p2);
/**
\brief Return a probe that evaluates to "true" when the value returned by \c p1 is greater than the value returned by \c p2.
\remark For probes, "true" is any value different from 0.0.
def_API('Z3_probe_gt', PROBE, (_in(CONTEXT), _in(PROBE), _in(PROBE)))
*/
Z3_probe Z3_API Z3_probe_gt(__in Z3_context x, __in Z3_probe p1, __in Z3_probe p2);
/**
\brief Return a probe that evaluates to "true" when the value returned by \c p1 is less than or equal to the value returned by \c p2.
\remark For probes, "true" is any value different from 0.0.
def_API('Z3_probe_le', PROBE, (_in(CONTEXT), _in(PROBE), _in(PROBE)))
*/
Z3_probe Z3_API Z3_probe_le(__in Z3_context x, __in Z3_probe p1, __in Z3_probe p2);
/**
\brief Return a probe that evaluates to "true" when the value returned by \c p1 is greater than or equal to the value returned by \c p2.
\remark For probes, "true" is any value different from 0.0.
def_API('Z3_probe_ge', PROBE, (_in(CONTEXT), _in(PROBE), _in(PROBE)))
*/
Z3_probe Z3_API Z3_probe_ge(__in Z3_context x, __in Z3_probe p1, __in Z3_probe p2);
/**
\brief Return a probe that evaluates to "true" when the value returned by \c p1 is equal to the value returned by \c p2.
\remark For probes, "true" is any value different from 0.0.
def_API('Z3_probe_eq', PROBE, (_in(CONTEXT), _in(PROBE), _in(PROBE)))
*/
Z3_probe Z3_API Z3_probe_eq(__in Z3_context x, __in Z3_probe p1, __in Z3_probe p2);
/**
\brief Return a probe that evaluates to "true" when \c p1 and \c p2 evaluates to true.
\remark For probes, "true" is any value different from 0.0.
def_API('Z3_probe_and', PROBE, (_in(CONTEXT), _in(PROBE), _in(PROBE)))
*/
Z3_probe Z3_API Z3_probe_and(__in Z3_context x, __in Z3_probe p1, __in Z3_probe p2);
/**
\brief Return a probe that evaluates to "true" when \c p1 or \c p2 evaluates to true.
\remark For probes, "true" is any value different from 0.0.
def_API('Z3_probe_or', PROBE, (_in(CONTEXT), _in(PROBE), _in(PROBE)))
*/
Z3_probe Z3_API Z3_probe_or(__in Z3_context x, __in Z3_probe p1, __in Z3_probe p2);
/**
\brief Return a probe that evaluates to "true" when \c p does not evaluate to true.
\remark For probes, "true" is any value different from 0.0.
def_API('Z3_probe_not', PROBE, (_in(CONTEXT), _in(PROBE)))
*/
Z3_probe Z3_API Z3_probe_not(__in Z3_context x, __in Z3_probe p);
/**
\brief Return the number of builtin tactics available in Z3.
def_API('Z3_get_num_tactics', UINT, (_in(CONTEXT),))
*/
unsigned Z3_API Z3_get_num_tactics(__in Z3_context c);
/**
\brief Return the name of the idx tactic.
\pre i < Z3_get_num_tactics(c)
def_API('Z3_get_tactic_name', STRING, (_in(CONTEXT), _in(UINT)))
*/
Z3_string Z3_API Z3_get_tactic_name(__in Z3_context c, unsigned i);
/**
\brief Return the number of builtin probes available in Z3.
def_API('Z3_get_num_probes', UINT, (_in(CONTEXT),))
*/
unsigned Z3_API Z3_get_num_probes(__in Z3_context c);
/**
\brief Return the name of the i probe.
\pre i < Z3_get_num_probes(c)
def_API('Z3_get_probe_name', STRING, (_in(CONTEXT), _in(UINT)))
*/
Z3_string Z3_API Z3_get_probe_name(__in Z3_context c, unsigned i);
/**
\brief Return a string containing a description of parameters accepted by the given tactic.
def_API('Z3_tactic_get_help', STRING, (_in(CONTEXT), _in(TACTIC)))
*/
Z3_string Z3_API Z3_tactic_get_help(__in Z3_context c, __in Z3_tactic t);
/**
\brief Return the parameter description set for the given tactic object.
def_API('Z3_tactic_get_param_descrs', PARAM_DESCRS, (_in(CONTEXT), _in(TACTIC)))
*/
Z3_param_descrs Z3_API Z3_tactic_get_param_descrs(__in Z3_context c, __in Z3_tactic t);
/**
\brief Return a string containing a description of the tactic with the given name.
def_API('Z3_tactic_get_descr', STRING, (_in(CONTEXT), _in(STRING)))
*/
Z3_string Z3_API Z3_tactic_get_descr(__in Z3_context c, __in Z3_string name);
/**
\brief Return a string containing a description of the probe with the given name.
def_API('Z3_probe_get_descr', STRING, (_in(CONTEXT), _in(STRING)))
*/
Z3_string Z3_API Z3_probe_get_descr(__in Z3_context c, __in Z3_string name);
/**
\brief Execute the probe over the goal. The probe always produce a double value.
"Boolean" probes return 0.0 for false, and a value different from 0.0 for true.
def_API('Z3_probe_apply', DOUBLE, (_in(CONTEXT), _in(PROBE), _in(GOAL)))
*/
double Z3_API Z3_probe_apply(__in Z3_context c, __in Z3_probe p, __in Z3_goal g);
/**
\brief Apply tactic \c t to the goal \c g.
def_API('Z3_tactic_apply', APPLY_RESULT, (_in(CONTEXT), _in(TACTIC), _in(GOAL)))
*/
Z3_apply_result Z3_API Z3_tactic_apply(__in Z3_context c, __in Z3_tactic t, __in Z3_goal g);
/**
\brief Apply tactic \c t to the goal \c g using the parameter set \c p.
def_API('Z3_tactic_apply_ex', APPLY_RESULT, (_in(CONTEXT), _in(TACTIC), _in(GOAL), _in(PARAMS)))
*/
Z3_apply_result Z3_API Z3_tactic_apply_ex(Z3_context c, Z3_tactic t, Z3_goal g, Z3_params p);
#ifdef CorML3
/**
\brief Increment the reference counter of the given \c Z3_apply_result object.
def_API('Z3_apply_result_inc_ref', VOID, (_in(CONTEXT), _in(APPLY_RESULT)))
*/
void Z3_API Z3_apply_result_inc_ref(__in Z3_context c, __in Z3_apply_result r);
/**
\brief Decrement the reference counter of the given \c Z3_apply_result object.
def_API('Z3_apply_result_dec_ref', VOID, (_in(CONTEXT), _in(APPLY_RESULT)))
*/
void Z3_API Z3_apply_result_dec_ref(__in Z3_context c, __in Z3_apply_result r);
#endif
/**
\brief Convert the \c Z3_apply_result object returned by #Z3_tactic_apply into a string.
def_API('Z3_apply_result_to_string', STRING, (_in(CONTEXT), _in(APPLY_RESULT)))
*/
Z3_string Z3_API Z3_apply_result_to_string(__in Z3_context c, __in Z3_apply_result r);
/**
\brief Return the number of subgoals in the \c Z3_apply_result object returned by #Z3_tactic_apply.
def_API('Z3_apply_result_get_num_subgoals', UINT, (_in(CONTEXT), _in(APPLY_RESULT)))
*/
unsigned Z3_API Z3_apply_result_get_num_subgoals(__in Z3_context c, __in Z3_apply_result r);
/**
\brief Return one of the subgoals in the \c Z3_apply_result object returned by #Z3_tactic_apply.
\pre i < Z3_apply_result_get_num_subgoals(c, r)
def_API('Z3_apply_result_get_subgoal', GOAL, (_in(CONTEXT), _in(APPLY_RESULT), _in(UINT)))
*/
Z3_goal Z3_API Z3_apply_result_get_subgoal(__in Z3_context c, __in Z3_apply_result r, __in unsigned i);
/**
\brief Convert a model for the subgoal \c Z3_apply_result_get_subgoal(c, r, i) into a model for the original goal \c g.
Where \c g is the goal used to create \c r using \c Z3_tactic_apply(c, t, g).
def_API('Z3_apply_result_convert_model', MODEL, (_in(CONTEXT), _in(APPLY_RESULT), _in(UINT), _in(MODEL)))
*/
Z3_model Z3_API Z3_apply_result_convert_model(__in Z3_context c, __in Z3_apply_result r, __in unsigned i, __in Z3_model m);
/*@}*/
/**
@name Solvers
*/
/*@{*/
/**
\brief Create a new (incremental) solver. This solver also uses a
set of builtin tactics for handling the first check-sat command, and
check-sat commands that take more than a given number of milliseconds to be solved.
\conly \remark User must use #Z3_solver_inc_ref and #Z3_solver_dec_ref to manage solver objects.
\conly Even if the context was created using #Z3_mk_context instead of #Z3_mk_context_rc.
def_API('Z3_mk_solver', SOLVER, (_in(CONTEXT),))
*/
Z3_solver Z3_API Z3_mk_solver(__in Z3_context c);
/**
\brief Create a new (incremental) solver.
The function #Z3_solver_get_model retrieves a model if the
assertions is satisfiable (i.e., the result is \c
Z3_L_TRUE) and model construction is enabled.
The function #Z3_solver_get_model can also be used even
if the result is \c Z3_L_UNDEF, but the returned model
is not guaranteed to satisfy quantified assertions.
def_API('Z3_mk_simple_solver', SOLVER, (_in(CONTEXT),))
*/
Z3_solver Z3_API Z3_mk_simple_solver(__in Z3_context c);
/**
\brief Create a new solver customized for the given logic.
It behaves like #Z3_mk_solver if the logic is unknown or unsupported.
\conly \remark User must use #Z3_solver_inc_ref and #Z3_solver_dec_ref to manage solver objects.
\conly Even if the context was created using #Z3_mk_context instead of #Z3_mk_context_rc.
def_API('Z3_mk_solver_for_logic', SOLVER, (_in(CONTEXT), _in(SYMBOL)))
*/
Z3_solver Z3_API Z3_mk_solver_for_logic(__in Z3_context c, __in Z3_symbol logic);
/**
\brief Create a new solver that is implemented using the given tactic.
The solver supports the commands #Z3_solver_push and #Z3_solver_pop, but it
will always solve each #Z3_solver_check from scratch.
def_API('Z3_mk_solver_from_tactic', SOLVER, (_in(CONTEXT), _in(TACTIC)))
*/
Z3_solver Z3_API Z3_mk_solver_from_tactic(__in Z3_context c, __in Z3_tactic t);
/**
\brief Return a string describing all solver available parameters.
def_API('Z3_solver_get_help', STRING, (_in(CONTEXT), _in(SOLVER)))
*/
Z3_string Z3_API Z3_solver_get_help(__in Z3_context c, __in Z3_solver s);
/**
\brief Return the parameter description set for the given solver object.
def_API('Z3_solver_get_param_descrs', PARAM_DESCRS, (_in(CONTEXT), _in(SOLVER)))
*/
Z3_param_descrs Z3_API Z3_solver_get_param_descrs(__in Z3_context c, __in Z3_solver s);
/**
\brief Set the given solver using the given parameters.
def_API('Z3_solver_set_params', VOID, (_in(CONTEXT), _in(SOLVER), _in(PARAMS)))
*/
void Z3_API Z3_solver_set_params(__in Z3_context c, __in Z3_solver s, __in Z3_params p);
#ifdef Conly
/**
\brief Increment the reference counter of the given solver.
def_API('Z3_solver_inc_ref', VOID, (_in(CONTEXT), _in(SOLVER)))
*/
void Z3_API Z3_solver_inc_ref(__in Z3_context c, __in Z3_solver s);
/**
\brief Decrement the reference counter of the given solver.
def_API('Z3_solver_dec_ref', VOID, (_in(CONTEXT), _in(SOLVER)))
*/
void Z3_API Z3_solver_dec_ref(__in Z3_context c, __in Z3_solver s);
#endif
/**
\brief Create a backtracking point.
The solver contains a stack of assertions.
\sa Z3_solver_pop
def_API('Z3_solver_push', VOID, (_in(CONTEXT), _in(SOLVER)))
*/
void Z3_API Z3_solver_push(__in Z3_context c, __in Z3_solver s);
/**
\brief Backtrack \c n backtracking points.
\sa Z3_solver_push
\pre n <= Z3_solver_get_num_scopes(c, s)
def_API('Z3_solver_pop', VOID, (_in(CONTEXT), _in(SOLVER), _in(UINT)))
*/
void Z3_API Z3_solver_pop(__in Z3_context c, __in Z3_solver s, unsigned n);
/**
\brief Remove all assertions from the solver.
def_API('Z3_solver_reset', VOID, (_in(CONTEXT), _in(SOLVER)))
*/
void Z3_API Z3_solver_reset(__in Z3_context c, __in Z3_solver s);
/**
\brief Return the number of backtracking points.
\sa Z3_solver_push
\sa Z3_solver_pop
def_API('Z3_solver_get_num_scopes', UINT, (_in(CONTEXT), _in(SOLVER)))
*/
unsigned Z3_API Z3_solver_get_num_scopes(__in Z3_context c, __in Z3_solver s);
/**
\brief Assert a constraint into the solver.
The functions #Z3_solver_check and #Z3_solver_check_assumptions should be
used to check whether the logical context is consistent or not.
def_API('Z3_solver_assert', VOID, (_in(CONTEXT), _in(SOLVER), _in(AST)))
*/
void Z3_API Z3_solver_assert(__in Z3_context c, __in Z3_solver s, __in Z3_ast a);
/**
\brief Assert a constraint \c a into the solver, and track it (in the unsat) core using
the Boolean constant \c 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.
\pre \c a must be a Boolean expression
\pre \c p must be a Boolean constant (aka variable).
def_API('Z3_solver_assert_and_track', VOID, (_in(CONTEXT), _in(SOLVER), _in(AST), _in(AST)))
*/
void Z3_API Z3_solver_assert_and_track(__in Z3_context c, __in Z3_solver s, __in Z3_ast a, __in Z3_ast p);
/**
\brief Return the set of asserted formulas as a goal object.
def_API('Z3_solver_get_assertions', AST_VECTOR, (_in(CONTEXT), _in(SOLVER)))
*/
Z3_ast_vector Z3_API Z3_solver_get_assertions(__in Z3_context c, __in Z3_solver s);
/**
\brief Check whether the assertions in a given solver are consistent or not.
The function #Z3_solver_get_model retrieves a model if the
assertions is satisfiable (i.e., the result is \c
Z3_L_TRUE) and model construction is enabled.
Note that if the call returns Z3_L_UNDEF, Z3 does not
ensure that calls to #Z3_solver_get_model succeed and any models
produced in this case are not guaranteed to satisfy the assertions.
The function #Z3_solver_get_proof retrieves a proof if proof
generation was enabled when the context was created, and the
assertions are unsatisfiable (i.e., the result is \c Z3_L_FALSE).
def_API('Z3_solver_check', INT, (_in(CONTEXT), _in(SOLVER)))
*/
Z3_lbool Z3_API Z3_solver_check(__in Z3_context c, __in Z3_solver s);
/**
\brief Check whether the assertions in the given solver and
optional assumptions are consistent or not.
The function #Z3_solver_get_unsat_core retrieves the subset of the
assumptions used in the unsatisfiability proof produced by Z3.
\sa Z3_solver_check
def_API('Z3_solver_check_assumptions', INT, (_in(CONTEXT), _in(SOLVER), _in(UINT), _in_array(2, AST)))
*/
Z3_lbool Z3_API Z3_solver_check_assumptions(__in Z3_context c, __in Z3_solver s,
__in unsigned num_assumptions, __in_ecount(num_assumptions) Z3_ast const assumptions[]);
/**
\brief Retrieve the model for the last #Z3_solver_check or #Z3_solver_check_assumptions
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 \c Z3_L_FALSE.
def_API('Z3_solver_get_model', MODEL, (_in(CONTEXT), _in(SOLVER)))
*/
Z3_model Z3_API Z3_solver_get_model(__in Z3_context c, __in Z3_solver s);
/**
\brief Retrieve the proof for the last #Z3_solver_check or #Z3_solver_check_assumptions
The error handler is invoked if proof generation is not enabled,
or if the commands above were not invoked for the given solver,
or if the result was different from \c Z3_L_FALSE.
def_API('Z3_solver_get_proof', AST, (_in(CONTEXT), _in(SOLVER)))
*/
Z3_ast Z3_API Z3_solver_get_proof(__in Z3_context c, __in Z3_solver s);
/**
\brief Retrieve the unsat core for the last #Z3_solver_check_assumptions
The unsat core is a subset of the assumptions \c a.
def_API('Z3_solver_get_unsat_core', AST_VECTOR, (_in(CONTEXT), _in(SOLVER)))
*/
Z3_ast_vector Z3_API Z3_solver_get_unsat_core(__in Z3_context c, __in Z3_solver s);
/**
\brief Return a brief justification for an "unknown" result (i.e., Z3_L_UNDEF) for
the commands #Z3_solver_check and #Z3_solver_check_assumptions
def_API('Z3_solver_get_reason_unknown', STRING, (_in(CONTEXT), _in(SOLVER)))
*/
Z3_string Z3_API Z3_solver_get_reason_unknown(__in Z3_context c, __in Z3_solver s);
/**
\brief Return statistics for the given solver.
\conly \remark User must use #Z3_stats_inc_ref and #Z3_stats_dec_ref to manage Z3_stats objects.
def_API('Z3_solver_get_statistics', STATS, (_in(CONTEXT), _in(SOLVER)))
*/
Z3_stats Z3_API Z3_solver_get_statistics(__in Z3_context c, __in Z3_solver s);
/**
\brief Convert a solver into a string.
def_API('Z3_solver_to_string', STRING, (_in(CONTEXT), _in(SOLVER)))
*/
Z3_string Z3_API Z3_solver_to_string(__in Z3_context c, __in Z3_solver s);
/*@}*/
/**
@name Statistics
*/
/*@{*/
#ifdef ML4only
#include <mlx_statistics.idl>
#endif
/**
\brief Convert a statistics into a string.
def_API('Z3_stats_to_string', STRING, (_in(CONTEXT), _in(STATS)))
*/
Z3_string Z3_API Z3_stats_to_string(__in Z3_context c, __in Z3_stats s);
/**
\mlonly {4 {L Low-level API}} \endmlonly
*/
#ifdef Conly
/**
\brief Increment the reference counter of the given statistics object.
def_API('Z3_stats_inc_ref', VOID, (_in(CONTEXT), _in(STATS)))
*/
void Z3_API Z3_stats_inc_ref(__in Z3_context c, __in Z3_stats s);
/**
\brief Decrement the reference counter of the given statistics object.
def_API('Z3_stats_dec_ref', VOID, (_in(CONTEXT), _in(STATS)))
*/
void Z3_API Z3_stats_dec_ref(__in Z3_context c, __in Z3_stats s);
#endif
/**
\brief Return the number of statistical data in \c s.
def_API('Z3_stats_size', UINT, (_in(CONTEXT), _in(STATS)))
*/
unsigned Z3_API Z3_stats_size(__in Z3_context c, __in Z3_stats s);
/**
\brief Return the key (a string) for a particular statistical data.
\pre idx < Z3_stats_size(c, s)
def_API('Z3_stats_get_key', STRING, (_in(CONTEXT), _in(STATS), _in(UINT)))
*/
Z3_string Z3_API Z3_stats_get_key(__in Z3_context c, __in Z3_stats s, __in unsigned idx);
/**
\brief Return Z3_TRUE if the given statistical data is a unsigned integer.
\pre idx < Z3_stats_size(c, s)
def_API('Z3_stats_is_uint', BOOL, (_in(CONTEXT), _in(STATS), _in(UINT)))
*/
Z3_bool Z3_API Z3_stats_is_uint(__in Z3_context c, __in Z3_stats s, __in unsigned idx);
/**
\brief Return Z3_TRUE if the given statistical data is a double.
\pre idx < Z3_stats_size(c, s)
def_API('Z3_stats_is_double', BOOL, (_in(CONTEXT), _in(STATS), _in(UINT)))
*/
Z3_bool Z3_API Z3_stats_is_double(__in Z3_context c, __in Z3_stats s, __in unsigned idx);
/**
\brief Return the unsigned value of the given statistical data.
\pre idx < Z3_stats_size(c, s) && Z3_stats_is_uint(c, s)
def_API('Z3_stats_get_uint_value', UINT, (_in(CONTEXT), _in(STATS), _in(UINT)))
*/
unsigned Z3_API Z3_stats_get_uint_value(__in Z3_context c, __in Z3_stats s, __in unsigned idx);
/**
\brief Return the double value of the given statistical data.
\pre idx < Z3_stats_size(c, s) && Z3_stats_is_double(c, s)
def_API('Z3_stats_get_double_value', DOUBLE, (_in(CONTEXT), _in(STATS), _in(UINT)))
*/
double Z3_API Z3_stats_get_double_value(__in Z3_context c, __in Z3_stats s, __in unsigned idx);
/*@}*/
#endif
#ifdef CorML3
/**
@name Deprecated Injective functions API
*/
/*@{*/
/**
\brief Create injective function declaration
\deprecated This method just asserts a (universally quantified) formula that asserts that
the new function is injective. It is compatible with the old interface for solving:
#Z3_assert_cnstr, #Z3_check_assumptions, etc.
def_API('Z3_mk_injective_function', FUNC_DECL, (_in(CONTEXT), _in(SYMBOL), _in(UINT), _in_array(2, SORT), _in(SORT)))
*/
Z3_func_decl Z3_API Z3_mk_injective_function(
__in Z3_context c,
__in Z3_symbol s,
unsigned domain_size, __in_ecount(domain_size) Z3_sort const domain[],
__in Z3_sort range
);
/*@}*/
#endif
/**
@name Deprecated Constraints API
*/
/*@{*/
#ifdef CorML3
/**
\brief Set the SMTLIB logic to be used in the given logical context.
It is incorrect to invoke this function after invoking
#Z3_check, #Z3_check_and_get_model, #Z3_check_assumptions and #Z3_push.
Return \c Z3_TRUE if the logic was changed successfully, and \c Z3_FALSE otherwise.
\deprecated Subsumed by #Z3_mk_solver_for_logic
def_API('Z3_set_logic', VOID, (_in(CONTEXT), _in(STRING)))
*/
Z3_bool Z3_API Z3_set_logic(__in Z3_context c, __in Z3_string logic);
/**
\brief Create a backtracking point.
The logical context can be viewed as a stack of contexts. The
scope level is the number of elements on this stack. The stack
of contexts is simulated using trail (undo) stacks.
\sa Z3_pop
\deprecated Subsumed by #Z3_solver_push
def_API('Z3_push', VOID, (_in(CONTEXT),))
*/
void Z3_API Z3_push(__in Z3_context c);
/**
\brief Backtrack.
Restores the context from the top of the stack, and pops it off the
stack. Any changes to the logical context (by #Z3_assert_cnstr or
other functions) between the matching #Z3_push and \c Z3_pop
operators are flushed, and the context is completely restored to
what it was right before the #Z3_push.
\sa Z3_push
\deprecated Subsumed by #Z3_solver_pop
def_API('Z3_pop', VOID, (_in(CONTEXT), _in(UINT)))
*/
void Z3_API Z3_pop(__in Z3_context c, __in unsigned num_scopes);
/**
\brief Retrieve the current scope level.
It retrieves the number of scopes that have been pushed, but not yet popped.
\sa Z3_push
\sa Z3_pop
\deprecated Subsumed by #Z3_solver_get_num_scopes.
def_API('Z3_get_num_scopes', UINT, (_in(CONTEXT),))
*/
unsigned Z3_API Z3_get_num_scopes(__in Z3_context c);
/**
\conly \brief Persist AST through num_scopes pops.
\conly This function is only relevant if \c c was created using #Z3_mk_context.
\conly If \c c was created using #Z3_mk_context_rc, this function is a NOOP.
\conly Normally, for contexts created using #Z3_mk_context,
\conly references to terms are no longer valid when
\conly popping scopes beyond the level where the terms are created.
\conly If you want to reference a term below the scope where it
\conly was created, use this method to specify how many pops
\conly the term should survive.
\conly The num_scopes should be at most equal to the number of
\conly calls to Z3_push subtracted with the calls to Z3_pop.
\conly \deprecated Z3 users should move to #Z3_mk_context_rc and use the
\conly reference counting APIs for managing AST nodes.
\mlonly \deprecated This function has no effect. \endmlonly
def_API('Z3_persist_ast', VOID, (_in(CONTEXT), _in(AST), _in(UINT)))
*/
void Z3_API Z3_persist_ast(__in Z3_context c, __in Z3_ast a, __in unsigned num_scopes);
/**
\brief Assert a constraint into the logical context.
After one assertion, the logical context may become
inconsistent.
The functions #Z3_check or #Z3_check_and_get_model should be
used to check whether the logical context is consistent or not.
\sa Z3_check
\sa Z3_check_and_get_model
\deprecated Subsumed by #Z3_solver_assert
def_API('Z3_assert_cnstr', VOID, (_in(CONTEXT), _in(AST)))
*/
void Z3_API Z3_assert_cnstr(__in Z3_context c, __in Z3_ast a);
/**
\brief Check whether the given logical context is consistent or not.
If the logical context is not unsatisfiable (i.e., the return value is different from \c Z3_L_FALSE)
and model construction is enabled (see #Z3_mk_config),
\conly then a model is stored in \c m. Otherwise, the value \c NULL is stored in \c m.
\mlonly then a valid model is returned. Otherwise, it is unsafe to use the returned model.\endmlonly
\conly The caller is responsible for deleting the model using the function #Z3_del_model.
\conly \remark In contrast with the rest of the Z3 API, the reference counter of the
\conly model is incremented. This is to guarantee backward compatibility. In previous
\conly versions, models did not support reference counting.
\remark Model construction must be enabled using configuration
parameters (See, #Z3_mk_config).
\sa Z3_check
\conly \sa Z3_del_model
\deprecated Subsumed by #Z3_solver_check
def_API('Z3_check_and_get_model', INT, (_in(CONTEXT), _out(MODEL)))
*/
Z3_lbool Z3_API Z3_check_and_get_model(__in Z3_context c, __out Z3_model * m);
/**
\brief Check whether the given logical context is consistent or not.
The function #Z3_check_and_get_model should be used when models are needed.
\sa Z3_check_and_get_model
\deprecated Subsumed by #Z3_solver_check
def_API('Z3_check', INT, (_in(CONTEXT),))
*/
Z3_lbool Z3_API Z3_check(__in Z3_context c);
/**
\brief Check whether the given logical context and optional assumptions is consistent or not.
If the logical context is not unsatisfiable (i.e., the return value is different from \c Z3_L_FALSE),
\conly a non-NULL model argument is passed in,
and model construction is enabled (see #Z3_mk_config),
\conly then a model is stored in \c m. Otherwise, \c m is left unchanged.
\mlonly then a valid model is returned. Otherwise, it is unsafe to use the returned model.\endmlonly
\conly The caller is responsible for deleting the model using the function #Z3_del_model.
\conly \remark If the model argument is non-NULL, then model construction must be enabled using configuration
\conly parameters (See, #Z3_mk_config).
\param c logical context.
\param num_assumptions number of auxiliary assumptions.
\param assumptions array of auxiliary assumptions
\param m optional pointer to a model.
\param proof optional pointer to a proof term.
\param core_size size of unsatisfiable core.
\param core pointer to an array receiving unsatisfiable core.
The unsatisfiable core is a subset of the assumptions, so the array has the same size as the assumptions.
The \c core array is not populated if \c core_size is set to 0.
\pre assumptions comprises of propositional literals.
In other words, you cannot use compound formulas for assumptions,
but should use propositional variables or negations of propositional variables.
\conly \remark In constrast with the rest of the Z3 API, the reference counter of the
\conly model is incremented. This is to guarantee backward compatibility. In previous
\conly versions, models did not support reference counting.
\sa Z3_check
\conly \sa Z3_del_model
\deprecated Subsumed by #Z3_solver_check_assumptions
def_API('Z3_check_assumptions', INT, (_in(CONTEXT), _in(UINT), _in_array(1, AST), _out(MODEL), _out(AST), _out(UINT), _out_array2(1, 5, AST)))
*/
Z3_lbool Z3_API Z3_check_assumptions(
__in Z3_context c,
__in unsigned num_assumptions, __in_ecount(num_assumptions) Z3_ast const assumptions[],
__out Z3_model * m, __out Z3_ast* proof,
__inout unsigned* core_size, __inout_ecount(num_assumptions) Z3_ast core[]
);
#endif
#ifdef CorML4
/**
\brief Retrieve congruence class representatives for terms.
The function can be used for relying on Z3 to identify equal terms under the current
set of assumptions. The array of terms and array of class identifiers should have
the same length. The class identifiers are numerals that are assigned to the same
value for their corresponding terms if the current context forces the terms to be
equal. You cannot deduce that terms corresponding to different numerals must be all different,
(especially when using non-convex theories).
All implied equalities are returned by this call.
This means that two terms map to the same class identifier if and only if
the current context implies that they are equal.
A side-effect of the function is a satisfiability check on the assertions on the solver that is passed in.
The function return Z3_L_FALSE if the current assertions are not satisfiable.
\sa Z3_check_and_get_model
\sa Z3_check
\deprecated To be moved outside of API.
def_API('Z3_get_implied_equalities', UINT, (_in(CONTEXT), _in(SOLVER), _in(UINT), _in_array(2, AST), _out_array(2, UINT)))
*/
Z3_lbool Z3_API Z3_get_implied_equalities(
__in Z3_context c,
__in Z3_solver s,
__in unsigned num_terms,
__in_ecount(num_terms) Z3_ast const terms[],
__out_ecount(num_terms) unsigned class_ids[]
);
#endif
#ifdef CorML3
/**
\brief Delete a model object.
\sa Z3_check_and_get_model
\conly \remark The Z3_check_and_get_model automatically increments a reference count on the model.
\conly The expected usage is that models created by that method are deleted using Z3_del_model.
\conly This is for backwards compatibility and in contrast to the rest of the API where
\conly callers are responsible for managing reference counts.
\deprecated Subsumed by Z3_solver API
def_API('Z3_del_model', VOID, (_in(CONTEXT), _in(MODEL)))
*/
void Z3_API Z3_del_model(__in Z3_context c, __in Z3_model m);
/*@}*/
/**
@name Deprecated Search control API
*/
/*@{*/
/**
\brief Cancel an ongoing check.
Notifies the current check to abort and return.
This method should be called from a different thread
than the one performing the check.
\deprecated Use #Z3_interrupt instead.
def_API('Z3_soft_check_cancel', VOID, (_in(CONTEXT), ))
*/
void Z3_API Z3_soft_check_cancel(__in Z3_context c);
/**
\brief Retrieve reason for search failure.
If a call to #Z3_check or #Z3_check_and_get_model returns Z3_L_UNDEF,
use this facility to determine the more detailed cause of search failure.
\deprecated Subsumed by #Z3_solver_get_reason_unknown
def_API('Z3_get_search_failure', UINT, (_in(CONTEXT), ))
*/
Z3_search_failure Z3_API Z3_get_search_failure(__in Z3_context c);
/*@}*/
/**
@name Deprecated Labels API
*/
/*@{*/
/**
\brief Create a labeled formula.
\param c logical context.
\param s name of the label.
\param is_pos label polarity.
\param f formula being labeled.
A label behaves as an identity function, so the truth value of the
labeled formula is unchanged. Labels are used for identifying
useful sub-formulas when generating counter-examples.
\deprecated Labels are only supported by the old Solver API.
This feature is not essential (it can be simulated using auxiliary Boolean variables).
It is only available for backward compatibility.
def_API('Z3_mk_label', AST, (_in(CONTEXT), _in(SYMBOL), _in(BOOL), _in(AST)))
*/
Z3_ast Z3_API Z3_mk_label(__in Z3_context c, __in Z3_symbol s, Z3_bool is_pos, Z3_ast f);
/**
\brief Retrieve the set of labels that were relevant in
the context of the current satisfied context.
\sa Z3_del_literals
\sa Z3_get_num_literals
\sa Z3_get_label_symbol
\sa Z3_get_literal
\deprecated This procedure is based on the old Solver API.
def_API('Z3_get_relevant_labels', LITERALS, (_in(CONTEXT), ))
*/
Z3_literals Z3_API Z3_get_relevant_labels(__in Z3_context c);
/**
\brief Retrieve the set of literals that satisfy the current context.
\sa Z3_del_literals
\sa Z3_get_num_literals
\sa Z3_get_label_symbol
\sa Z3_get_literal
\deprecated This procedure is based on the old Solver API.
def_API('Z3_get_relevant_literals', LITERALS, (_in(CONTEXT), ))
*/
Z3_literals Z3_API Z3_get_relevant_literals(__in Z3_context c);
/**
\brief Retrieve the set of literals that whose assignment were
guess, but not propagated during the search.
\sa Z3_del_literals
\sa Z3_get_num_literals
\sa Z3_get_label_symbol
\sa Z3_get_literal
\deprecated This procedure is based on the old Solver API.
def_API('Z3_get_guessed_literals', LITERALS, (_in(CONTEXT), ))
*/
Z3_literals Z3_API Z3_get_guessed_literals(__in Z3_context c);
/**
\brief Delete a labels context.
\sa Z3_get_relevant_labels
\deprecated This procedure is based on the old Solver API.
def_API('Z3_del_literals', VOID, (_in(CONTEXT), _in(LITERALS)))
*/
void Z3_API Z3_del_literals(__in Z3_context c, __in Z3_literals lbls);
/**
\brief Retrieve the number of label symbols that were returned.
\sa Z3_get_relevant_labels
\deprecated This procedure is based on the old Solver API.
def_API('Z3_get_num_literals', UINT, (_in(CONTEXT), _in(LITERALS)))
*/
unsigned Z3_API Z3_get_num_literals(__in Z3_context c, __in Z3_literals lbls);
/**
\brief Retrieve label symbol at idx.
\deprecated This procedure is based on the old Solver API.
def_API('Z3_get_label_symbol', SYMBOL, (_in(CONTEXT), _in(LITERALS), _in(UINT)))
*/
Z3_symbol Z3_API Z3_get_label_symbol(__in Z3_context c, __in Z3_literals lbls, __in unsigned idx);
/**
\brief Retrieve literal expression at idx.
\deprecated This procedure is based on the old Solver API.
def_API('Z3_get_literal', AST, (_in(CONTEXT), _in(LITERALS), _in(UINT)))
*/
Z3_ast Z3_API Z3_get_literal(__in Z3_context c, __in Z3_literals lbls, __in unsigned idx);
/**
\brief Disable label.
The disabled label is not going to be used when blocking the subsequent search.
\sa Z3_block_literals
\deprecated This procedure is based on the old Solver API.
def_API('Z3_disable_literal', VOID, (_in(CONTEXT), _in(LITERALS), _in(UINT)))
*/
void Z3_API Z3_disable_literal(__in Z3_context c, __in Z3_literals lbls, __in unsigned idx);
/**
\brief Block subsequent checks using the remaining enabled labels.
\deprecated This procedure is based on the old Solver API.
def_API('Z3_block_literals', VOID, (_in(CONTEXT), _in(LITERALS)))
*/
void Z3_API Z3_block_literals(__in Z3_context c, __in Z3_literals lbls);
/*@}*/
/**
@name Deprecated Model API
*/
/*@{*/
/**
\brief Return the number of constants assigned by the given model.
\mlonly \remark Consider using {!get_model_constants}. \endmlonly
\sa Z3_get_model_constant
\deprecated use #Z3_model_get_num_consts
def_API('Z3_get_model_num_constants', UINT, (_in(CONTEXT), _in(MODEL)))
*/
unsigned Z3_API Z3_get_model_num_constants(__in Z3_context c, __in Z3_model m);
/**
\brief \mlh get_model_constant c m i \endmlh
Return the i-th constant in the given model.
\mlonly \remark Consider using {!get_model_constants}. \endmlonly
\pre i < Z3_get_model_num_constants(c, m)
\deprecated use #Z3_model_get_const_decl
def_API('Z3_get_model_constant', FUNC_DECL, (_in(CONTEXT), _in(MODEL), _in(UINT)))
*/
Z3_func_decl Z3_API Z3_get_model_constant(__in Z3_context c, __in Z3_model m, __in unsigned i);
/**
\brief Return the number of function interpretations in the given model.
A function interpretation is represented as a finite map and an 'else' value.
Each entry in the finite map represents the value of a function given a set of arguments.
\deprecated use #Z3_model_get_num_funcs
def_API('Z3_get_model_num_funcs', UINT, (_in(CONTEXT), _in(MODEL)))
*/
unsigned Z3_API Z3_get_model_num_funcs(__in Z3_context c, __in Z3_model m);
/**
\brief \mlh get_model_func_decl c m i \endmlh
Return the declaration of the i-th function in the given model.
\pre i < Z3_get_model_num_funcs(c, m)
\sa Z3_get_model_num_funcs
\deprecated use #Z3_model_get_func_decl
def_API('Z3_get_model_func_decl', FUNC_DECL, (_in(CONTEXT), _in(MODEL), _in(UINT)))
*/
Z3_func_decl Z3_API Z3_get_model_func_decl(__in Z3_context c, __in Z3_model m, __in unsigned i);
/**
\brief Return the value of the given constant or function
in the given model.
\deprecated Consider using #Z3_model_eval or #Z3_model_get_func_interp
def_API('Z3_eval_func_decl', BOOL, (_in(CONTEXT), _in(MODEL), _in(FUNC_DECL), _out(AST)))
*/
Z3_bool Z3_API Z3_eval_func_decl(__in Z3_context c, __in Z3_model m, __in Z3_func_decl decl, __out Z3_ast* v);
/**
\brief \mlh is_array_value c v \endmlh
Determine whether the term encodes an array value.
A term encodes an array value if it is a nested sequence of
applications of store on top of a constant array.
The indices to the stores have to be values (for example, integer constants)
so that equality between the indices can be evaluated.
Array values are useful for representing interpretations for arrays.
Return the number of entries mapping to non-default values of the array.
\deprecated Use #Z3_is_as_array
def_API('Z3_is_array_value', BOOL, (_in(CONTEXT), _in(MODEL), _in(AST), _out(UINT)))
*/
Z3_bool Z3_API Z3_is_array_value(__in Z3_context c, __in Z3_model m, __in Z3_ast v, __out unsigned* num_entries);
/**
\brief \mlh get_array_value c v \endmlh
An array values is represented as a dictionary plus a
default (else) value. This function returns the array graph.
\pre Z3_TRUE == Z3_is_array_value(c, v, &num_entries)
\deprecated Use Z3_func_interp objects and #Z3_get_as_array_func_decl
def_API('Z3_get_array_value', VOID, (_in(CONTEXT), _in(MODEL), _in(AST), _in(UINT), _out_array(3, AST), _out_array(3, AST), _out (AST)))
*/
void Z3_API Z3_get_array_value(__in Z3_context c,
__in Z3_model m,
__in Z3_ast v,
__in unsigned num_entries,
__inout_ecount(num_entries) Z3_ast indices[],
__inout_ecount(num_entries) Z3_ast values[],
__out Z3_ast* else_value
);
/**
\brief \mlh get_model_func_else c m i \endmlh
Return the 'else' value of the i-th function interpretation in the given model.
A function interpretation is represented as a finite map and an 'else' value.
\mlonly \remark Consider using {!get_model_funcs}. \endmlonly
\pre i < Z3_get_model_num_funcs(c, m)
\sa Z3_get_model_num_funcs
\sa Z3_get_model_func_num_entries
\sa Z3_get_model_func_entry_num_args
\sa Z3_get_model_func_entry_arg
\deprecated Use Z3_func_interp objects
def_API('Z3_get_model_func_else', AST, (_in(CONTEXT), _in(MODEL), _in(UINT)))
*/
Z3_ast Z3_API Z3_get_model_func_else(__in Z3_context c, __in Z3_model m, __in unsigned i);
/**
\brief \mlh get_model_func_num_entries c m i \endmlh
Return the number of entries of the i-th function interpretation in the given model.
A function interpretation is represented as a finite map and an 'else' value.
\mlonly \remark Consider using {!get_model_funcs}. \endmlonly
\pre i < Z3_get_model_num_funcs(c, m)
\sa Z3_get_model_num_funcs
\sa Z3_get_model_func_else
\sa Z3_get_model_func_entry_num_args
\sa Z3_get_model_func_entry_arg
\deprecated Use Z3_func_interp objects
def_API('Z3_get_model_func_num_entries', UINT, (_in(CONTEXT), _in(MODEL), _in(UINT)))
*/
unsigned Z3_API Z3_get_model_func_num_entries(__in Z3_context c, __in Z3_model m, __in unsigned i);
/**
\brief \mlh get_model_func_entry_num_args c m i j \endmlh
Return the number of arguments of the j-th entry of the i-th function interpretation in the given
model.
A function interpretation is represented as a finite map and an 'else' value.
This function returns the j-th entry of this map.
An entry represents the value of a function given a set of arguments.
\conly That is: it has the following format <tt>f(args[0],...,args[num_args - 1]) = val</tt>.
\mlonly \remark Consider using {!get_model_funcs}. \endmlonly
\pre i < Z3_get_model_num_funcs(c, m)
\pre j < Z3_get_model_func_num_entries(c, m, i)
\sa Z3_get_model_num_funcs
\sa Z3_get_model_func_num_entries
\sa Z3_get_model_func_entry_arg
\deprecated Use Z3_func_interp objects
def_API('Z3_get_model_func_entry_num_args', UINT, (_in(CONTEXT), _in(MODEL), _in(UINT), _in(UINT)))
*/
unsigned Z3_API Z3_get_model_func_entry_num_args(__in Z3_context c,
__in Z3_model m,
__in unsigned i,
__in unsigned j);
/**
\brief \mlh get_model_func_entry_arg c m i j k \endmlh
Return the k-th argument of the j-th entry of the i-th function interpretation in the given
model.
A function interpretation is represented as a finite map and an 'else' value.
This function returns the j-th entry of this map.
An entry represents the value of a function given a set of arguments.
\conly That is: it has the following format <tt>f(args[0],...,args[num_args - 1]) = val</tt>.
\mlonly \remark Consider using {!get_model_funcs}. \endmlonly
\pre i < Z3_get_model_num_funcs(c, m)
\pre j < Z3_get_model_func_num_entries(c, m, i)
\pre k < Z3_get_model_func_entry_num_args(c, m, i, j)
\sa Z3_get_model_num_funcs
\sa Z3_get_model_func_num_entries
\sa Z3_get_model_func_entry_num_args
\deprecated Use Z3_func_interp objects
def_API('Z3_get_model_func_entry_arg', AST, (_in(CONTEXT), _in(MODEL), _in(UINT), _in(UINT), _in(UINT)))
*/
Z3_ast Z3_API Z3_get_model_func_entry_arg(__in Z3_context c,
__in Z3_model m,
__in unsigned i,
__in unsigned j,
__in unsigned k);
/**
\brief \mlh get_model_func_entry_value c m i j \endmlh
Return the return value of the j-th entry of the i-th function interpretation in the given
model.
A function interpretation is represented as a finite map and an 'else' value.
This function returns the j-th entry of this map.
An entry represents the value of a function given a set of arguments.
\conly That is: it has the following format <tt>f(args[0],...,args[num_args - 1]) = val</tt>.
\mlonly \remark Consider using {!get_model_funcs}. \endmlonly
\pre i < Z3_get_model_num_funcs(c, m)
\pre j < Z3_get_model_func_num_entries(c, m, i)
\sa Z3_get_model_num_funcs
\sa Z3_get_model_func_num_entries
\deprecated Use Z3_func_interp objects
def_API('Z3_get_model_func_entry_value', AST, (_in(CONTEXT), _in(MODEL), _in(UINT), _in(UINT)))
*/
Z3_ast Z3_API Z3_get_model_func_entry_value(__in Z3_context c,
__in Z3_model m,
__in unsigned i,
__in unsigned j);
/**
\brief \mlh eval c m t \endmlh
Evaluate the AST node \c t in the given model.
\conly Return \c Z3_TRUE if succeeded, and store the result in \c v.
\mlonly Return a pair: Boolean and value. The Boolean is true if the term was successfully evaluated. \endmlonly
The evaluation may fail for the following reasons:
- \c t contains a quantifier.
- the model \c m is partial, that is, it doesn't have a complete interpretation for uninterpreted functions.
That is, the option <tt>MODEL_PARTIAL=true</tt> was used.
- \c t is type incorrect.
\deprecated Use #Z3_model_eval
def_API('Z3_eval', BOOL, (_in(CONTEXT), _in(MODEL), _in(AST), _out(AST)))
*/
Z3_bool Z3_API Z3_eval(__in Z3_context c, __in Z3_model m, __in Z3_ast t, __out Z3_ast * v);
/**
\brief Evaluate declaration given values.
Provides direct way to evaluate declarations
without going over terms.
\deprecated Consider using #Z3_model_eval and #Z3_substitute_vars
def_API('Z3_eval_decl', BOOL, (_in(CONTEXT), _in(MODEL), _in(FUNC_DECL), _in(UINT), _in_array(3, AST), _out(AST)))
*/
Z3_bool Z3_API Z3_eval_decl(__in Z3_context c, __in Z3_model m,
__in Z3_func_decl d,
__in unsigned num_args,
__in_ecount(num_args) Z3_ast const args[],
__out Z3_ast* v);
/*@}*/
/**
@name Deprecated String conversion API
*/
/*@{*/
/**
\brief Convert the given logical context into a string.
This function is mainly used for debugging purposes. It displays
the internal structure of a logical context.
\conly \warning The result buffer is statically allocated by Z3. It will
\conly be automatically deallocated when #Z3_del_context is invoked.
\conly So, the buffer is invalidated in the next call to \c Z3_context_to_string.
\deprecated This method is obsolete. It just displays the internal representation of
the global solver available for backward compatibility reasons.
def_API('Z3_context_to_string', STRING, (_in(CONTEXT),))
*/
Z3_string Z3_API Z3_context_to_string(__in Z3_context c);
/**
\brief Return runtime statistics as a string.
This function is mainly used for debugging purposes. It displays
statistics of the search activity.
\conly \warning The result buffer is statically allocated by Z3. It will
\conly be automatically deallocated when #Z3_del_context is invoked.
\conly So, the buffer is invalidated in the next call to \c Z3_context_to_string.
\deprecated This method is based on the old solver API.
Use #Z3_stats_to_string when using the new solver API.
def_API('Z3_statistics_to_string', STRING, (_in(CONTEXT),))
*/
Z3_string Z3_API Z3_statistics_to_string(__in Z3_context c);
/**
\brief Extract satisfying assignment from context as a conjunction.
This function can be used for debugging purposes. It returns a conjunction
of formulas that are assigned to true in the current context.
This conjunction will contain not only the assertions that are set to true
under the current assignment, but will also include additional literals
if there has been a call to #Z3_check or #Z3_check_and_get_model.
\deprecated This method is based on the old solver API.
def_API('Z3_get_context_assignment', AST, (_in(CONTEXT),))
*/
Z3_ast Z3_API Z3_get_context_assignment(__in Z3_context c);
/*@}*/
#endif
#ifndef CAMLIDL
#ifdef __cplusplus
};
#endif // __cplusplus
#else
}
#endif // CAMLIDL
/*@}*/
#endif
View git blame Copy permalink