Z3
C API

Algebraic Numbers API

Z3_bool Z3_API Z3_algebraic_is_value (Z3_context c, Z3_ast a)
 Return Z3_TRUE if can be used as value in the Z3 real algebraic number package. More...
 
Z3_bool Z3_API Z3_algebraic_is_pos (Z3_context c, Z3_ast a)
 Return the Z3_TRUE if a is positive, and Z3_FALSE otherwise. More...
 
Z3_bool Z3_API Z3_algebraic_is_neg (Z3_context c, Z3_ast a)
 Return the Z3_TRUE if a is negative, and Z3_FALSE otherwise. More...
 
Z3_bool Z3_API Z3_algebraic_is_zero (Z3_context c, Z3_ast a)
 Return the Z3_TRUE if a is zero, and Z3_FALSE otherwise. More...
 
int Z3_API Z3_algebraic_sign (Z3_context c, Z3_ast a)
 Return 1 if a is positive, 0 if a is zero, and -1 if a is negative. More...
 
Z3_ast Z3_API Z3_algebraic_add (Z3_context c, Z3_ast a, Z3_ast b)
 Return the value a + b. More...
 
Z3_ast Z3_API Z3_algebraic_sub (Z3_context c, Z3_ast a, Z3_ast b)
 Return the value a - b. More...
 
Z3_ast Z3_API Z3_algebraic_mul (Z3_context c, Z3_ast a, Z3_ast b)
 Return the value a * b. More...
 
Z3_ast Z3_API Z3_algebraic_div (Z3_context c, Z3_ast a, Z3_ast b)
 Return the value a / b. More...
 
Z3_ast Z3_API Z3_algebraic_root (Z3_context c, Z3_ast a, unsigned k)
 Return the a^(1/k) More...
 
Z3_ast Z3_API Z3_algebraic_power (Z3_context c, Z3_ast a, unsigned k)
 Return the a^k. More...
 
Z3_bool Z3_API Z3_algebraic_lt (Z3_context c, Z3_ast a, Z3_ast b)
 Return Z3_TRUE if a < b, and Z3_FALSE otherwise. More...
 
Z3_bool Z3_API Z3_algebraic_gt (Z3_context c, Z3_ast a, Z3_ast b)
 Return Z3_TRUE if a > b, and Z3_FALSE otherwise. More...
 
Z3_bool Z3_API Z3_algebraic_le (Z3_context c, Z3_ast a, Z3_ast b)
 Return Z3_TRUE if a <= b, and Z3_FALSE otherwise. More...
 
Z3_bool Z3_API Z3_algebraic_ge (Z3_context c, Z3_ast a, Z3_ast b)
 Return Z3_TRUE if a >= b, and Z3_FALSE otherwise. More...
 
Z3_bool Z3_API Z3_algebraic_eq (Z3_context c, Z3_ast a, Z3_ast b)
 Return Z3_TRUE if a == b, and Z3_FALSE otherwise. More...
 
Z3_bool Z3_API Z3_algebraic_neq (Z3_context c, Z3_ast a, Z3_ast b)
 Return Z3_TRUE if a != b, and Z3_FALSE otherwise. More...
 
Z3_ast_vector Z3_API Z3_algebraic_roots (Z3_context c, Z3_ast p, unsigned n, Z3_ast a[])
 Given a multivariate polynomial p(x_0, ..., x_{n-1}, x_n), returns the roots of the univariate polynomial p(a[0], ..., a[n-1], x_n). More...
 
int Z3_API Z3_algebraic_eval (Z3_context c, Z3_ast p, unsigned n, Z3_ast a[])
 Given a multivariate polynomial p(x_0, ..., x_{n-1}), return the sign of p(a[0], ..., a[n-1]). More...
 

Types

Most of the types in the C API are opaque pointers.

  • Z3_config: configuration object used to initialize logical contexts.

Z3_context: manager of all other Z3 objects, global configuration options, etc.

  • Z3_symbol: Lisp-like symbol used to name types, constants, and functions. A symbol can be created using string or integers.
  • Z3_ast: abstract syntax tree node. That is, the data-structure used in Z3 to represent terms, formulas and types.
  • Z3_sort: kind of AST used to represent types.
  • Z3_func_decl: kind of AST used to represent function symbols.
  • Z3_app: kind of AST used to represent function applications.
  • Z3_pattern: kind of AST used to represent pattern and multi-patterns used to guide quantifier instantiation.
    • Z3_constructor: type constructor for a (recursive) datatype.
  • Z3_params: parameter set used to configure many components such as: simplifiers, tactics, solvers, etc.
  • Z3_model: model for the constraints asserted into the logical context.
  • Z3_func_interp: interpretation of a function in a model.
  • Z3_func_entry: representation of the value of a Z3_func_interp at a particular point.
  • Z3_fixedpoint: context for the recursive predicate solver.
  • Z3_optimize: context for solving optimization queries.
  • Z3_ast_vector: vector of Z3_ast objects.
  • Z3_ast_map: mapping from Z3_ast to Z3_ast objects.
  • Z3_goal: set of formulas that can be solved and/or transformed using tactics and solvers.
  • Z3_tactic: basic building block for creating custom solvers for specific problem domains.
  • 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.
  • Z3_apply_result: collection of subgoals resulting from applying of a tactic to a goal.
  • Z3_solver: (incremental) solver, possibly specialized by a particular tactic or logic.
  • Z3_stats: statistical data for a solver.
enum  Z3_lbool { Z3_L_FALSE = -1, Z3_L_UNDEF, Z3_L_TRUE }
 Lifted Boolean type: false, undefined, true. More...
 
enum  Z3_symbol_kind { Z3_INT_SYMBOL, Z3_STRING_SYMBOL }
 The different kinds of symbol. In Z3, a symbol can be represented using integers and strings (See Z3_get_symbol_kind). More...
 
enum  Z3_parameter_kind {
  Z3_PARAMETER_INT, Z3_PARAMETER_DOUBLE, Z3_PARAMETER_RATIONAL, Z3_PARAMETER_SYMBOL,
  Z3_PARAMETER_SORT, Z3_PARAMETER_AST, Z3_PARAMETER_FUNC_DECL
}
 The different kinds of parameters that can be associated with function symbols. More...
 
enum  Z3_sort_kind {
  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
}
 The different kinds of Z3 types (See Z3_get_sort_kind). More...
 
enum  Z3_ast_kind {
  Z3_NUMERAL_AST, Z3_APP_AST, Z3_VAR_AST, Z3_QUANTIFIER_AST,
  Z3_SORT_AST, Z3_FUNC_DECL_AST, Z3_UNKNOWN_AST = 1000
}
 The different kinds of Z3 AST (abstract syntax trees). That is, terms, formulas and types. More...
 
enum  Z3_decl_kind {
  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, 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, 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, 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, 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, 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, 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, Z3_OP_LABEL = 0x700,
  Z3_OP_LABEL_LIT, Z3_OP_DT_CONSTRUCTOR =0x800, Z3_OP_DT_RECOGNISER, Z3_OP_DT_ACCESSOR,
  Z3_OP_DT_UPDATE_FIELD, Z3_OP_PB_AT_MOST =0x900, Z3_OP_PB_LE, Z3_OP_PB_GE,
  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
}
 The different kinds of interpreted function kinds. More...
 
enum  Z3_param_kind {
  Z3_PK_UINT, Z3_PK_BOOL, Z3_PK_DOUBLE, Z3_PK_SYMBOL,
  Z3_PK_STRING, Z3_PK_OTHER, Z3_PK_INVALID
}
 The different kinds of parameters that can be associated with parameter sets. (see Z3_mk_params). More...
 
enum  Z3_search_failure {
  Z3_NO_FAILURE, Z3_UNKNOWN, Z3_TIMEOUT, Z3_MEMOUT_WATERMARK,
  Z3_CANCELED, Z3_NUM_CONFLICTS, Z3_THEORY, Z3_QUANTIFIERS
}
 The different kinds of search failure types. More...
 
enum  Z3_ast_print_mode { Z3_PRINT_SMTLIB_FULL, Z3_PRINT_LOW_LEVEL, Z3_PRINT_SMTLIB_COMPLIANT, Z3_PRINT_SMTLIB2_COMPLIANT }
 Z3 pretty printing modes (See Z3_set_ast_print_mode). More...
 
enum  Z3_error_code {
  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 codes (See Z3_get_error_code). More...
 
enum  Z3_goal_prec { Z3_GOAL_PRECISE, Z3_GOAL_UNDER, Z3_GOAL_OVER, Z3_GOAL_UNDER_OVER }
 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. More...
 
typedef int Z3_bool
 Z3 Boolean type. It is just an alias for int. More...
 
typedef const char * Z3_string
 Z3 string type. It is just an alias for const char *. More...
 
typedef Z3_stringZ3_string_ptr
 
typedef void Z3_error_handler(Z3_context c, Z3_error_code e)
 Z3 custom error handler (See Z3_set_error_handler). More...
 
#define Z3_TRUE   1
 True value. It is just an alias for 1. More...
 
#define Z3_FALSE   0
 False value. It is just an alias for 0. More...
 

Configuration

void Z3_API Z3_global_param_set (Z3_string param_id, Z3_string param_value)
 Set a global (or module) parameter. This setting is shared by all Z3 contexts. More...
 
void Z3_API Z3_global_param_reset_all (void)
 Restore the value of all global (and module) parameters. This command will not affect already created objects (such as tactics and solvers). More...
 
Z3_bool Z3_API Z3_global_param_get (Z3_string param_id, Z3_string_ptr param_value)
 Get a global (or module) parameter. More...
 

Create configuration

Z3_config Z3_API Z3_mk_config (void)
 Create a configuration object for the Z3 context object. More...
 
void Z3_API Z3_del_config (Z3_config c)
 Delete the given configuration object. More...
 
void Z3_API Z3_set_param_value (Z3_config c, Z3_string param_id, Z3_string param_value)
 Set a configuration parameter. More...
 

Create context

Z3_context Z3_API Z3_mk_context (Z3_config c)
 Create a context using the given configuration. More...
 
Z3_context Z3_API Z3_mk_context_rc (Z3_config c)
 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. More...
 
void Z3_API Z3_del_context (Z3_context c)
 Delete the given logical context. More...
 
void Z3_API Z3_inc_ref (Z3_context c, Z3_ast a)
 Increment the reference counter of the given AST. The context c should have been created using Z3_mk_context_rc. This function is a NOOP if c was created using Z3_mk_context. More...
 
void Z3_API Z3_dec_ref (Z3_context c, Z3_ast a)
 Decrement the reference counter of the given AST. The context c should have been created using Z3_mk_context_rc. This function is a NOOP if c was created using Z3_mk_context. More...
 
void Z3_API Z3_update_param_value (Z3_context c, Z3_string param_id, Z3_string param_value)
 Set a value of a context parameter. More...
 
void Z3_API Z3_interrupt (Z3_context c)
 Interrupt the execution of a Z3 procedure. This procedure can be used to interrupt: solvers, simplifiers and tactics. More...
 

Parameters

Z3_params Z3_API Z3_mk_params (Z3_context c)
 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. More...
 
void Z3_API Z3_params_inc_ref (Z3_context c, Z3_params p)
 Increment the reference counter of the given parameter set. More...
 
void Z3_API Z3_params_dec_ref (Z3_context c, Z3_params p)
 Decrement the reference counter of the given parameter set. More...
 
void Z3_API Z3_params_set_bool (Z3_context c, Z3_params p, Z3_symbol k, Z3_bool v)
 Add a Boolean parameter k with value v to the parameter set p. More...
 
void Z3_API Z3_params_set_uint (Z3_context c, Z3_params p, Z3_symbol k, unsigned v)
 Add a unsigned parameter k with value v to the parameter set p. More...
 
void Z3_API Z3_params_set_double (Z3_context c, Z3_params p, Z3_symbol k, double v)
 Add a double parameter k with value v to the parameter set p. More...
 
void Z3_API Z3_params_set_symbol (Z3_context c, Z3_params p, Z3_symbol k, Z3_symbol v)
 Add a symbol parameter k with value v to the parameter set p. More...
 
Z3_string Z3_API Z3_params_to_string (Z3_context c, Z3_params p)
 Convert a parameter set into a string. This function is mainly used for printing the contents of a parameter set. More...
 
void Z3_API Z3_params_validate (Z3_context c, Z3_params p, Z3_param_descrs d)
 Validate the parameter set p against the parameter description set d. More...
 

Parameter Descriptions

void Z3_API Z3_param_descrs_inc_ref (Z3_context c, Z3_param_descrs p)
 Increment the reference counter of the given parameter description set. More...
 
void Z3_API Z3_param_descrs_dec_ref (Z3_context c, Z3_param_descrs p)
 Decrement the reference counter of the given parameter description set. More...
 
Z3_param_kind Z3_API Z3_param_descrs_get_kind (Z3_context c, Z3_param_descrs p, Z3_symbol n)
 Return the kind associated with the given parameter name n. More...
 
unsigned Z3_API Z3_param_descrs_size (Z3_context c, Z3_param_descrs p)
 Return the number of parameters in the given parameter description set. More...
 
Z3_symbol Z3_API Z3_param_descrs_get_name (Z3_context c, Z3_param_descrs p, unsigned i)
 Return the number of parameters in the given parameter description set. More...
 
Z3_string Z3_API Z3_param_descrs_to_string (Z3_context c, Z3_param_descrs p)
 Convert a parameter description set into a string. This function is mainly used for printing the contents of a parameter description set. More...
 

Symbols

Z3_symbol Z3_API Z3_mk_int_symbol (Z3_context c, int i)
 Create a Z3 symbol using an integer. More...
 
Z3_symbol Z3_API Z3_mk_string_symbol (Z3_context c, Z3_string s)
 Create a Z3 symbol using a C string. More...
 

Sorts

Z3_sort Z3_API Z3_mk_uninterpreted_sort (Z3_context c, Z3_symbol s)
 Create a free (uninterpreted) type using the given name (symbol). More...
 
Z3_sort Z3_API Z3_mk_bool_sort (Z3_context c)
 Create the Boolean type. More...
 
Z3_sort Z3_API Z3_mk_int_sort (Z3_context c)
 Create the integer type. More...
 
Z3_sort Z3_API Z3_mk_real_sort (Z3_context c)
 Create the real type. More...
 
Z3_sort Z3_API Z3_mk_bv_sort (Z3_context c, unsigned sz)
 Create a bit-vector type of the given size. More...
 
Z3_sort Z3_API Z3_mk_finite_domain_sort (Z3_context c, Z3_symbol name, unsigned __int64 size)
 Create a named finite domain sort. More...
 
Z3_sort Z3_API Z3_mk_array_sort (Z3_context c, Z3_sort domain, Z3_sort range)
 Create an array type. More...
 
Z3_sort Z3_API Z3_mk_tuple_sort (Z3_context c, Z3_symbol mk_tuple_name, unsigned num_fields, Z3_symbol const field_names[], Z3_sort const field_sorts[], Z3_func_decl *mk_tuple_decl, Z3_func_decl proj_decl[])
 Create a tuple type. More...
 
Z3_sort Z3_API Z3_mk_enumeration_sort (Z3_context c, Z3_symbol name, unsigned n, Z3_symbol const enum_names[], Z3_func_decl enum_consts[], Z3_func_decl enum_testers[])
 Create a enumeration sort. More...
 
Z3_sort Z3_API Z3_mk_list_sort (Z3_context c, Z3_symbol name, Z3_sort elem_sort, Z3_func_decl *nil_decl, Z3_func_decl *is_nil_decl, Z3_func_decl *cons_decl, Z3_func_decl *is_cons_decl, Z3_func_decl *head_decl, Z3_func_decl *tail_decl)
 Create a list sort. More...
 
BEGIN_MLAPI_EXCLUDE Z3_constructor Z3_API Z3_mk_constructor (Z3_context c, Z3_symbol name, Z3_symbol recognizer, unsigned num_fields, Z3_symbol const field_names[], Z3_sort_opt const sorts[], unsigned sort_refs[])
 Create a constructor. More...
 
void Z3_API Z3_del_constructor (Z3_context c, Z3_constructor constr)
 Reclaim memory allocated to constructor. More...
 
Z3_sort Z3_API Z3_mk_datatype (Z3_context c, Z3_symbol name, unsigned num_constructors, Z3_constructor constructors[])
 Create datatype, such as lists, trees, records, enumerations or unions of records. The datatype may be recursive. Return the datatype sort. More...
 
Z3_constructor_list Z3_API Z3_mk_constructor_list (Z3_context c, unsigned num_constructors, Z3_constructor const constructors[])
 Create list of constructors. More...
 
void Z3_API Z3_del_constructor_list (Z3_context c, Z3_constructor_list clist)
 Reclaim memory allocated for constructor list. More...
 
void Z3_API Z3_mk_datatypes (Z3_context c, unsigned num_sorts, Z3_symbol const sort_names[], Z3_sort sorts[], Z3_constructor_list constructor_lists[])
 Create mutually recursive datatypes. More...
 
void Z3_API Z3_query_constructor (Z3_context c, Z3_constructor constr, unsigned num_fields, Z3_func_decl *constructor, Z3_func_decl *tester, Z3_func_decl accessors[])
 Query constructor for declared functions. More...
 

Constants and Applications

Z3_func_decl Z3_API Z3_mk_func_decl (Z3_context c, Z3_symbol s, unsigned domain_size, Z3_sort const domain[], Z3_sort range)
 Declare a constant or function. More...
 
Z3_ast Z3_API Z3_mk_app (Z3_context c, Z3_func_decl d, unsigned num_args, Z3_ast const args[])
 Create a constant or function application. More...
 
Z3_ast Z3_API Z3_mk_const (Z3_context c, Z3_symbol s, Z3_sort ty)
 Declare and create a constant. More...
 
Z3_func_decl Z3_API Z3_mk_fresh_func_decl (Z3_context c, Z3_string prefix, unsigned domain_size, Z3_sort const domain[], Z3_sort range)
 Declare a fresh constant or function. More...
 
Z3_ast Z3_API Z3_mk_fresh_const (Z3_context c, Z3_string prefix, Z3_sort ty)
 Declare and create a fresh constant. More...
 

Propositional Logic and Equality

Z3_ast Z3_API Z3_mk_true (Z3_context c)
 Create an AST node representing true. More...
 
Z3_ast Z3_API Z3_mk_false (Z3_context c)
 Create an AST node representing false. More...
 
Z3_ast Z3_API Z3_mk_eq (Z3_context c, Z3_ast l, Z3_ast r)
 Create an AST node representing l = r. More...
 
Z3_ast Z3_API Z3_mk_distinct (Z3_context c, unsigned num_args, Z3_ast const args[])
 Create an AST node representing distinct(args[0], ..., args[num_args-1]).The distinct construct is used for declaring the arguments pairwise distinct. That is, Forall 0 <= i < j < num_args. not args[i] = args[j]. More...
 
Z3_ast Z3_API Z3_mk_not (Z3_context c, Z3_ast a)
 Create an AST node representing not(a). More...
 
Z3_ast Z3_API Z3_mk_ite (Z3_context c, Z3_ast t1, Z3_ast t2, Z3_ast t3)
 Create an AST node representing an if-then-else: ite(t1, t2, t3). More...
 
Z3_ast Z3_API Z3_mk_iff (Z3_context c, Z3_ast t1, Z3_ast t2)
 Create an AST node representing t1 iff t2. More...
 
Z3_ast Z3_API Z3_mk_implies (Z3_context c, Z3_ast t1, Z3_ast t2)
 Create an AST node representing t1 implies t2. More...
 
Z3_ast Z3_API Z3_mk_xor (Z3_context c, Z3_ast t1, Z3_ast t2)
 Create an AST node representing t1 xor t2. More...
 
Z3_ast Z3_API Z3_mk_and (Z3_context c, unsigned num_args, Z3_ast const args[])
 Create an AST node representing args[0] and ... and args[num_args-1].The array args must have num_args elements. All arguments must have Boolean sort. More...
 
Z3_ast Z3_API Z3_mk_or (Z3_context c, unsigned num_args, Z3_ast const args[])
 Create an AST node representing args[0] or ... or args[num_args-1].The array args must have num_args elements. All arguments must have Boolean sort. More...
 

Arithmetic: Integers and Reals

Z3_ast Z3_API Z3_mk_add (Z3_context c, unsigned num_args, Z3_ast const args[])
 Create an AST node representing args[0] + ... + args[num_args-1].The array args must have num_args elements. All arguments must have int or real sort. More...
 
Z3_ast Z3_API Z3_mk_mul (Z3_context c, unsigned num_args, Z3_ast const args[])
 Create an AST node representing args[0] * ... * args[num_args-1].The array args must have num_args elements. All arguments must have int or real sort. More...
 
Z3_ast Z3_API Z3_mk_sub (Z3_context c, unsigned num_args, Z3_ast const args[])
 Create an AST node representing args[0] - ... - args[num_args - 1].The array args must have num_args elements. All arguments must have int or real sort. More...
 
Z3_ast Z3_API Z3_mk_unary_minus (Z3_context c, Z3_ast arg)
 Create an AST node representing -arg.The arguments must have int or real type. More...
 
Z3_ast Z3_API Z3_mk_div (Z3_context c, Z3_ast arg1, Z3_ast arg2)
 Create an AST node representing arg1 div arg2.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. More...
 
Z3_ast Z3_API Z3_mk_mod (Z3_context c, Z3_ast arg1, Z3_ast arg2)
 Create an AST node representing arg1 mod arg2.The arguments must have int type. More...
 
Z3_ast Z3_API Z3_mk_rem (Z3_context c, Z3_ast arg1, Z3_ast arg2)
 Create an AST node representing arg1 rem arg2.The arguments must have int type. More...
 
Z3_ast Z3_API Z3_mk_power (Z3_context c, Z3_ast arg1, Z3_ast arg2)
 Create an AST node representing arg1^arg2. More...
 
Z3_ast Z3_API Z3_mk_lt (Z3_context c, Z3_ast t1, Z3_ast t2)
 Create less than. More...
 
Z3_ast Z3_API Z3_mk_le (Z3_context c, Z3_ast t1, Z3_ast t2)
 Create less than or equal to. More...
 
Z3_ast Z3_API Z3_mk_gt (Z3_context c, Z3_ast t1, Z3_ast t2)
 Create greater than. More...
 
Z3_ast Z3_API Z3_mk_ge (Z3_context c, Z3_ast t1, Z3_ast t2)
 Create greater than or equal to. More...
 
Z3_ast Z3_API Z3_mk_int2real (Z3_context c, Z3_ast t1)
 Coerce an integer to a real. More...
 
Z3_ast Z3_API Z3_mk_real2int (Z3_context c, Z3_ast t1)
 Coerce a real to an integer. More...
 
Z3_ast Z3_API Z3_mk_is_int (Z3_context c, Z3_ast t1)
 Check if a real number is an integer. More...
 

Bit-vectors

Z3_ast Z3_API Z3_mk_bvnot (Z3_context c, Z3_ast t1)
 Bitwise negation. More...
 
Z3_ast Z3_API Z3_mk_bvredand (Z3_context c, Z3_ast t1)
 Take conjunction of bits in vector, return vector of length 1. More...
 
Z3_ast Z3_API Z3_mk_bvredor (Z3_context c, Z3_ast t1)
 Take disjunction of bits in vector, return vector of length 1. More...
 
Z3_ast Z3_API Z3_mk_bvand (Z3_context c, Z3_ast t1, Z3_ast t2)
 Bitwise and. More...
 
Z3_ast Z3_API Z3_mk_bvor (Z3_context c, Z3_ast t1, Z3_ast t2)
 Bitwise or. More...
 
Z3_ast Z3_API Z3_mk_bvxor (Z3_context c, Z3_ast t1, Z3_ast t2)
 Bitwise exclusive-or. More...
 
Z3_ast Z3_API Z3_mk_bvnand (Z3_context c, Z3_ast t1, Z3_ast t2)
 Bitwise nand. More...
 
Z3_ast Z3_API Z3_mk_bvnor (Z3_context c, Z3_ast t1, Z3_ast t2)
 Bitwise nor. More...
 
Z3_ast Z3_API Z3_mk_bvxnor (Z3_context c, Z3_ast t1, Z3_ast t2)
 Bitwise xnor. More...
 
Z3_ast Z3_API Z3_mk_bvneg (Z3_context c, Z3_ast t1)
 Standard two's complement unary minus. More...
 
Z3_ast Z3_API Z3_mk_bvadd (Z3_context c, Z3_ast t1, Z3_ast t2)
 Standard two's complement addition. More...
 
Z3_ast Z3_API Z3_mk_bvsub (Z3_context c, Z3_ast t1, Z3_ast t2)
 Standard two's complement subtraction. More...
 
Z3_ast Z3_API Z3_mk_bvmul (Z3_context c, Z3_ast t1, Z3_ast t2)
 Standard two's complement multiplication. More...
 
Z3_ast Z3_API Z3_mk_bvudiv (Z3_context c, Z3_ast t1, Z3_ast t2)
 Unsigned division. More...
 
Z3_ast Z3_API Z3_mk_bvsdiv (Z3_context c, Z3_ast t1, Z3_ast t2)
 Two's complement signed division. More...
 
Z3_ast Z3_API Z3_mk_bvurem (Z3_context c, Z3_ast t1, Z3_ast t2)
 Unsigned remainder. More...
 
Z3_ast Z3_API Z3_mk_bvsrem (Z3_context c, Z3_ast t1, Z3_ast t2)
 Two's complement signed remainder (sign follows dividend). More...
 
Z3_ast Z3_API Z3_mk_bvsmod (Z3_context c, Z3_ast t1, Z3_ast t2)
 Two's complement signed remainder (sign follows divisor). More...
 
Z3_ast Z3_API Z3_mk_bvult (Z3_context c, Z3_ast t1, Z3_ast t2)
 Unsigned less than. More...
 
Z3_ast Z3_API Z3_mk_bvslt (Z3_context c, Z3_ast t1, Z3_ast t2)
 Two's complement signed less than. More...
 
Z3_ast Z3_API Z3_mk_bvule (Z3_context c, Z3_ast t1, Z3_ast t2)
 Unsigned less than or equal to. More...
 
Z3_ast Z3_API Z3_mk_bvsle (Z3_context c, Z3_ast t1, Z3_ast t2)
 Two's complement signed less than or equal to. More...
 
Z3_ast Z3_API Z3_mk_bvuge (Z3_context c, Z3_ast t1, Z3_ast t2)
 Unsigned greater than or equal to. More...
 
Z3_ast Z3_API Z3_mk_bvsge (Z3_context c, Z3_ast t1, Z3_ast t2)
 Two's complement signed greater than or equal to. More...
 
Z3_ast Z3_API Z3_mk_bvugt (Z3_context c, Z3_ast t1, Z3_ast t2)
 Unsigned greater than. More...
 
Z3_ast Z3_API Z3_mk_bvsgt (Z3_context c, Z3_ast t1, Z3_ast t2)
 Two's complement signed greater than. More...
 
Z3_ast Z3_API Z3_mk_concat (Z3_context c, Z3_ast t1, Z3_ast t2)
 Concatenate the given bit-vectors. More...
 
Z3_ast Z3_API Z3_mk_extract (Z3_context c, unsigned high, unsigned low, Z3_ast t1)
 Extract the bits high down to low from a bitvector of size m to yield a new bitvector of size n, where n = high - low + 1. More...
 
Z3_ast Z3_API Z3_mk_sign_ext (Z3_context c, unsigned i, Z3_ast t1)
 Sign-extend of the given bit-vector to the (signed) equivalent bitvector of size m+i, where m is the size of the given bit-vector. More...
 
Z3_ast Z3_API Z3_mk_zero_ext (Z3_context c, unsigned i, Z3_ast t1)
 Extend the given bit-vector with zeros to the (unsigned) equivalent bitvector of size m+i, where m is the size of the given bit-vector. More...
 
Z3_ast Z3_API Z3_mk_repeat (Z3_context c, unsigned i, Z3_ast t1)
 Repeat the given bit-vector up length i. More...
 
Z3_ast Z3_API Z3_mk_bvshl (Z3_context c, Z3_ast t1, Z3_ast t2)
 Shift left. More...
 
Z3_ast Z3_API Z3_mk_bvlshr (Z3_context c, Z3_ast t1, Z3_ast t2)
 Logical shift right. More...
 
Z3_ast Z3_API Z3_mk_bvashr (Z3_context c, Z3_ast t1, Z3_ast t2)
 Arithmetic shift right. More...
 
Z3_ast Z3_API Z3_mk_rotate_left (Z3_context c, unsigned i, Z3_ast t1)
 Rotate bits of t1 to the left i times. More...
 
Z3_ast Z3_API Z3_mk_rotate_right (Z3_context c, unsigned i, Z3_ast t1)
 Rotate bits of t1 to the right i times. More...
 
Z3_ast Z3_API Z3_mk_ext_rotate_left (Z3_context c, Z3_ast t1, Z3_ast t2)
 Rotate bits of t1 to the left t2 times. More...
 
Z3_ast Z3_API Z3_mk_ext_rotate_right (Z3_context c, Z3_ast t1, Z3_ast t2)
 Rotate bits of t1 to the right t2 times. More...
 
Z3_ast Z3_API Z3_mk_int2bv (Z3_context c, unsigned n, Z3_ast t1)
 Create an n bit bit-vector from the integer argument t1. More...
 
Z3_ast Z3_API Z3_mk_bv2int (Z3_context c, Z3_ast t1, Z3_bool is_signed)
 Create an integer from the bit-vector argument t1. If is_signed is false, then the bit-vector t1 is treated as unsigned. So the result is non-negative and in the range [0..2^N-1], where N are the number of bits in t1. If is_signed is true, t1 is treated as a signed bit-vector. More...
 
Z3_ast Z3_API Z3_mk_bvadd_no_overflow (Z3_context c, Z3_ast t1, Z3_ast t2, Z3_bool is_signed)
 Create a predicate that checks that the bit-wise addition of t1 and t2 does not overflow. More...
 
Z3_ast Z3_API Z3_mk_bvadd_no_underflow (Z3_context c, Z3_ast t1, Z3_ast t2)
 Create a predicate that checks that the bit-wise signed addition of t1 and t2 does not underflow. More...
 
Z3_ast Z3_API Z3_mk_bvsub_no_overflow (Z3_context c, Z3_ast t1, Z3_ast t2)
 Create a predicate that checks that the bit-wise signed subtraction of t1 and t2 does not overflow. More...
 
Z3_ast Z3_API Z3_mk_bvsub_no_underflow (Z3_context c, Z3_ast t1, Z3_ast t2, Z3_bool is_signed)
 Create a predicate that checks that the bit-wise subtraction of t1 and t2 does not underflow. More...
 
Z3_ast Z3_API Z3_mk_bvsdiv_no_overflow (Z3_context c, Z3_ast t1, Z3_ast t2)
 Create a predicate that checks that the bit-wise signed division of t1 and t2 does not overflow. More...
 
Z3_ast Z3_API Z3_mk_bvneg_no_overflow (Z3_context c, Z3_ast t1)
 Check that bit-wise negation does not overflow when t1 is interpreted as a signed bit-vector. More...
 
Z3_ast Z3_API Z3_mk_bvmul_no_overflow (Z3_context c, Z3_ast t1, Z3_ast t2, Z3_bool is_signed)
 Create a predicate that checks that the bit-wise multiplication of t1 and t2 does not overflow. More...
 
Z3_ast Z3_API Z3_mk_bvmul_no_underflow (Z3_context c, Z3_ast t1, Z3_ast t2)
 Create a predicate that checks that the bit-wise signed multiplication of t1 and t2 does not underflow. More...
 

Arrays

Z3_ast Z3_API Z3_mk_select (Z3_context c, Z3_ast a, Z3_ast i)
 Array read. The argument a is the array and i is the index of the array that gets read. More...
 
Z3_ast Z3_API Z3_mk_store (Z3_context c, Z3_ast a, Z3_ast i, Z3_ast v)
 Array update. More...
 
Z3_ast Z3_API Z3_mk_const_array (Z3_context c, Z3_sort domain, Z3_ast v)
 Create the constant array. More...
 
Z3_ast Z3_API Z3_mk_map (Z3_context c, Z3_func_decl f, unsigned n, Z3_ast const *args)
 map f on the the argument arrays. More...
 
Z3_ast Z3_API Z3_mk_array_default (Z3_context c, Z3_ast array)
 Access the array default value. Produces the default range value, for arrays that can be represented as finite maps with a default range value. More...
 

Sets

Z3_sort Z3_API Z3_mk_set_sort (Z3_context c, Z3_sort ty)
 Create Set type. More...
 
Z3_ast Z3_API Z3_mk_empty_set (Z3_context c, Z3_sort domain)
 Create the empty set. More...
 
Z3_ast Z3_API Z3_mk_full_set (Z3_context c, Z3_sort domain)
 Create the full set. More...
 
Z3_ast Z3_API Z3_mk_set_add (Z3_context c, Z3_ast set, Z3_ast elem)
 Add an element to a set. More...
 
Z3_ast Z3_API Z3_mk_set_del (Z3_context c, Z3_ast set, Z3_ast elem)
 Remove an element to a set. More...
 
Z3_ast Z3_API Z3_mk_set_union (Z3_context c, unsigned num_args, Z3_ast const args[])
 Take the union of a list of sets. More...
 
Z3_ast Z3_API Z3_mk_set_intersect (Z3_context c, unsigned num_args, Z3_ast const args[])
 Take the intersection of a list of sets. More...
 
Z3_ast Z3_API Z3_mk_set_difference (Z3_context c, Z3_ast arg1, Z3_ast arg2)
 Take the set difference between two sets. More...
 
Z3_ast Z3_API Z3_mk_set_complement (Z3_context c, Z3_ast arg)
 Take the complement of a set. More...
 
Z3_ast Z3_API Z3_mk_set_member (Z3_context c, Z3_ast elem, Z3_ast set)
 Check for set membership. More...
 
Z3_ast Z3_API Z3_mk_set_subset (Z3_context c, Z3_ast arg1, Z3_ast arg2)
 Check for subsetness of sets. More...
 

Numerals

Z3_ast Z3_API Z3_mk_numeral (Z3_context c, Z3_string numeral, Z3_sort ty)
 Create a numeral of a given sort. More...
 
Z3_ast Z3_API Z3_mk_real (Z3_context c, int num, int den)
 Create a real from a fraction. More...
 
Z3_ast Z3_API Z3_mk_int (Z3_context c, int v, Z3_sort ty)
 Create a numeral of an int, bit-vector, or finite-domain sort. More...
 
Z3_ast Z3_API Z3_mk_unsigned_int (Z3_context c, unsigned v, Z3_sort ty)
 Create a numeral of a int, bit-vector, or finite-domain sort. More...
 
Z3_ast Z3_API Z3_mk_int64 (Z3_context c, __int64 v, Z3_sort ty)
 Create a numeral of a int, bit-vector, or finite-domain sort. More...
 
Z3_ast Z3_API Z3_mk_unsigned_int64 (Z3_context c, unsigned __int64 v, Z3_sort ty)
 Create a numeral of a int, bit-vector, or finite-domain sort. More...
 

Quantifiers

Z3_pattern Z3_API Z3_mk_pattern (Z3_context c, unsigned num_patterns, Z3_ast const terms[])
 Create a pattern for quantifier instantiation. More...
 
Z3_ast Z3_API Z3_mk_bound (Z3_context c, unsigned index, Z3_sort ty)
 Create a bound variable. More...
 
Z3_ast Z3_API Z3_mk_forall (Z3_context c, unsigned weight, unsigned num_patterns, Z3_pattern const patterns[], unsigned num_decls, Z3_sort const sorts[], Z3_symbol const decl_names[], Z3_ast body)
 Create a forall formula. It takes an expression body that contains bound variables of the same sorts as the sorts listed in the array sorts. The bound variables are de-Bruijn indices created using Z3_mk_bound. The array decl_names contains the names that the quantified formula uses for the bound variables. Z3 applies the convention that the last element in the decl_names and sorts array refers to the variable with index 0, the second to last element of decl_names and sorts refers to the variable with index 1, etc. More...
 
Z3_ast Z3_API Z3_mk_exists (Z3_context c, unsigned weight, unsigned num_patterns, Z3_pattern const patterns[], unsigned num_decls, Z3_sort const sorts[], Z3_symbol const decl_names[], Z3_ast body)
 Create an exists formula. Similar to Z3_mk_forall. More...
 
Z3_ast Z3_API Z3_mk_quantifier (Z3_context c, Z3_bool is_forall, unsigned weight, unsigned num_patterns, Z3_pattern const patterns[], unsigned num_decls, Z3_sort const sorts[], Z3_symbol const decl_names[], Z3_ast body)
 Create a quantifier - universal or existential, with pattern hints. See the documentation for Z3_mk_forall for an explanation of the parameters. More...
 
Z3_ast Z3_API Z3_mk_quantifier_ex (Z3_context c, Z3_bool is_forall, unsigned weight, Z3_symbol quantifier_id, Z3_symbol skolem_id, unsigned num_patterns, Z3_pattern const patterns[], unsigned num_no_patterns, Z3_ast const no_patterns[], unsigned num_decls, Z3_sort const sorts[], Z3_symbol const decl_names[], Z3_ast body)
 Create a quantifier - universal or existential, with pattern hints, no patterns, and attributes. More...
 
Z3_ast Z3_API Z3_mk_forall_const (Z3_context c, unsigned weight, unsigned num_bound, Z3_app const bound[], unsigned num_patterns, Z3_pattern const patterns[], Z3_ast body)
 Create a universal quantifier using a list of constants that will form the set of bound variables. More...
 
Z3_ast Z3_API Z3_mk_exists_const (Z3_context c, unsigned weight, unsigned num_bound, Z3_app const bound[], unsigned num_patterns, Z3_pattern const patterns[], Z3_ast body)
 Similar to Z3_mk_forall_const. More...
 
Z3_ast Z3_API Z3_mk_quantifier_const (Z3_context c, Z3_bool is_forall, unsigned weight, unsigned num_bound, Z3_app const bound[], unsigned num_patterns, Z3_pattern const patterns[], Z3_ast body)
 Create a universal or existential quantifier using a list of constants that will form the set of bound variables. More...
 
Z3_ast Z3_API Z3_mk_quantifier_const_ex (Z3_context c, Z3_bool is_forall, unsigned weight, Z3_symbol quantifier_id, Z3_symbol skolem_id, unsigned num_bound, Z3_app const bound[], unsigned num_patterns, Z3_pattern const patterns[], unsigned num_no_patterns, Z3_ast const no_patterns[], Z3_ast body)
 Create a universal or existential quantifier using a list of constants that will form the set of bound variables. More...
 

Accessors

Z3_symbol_kind Z3_API Z3_get_symbol_kind (Z3_context c, Z3_symbol s)
 Return Z3_INT_SYMBOL if the symbol was constructed using Z3_mk_int_symbol, and Z3_STRING_SYMBOL if the symbol was constructed using Z3_mk_string_symbol. More...
 
int Z3_API Z3_get_symbol_int (Z3_context c, Z3_symbol s)
 Return the symbol int value. More...
 
Z3_string Z3_API Z3_get_symbol_string (Z3_context c, Z3_symbol s)
 Return the symbol name. More...
 
Z3_symbol Z3_API Z3_get_sort_name (Z3_context c, Z3_sort d)
 Return the sort name as a symbol. More...
 
unsigned Z3_API Z3_get_sort_id (Z3_context c, Z3_sort s)
 Return a unique identifier for s. More...
 
Z3_ast Z3_API Z3_sort_to_ast (Z3_context c, Z3_sort s)
 Convert a Z3_sort into Z3_ast. This is just type casting. More...
 
Z3_bool Z3_API Z3_is_eq_sort (Z3_context c, Z3_sort s1, Z3_sort s2)
 compare sorts. More...
 
Z3_sort_kind Z3_API Z3_get_sort_kind (Z3_context c, Z3_sort t)
 Return the sort kind (e.g., array, tuple, int, bool, etc). More...
 
unsigned Z3_API Z3_get_bv_sort_size (Z3_context c, Z3_sort t)
 Return the size of the given bit-vector sort. More...
 
Z3_bool Z3_API Z3_get_finite_domain_sort_size (Z3_context c, Z3_sort s, unsigned __int64 *r)
 Store the size of the sort in r. Return Z3_FALSE if the call failed. That is, Z3_get_sort_kind(s) == Z3_FINITE_DOMAIN_SORT. More...
 
Z3_sort Z3_API Z3_get_array_sort_domain (Z3_context c, Z3_sort t)
 Return the domain of the given array sort. More...
 
Z3_sort Z3_API Z3_get_array_sort_range (Z3_context c, Z3_sort t)
 Return the range of the given array sort. More...
 
Z3_func_decl Z3_API Z3_get_tuple_sort_mk_decl (Z3_context c, Z3_sort t)
 Return the constructor declaration of the given tuple sort. More...
 
unsigned Z3_API Z3_get_tuple_sort_num_fields (Z3_context c, Z3_sort t)
 Return the number of fields of the given tuple sort. More...
 
Z3_func_decl Z3_API Z3_get_tuple_sort_field_decl (Z3_context c, Z3_sort t, unsigned i)
 Return the i-th field declaration (i.e., projection function declaration) of the given tuple sort. More...
 
unsigned Z3_API Z3_get_datatype_sort_num_constructors (Z3_context c, Z3_sort t)
 Return number of constructors for datatype. More...
 
Z3_func_decl Z3_API Z3_get_datatype_sort_constructor (Z3_context c, Z3_sort t, unsigned idx)
 Return idx'th constructor. More...
 
Z3_func_decl Z3_API Z3_get_datatype_sort_recognizer (Z3_context c, Z3_sort t, unsigned idx)
 Return idx'th recognizer. More...
 
Z3_func_decl Z3_API Z3_get_datatype_sort_constructor_accessor (Z3_context c, Z3_sort t, unsigned idx_c, unsigned idx_a)
 Return idx_a'th accessor for the idx_c'th constructor. More...
 
Z3_ast Z3_API Z3_datatype_update_field (Z3_context c, Z3_func_decl field_access, Z3_ast t, Z3_ast value)
 Update record field with a value. More...
 
unsigned Z3_API Z3_get_relation_arity (Z3_context c, Z3_sort s)
 Return arity of relation. More...
 
Z3_sort Z3_API Z3_get_relation_column (Z3_context c, Z3_sort s, unsigned col)
 Return sort at i'th column of relation sort. More...
 
Z3_ast Z3_API Z3_mk_atmost (Z3_context c, unsigned num_args, Z3_ast const args[], unsigned k)
 Pseudo-Boolean relations. More...
 
Z3_ast Z3_API Z3_mk_pble (Z3_context c, unsigned num_args, Z3_ast const args[], int coeffs[], int k)
 Pseudo-Boolean relations. More...
 
Z3_ast Z3_API Z3_func_decl_to_ast (Z3_context c, Z3_func_decl f)
 Convert a Z3_func_decl into Z3_ast. This is just type casting. More...
 
Z3_bool Z3_API Z3_is_eq_func_decl (Z3_context c, Z3_func_decl f1, Z3_func_decl f2)
 compare terms. More...
 
unsigned Z3_API Z3_get_func_decl_id (Z3_context c, Z3_func_decl f)
 Return a unique identifier for f. More...
 
Z3_symbol Z3_API Z3_get_decl_name (Z3_context c, Z3_func_decl d)
 Return the constant declaration name as a symbol. More...
 
Z3_decl_kind Z3_API Z3_get_decl_kind (Z3_context c, Z3_func_decl d)
 Return declaration kind corresponding to declaration. More...
 
unsigned Z3_API Z3_get_domain_size (Z3_context c, Z3_func_decl d)
 Return the number of parameters of the given declaration. More...
 
unsigned Z3_API Z3_get_arity (Z3_context c, Z3_func_decl d)
 Alias for Z3_get_domain_size. More...
 
Z3_sort Z3_API Z3_get_domain (Z3_context c, Z3_func_decl d, unsigned i)
 Return the sort of the i-th parameter of the given function declaration. More...
 
Z3_sort Z3_API Z3_get_range (Z3_context c, Z3_func_decl d)
 Return the range of the given declaration. More...
 
unsigned Z3_API Z3_get_decl_num_parameters (Z3_context c, Z3_func_decl d)
 Return the number of parameters associated with a declaration. More...
 
Z3_parameter_kind Z3_API Z3_get_decl_parameter_kind (Z3_context c, Z3_func_decl d, unsigned idx)
 Return the parameter type associated with a declaration. More...
 
int Z3_API Z3_get_decl_int_parameter (Z3_context c, Z3_func_decl d, unsigned idx)
 Return the integer value associated with an integer parameter. More...
 
double Z3_API Z3_get_decl_double_parameter (Z3_context c, Z3_func_decl d, unsigned idx)
 Return the double value associated with an double parameter. More...
 
Z3_symbol Z3_API Z3_get_decl_symbol_parameter (Z3_context c, Z3_func_decl d, unsigned idx)
 Return the double value associated with an double parameter. More...
 
Z3_sort Z3_API Z3_get_decl_sort_parameter (Z3_context c, Z3_func_decl d, unsigned idx)
 Return the sort value associated with a sort parameter. More...
 
Z3_ast Z3_API Z3_get_decl_ast_parameter (Z3_context c, Z3_func_decl d, unsigned idx)
 Return the expresson value associated with an expression parameter. More...
 
Z3_func_decl Z3_API Z3_get_decl_func_decl_parameter (Z3_context c, Z3_func_decl d, unsigned idx)
 Return the expresson value associated with an expression parameter. More...
 
Z3_string Z3_API Z3_get_decl_rational_parameter (Z3_context c, Z3_func_decl d, unsigned idx)
 Return the rational value, as a string, associated with a rational parameter. More...
 
Z3_ast Z3_API Z3_app_to_ast (Z3_context c, Z3_app a)
 Convert a Z3_app into Z3_ast. This is just type casting. More...
 
Z3_func_decl Z3_API Z3_get_app_decl (Z3_context c, Z3_app a)
 Return the declaration of a constant or function application. More...
 
unsigned Z3_API Z3_get_app_num_args (Z3_context c, Z3_app a)
 Return the number of argument of an application. If t is an constant, then the number of arguments is 0. More...
 
Z3_ast Z3_API Z3_get_app_arg (Z3_context c, Z3_app a, unsigned i)
 Return the i-th argument of the given application. More...
 
Z3_bool Z3_API Z3_is_eq_ast (Z3_context c, Z3_ast t1, Z3_ast t2)
 compare terms. More...
 
unsigned Z3_API Z3_get_ast_id (Z3_context c, Z3_ast t)
 Return a unique identifier for 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. More...
 
unsigned Z3_API Z3_get_ast_hash (Z3_context c, Z3_ast a)
 Return a hash code for the given AST. The hash code is structural. You can use Z3_get_ast_id interchangably with this function. More...
 
Z3_sort Z3_API Z3_get_sort (Z3_context c, Z3_ast a)
 Return the sort of an AST node. More...
 
Z3_bool Z3_API Z3_is_well_sorted (Z3_context c, Z3_ast t)
 Return true if the given expression t is well sorted. More...
 
Z3_lbool Z3_API Z3_get_bool_value (Z3_context c, Z3_ast a)
 Return Z3_L_TRUE if a is true, Z3_L_FALSE if it is false, and Z3_L_UNDEF otherwise. More...
 
Z3_ast_kind Z3_API Z3_get_ast_kind (Z3_context c, Z3_ast a)
 Return the kind of the given AST. More...
 
Z3_bool Z3_API Z3_is_app (Z3_context c, Z3_ast a)
 
Z3_bool Z3_API Z3_is_numeral_ast (Z3_context c, Z3_ast a)
 
Z3_bool Z3_API Z3_is_algebraic_number (Z3_context c, Z3_ast a)
 Return true if the give AST is a real algebraic number. More...
 
Z3_app Z3_API Z3_to_app (Z3_context c, Z3_ast a)
 Convert an ast into an APP_AST. This is just type casting. More...
 
Z3_func_decl Z3_API Z3_to_func_decl (Z3_context c, Z3_ast a)
 Convert an AST into a FUNC_DECL_AST. This is just type casting. More...
 
Z3_string Z3_API Z3_get_numeral_string (Z3_context c, Z3_ast a)
 Return numeral value, as a string of a numeric constant term. More...
 
Z3_string Z3_API Z3_get_numeral_decimal_string (Z3_context c, Z3_ast a, unsigned precision)
 Return numeral as a string in decimal notation. The result has at most precision decimal places. More...
 
Z3_ast Z3_API Z3_get_numerator (Z3_context c, Z3_ast a)
 Return the numerator (as a numeral AST) of a numeral AST of sort Real. More...
 
Z3_ast Z3_API Z3_get_denominator (Z3_context c, Z3_ast a)
 Return the denominator (as a numeral AST) of a numeral AST of sort Real. More...
 
Z3_bool Z3_API Z3_get_numeral_small (Z3_context c, Z3_ast a, __int64 *num, __int64 *den)
 Return numeral value, as a pair of 64 bit numbers if the representation fits. More...
 
Z3_bool Z3_API Z3_get_numeral_int (Z3_context c, Z3_ast v, int *i)
 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. More...
 
Z3_bool Z3_API Z3_get_numeral_uint (Z3_context c, Z3_ast v, unsigned *u)
 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. More...
 
Z3_bool Z3_API Z3_get_numeral_uint64 (Z3_context c, Z3_ast v, unsigned __int64 *u)
 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. More...
 
Z3_bool Z3_API Z3_get_numeral_int64 (Z3_context c, Z3_ast v, __int64 *i)
 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. More...
 
Z3_bool Z3_API Z3_get_numeral_rational_int64 (Z3_context c, Z3_ast v, __int64 *num, __int64 *den)
 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. More...
 
Z3_ast Z3_API Z3_get_algebraic_number_lower (Z3_context c, Z3_ast a, unsigned precision)
 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. More...
 
Z3_ast Z3_API Z3_get_algebraic_number_upper (Z3_context c, Z3_ast a, unsigned precision)
 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. More...
 
Z3_ast Z3_API Z3_pattern_to_ast (Z3_context c, Z3_pattern p)
 Convert a Z3_pattern into Z3_ast. This is just type casting. More...
 
unsigned Z3_API Z3_get_pattern_num_terms (Z3_context c, Z3_pattern p)
 Return number of terms in pattern. More...
 
Z3_ast Z3_API Z3_get_pattern (Z3_context c, Z3_pattern p, unsigned idx)
 Return i'th ast in pattern. More...
 
unsigned Z3_API Z3_get_index_value (Z3_context c, Z3_ast a)
 Return index of de-Brujin bound variable. More...
 
Z3_bool Z3_API Z3_is_quantifier_forall (Z3_context c, Z3_ast a)
 Determine if quantifier is universal. More...
 
unsigned Z3_API Z3_get_quantifier_weight (Z3_context c, Z3_ast a)
 Obtain weight of quantifier. More...
 
unsigned Z3_API Z3_get_quantifier_num_patterns (Z3_context c, Z3_ast a)
 Return number of patterns used in quantifier. More...
 
Z3_pattern Z3_API Z3_get_quantifier_pattern_ast (Z3_context c, Z3_ast a, unsigned i)
 Return i'th pattern. More...
 
unsigned Z3_API Z3_get_quantifier_num_no_patterns (Z3_context c, Z3_ast a)
 Return number of no_patterns used in quantifier. More...
 
Z3_ast Z3_API Z3_get_quantifier_no_pattern_ast (Z3_context c, Z3_ast a, unsigned i)
 Return i'th no_pattern. More...
 
unsigned Z3_API Z3_get_quantifier_num_bound (Z3_context c, Z3_ast a)
 Return number of bound variables of quantifier. More...
 
Z3_symbol Z3_API Z3_get_quantifier_bound_name (Z3_context c, Z3_ast a, unsigned i)
 Return symbol of the i'th bound variable. More...
 
Z3_sort Z3_API Z3_get_quantifier_bound_sort (Z3_context c, Z3_ast a, unsigned i)
 Return sort of the i'th bound variable. More...
 
Z3_ast Z3_API Z3_get_quantifier_body (Z3_context c, Z3_ast a)
 Return body of quantifier. More...
 
Z3_ast Z3_API Z3_simplify (Z3_context c, Z3_ast a)
 Interface to simplifier. More...
 
Z3_ast Z3_API Z3_simplify_ex (Z3_context c, Z3_ast a, Z3_params p)
 Interface to simplifier. More...
 
Z3_string Z3_API Z3_simplify_get_help (Z3_context c)
 Return a string describing all available parameters. More...
 
Z3_param_descrs Z3_API Z3_simplify_get_param_descrs (Z3_context c)
 Return the parameter description set for the simplify procedure. More...
 

Modifiers

Z3_ast Z3_API Z3_update_term (Z3_context c, Z3_ast a, unsigned num_args, Z3_ast const args[])
 Update the arguments of term a using the arguments args. The number of arguments num_args should coincide with the number of arguments to a. If a is a quantifier, then num_args has to be 1. More...
 
Z3_ast Z3_API Z3_substitute (Z3_context c, Z3_ast a, unsigned num_exprs, Z3_ast const from[], Z3_ast const to[])
 Substitute every occurrence of from[i] in a with to[i], for i smaller than num_exprs. The result is the new AST. The arrays from and to must have size num_exprs. For every i smaller than num_exprs, we must have that sort of from[i] must be equal to sort of to[i]. More...
 
Z3_ast Z3_API Z3_substitute_vars (Z3_context c, Z3_ast a, unsigned num_exprs, Z3_ast const to[])
 Substitute the free variables in a with the expressions in to. For every i smaller than num_exprs, the variable with de-Bruijn index i is replaced with term to[i]. More...
 
Z3_ast Z3_API Z3_translate (Z3_context source, Z3_ast a, Z3_context target)
 Translate/Copy the AST a from context source to context target. AST a must have been created using context source. More...
 

Models

void Z3_API Z3_model_inc_ref (Z3_context c, Z3_model m)
 Increment the reference counter of the given model. More...
 
void Z3_API Z3_model_dec_ref (Z3_context c, Z3_model m)
 Decrement the reference counter of the given model. More...
 
Z3_bool Z3_API Z3_model_eval (Z3_context c, Z3_model m, Z3_ast t, Z3_bool model_completion, Z3_ast *v)
 Evaluate the AST node t in the given model. Return Z3_TRUE if succeeded, and store the result in v.If model_completion is Z3_TRUE, then Z3 will assign an interpretation for any constant or function that does not have an interpretation in m. These constants and functions were essentially don't cares. More...
 
Z3_ast Z3_API Z3_model_get_const_interp (Z3_context c, Z3_model m, Z3_func_decl a)
 Return the interpretation (i.e., assignment) of constant a in the model m. Return NULL, if the model does not assign an interpretation for a. That should be interpreted as: the value of a does not matter. More...
 
Z3_bool Z3_API Z3_model_has_interp (Z3_context c, Z3_model m, Z3_func_decl a)
 Test if there exists an interpretation (i.e., assignment) for a in the model m. More...
 
Z3_func_interp Z3_API Z3_model_get_func_interp (Z3_context c, Z3_model m, Z3_func_decl f)
 Return the interpretation of the function f in the model m. Return NULL, if the model does not assign an interpretation for f. That should be interpreted as: the f does not matter. More...
 
unsigned Z3_API Z3_model_get_num_consts (Z3_context c, Z3_model m)
 Return the number of constants assigned by the given model. More...
 
Z3_func_decl Z3_API Z3_model_get_const_decl (Z3_context c, Z3_model m, unsigned i)
 Return the i-th constant in the given model. More...
 
unsigned Z3_API Z3_model_get_num_funcs (Z3_context c, Z3_model m)
 Return the number of function interpretations in the given model. More...
 
Z3_func_decl Z3_API Z3_model_get_func_decl (Z3_context c, Z3_model m, unsigned i)
 Return the declaration of the i-th function in the given model. More...
 
unsigned Z3_API Z3_model_get_num_sorts (Z3_context c, Z3_model m)
 Return the number of uninterpreted sorts that m assigs an interpretation to. More...
 
Z3_sort Z3_API Z3_model_get_sort (Z3_context c, Z3_model m, unsigned i)
 Return a uninterpreted sort that m assigns an interpretation. More...
 
Z3_ast_vector Z3_API Z3_model_get_sort_universe (Z3_context c, Z3_model m, Z3_sort s)
 Return the finite set of distinct values that represent the interpretation for sort s. More...
 
Z3_bool Z3_API Z3_is_as_array (Z3_context c, Z3_ast a)
 The (_ as-array f) AST node is a construct for assigning interpretations for arrays in Z3. It is the array such that forall indices i we have that (select (_ as-array f) i) is equal to (f i). This procedure returns Z3_TRUE if the a is an as-array AST node. More...
 
Z3_func_decl Z3_API Z3_get_as_array_func_decl (Z3_context c, Z3_ast a)
 Return the function declaration f associated with a (_ as_array f) node. More...
 
void Z3_API Z3_func_interp_inc_ref (Z3_context c, Z3_func_interp f)
 Increment the reference counter of the given Z3_func_interp object. More...
 
void Z3_API Z3_func_interp_dec_ref (Z3_context c, Z3_func_interp f)
 Decrement the reference counter of the given Z3_func_interp object. More...
 
unsigned Z3_API Z3_func_interp_get_num_entries (Z3_context c, Z3_func_interp f)
 Return the number of entries in the given function interpretation. More...
 
Z3_func_entry Z3_API Z3_func_interp_get_entry (Z3_context c, Z3_func_interp f, unsigned i)
 Return a "point" of the given function intepretation. It represents the value of f in a particular point. More...
 
Z3_ast Z3_API Z3_func_interp_get_else (Z3_context c, Z3_func_interp f)
 Return the 'else' value of the given function interpretation. More...
 
unsigned Z3_API Z3_func_interp_get_arity (Z3_context c, Z3_func_interp f)
 Return the arity (number of arguments) of the given function interpretation. More...
 
void Z3_API Z3_func_entry_inc_ref (Z3_context c, Z3_func_entry e)
 Increment the reference counter of the given Z3_func_entry object. More...
 
void Z3_API Z3_func_entry_dec_ref (Z3_context c, Z3_func_entry e)
 Decrement the reference counter of the given Z3_func_entry object. More...
 
Z3_ast Z3_API Z3_func_entry_get_value (Z3_context c, Z3_func_entry e)
 Return the value of this point. More...
 
unsigned Z3_API Z3_func_entry_get_num_args (Z3_context c, Z3_func_entry e)
 Return the number of arguments in a Z3_func_entry object. More...
 
Z3_ast Z3_API Z3_func_entry_get_arg (Z3_context c, Z3_func_entry e, unsigned i)
 Return an argument of a Z3_func_entry object. More...
 

Interaction logging.

Z3_bool Z3_API Z3_open_log (Z3_string filename)
 Log interaction to a file. More...
 
void Z3_API Z3_append_log (Z3_string string)
 Append user-defined string to interaction log. More...
 
void Z3_API Z3_close_log (void)
 Close interaction log. More...
 
void Z3_API Z3_toggle_warning_messages (Z3_bool enabled)
 Enable/disable printing warning messages to the console. More...
 

String conversion

void Z3_API Z3_set_ast_print_mode (Z3_context c, Z3_ast_print_mode mode)
 Select mode for the format used for pretty-printing AST nodes. More...
 
Z3_string Z3_API Z3_ast_to_string (Z3_context c, Z3_ast a)
 Convert the given AST node into a string. More...
 
Z3_string Z3_API Z3_pattern_to_string (Z3_context c, Z3_pattern p)
 
Z3_string Z3_API Z3_sort_to_string (Z3_context c, Z3_sort s)
 
Z3_string Z3_API Z3_func_decl_to_string (Z3_context c, Z3_func_decl d)
 
Z3_string Z3_API Z3_model_to_string (Z3_context c, Z3_model m)
 Convert the given model into a string. More...
 
Z3_string Z3_API Z3_benchmark_to_smtlib_string (Z3_context c, Z3_string name, Z3_string logic, Z3_string status, Z3_string attributes, unsigned num_assumptions, Z3_ast const assumptions[], Z3_ast formula)
 Convert the given benchmark into SMT-LIB formatted string. More...
 

Parser interface

Z3_ast Z3_API Z3_parse_smtlib2_string (Z3_context c, Z3_string str, unsigned num_sorts, Z3_symbol const sort_names[], Z3_sort const sorts[], unsigned num_decls, Z3_symbol const decl_names[], Z3_func_decl const decls[])
 Parse the given string using the SMT-LIB2 parser. More...
 
Z3_ast Z3_API Z3_parse_smtlib2_file (Z3_context c, Z3_string file_name, unsigned num_sorts, Z3_symbol const sort_names[], Z3_sort const sorts[], unsigned num_decls, Z3_symbol const decl_names[], Z3_func_decl const decls[])
 Similar to Z3_parse_smtlib2_string, but reads the benchmark from a file. More...
 
void Z3_API Z3_parse_smtlib_string (Z3_context c, Z3_string str, unsigned num_sorts, Z3_symbol const sort_names[], Z3_sort const sorts[], unsigned num_decls, Z3_symbol const decl_names[], Z3_func_decl const decls[])
 Parse the given string using the SMT-LIB parser. More...
 
void Z3_API Z3_parse_smtlib_file (Z3_context c, Z3_string file_name, unsigned num_sorts, Z3_symbol const sort_names[], Z3_sort const sorts[], unsigned num_decls, Z3_symbol const decl_names[], Z3_func_decl const decls[])
 Similar to Z3_parse_smtlib_string, but reads the benchmark from a file. More...
 
unsigned Z3_API Z3_get_smtlib_num_formulas (Z3_context c)
 Return the number of SMTLIB formulas parsed by the last call to Z3_parse_smtlib_string or Z3_parse_smtlib_file. More...
 
Z3_ast Z3_API Z3_get_smtlib_formula (Z3_context c, unsigned i)
 Return the i-th formula parsed by the last call to Z3_parse_smtlib_string or Z3_parse_smtlib_file. More...
 
unsigned Z3_API Z3_get_smtlib_num_assumptions (Z3_context c)
 Return the number of SMTLIB assumptions parsed by Z3_parse_smtlib_string or Z3_parse_smtlib_file. More...
 
Z3_ast Z3_API Z3_get_smtlib_assumption (Z3_context c, unsigned i)
 Return the i-th assumption parsed by the last call to Z3_parse_smtlib_string or Z3_parse_smtlib_file. More...
 
unsigned Z3_API Z3_get_smtlib_num_decls (Z3_context c)
 Return the number of declarations parsed by Z3_parse_smtlib_string or Z3_parse_smtlib_file. More...
 
Z3_func_decl Z3_API Z3_get_smtlib_decl (Z3_context c, unsigned i)
 Return the i-th declaration parsed by the last call to Z3_parse_smtlib_string or Z3_parse_smtlib_file. More...
 
unsigned Z3_API Z3_get_smtlib_num_sorts (Z3_context c)
 Return the number of sorts parsed by Z3_parse_smtlib_string or Z3_parse_smtlib_file. More...
 
Z3_sort Z3_API Z3_get_smtlib_sort (Z3_context c, unsigned i)
 Return the i-th sort parsed by the last call to Z3_parse_smtlib_string or Z3_parse_smtlib_file. More...
 
BEGIN_MLAPI_EXCLUDE Z3_string Z3_API Z3_get_smtlib_error (Z3_context c)
 Retrieve that last error message information generated from parsing. More...
 

Error Handling

Z3_error_code Z3_API Z3_get_error_code (Z3_context c)
 Return the error code for the last API call. More...
 
void Z3_API Z3_set_error_handler (Z3_context c, Z3_error_handler h)
 Register a Z3 error handler. More...
 
void Z3_API Z3_set_error (Z3_context c, Z3_error_code e)
 Set an error. More...
 
Z3_string Z3_API Z3_get_error_msg (Z3_error_code err)
 Return a string describing the given error code. More...
 
BEGIN_MLAPI_EXCLUDE Z3_string Z3_API Z3_get_error_msg_ex (Z3_context c, Z3_error_code err)
 Return a string describing the given error code. More...
 

Miscellaneous

void Z3_API Z3_get_version (unsigned *major, unsigned *minor, unsigned *build_number, unsigned *revision_number)
 Return Z3 version number information. More...
 
void Z3_API Z3_enable_trace (Z3_string tag)
 Enable tracing messages tagged as tag when Z3 is compiled in debug mode. It is a NOOP otherwise. More...
 
void Z3_API Z3_disable_trace (Z3_string tag)
 Disable tracing messages tagged as tag when Z3 is compiled in debug mode. It is a NOOP otherwise. More...
 
void Z3_API Z3_reset_memory (void)
 Reset all allocated resources. More...
 
void Z3_API Z3_finalize_memory (void)
 Destroy all allocated resources. More...
 

External Theory Plugins

typedef Z3_bool Z3_reduce_eq_callback_fptr(Z3_theory t, Z3_ast a, Z3_ast b, Z3_ast *r)
 
typedef Z3_bool Z3_reduce_app_callback_fptr(Z3_theory, Z3_func_decl, unsigned, Z3_ast const [], Z3_ast *)
 
typedef Z3_bool Z3_reduce_distinct_callback_fptr(Z3_theory, unsigned, Z3_ast const [], Z3_ast *)
 
typedef void Z3_theory_callback_fptr(Z3_theory t)
 
typedef Z3_bool Z3_theory_final_check_callback_fptr(Z3_theory)
 
typedef void Z3_theory_ast_callback_fptr(Z3_theory, Z3_ast)
 
typedef void Z3_theory_ast_bool_callback_fptr(Z3_theory, Z3_ast, Z3_bool)
 
typedef void Z3_theory_ast_ast_callback_fptr(Z3_theory, Z3_ast, Z3_ast)
 
Z3_theory Z3_API Z3_mk_theory (Z3_context c, Z3_string th_name, Z3_theory_data data)
 Create a new user defined theory. The new theory will be identified by the name th_name. A theory must be created before asserting any assertion to the given context. Return NULL in case of failure. More...
 
Z3_theory_data Z3_API Z3_theory_get_ext_data (Z3_theory t)
 Return a pointer to the external data-structure supplied to the function Z3_mk_theory. More...
 
Z3_sort Z3_API Z3_theory_mk_sort (Z3_context c, Z3_theory t, Z3_symbol s)
 Create an interpreted theory sort. More...
 
Z3_ast Z3_API Z3_theory_mk_value (Z3_context c, Z3_theory t, Z3_symbol n, Z3_sort s)
 Create an interpreted theory constant value. Values are assumed to be different from each other. More...
 
Z3_ast Z3_API Z3_theory_mk_constant (Z3_context c, Z3_theory t, Z3_symbol n, Z3_sort s)
 Create an interpreted constant for the given theory. More...
 
Z3_func_decl Z3_API Z3_theory_mk_func_decl (Z3_context c, Z3_theory t, Z3_symbol n, unsigned domain_size, Z3_sort const domain[], Z3_sort range)
 Create an interpreted function declaration for the given theory. More...
 
Z3_context Z3_API Z3_theory_get_context (Z3_theory t)
 Return the context where the given theory is installed. More...
 
void Z3_API Z3_set_delete_callback (Z3_theory t, Z3_theory_callback_fptr f)
 Set a callback that is invoked when theory t is deleted. This callback should be used to delete external data-structures associated with the given theory. More...
 
void Z3_API Z3_set_reduce_app_callback (Z3_theory t, Z3_reduce_app_callback_fptr f)
 Set a callback for simplifying operators of the given theory. The callback f is invoked by Z3's simplifier. More...
 
void Z3_API Z3_set_reduce_eq_callback (Z3_theory t, Z3_reduce_eq_callback_fptr f)
 Set a callback for simplifying the atom s_1 = s_2, when the sort of s_1 and s_2 is an interpreted sort of the given theory. The callback f is invoked by Z3's simplifier. More...
 
void Z3_API Z3_set_reduce_distinct_callback (Z3_theory t, Z3_reduce_distinct_callback_fptr f)
 Set a callback for simplifying the atom distinct(s_1, ..., s_n), when the sort of s_1, ..., s_n is an interpreted sort of the given theory. The callback f is invoked by Z3's simplifier. More...
 
void Z3_API Z3_set_new_app_callback (Z3_theory t, Z3_theory_ast_callback_fptr f)
 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. More...
 
void Z3_API Z3_set_new_elem_callback (Z3_theory t, Z3_theory_ast_callback_fptr f)
 Set a callback that is invoked when an expression of sort s, where s is an interpreted sort of the theory 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. More...
 
void Z3_API Z3_set_init_search_callback (Z3_theory t, Z3_theory_callback_fptr f)
 Set a callback that is invoked when Z3 starts searching for a satisfying assignment. More...
 
void Z3_API Z3_set_push_callback (Z3_theory t, Z3_theory_callback_fptr f)
 Set a callback that is invoked when Z3 creates a case-split (aka backtracking point). More...
 
void Z3_API Z3_set_pop_callback (Z3_theory t, Z3_theory_callback_fptr f)
 Set a callback that is invoked when Z3 backtracks a case-split. More...
 
void Z3_API Z3_set_restart_callback (Z3_theory t, Z3_theory_callback_fptr f)
 Set a callback that is invoked when Z3 restarts the search for a satisfying assignment. More...
 
void Z3_API Z3_set_reset_callback (Z3_theory t, Z3_theory_callback_fptr f)
 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. More...
 
void Z3_API Z3_set_final_check_callback (Z3_theory t, Z3_theory_final_check_callback_fptr f)
 Set a callback that is invoked before Z3 starts building a model. A theory may use this callback to perform expensive operations. More...
 
void Z3_API Z3_set_new_eq_callback (Z3_theory t, Z3_theory_ast_ast_callback_fptr f)
 Set a callback that is invoked when an equality s_1 = s_2 is found by the logical context. More...
 
void Z3_API Z3_set_new_diseq_callback (Z3_theory t, Z3_theory_ast_ast_callback_fptr f)
 Set a callback that is invoked when a disequality s_1 != s_2 is found by the logical context. More...
 
void Z3_API Z3_set_new_assignment_callback (Z3_theory t, Z3_theory_ast_bool_callback_fptr f)
 Set a callback that is invoked when a theory predicate is assigned to true/false by Z3. More...
 
void Z3_API Z3_set_new_relevant_callback (Z3_theory t, Z3_theory_ast_callback_fptr f)
 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. More...
 
void Z3_API Z3_theory_assert_axiom (Z3_theory t, Z3_ast ax)
 Assert a theory axiom/lemmas during the search. More...
 
void Z3_API Z3_theory_assume_eq (Z3_theory t, Z3_ast lhs, Z3_ast rhs)
 Inform to the logical context that lhs and rhs have the same interpretation in the model being built by theory t. If lhs = rhs is inconsistent with other theories, then the logical context will backtrack. More...
 
void Z3_API Z3_theory_enable_axiom_simplification (Z3_theory t, Z3_bool flag)
 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. More...
 
Z3_ast Z3_API Z3_theory_get_eqc_root (Z3_theory t, Z3_ast n)
 Return the root of the equivalence class containing n. More...
 
Z3_ast Z3_API Z3_theory_get_eqc_next (Z3_theory t, Z3_ast n)
 Return the next element in the equivalence class containing n. More...
 
unsigned Z3_API Z3_theory_get_num_parents (Z3_theory t, Z3_ast n)
 Return the number of parents of n that are operators of the given theory. More...
 
Z3_ast Z3_API Z3_theory_get_parent (Z3_theory t, Z3_ast n, unsigned i)
 Return the i-th parent of n. See Z3_theory_get_num_parents. More...
 
Z3_bool Z3_API Z3_theory_is_value (Z3_theory t, Z3_ast n)
 Return Z3_TRUE if n is an interpreted theory value. More...
 
Z3_bool Z3_API Z3_theory_is_decl (Z3_theory t, Z3_func_decl d)
 Return Z3_TRUE if d is an interpreted theory declaration. More...
 
unsigned Z3_API Z3_theory_get_num_elems (Z3_theory t)
 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. More...
 
Z3_ast Z3_API Z3_theory_get_elem (Z3_theory t, unsigned i)
 Return the i-th elem of the given theory in the logical context. More...
 
unsigned Z3_API Z3_theory_get_num_apps (Z3_theory t)
 Return the number of theory applications in the logical context. These are the expressions notified using the callback Z3_set_new_app_callback. More...
 
Z3_ast Z3_API Z3_theory_get_app (Z3_theory t, unsigned i)
 Return the i-th application of the given theory in the logical context. More...
 

Fixedpoint facilities

typedef void Z3_fixedpoint_reduce_assign_callback_fptr(void *, Z3_func_decl, unsigned, Z3_ast const [], unsigned, Z3_ast const [])
 The following utilities allows adding user-defined domains. More...
 
typedef void Z3_fixedpoint_reduce_app_callback_fptr(void *, Z3_func_decl, unsigned, Z3_ast const [], Z3_ast *)
 
Z3_fixedpoint Z3_API Z3_mk_fixedpoint (Z3_context c)
 Create a new fixedpoint context. More...
 
void Z3_API Z3_fixedpoint_inc_ref (Z3_context c, Z3_fixedpoint d)
 Increment the reference counter of the given fixedpoint context. More...
 
void Z3_API Z3_fixedpoint_dec_ref (Z3_context c, Z3_fixedpoint d)
 Decrement the reference counter of the given fixedpoint context. More...
 
void Z3_API Z3_fixedpoint_add_rule (Z3_context c, Z3_fixedpoint d, Z3_ast rule, Z3_symbol name)
 Add a universal Horn clause as a named rule. The horn_rule should be of the form: More...
 
void Z3_API Z3_fixedpoint_add_fact (Z3_context c, Z3_fixedpoint d, Z3_func_decl r, unsigned num_args, unsigned args[])
 Add a Database fact. More...
 
void Z3_API Z3_fixedpoint_assert (Z3_context c, Z3_fixedpoint d, Z3_ast axiom)
 Assert a constraint to the fixedpoint context. More...
 
Z3_lbool Z3_API Z3_fixedpoint_query (Z3_context c, Z3_fixedpoint d, Z3_ast query)
 Pose a query against the asserted rules. More...
 
Z3_lbool Z3_API Z3_fixedpoint_query_relations (Z3_context c, Z3_fixedpoint d, unsigned num_relations, Z3_func_decl const relations[])
 Pose multiple queries against the asserted rules. More...
 
Z3_ast Z3_API Z3_fixedpoint_get_answer (Z3_context c, Z3_fixedpoint d)
 Retrieve a formula that encodes satisfying answers to the query. More...
 
Z3_string Z3_API Z3_fixedpoint_get_reason_unknown (Z3_context c, Z3_fixedpoint d)
 Retrieve a string that describes the last status returned by Z3_fixedpoint_query. More...
 
void Z3_API Z3_fixedpoint_update_rule (Z3_context c, Z3_fixedpoint d, Z3_ast a, Z3_symbol name)
 Update a named rule. A rule with the same name must have been previously created. More...
 
unsigned Z3_API Z3_fixedpoint_get_num_levels (Z3_context c, Z3_fixedpoint d, Z3_func_decl pred)
 Query the PDR engine for the maximal levels properties are known about predicate. More...
 
Z3_ast Z3_API Z3_fixedpoint_get_cover_delta (Z3_context c, Z3_fixedpoint d, int level, Z3_func_decl pred)
 
void Z3_API Z3_fixedpoint_add_cover (Z3_context c, Z3_fixedpoint d, int level, Z3_func_decl pred, Z3_ast property)
 Add property about the predicate pred. Add a property of predicate pred at level. It gets pushed forward when possible. More...
 
Z3_stats Z3_API Z3_fixedpoint_get_statistics (Z3_context c, Z3_fixedpoint d)
 Retrieve statistics information from the last call to Z3_fixedpoint_query. More...
 
void Z3_API Z3_fixedpoint_register_relation (Z3_context c, Z3_fixedpoint d, Z3_func_decl f)
 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. More...
 
void Z3_API Z3_fixedpoint_set_predicate_representation (Z3_context c, Z3_fixedpoint d, Z3_func_decl f, unsigned num_relations, Z3_symbol const relation_kinds[])
 Configure the predicate representation. More...
 
Z3_ast_vector Z3_API Z3_fixedpoint_get_rules (Z3_context c, Z3_fixedpoint f)
 Retrieve set of rules from fixedpoint context. More...
 
Z3_ast_vector Z3_API Z3_fixedpoint_get_assertions (Z3_context c, Z3_fixedpoint f)
 Retrieve set of background assertions from fixedpoint context. More...
 
void Z3_API Z3_fixedpoint_set_params (Z3_context c, Z3_fixedpoint f, Z3_params p)
 Set parameters on fixedpoint context. More...
 
Z3_string Z3_API Z3_fixedpoint_get_help (Z3_context c, Z3_fixedpoint f)
 Return a string describing all fixedpoint available parameters. More...
 
Z3_param_descrs Z3_API Z3_fixedpoint_get_param_descrs (Z3_context c, Z3_fixedpoint f)
 Return the parameter description set for the given fixedpoint object. More...
 
Z3_string Z3_API Z3_fixedpoint_to_string (Z3_context c, Z3_fixedpoint f, unsigned num_queries, Z3_ast queries[])
 Print the current rules and background axioms as a string. More...
 
Z3_ast_vector Z3_API Z3_fixedpoint_from_string (Z3_context c, Z3_fixedpoint f, Z3_string s)
 Parse an SMT-LIB2 string with fixedpoint rules. Add the rules to the current fixedpoint context. Return the set of queries in the string. More...
 
Z3_ast_vector Z3_API Z3_fixedpoint_from_file (Z3_context c, Z3_fixedpoint f, Z3_string s)
 Parse an SMT-LIB2 file with fixedpoint rules. Add the rules to the current fixedpoint context. Return the set of queries in the file. More...
 
void Z3_API Z3_fixedpoint_push (Z3_context c, Z3_fixedpoint d)
 Create a backtracking point. More...
 
void Z3_API Z3_fixedpoint_pop (Z3_context c, Z3_fixedpoint d)
 Backtrack one backtracking point. More...
 
void Z3_API Z3_fixedpoint_init (Z3_context c, Z3_fixedpoint d, void *state)
 Initialize the context with a user-defined state. More...
 
void Z3_API Z3_fixedpoint_set_reduce_assign_callback (Z3_context c, Z3_fixedpoint d, Z3_fixedpoint_reduce_assign_callback_fptr cb)
 Register a callback to destructive updates. More...
 
void Z3_API Z3_fixedpoint_set_reduce_app_callback (Z3_context c, Z3_fixedpoint d, Z3_fixedpoint_reduce_app_callback_fptr cb)
 Register a callback for buildling terms based on the relational operators. More...
 

Optimize facilities

Z3_optimize Z3_API Z3_mk_optimize (Z3_context c)
 Create a new optimize context. More...
 
void Z3_API Z3_optimize_inc_ref (Z3_context c, Z3_optimize d)
 Increment the reference counter of the given optimize context. More...
 
void Z3_API Z3_optimize_dec_ref (Z3_context c, Z3_optimize d)
 Decrement the reference counter of the given optimize context. More...
 
void Z3_API Z3_optimize_assert (Z3_context c, Z3_optimize o, Z3_ast a)
 Assert hard constraint to the optimization context. More...
 
unsigned Z3_API Z3_optimize_assert_soft (Z3_context c, Z3_optimize o, Z3_ast a, Z3_string weight, Z3_symbol id)
 Assert soft constraint to the optimization context. More...
 
unsigned Z3_API Z3_optimize_maximize (Z3_context c, Z3_optimize o, Z3_ast t)
 Add a maximization constraint. More...
 
unsigned Z3_API Z3_optimize_minimize (Z3_context c, Z3_optimize o, Z3_ast t)
 Add a minimization constraint. More...
 
void Z3_API Z3_optimize_push (Z3_context c, Z3_optimize d)
 Create a backtracking point. More...
 
void Z3_API Z3_optimize_pop (Z3_context c, Z3_optimize d)
 Backtrack one level. More...
 
Z3_lbool Z3_API Z3_optimize_check (Z3_context c, Z3_optimize o)
 Check consistency and produce optimal values. More...
 
Z3_string Z3_API Z3_optimize_get_reason_unknown (Z3_context c, Z3_optimize d)
 Retrieve a string that describes the last status returned by Z3_optimize_check. More...
 
Z3_model Z3_API Z3_optimize_get_model (Z3_context c, Z3_optimize o)
 Retrieve the model for the last Z3_optimize_check. More...
 
void Z3_API Z3_optimize_set_params (Z3_context c, Z3_optimize o, Z3_params p)
 Set parameters on optimization context. More...
 
Z3_param_descrs Z3_API Z3_optimize_get_param_descrs (Z3_context c, Z3_optimize o)
 Return the parameter description set for the given optimize object. More...
 
Z3_ast Z3_API Z3_optimize_get_lower (Z3_context c, Z3_optimize o, unsigned idx)
 Retrieve lower bound value or approximation for the i'th optimization objective. More...
 
Z3_ast Z3_API Z3_optimize_get_upper (Z3_context c, Z3_optimize o, unsigned idx)
 Retrieve upper bound value or approximation for the i'th optimization objective. More...
 
Z3_string Z3_API Z3_optimize_to_string (Z3_context c, Z3_optimize o)
 Print the current context as a string. More...
 
Z3_string Z3_API Z3_optimize_get_help (Z3_context c, Z3_optimize t)
 Return a string containing a description of parameters accepted by optimize. More...
 
Z3_stats Z3_API Z3_optimize_get_statistics (Z3_context c, Z3_optimize d)
 Retrieve statistics information from the last call to Z3_optimize_check. More...
 

AST vectors

Z3_ast_vector Z3_API Z3_mk_ast_vector (Z3_context c)
 Return an empty AST vector. More...
 
void Z3_API Z3_ast_vector_inc_ref (Z3_context c, Z3_ast_vector v)
 Increment the reference counter of the given AST vector. More...
 
void Z3_API Z3_ast_vector_dec_ref (Z3_context c, Z3_ast_vector v)
 Decrement the reference counter of the given AST vector. More...
 
unsigned Z3_API Z3_ast_vector_size (Z3_context c, Z3_ast_vector v)
 Return the size of the given AST vector. More...
 
Z3_ast Z3_API Z3_ast_vector_get (Z3_context c, Z3_ast_vector v, unsigned i)
 Return the AST at position i in the AST vector v. More...
 
void Z3_API Z3_ast_vector_set (Z3_context c, Z3_ast_vector v, unsigned i, Z3_ast a)
 Update position i of the AST vector v with the AST a. More...
 
void Z3_API Z3_ast_vector_resize (Z3_context c, Z3_ast_vector v, unsigned n)
 Resize the AST vector v. More...
 
void Z3_API Z3_ast_vector_push (Z3_context c, Z3_ast_vector v, Z3_ast a)
 Add the AST a in the end of the AST vector v. The size of v is increased by one. More...
 
Z3_ast_vector Z3_API Z3_ast_vector_translate (Z3_context s, Z3_ast_vector v, Z3_context t)
 Translate the AST vector v from context s into an AST vector in context t. More...
 
Z3_string Z3_API Z3_ast_vector_to_string (Z3_context c, Z3_ast_vector v)
 Convert AST vector into a string. More...
 

AST maps

Z3_ast_map Z3_API Z3_mk_ast_map (Z3_context c)
 Return an empty mapping from AST to AST. More...
 
void Z3_API Z3_ast_map_inc_ref (Z3_context c, Z3_ast_map m)
 Increment the reference counter of the given AST map. More...
 
void Z3_API Z3_ast_map_dec_ref (Z3_context c, Z3_ast_map m)
 Decrement the reference counter of the given AST map. More...
 
Z3_bool Z3_API Z3_ast_map_contains (Z3_context c, Z3_ast_map m, Z3_ast k)
 Return true if the map m contains the AST key k. More...
 
Z3_ast Z3_API Z3_ast_map_find (Z3_context c, Z3_ast_map m, Z3_ast k)
 Return the value associated with the key k. More...
 
void Z3_API Z3_ast_map_insert (Z3_context c, Z3_ast_map m, Z3_ast k, Z3_ast v)
 Store/Replace a new key, value pair in the given map. More...
 
void Z3_API Z3_ast_map_erase (Z3_context c, Z3_ast_map m, Z3_ast k)
 Erase a key from the map. More...
 
void Z3_API Z3_ast_map_reset (Z3_context c, Z3_ast_map m)
 Remove all keys from the given map. More...
 
unsigned Z3_API Z3_ast_map_size (Z3_context c, Z3_ast_map m)
 Return the size of the given map. More...
 
Z3_ast_vector Z3_API Z3_ast_map_keys (Z3_context c, Z3_ast_map m)
 Return the keys stored in the given map. More...
 
Z3_string Z3_API Z3_ast_map_to_string (Z3_context c, Z3_ast_map m)
 Convert the given map into a string. More...
 

Goals

Z3_goal Z3_API Z3_mk_goal (Z3_context c, Z3_bool models, Z3_bool unsat_cores, Z3_bool proofs)
 Create a goal (aka problem). A goal is essentially a set of formulas, that can be solved and/or transformed using tactics and solvers. More...
 
void Z3_API Z3_goal_inc_ref (Z3_context c, Z3_goal g)
 Increment the reference counter of the given goal. More...
 
void Z3_API Z3_goal_dec_ref (Z3_context c, Z3_goal g)
 Decrement the reference counter of the given goal. More...
 
Z3_goal_prec Z3_API Z3_goal_precision (Z3_context c, Z3_goal g)
 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. More...
 
void Z3_API Z3_goal_assert (Z3_context c, Z3_goal g, Z3_ast a)
 Add a new formula a to the given goal. More...
 
Z3_bool Z3_API Z3_goal_inconsistent (Z3_context c, Z3_goal g)
 Return true if the given goal contains the formula false. More...
 
unsigned Z3_API Z3_goal_depth (Z3_context c, Z3_goal g)
 Return the depth of the given goal. It tracks how many transformations were applied to it. More...
 
void Z3_API Z3_goal_reset (Z3_context c, Z3_goal g)
 Erase all formulas from the given goal. More...
 
unsigned Z3_API Z3_goal_size (Z3_context c, Z3_goal g)
 Return the number of formulas in the given goal. More...
 
Z3_ast Z3_API Z3_goal_formula (Z3_context c, Z3_goal g, unsigned idx)
 Return a formula from the given goal. More...
 
unsigned Z3_API Z3_goal_num_exprs (Z3_context c, Z3_goal g)
 Return the number of formulas, subformulas and terms in the given goal. More...
 
Z3_bool Z3_API Z3_goal_is_decided_sat (Z3_context c, Z3_goal g)
 Return true if the goal is empty, and it is precise or the product of a under approximation. More...
 
Z3_bool Z3_API Z3_goal_is_decided_unsat (Z3_context c, Z3_goal g)
 Return true if the goal contains false, and it is precise or the product of an over approximation. More...
 
Z3_goal Z3_API Z3_goal_translate (Z3_context source, Z3_goal g, Z3_context target)
 Copy a goal g from the context source to a the context target. More...
 
Z3_string Z3_API Z3_goal_to_string (Z3_context c, Z3_goal g)
 Convert a goal into a string. More...
 

Tactics and Probes

Z3_tactic Z3_API Z3_mk_tactic (Z3_context c, Z3_string name)
 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 (help-tactics) in the SMT 2.0 front-end. More...
 
void Z3_API Z3_tactic_inc_ref (Z3_context c, Z3_tactic t)
 Increment the reference counter of the given tactic. More...
 
void Z3_API Z3_tactic_dec_ref (Z3_context c, Z3_tactic g)
 Decrement the reference counter of the given tactic. More...
 
Z3_probe Z3_API Z3_mk_probe (Z3_context c, Z3_string name)
 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 (help-tactics) in the SMT 2.0 front-end. More...
 
void Z3_API Z3_probe_inc_ref (Z3_context c, Z3_probe p)
 Increment the reference counter of the given probe. More...
 
void Z3_API Z3_probe_dec_ref (Z3_context c, Z3_probe p)
 Decrement the reference counter of the given probe. More...
 
Z3_tactic Z3_API Z3_tactic_and_then (Z3_context c, Z3_tactic t1, Z3_tactic t2)
 Return a tactic that applies t1 to a given goal and t2 to every subgoal produced by t1. More...
 
Z3_tactic Z3_API Z3_tactic_or_else (Z3_context c, Z3_tactic t1, Z3_tactic t2)
 Return a tactic that first applies t1 to a given goal, if it fails then returns the result of t2 applied to the given goal. More...
 
Z3_tactic Z3_API Z3_tactic_par_or (Z3_context c, unsigned num, Z3_tactic const ts[])
 Return a tactic that applies the given tactics in parallel. More...
 
Z3_tactic Z3_API Z3_tactic_par_and_then (Z3_context c, Z3_tactic t1, Z3_tactic t2)
 Return a tactic that applies t1 to a given goal and then t2 to every subgoal produced by t1. The subgoals are processed in parallel. More...
 
Z3_tactic Z3_API Z3_tactic_try_for (Z3_context c, Z3_tactic t, unsigned ms)
 Return a tactic that applies t to a given goal for ms milliseconds. If t does not terminate in ms milliseconds, then it fails. More...
 
Z3_tactic Z3_API Z3_tactic_when (Z3_context c, Z3_probe p, Z3_tactic t)
 Return a tactic that applies t to a given goal is the probe p evaluates to true. If p evaluates to false, then the new tactic behaves like the skip tactic. More...
 
Z3_tactic Z3_API Z3_tactic_cond (Z3_context c, Z3_probe p, Z3_tactic t1, Z3_tactic t2)
 Return a tactic that applies t1 to a given goal if the probe p evaluates to true, and t2 if p evaluates to false. More...
 
Z3_tactic Z3_API Z3_tactic_repeat (Z3_context c, Z3_tactic t, unsigned max)
 Return a tactic that keeps applying t until the goal is not modified anymore or the maximum number of iterations max is reached. More...
 
Z3_tactic Z3_API Z3_tactic_skip (Z3_context c)
 Return a tactic that just return the given goal. More...
 
Z3_tactic Z3_API Z3_tactic_fail (Z3_context c)
 Return a tactic that always fails. More...
 
Z3_tactic Z3_API Z3_tactic_fail_if (Z3_context c, Z3_probe p)
 Return a tactic that fails if the probe p evaluates to false. More...
 
Z3_tactic Z3_API Z3_tactic_fail_if_not_decided (Z3_context c)
 Return a tactic that fails if the goal is not trivially satisfiable (i.e., empty) or trivially unsatisfiable (i.e., contains false). More...
 
Z3_tactic Z3_API Z3_tactic_using_params (Z3_context c, Z3_tactic t, Z3_params p)
 Return a tactic that applies t using the given set of parameters. More...
 
Z3_probe Z3_API Z3_probe_const (Z3_context x, double val)
 Return a probe that always evaluates to val. More...
 
Z3_probe Z3_API Z3_probe_lt (Z3_context x, Z3_probe p1, Z3_probe p2)
 Return a probe that evaluates to "true" when the value returned by p1 is less than the value returned by p2. More...
 
Z3_probe Z3_API Z3_probe_gt (Z3_context x, Z3_probe p1, Z3_probe p2)
 Return a probe that evaluates to "true" when the value returned by p1 is greater than the value returned by p2. More...
 
Z3_probe Z3_API Z3_probe_le (Z3_context x, Z3_probe p1, Z3_probe p2)
 Return a probe that evaluates to "true" when the value returned by p1 is less than or equal to the value returned by p2. More...
 
Z3_probe Z3_API Z3_probe_ge (Z3_context x, Z3_probe p1, Z3_probe p2)
 Return a probe that evaluates to "true" when the value returned by p1 is greater than or equal to the value returned by p2. More...
 
Z3_probe Z3_API Z3_probe_eq (Z3_context x, Z3_probe p1, Z3_probe p2)
 Return a probe that evaluates to "true" when the value returned by p1 is equal to the value returned by p2. More...
 
Z3_probe Z3_API Z3_probe_and (Z3_context x, Z3_probe p1, Z3_probe p2)
 Return a probe that evaluates to "true" when p1 and p2 evaluates to true. More...
 
Z3_probe Z3_API Z3_probe_or (Z3_context x, Z3_probe p1, Z3_probe p2)
 Return a probe that evaluates to "true" when p1 or p2 evaluates to true. More...
 
Z3_probe Z3_API Z3_probe_not (Z3_context x, Z3_probe p)
 Return a probe that evaluates to "true" when p does not evaluate to true. More...
 
unsigned Z3_API Z3_get_num_tactics (Z3_context c)
 Return the number of builtin tactics available in Z3. More...
 
Z3_string Z3_API Z3_get_tactic_name (Z3_context c, unsigned i)
 Return the name of the idx tactic. More...
 
unsigned Z3_API Z3_get_num_probes (Z3_context c)
 Return the number of builtin probes available in Z3. More...
 
Z3_string Z3_API Z3_get_probe_name (Z3_context c, unsigned i)
 Return the name of the i probe. More...
 
Z3_string Z3_API Z3_tactic_get_help (Z3_context c, Z3_tactic t)
 Return a string containing a description of parameters accepted by the given tactic. More...
 
Z3_param_descrs Z3_API Z3_tactic_get_param_descrs (Z3_context c, Z3_tactic t)
 Return the parameter description set for the given tactic object. More...
 
Z3_string Z3_API Z3_tactic_get_descr (Z3_context c, Z3_string name)
 Return a string containing a description of the tactic with the given name. More...
 
Z3_string Z3_API Z3_probe_get_descr (Z3_context c, Z3_string name)
 Return a string containing a description of the probe with the given name. More...
 
double Z3_API Z3_probe_apply (Z3_context c, Z3_probe p, Z3_goal g)
 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. More...
 
Z3_apply_result Z3_API Z3_tactic_apply (Z3_context c, Z3_tactic t, Z3_goal g)
 Apply tactic t to the goal g. More...
 
Z3_apply_result Z3_API Z3_tactic_apply_ex (Z3_context c, Z3_tactic t, Z3_goal g, Z3_params p)
 Apply tactic t to the goal g using the parameter set p. More...
 
void Z3_API Z3_apply_result_inc_ref (Z3_context c, Z3_apply_result r)
 Increment the reference counter of the given Z3_apply_result object. More...
 
void Z3_API Z3_apply_result_dec_ref (Z3_context c, Z3_apply_result r)
 Decrement the reference counter of the given Z3_apply_result object. More...
 
Z3_string Z3_API Z3_apply_result_to_string (Z3_context c, Z3_apply_result r)
 Convert the Z3_apply_result object returned by Z3_tactic_apply into a string. More...
 
unsigned Z3_API Z3_apply_result_get_num_subgoals (Z3_context c, Z3_apply_result r)
 Return the number of subgoals in the Z3_apply_result object returned by Z3_tactic_apply. More...
 
Z3_goal Z3_API Z3_apply_result_get_subgoal (Z3_context c, Z3_apply_result r, unsigned i)
 Return one of the subgoals in the Z3_apply_result object returned by Z3_tactic_apply. More...
 
Z3_model Z3_API Z3_apply_result_convert_model (Z3_context c, Z3_apply_result r, unsigned i, Z3_model m)
 Convert a model for the subgoal Z3_apply_result_get_subgoal(c, r, i) into a model for the original goal g. Where g is the goal used to create r using Z3_tactic_apply(c, t, g). More...
 

Solvers

Z3_solver Z3_API Z3_mk_solver (Z3_context c)
 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. More...
 
Z3_solver Z3_API Z3_mk_simple_solver (Z3_context c)
 Create a new (incremental) solver. More...
 
Z3_solver Z3_API Z3_mk_solver_for_logic (Z3_context c, Z3_symbol logic)
 Create a new solver customized for the given logic. It behaves like Z3_mk_solver if the logic is unknown or unsupported. More...
 
Z3_solver Z3_API Z3_mk_solver_from_tactic (Z3_context c, Z3_tactic t)
 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. More...
 
Z3_string Z3_API Z3_solver_get_help (Z3_context c, Z3_solver s)
 Return a string describing all solver available parameters. More...
 
Z3_param_descrs Z3_API Z3_solver_get_param_descrs (Z3_context c, Z3_solver s)
 Return the parameter description set for the given solver object. More...
 
void Z3_API Z3_solver_set_params (Z3_context c, Z3_solver s, Z3_params p)
 Set the given solver using the given parameters. More...
 
void Z3_API Z3_solver_inc_ref (Z3_context c, Z3_solver s)
 Increment the reference counter of the given solver. More...
 
void Z3_API Z3_solver_dec_ref (Z3_context c, Z3_solver s)
 Decrement the reference counter of the given solver. More...
 
void Z3_API Z3_solver_push (Z3_context c, Z3_solver s)
 Create a backtracking point. More...
 
void Z3_API Z3_solver_pop (Z3_context c, Z3_solver s, unsigned n)
 Backtrack n backtracking points. More...
 
void Z3_API Z3_solver_reset (Z3_context c, Z3_solver s)
 Remove all assertions from the solver. More...
 
unsigned Z3_API Z3_solver_get_num_scopes (Z3_context c, Z3_solver s)
 Return the number of backtracking points. More...
 
void Z3_API Z3_solver_assert (Z3_context c, Z3_solver s, Z3_ast a)
 Assert a constraint into the solver. More...
 
void Z3_API Z3_solver_assert_and_track (Z3_context c, Z3_solver s, Z3_ast a, Z3_ast p)
 Assert a constraint a into the solver, and track it (in the unsat) core using the Boolean constant p. More...
 
Z3_ast_vector Z3_API Z3_solver_get_assertions (Z3_context c, Z3_solver s)
 Return the set of asserted formulas as a goal object. More...
 
Z3_lbool Z3_API Z3_solver_check (Z3_context c, Z3_solver s)
 Check whether the assertions in a given solver are consistent or not. More...
 
Z3_lbool Z3_API Z3_solver_check_assumptions (Z3_context c, Z3_solver s, unsigned num_assumptions, Z3_ast const assumptions[])
 Check whether the assertions in the given solver and optional assumptions are consistent or not. More...
 
Z3_model Z3_API Z3_solver_get_model (Z3_context c, Z3_solver s)
 Retrieve the model for the last Z3_solver_check or Z3_solver_check_assumptions. More...
 
Z3_ast Z3_API Z3_solver_get_proof (Z3_context c, Z3_solver s)
 Retrieve the proof for the last Z3_solver_check or Z3_solver_check_assumptions. More...
 
Z3_ast_vector Z3_API Z3_solver_get_unsat_core (Z3_context c, Z3_solver s)
 Retrieve the unsat core for the last Z3_solver_check_assumptions The unsat core is a subset of the assumptions a. More...
 
Z3_string Z3_API Z3_solver_get_reason_unknown (Z3_context c, Z3_solver s)
 Return a brief justification for an "unknown" result (i.e., Z3_L_UNDEF) for the commands Z3_solver_check and Z3_solver_check_assumptions. More...
 
Z3_stats Z3_API Z3_solver_get_statistics (Z3_context c, Z3_solver s)
 Return statistics for the given solver. More...
 
Z3_string Z3_API Z3_solver_to_string (Z3_context c, Z3_solver s)
 Convert a solver into a string. More...
 

Statistics

Z3_string Z3_API Z3_stats_to_string (Z3_context c, Z3_stats s)
 Convert a statistics into a string. More...
 
void Z3_API Z3_stats_inc_ref (Z3_context c, Z3_stats s)
 Increment the reference counter of the given statistics object. More...
 
void Z3_API Z3_stats_dec_ref (Z3_context c, Z3_stats s)
 Decrement the reference counter of the given statistics object. More...
 
unsigned Z3_API Z3_stats_size (Z3_context c, Z3_stats s)
 Return the number of statistical data in s. More...
 
Z3_string Z3_API Z3_stats_get_key (Z3_context c, Z3_stats s, unsigned idx)
 Return the key (a string) for a particular statistical data. More...
 
Z3_bool Z3_API Z3_stats_is_uint (Z3_context c, Z3_stats s, unsigned idx)
 Return Z3_TRUE if the given statistical data is a unsigned integer. More...
 
Z3_bool Z3_API Z3_stats_is_double (Z3_context c, Z3_stats s, unsigned idx)
 Return Z3_TRUE if the given statistical data is a double. More...
 
unsigned Z3_API Z3_stats_get_uint_value (Z3_context c, Z3_stats s, unsigned idx)
 Return the unsigned value of the given statistical data. More...
 
double Z3_API Z3_stats_get_double_value (Z3_context c, Z3_stats s, unsigned idx)
 Return the double value of the given statistical data. More...
 

Deprecated Injective functions API

Z3_func_decl Z3_API Z3_mk_injective_function (Z3_context c, Z3_symbol s, unsigned domain_size, Z3_sort const domain[], Z3_sort range)
 Create injective function declaration. More...
 

Deprecated Constraints API

Z3_bool Z3_API Z3_set_logic (Z3_context c, Z3_string logic)
 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 Z3_TRUE if the logic was changed successfully, and Z3_FALSE otherwise. More...
 
void Z3_API Z3_push (Z3_context c)
 Create a backtracking point. More...
 
void Z3_API Z3_pop (Z3_context c, unsigned num_scopes)
 Backtrack. More...
 
unsigned Z3_API Z3_get_num_scopes (Z3_context c)
 Retrieve the current scope level. More...
 
void Z3_API Z3_persist_ast (Z3_context c, Z3_ast a, unsigned num_scopes)
 Persist AST through num_scopes pops. This function is only relevant if c was created using Z3_mk_context. If c was created using Z3_mk_context_rc, this function is a NOOP. More...
 
void Z3_API Z3_assert_cnstr (Z3_context c, Z3_ast a)
 Assert a constraint into the logical context. More...
 
Z3_lbool Z3_API Z3_check_and_get_model (Z3_context c, Z3_model *m)
 Check whether the given logical context is consistent or not. More...
 
Z3_lbool Z3_API Z3_check (Z3_context c)
 Check whether the given logical context is consistent or not. More...
 
Z3_lbool Z3_API Z3_check_assumptions (Z3_context c, unsigned num_assumptions, Z3_ast const assumptions[], Z3_model *m, Z3_ast *proof, unsigned *core_size, Z3_ast core[])
 Check whether the given logical context and optional assumptions is consistent or not. More...
 
Z3_lbool Z3_API Z3_get_implied_equalities (Z3_context c, Z3_solver s, unsigned num_terms, Z3_ast const terms[], unsigned class_ids[])
 Retrieve congruence class representatives for terms. More...
 
void Z3_API Z3_del_model (Z3_context c, Z3_model m)
 Delete a model object. More...
 

Deprecated Search control API

void Z3_API Z3_soft_check_cancel (Z3_context c)
 Cancel an ongoing check. More...
 
Z3_search_failure Z3_API Z3_get_search_failure (Z3_context c)
 Retrieve reason for search failure. More...
 

Deprecated Labels API

Z3_ast Z3_API Z3_mk_label (Z3_context c, Z3_symbol s, Z3_bool is_pos, Z3_ast f)
 Create a labeled formula. More...
 
Z3_literals Z3_API Z3_get_relevant_labels (Z3_context c)
 Retrieve the set of labels that were relevant in the context of the current satisfied context. More...
 
Z3_literals Z3_API Z3_get_relevant_literals (Z3_context c)
 Retrieve the set of literals that satisfy the current context. More...
 
Z3_literals Z3_API Z3_get_guessed_literals (Z3_context c)
 Retrieve the set of literals that whose assignment were guess, but not propagated during the search. More...
 
void Z3_API Z3_del_literals (Z3_context c, Z3_literals lbls)
 Delete a labels context. More...
 
unsigned Z3_API Z3_get_num_literals (Z3_context c, Z3_literals lbls)
 Retrieve the number of label symbols that were returned. More...
 
Z3_symbol Z3_API Z3_get_label_symbol (Z3_context c, Z3_literals lbls, unsigned idx)
 Retrieve label symbol at idx. More...
 
Z3_ast Z3_API Z3_get_literal (Z3_context c, Z3_literals lbls, unsigned idx)
 Retrieve literal expression at idx. More...
 
void Z3_API Z3_disable_literal (Z3_context c, Z3_literals lbls, unsigned idx)
 Disable label. More...
 
void Z3_API Z3_block_literals (Z3_context c, Z3_literals lbls)
 Block subsequent checks using the remaining enabled labels. More...
 

Deprecated Model API

unsigned Z3_API Z3_get_model_num_constants (Z3_context c, Z3_model m)
 Return the number of constants assigned by the given model. More...
 
Z3_func_decl Z3_API Z3_get_model_constant (Z3_context c, Z3_model m, unsigned i)
 Return the i-th constant in the given model. More...
 
unsigned Z3_API Z3_get_model_num_funcs (Z3_context c, Z3_model m)
 Return the number of function interpretations in the given model. More...
 
Z3_func_decl Z3_API Z3_get_model_func_decl (Z3_context c, Z3_model m, unsigned i)
 Return the declaration of the i-th function in the given model. More...
 
Z3_bool Z3_API Z3_eval_func_decl (Z3_context c, Z3_model m, Z3_func_decl decl, Z3_ast *v)
 Return the value of the given constant or function in the given model. More...
 
Z3_bool Z3_API Z3_is_array_value (Z3_context c, Z3_model m, Z3_ast v, unsigned *num_entries)
 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. More...
 
void Z3_API Z3_get_array_value (Z3_context c, Z3_model m, Z3_ast v, unsigned num_entries, Z3_ast indices[], Z3_ast values[], Z3_ast *else_value)
 An array values is represented as a dictionary plus a default (else) value. This function returns the array graph. More...
 
Z3_ast Z3_API Z3_get_model_func_else (Z3_context c, Z3_model m, unsigned i)
 Return the 'else' value of the i-th function interpretation in the given model. More...
 
unsigned Z3_API Z3_get_model_func_num_entries (Z3_context c, Z3_model m, unsigned i)
 Return the number of entries of the i-th function interpretation in the given model. More...
 
unsigned Z3_API Z3_get_model_func_entry_num_args (Z3_context c, Z3_model m, unsigned i, unsigned j)
 Return the number of arguments of the j-th entry of the i-th function interpretation in the given model. More...
 
Z3_ast Z3_API Z3_get_model_func_entry_arg (Z3_context c, Z3_model m, unsigned i, unsigned j, unsigned k)
 Return the k-th argument of the j-th entry of the i-th function interpretation in the given model. More...
 
Z3_ast Z3_API Z3_get_model_func_entry_value (Z3_context c, Z3_model m, unsigned i, unsigned j)
 Return the return value of the j-th entry of the i-th function interpretation in the given model. More...
 
Z3_bool Z3_API Z3_eval (Z3_context c, Z3_model m, Z3_ast t, Z3_ast *v)
 Evaluate the AST node t in the given model. Return Z3_TRUE if succeeded, and store the result in v.The evaluation may fail for the following reasons: More...
 
Z3_bool Z3_API Z3_eval_decl (Z3_context c, Z3_model m, Z3_func_decl d, unsigned num_args, Z3_ast const args[], Z3_ast *v)
 Evaluate declaration given values. More...
 

Deprecated String conversion API

Z3_string Z3_API Z3_context_to_string (Z3_context c)
 Convert the given logical context into a string. More...
 
Z3_string Z3_API Z3_statistics_to_string (Z3_context c)
 Return runtime statistics as a string. More...
 
Z3_ast Z3_API Z3_get_context_assignment (Z3_context c)
 Extract satisfying assignment from context as a conjunction. More...
 

Floating-Point API

Z3_sort Z3_API Z3_mk_fpa_rounding_mode_sort (Z3_context c)
 Create the RoundingMode sort. More...
 
Z3_ast Z3_API Z3_mk_fpa_round_nearest_ties_to_even (Z3_context c)
 Create a numeral of RoundingMode sort which represents the NearestTiesToEven rounding mode. More...
 
Z3_ast Z3_API Z3_mk_fpa_rne (Z3_context c)
 Create a numeral of RoundingMode sort which represents the NearestTiesToEven rounding mode. More...
 
Z3_ast Z3_API Z3_mk_fpa_round_nearest_ties_to_away (Z3_context c)
 Create a numeral of RoundingMode sort which represents the NearestTiesToAway rounding mode. More...
 
Z3_ast Z3_API Z3_mk_fpa_rna (Z3_context c)
 Create a numeral of RoundingMode sort which represents the NearestTiesToAway rounding mode. More...
 
Z3_ast Z3_API Z3_mk_fpa_round_toward_positive (Z3_context c)
 Create a numeral of RoundingMode sort which represents the TowardPositive rounding mode. More...
 
Z3_ast Z3_API Z3_mk_fpa_rtp (Z3_context c)
 Create a numeral of RoundingMode sort which represents the TowardPositive rounding mode. More...
 
Z3_ast Z3_API Z3_mk_fpa_round_toward_negative (Z3_context c)
 Create a numeral of RoundingMode sort which represents the TowardNegative rounding mode. More...
 
Z3_ast Z3_API Z3_mk_fpa_rtn (Z3_context c)
 Create a numeral of RoundingMode sort which represents the TowardNegative rounding mode. More...
 
Z3_ast Z3_API Z3_mk_fpa_round_toward_zero (Z3_context c)
 Create a numeral of RoundingMode sort which represents the TowardZero rounding mode. More...
 
Z3_ast Z3_API Z3_mk_fpa_rtz (Z3_context c)
 Create a numeral of RoundingMode sort which represents the TowardZero rounding mode. More...
 
Z3_sort Z3_API Z3_mk_fpa_sort (Z3_context c, unsigned ebits, unsigned sbits)
 Create a FloatingPoint sort. More...
 
Z3_sort Z3_API Z3_mk_fpa_sort_half (Z3_context c)
 Create the half-precision (16-bit) FloatingPoint sort. More...
 
Z3_sort Z3_API Z3_mk_fpa_sort_16 (Z3_context c)
 Create the half-precision (16-bit) FloatingPoint sort. More...
 
Z3_sort Z3_API Z3_mk_fpa_sort_single (Z3_context c)
 Create the single-precision (32-bit) FloatingPoint sort. More...
 
Z3_sort Z3_API Z3_mk_fpa_sort_32 (Z3_context c)
 Create the single-precision (32-bit) FloatingPoint sort. More...
 
Z3_sort Z3_API Z3_mk_fpa_sort_double (Z3_context c)
 Create the double-precision (64-bit) FloatingPoint sort. More...
 
Z3_sort Z3_API Z3_mk_fpa_sort_64 (Z3_context c)
 Create the double-precision (64-bit) FloatingPoint sort. More...
 
Z3_sort Z3_API Z3_mk_fpa_sort_quadruple (Z3_context c)
 Create the quadruple-precision (128-bit) FloatingPoint sort. More...
 
Z3_sort Z3_API Z3_mk_fpa_sort_128 (Z3_context c)
 Create the quadruple-precision (128-bit) FloatingPoint sort. More...
 
Z3_ast Z3_API Z3_mk_fpa_nan (Z3_context c, Z3_sort s)
 Create a floating-point NaN of sort s. More...
 
Z3_ast Z3_API Z3_mk_fpa_inf (Z3_context c, Z3_sort s, Z3_bool negative)
 Create a floating-point infinity of sort s. More...
 
Z3_ast Z3_API Z3_mk_fpa_zero (Z3_context c, Z3_sort s, Z3_bool negative)
 Create a floating-point zero of sort s. More...
 
Z3_ast Z3_API Z3_mk_fpa_fp (Z3_context c, Z3_ast sgn, Z3_ast exp, Z3_ast sig)
 Create an expression of FloatingPoint sort from three bit-vector expressions. More...
 
Z3_ast Z3_API Z3_mk_fpa_numeral_float (Z3_context c, float v, Z3_sort ty)
 Create a numeral of FloatingPoint sort from a float. More...
 
Z3_ast Z3_API Z3_mk_fpa_numeral_double (Z3_context c, double v, Z3_sort ty)
 Create a numeral of FloatingPoint sort from a double. More...
 
Z3_ast Z3_API Z3_mk_fpa_numeral_int (Z3_context c, signed v, Z3_sort ty)
 Create a numeral of FloatingPoint sort from a signed integer. More...
 
Z3_ast Z3_API Z3_mk_fpa_numeral_int_uint (Z3_context c, Z3_bool sgn, signed exp, unsigned sig, Z3_sort ty)
 Create a numeral of FloatingPoint sort from a sign bit and two integers. More...
 
Z3_ast Z3_API Z3_mk_fpa_numeral_int64_uint64 (Z3_context c, Z3_bool sgn, __int64 exp, __uint64 sig, Z3_sort ty)
 Create a numeral of FloatingPoint sort from a sign bit and two 64-bit integers. More...
 
Z3_ast Z3_API Z3_mk_fpa_abs (Z3_context c, Z3_ast t)
 Floating-point absolute value. More...
 
Z3_ast Z3_API Z3_mk_fpa_neg (Z3_context c, Z3_ast t)
 Floating-point negation. More...
 
Z3_ast Z3_API Z3_mk_fpa_add (Z3_context c, Z3_ast rm, Z3_ast t1, Z3_ast t2)
 Floating-point addition. More...
 
Z3_ast Z3_API Z3_mk_fpa_sub (Z3_context c, Z3_ast rm, Z3_ast t1, Z3_ast t2)
 Floating-point subtraction. More...
 
Z3_ast Z3_API Z3_mk_fpa_mul (Z3_context c, Z3_ast rm, Z3_ast t1, Z3_ast t2)
 Floating-point multiplication. More...
 
Z3_ast Z3_API Z3_mk_fpa_div (Z3_context c, Z3_ast rm, Z3_ast t1, Z3_ast t2)
 Floating-point division. More...
 
Z3_ast Z3_API Z3_mk_fpa_fma (Z3_context c, Z3_ast rm, Z3_ast t1, Z3_ast t2, Z3_ast t3)
 Floating-point fused multiply-add. More...
 
Z3_ast Z3_API Z3_mk_fpa_sqrt (Z3_context c, Z3_ast rm, Z3_ast t)
 Floating-point square root. More...
 
Z3_ast Z3_API Z3_mk_fpa_rem (Z3_context c, Z3_ast t1, Z3_ast t2)
 Floating-point remainder. More...
 
Z3_ast Z3_API Z3_mk_fpa_round_to_integral (Z3_context c, Z3_ast rm, Z3_ast t)
 Floating-point roundToIntegral. Rounds a floating-point number to the closest integer, again represented as a floating-point number. More...
 
Z3_ast Z3_API Z3_mk_fpa_min (Z3_context c, Z3_ast t1, Z3_ast t2)
 Minimum of floating-point numbers. More...
 
Z3_ast Z3_API Z3_mk_fpa_max (Z3_context c, Z3_ast t1, Z3_ast t2)
 Maximum of floating-point numbers. More...
 
Z3_ast Z3_API Z3_mk_fpa_leq (Z3_context c, Z3_ast t1, Z3_ast t2)
 Floating-point less than or equal. More...
 
Z3_ast Z3_API Z3_mk_fpa_lt (Z3_context c, Z3_ast t1, Z3_ast t2)
 Floating-point less than. More...
 
Z3_ast Z3_API Z3_mk_fpa_geq (Z3_context c, Z3_ast t1, Z3_ast t2)
 Floating-point greater than or equal. More...
 
Z3_ast Z3_API Z3_mk_fpa_gt (Z3_context c, Z3_ast t1, Z3_ast t2)
 Floating-point greater than. More...
 
Z3_ast Z3_API Z3_mk_fpa_eq (Z3_context c, Z3_ast t1, Z3_ast t2)
 Floating-point equality. More...
 
Z3_ast Z3_API Z3_mk_fpa_is_normal (Z3_context c, Z3_ast t)
 Predicate indicating whether t is a normal floating-point number. More...
 
Z3_ast Z3_API Z3_mk_fpa_is_subnormal (Z3_context c, Z3_ast t)
 Predicate indicating whether t is a subnormal floating-point number. More...
 
Z3_ast Z3_API Z3_mk_fpa_is_zero (Z3_context c, Z3_ast t)
 Predicate indicating whether t is a floating-point number with zero value, i.e., +zero or -zero. More...
 
Z3_ast Z3_API Z3_mk_fpa_is_infinite (Z3_context c, Z3_ast t)
 Predicate indicating whether t is a floating-point number representing +oo or -oo. More...
 
Z3_ast Z3_API Z3_mk_fpa_is_nan (Z3_context c, Z3_ast t)
 Predicate indicating whether t is a NaN. More...
 
Z3_ast Z3_API Z3_mk_fpa_is_negative (Z3_context c, Z3_ast t)
 Predicate indicating whether t is a negative floating-point number. More...
 
Z3_ast Z3_API Z3_mk_fpa_is_positive (Z3_context c, Z3_ast t)
 Predicate indicating whether t is a positive floating-point number. More...
 
Z3_ast Z3_API Z3_mk_fpa_to_fp_bv (Z3_context c, Z3_ast bv, Z3_sort s)
 Conversion of a single IEEE 754-2008 bit-vector into a floating-point number. More...
 
Z3_ast Z3_API Z3_mk_fpa_to_fp_float (Z3_context c, Z3_ast rm, Z3_ast t, Z3_sort s)
 Conversion of a FloatingPoint term into another term of different FloatingPoint sort. More...
 
Z3_ast Z3_API Z3_mk_fpa_to_fp_real (Z3_context c, Z3_ast rm, Z3_ast t, Z3_sort s)
 Conversion of a term of real sort into a term of FloatingPoint sort. More...
 
Z3_ast Z3_API Z3_mk_fpa_to_fp_signed (Z3_context c, Z3_ast rm, Z3_ast t, Z3_sort s)
 Conversion of a 2's complement signed bit-vector term into a term of FloatingPoint sort. More...
 
Z3_ast Z3_API Z3_mk_fpa_to_fp_unsigned (Z3_context c, Z3_ast rm, Z3_ast t, Z3_sort s)
 Conversion of a 2's complement unsigned bit-vector term into a term of FloatingPoint sort. More...
 
Z3_ast Z3_API Z3_mk_fpa_to_ubv (Z3_context c, Z3_ast rm, Z3_ast t, unsigned sz)
 Conversion of a floating-point term into an unsigned bit-vector. More...
 
Z3_ast Z3_API Z3_mk_fpa_to_sbv (Z3_context c, Z3_ast rm, Z3_ast t, unsigned sz)
 Conversion of a floating-point term into a signed bit-vector. More...
 
Z3_ast Z3_API Z3_mk_fpa_to_real (Z3_context c, Z3_ast t)
 Conversion of a floating-point term into a real-numbered term. More...
 

Z3-specific floating-point extensions

unsigned Z3_API Z3_fpa_get_ebits (Z3_context c, Z3_sort s)
 Retrieves the number of bits reserved for the exponent in a FloatingPoint sort. More...
 
unsigned Z3_API Z3_fpa_get_sbits (Z3_context c, Z3_sort s)
 Retrieves the number of bits reserved for the significand in a FloatingPoint sort. More...
 
Z3_bool Z3_API Z3_fpa_get_numeral_sign (Z3_context c, Z3_ast t, int *sgn)
 Retrieves the sign of a floating-point literal. More...
 
Z3_string Z3_API Z3_fpa_get_numeral_significand_string (Z3_context c, Z3_ast t)
 Return the significand value of a floating-point numeral as a string. More...
 
Z3_bool Z3_API Z3_fpa_get_numeral_significand_uint64 (Z3_context c, Z3_ast t, __uint64 *n)
 Return the significand value of a floating-point numeral as a uint64. More...
 
Z3_string Z3_API Z3_fpa_get_numeral_exponent_string (Z3_context c, Z3_ast t)
 Return the exponent value of a floating-point numeral as a string. More...
 
Z3_bool Z3_API Z3_fpa_get_numeral_exponent_int64 (Z3_context c, Z3_ast t, __int64 *n)
 Return the exponent value of a floating-point numeral as a signed 64-bit integer. More...
 
Z3_ast Z3_API Z3_mk_fpa_to_ieee_bv (Z3_context c, Z3_ast t)
 Conversion of a floating-point term into a bit-vector term in IEEE 754-2008 format. More...
 
Z3_ast Z3_API Z3_mk_fpa_to_fp_int_real (Z3_context c, Z3_ast rm, Z3_ast exp, Z3_ast sig, Z3_sort s)
 Conversion of a real-sorted significand and an integer-sorted exponent into a term of FloatingPoint sort. More...
 

Interpolation API

Z3_ast Z3_API Z3_mk_interpolant (Z3_context c, Z3_ast a)
 Create an AST node marking a formula position for interpolation. More...
 
Z3_context Z3_API Z3_mk_interpolation_context (Z3_config cfg)
 This function generates a Z3 context suitable for generation of interpolants. Formulas can be generated as abstract syntax trees in this context using the Z3 C API. More...
 
Z3_ast_vector Z3_API Z3_get_interpolant (Z3_context c, Z3_ast pf, Z3_ast pat, Z3_params p)
 
Z3_lbool Z3_API Z3_compute_interpolant (Z3_context c, Z3_ast pat, Z3_params p, Z3_ast_vector *interp, Z3_model *model)
 
Z3_string Z3_API Z3_interpolation_profile (Z3_context ctx)
 
int Z3_API Z3_read_interpolation_problem (Z3_context ctx, unsigned *num, Z3_ast *cnsts[], unsigned *parents[], Z3_string filename, Z3_string_ptr error, unsigned *num_theory, Z3_ast *theory[])
 Read an interpolation problem from file. More...
 
int Z3_API Z3_check_interpolant (Z3_context ctx, unsigned num, Z3_ast cnsts[], unsigned parents[], Z3_ast *interps, Z3_string_ptr error, unsigned num_theory, Z3_ast theory[])
 
void Z3_API Z3_write_interpolation_problem (Z3_context ctx, unsigned num, Z3_ast cnsts[], unsigned parents[], Z3_string filename, unsigned num_theory, Z3_ast theory[])
 

Polynomials API

Z3_ast_vector Z3_API Z3_polynomial_subresultants (Z3_context c, Z3_ast p, Z3_ast q, Z3_ast x)
 Return the nonzero subresultants of p and q with respect to the "variable" x. More...
 

Real Closed Fields API

void Z3_API Z3_rcf_del (Z3_context c, Z3_rcf_num a)
 Delete a RCF numeral created using the RCF API. More...
 
Z3_rcf_num Z3_API Z3_rcf_mk_rational (Z3_context c, Z3_string val)
 Return a RCF rational using the given string. More...
 
Z3_rcf_num Z3_API Z3_rcf_mk_small_int (Z3_context c, int val)
 Return a RCF small integer. More...
 
Z3_rcf_num Z3_API Z3_rcf_mk_pi (Z3_context c)
 Return Pi. More...
 
Z3_rcf_num Z3_API Z3_rcf_mk_e (Z3_context c)
 Return e (Euler's constant) More...
 
Z3_rcf_num Z3_API Z3_rcf_mk_infinitesimal (Z3_context c)
 Return a new infinitesimal that is smaller than all elements in the Z3 field. More...
 
unsigned Z3_API Z3_rcf_mk_roots (Z3_context c, unsigned n, Z3_rcf_num const a[], Z3_rcf_num roots[])
 Store in roots the roots of the polynomial a[n-1]*x^{n-1} + ... + a[0]. The output vector roots must have size n. It returns the number of roots of the polynomial. More...
 
Z3_rcf_num Z3_API Z3_rcf_add (Z3_context c, Z3_rcf_num a, Z3_rcf_num b)
 Return the value a + b. More...
 
Z3_rcf_num Z3_API Z3_rcf_sub (Z3_context c, Z3_rcf_num a, Z3_rcf_num b)
 Return the value a - b. More...
 
Z3_rcf_num Z3_API Z3_rcf_mul (Z3_context c, Z3_rcf_num a, Z3_rcf_num b)
 Return the value a * b. More...
 
Z3_rcf_num Z3_API Z3_rcf_div (Z3_context c, Z3_rcf_num a, Z3_rcf_num b)
 Return the value a / b. More...
 
Z3_rcf_num Z3_API Z3_rcf_neg (Z3_context c, Z3_rcf_num a)
 Return the value -a. More...
 
Z3_rcf_num Z3_API Z3_rcf_inv (Z3_context c, Z3_rcf_num a)
 Return the value 1/a. More...
 
Z3_rcf_num Z3_API Z3_rcf_power (Z3_context c, Z3_rcf_num a, unsigned k)
 Return the value a^k. More...
 
Z3_bool Z3_API Z3_rcf_lt (Z3_context c, Z3_rcf_num a, Z3_rcf_num b)
 Return Z3_TRUE if a < b. More...
 
Z3_bool Z3_API Z3_rcf_gt (Z3_context c, Z3_rcf_num a, Z3_rcf_num b)
 Return Z3_TRUE if a > b. More...
 
Z3_bool Z3_API Z3_rcf_le (Z3_context c, Z3_rcf_num a, Z3_rcf_num b)
 Return Z3_TRUE if a <= b. More...
 
Z3_bool Z3_API Z3_rcf_ge (Z3_context c, Z3_rcf_num a, Z3_rcf_num b)
 Return Z3_TRUE if a >= b. More...
 
Z3_bool Z3_API Z3_rcf_eq (Z3_context c, Z3_rcf_num a, Z3_rcf_num b)
 Return Z3_TRUE if a == b. More...
 
Z3_bool Z3_API Z3_rcf_neq (Z3_context c, Z3_rcf_num a, Z3_rcf_num b)
 Return Z3_TRUE if a != b. More...
 
Z3_string Z3_API Z3_rcf_num_to_string (Z3_context c, Z3_rcf_num a, Z3_bool compact, Z3_bool html)
 Convert the RCF numeral into a string. More...
 
Z3_string Z3_API Z3_rcf_num_to_decimal_string (Z3_context c, Z3_rcf_num a, unsigned prec)
 Convert the RCF numeral into a string in decimal notation. More...
 
void Z3_API Z3_rcf_get_numerator_denominator (Z3_context c, Z3_rcf_num a, Z3_rcf_num *n, Z3_rcf_num *d)
 Extract the "numerator" and "denominator" of the given RCF numeral. We have that a = n/d, moreover n and d are not represented using rational functions. More...
 

Detailed Description

Macro Definition Documentation

#define Z3_FALSE   0

False value. It is just an alias for 0.

Definition at line 135 of file z3_api.h.

Referenced by model::eval().

#define Z3_TRUE   1

True value. It is just an alias for 1.

Definition at line 130 of file z3_api.h.

Typedef Documentation

typedef int Z3_bool

Z3 Boolean type. It is just an alias for int.

Definition at line 110 of file z3_api.h.

typedef void Z3_error_handler(Z3_context c, Z3_error_code e)

Z3 custom error handler (See Z3_set_error_handler).

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')

Definition at line 1367 of file z3_api.h.

typedef void Z3_fixedpoint_reduce_app_callback_fptr(void *, Z3_func_decl, unsigned, Z3_ast const [], Z3_ast *)

Definition at line 5770 of file z3_api.h.

typedef void Z3_fixedpoint_reduce_assign_callback_fptr(void *, Z3_func_decl, unsigned, Z3_ast const [], unsigned, Z3_ast const [])

The following utilities allows adding user-defined domains.

Definition at line 5765 of file z3_api.h.

typedef Z3_bool Z3_reduce_app_callback_fptr(Z3_theory, Z3_func_decl, unsigned, Z3_ast const [], Z3_ast *)

Definition at line 5093 of file z3_api.h.

typedef Z3_bool Z3_reduce_distinct_callback_fptr(Z3_theory, unsigned, Z3_ast const [], Z3_ast *)

Definition at line 5095 of file z3_api.h.

typedef Z3_bool Z3_reduce_eq_callback_fptr(Z3_theory t, Z3_ast a, Z3_ast b, Z3_ast *r)

Definition at line 5091 of file z3_api.h.

typedef const char* Z3_string

Z3 string type. It is just an alias for const char *.

Definition at line 119 of file z3_api.h.

Definition at line 120 of file z3_api.h.

typedef void Z3_theory_ast_ast_callback_fptr(Z3_theory, Z3_ast, Z3_ast)

Definition at line 5105 of file z3_api.h.

typedef void Z3_theory_ast_bool_callback_fptr(Z3_theory, Z3_ast, Z3_bool)

Definition at line 5103 of file z3_api.h.

typedef void Z3_theory_ast_callback_fptr(Z3_theory, Z3_ast)

Definition at line 5101 of file z3_api.h.

typedef void Z3_theory_callback_fptr(Z3_theory t)

Definition at line 5097 of file z3_api.h.

typedef Z3_bool Z3_theory_final_check_callback_fptr(Z3_theory)

Definition at line 5099 of file z3_api.h.

Enumeration Type Documentation

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
Enumerator
Z3_NUMERAL_AST 
Z3_APP_AST 
Z3_VAR_AST 
Z3_QUANTIFIER_AST 
Z3_SORT_AST 
Z3_FUNC_DECL_AST 
Z3_UNKNOWN_AST 

Definition at line 222 of file z3_api.h.

223 {
225  Z3_APP_AST,
226  Z3_VAR_AST,
228  Z3_SORT_AST,
230  Z3_UNKNOWN_AST = 1000
231 } Z3_ast_kind;
Z3_ast_kind
The different kinds of Z3 AST (abstract syntax trees). That is, terms, formulas and types...
Definition: z3_api.h:222

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.
Enumerator
Z3_PRINT_SMTLIB_FULL 
Z3_PRINT_LOW_LEVEL 
Z3_PRINT_SMTLIB_COMPLIANT 
Z3_PRINT_SMTLIB2_COMPLIANT 

Definition at line 1284 of file z3_api.h.

1284  {
Z3_ast_print_mode
Z3 pretty printing modes (See Z3_set_ast_print_mode).
Definition: z3_api.h:1284

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 mapf[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.

           T1: p
           T2: (implies p 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).
           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).
        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:
     <div class="fragment"><pre class="fragment">
     T1: (R a b)
     T2: (R c b)
     T3: (R c d)
     [trans* T1 T2 T3]: (R a d)
     </pre></div>
     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.

           T1: (R t_1 s_1)
           ...
           Tn: (R t_n 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)

  • 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

        T1: (and l_1 ... l_n)
        
  • Z3_OP_PR_NOT_OR_ELIM: Given a proof for (not (or l_1 ... l_n)), produces a proof for (not l_i).

        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:
   <div class="fragment"><pre class="fragment">
   (= (+ x 0) x)
   (= (+ x 1 2) (+ 3 x))
   (iff (or x false) x)
   </pre></div>
  • 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:

           (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:

           T1: false
           

    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:
           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:
        T1: p
        [iff-true T1]: (iff p true)
        
  • Z3_OP_PR_IFF_FALSE:
        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:
     <div class="fragment"><pre class="fragment">
     (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)
     </pre></div>
     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:

    or:

    when e only occurs positively.

    When e is of the form (ite cond th 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:

           T1: (not s_1) ~ r_1
           T2: (not s_2) ~ r_2
           T3: s_1 ~ r_1'
           T4: s_2 ~ r_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

            T1: q ~ 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:

           T1: (not s_1) ~ r_1
           ...
           Tn: (not s_n) ~ r_n
       and
           T1: (not s_1) ~ r_1
           ...
           Tn: (not s_n) ~ 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'
                                    (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:
     <div class="fragment"><pre class="fragment">
     [sk]: (~ (not (forall x (p x y))) (not (p (sk y) y)))
     [sk]: (~ (exists x (p x y)) (p (sk y) y))
     </pre></div>
    
     This proof object has no antecedents.
    
  • Z3_OP_PR_MODUS_PONENS_OEQ: Modus ponens style rule for equi-satisfiability.

           T1: p
           T2: (~ p 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:
                 (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

                   (or l0 l1 l2 .. ln)
           

      or

                (=> (and l1 l2 .. ln) l0)
           

      or in the most general (ground) form:

                (=> (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:

                (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 n+1 arguments, where the first argument is the relation and the remaining n elements correspond to the 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 n+1 arguments, where the first argument is a relation, and the remaining 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 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.
Enumerator
Z3_OP_TRUE 
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 
Z3_OP_ANUM 
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 
Z3_OP_STORE 
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 
Z3_OP_BNUM 
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 
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 
Z3_OP_PR_UNDEF 
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 
Z3_OP_RA_STORE 
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 
Z3_OP_LABEL 
Z3_OP_LABEL_LIT 
Z3_OP_DT_CONSTRUCTOR 
Z3_OP_DT_RECOGNISER 
Z3_OP_DT_ACCESSOR 
Z3_OP_DT_UPDATE_FIELD 
Z3_OP_PB_AT_MOST 
Z3_OP_PB_LE 
Z3_OP_PB_GE 
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 

Definition at line 988 of file z3_api.h.

988  {
989  // Basic
990  Z3_OP_TRUE = 0x100,
991  Z3_OP_FALSE,
992  Z3_OP_EQ,
994  Z3_OP_ITE,
995  Z3_OP_AND,
996  Z3_OP_OR,
997  Z3_OP_IFF,
998  Z3_OP_XOR,
999  Z3_OP_NOT,
1000  Z3_OP_IMPLIES,
1001  Z3_OP_OEQ,
1002  Z3_OP_INTERP,
1003 
1004  // Arithmetic
1005  Z3_OP_ANUM = 0x200,
1006  Z3_OP_AGNUM,
1007  Z3_OP_LE,
1008  Z3_OP_GE,
1009  Z3_OP_LT,
1010  Z3_OP_GT,
1011  Z3_OP_ADD,
1012  Z3_OP_SUB,
1013  Z3_OP_UMINUS,
1014  Z3_OP_MUL,
1015  Z3_OP_DIV,
1016  Z3_OP_IDIV,
1017  Z3_OP_REM,
1018  Z3_OP_MOD,
1019  Z3_OP_TO_REAL,
1020  Z3_OP_TO_INT,
1021  Z3_OP_IS_INT,
1022  Z3_OP_POWER,
1023 
1024  // Arrays & Sets
1025  Z3_OP_STORE = 0x300,
1026  Z3_OP_SELECT,
1036 
1037  // Bit-vectors
1038  Z3_OP_BNUM = 0x400,
1039  Z3_OP_BIT1,
1040  Z3_OP_BIT0,
1041  Z3_OP_BNEG,
1042  Z3_OP_BADD,
1043  Z3_OP_BSUB,
1044  Z3_OP_BMUL,
1045 
1046  Z3_OP_BSDIV,
1047  Z3_OP_BUDIV,
1048  Z3_OP_BSREM,
1049  Z3_OP_BUREM,
1050  Z3_OP_BSMOD,
1051 
1052  // special functions to record the division by 0 cases
1053  // these are internal functions
1054  Z3_OP_BSDIV0,
1055  Z3_OP_BUDIV0,
1056  Z3_OP_BSREM0,
1057  Z3_OP_BUREM0,
1058  Z3_OP_BSMOD0,
1059 
1060  Z3_OP_ULEQ,
1061  Z3_OP_SLEQ,
1062  Z3_OP_UGEQ,
1063  Z3_OP_SGEQ,
1064  Z3_OP_ULT,
1065  Z3_OP_SLT,
1066  Z3_OP_UGT,
1067  Z3_OP_SGT,
1068 
1069  Z3_OP_BAND,
1070  Z3_OP_BOR,
1071  Z3_OP_BNOT,
1072  Z3_OP_BXOR,
1073  Z3_OP_BNAND,
1074  Z3_OP_BNOR,
1075  Z3_OP_BXNOR,
1076 
1077  Z3_OP_CONCAT,
1080  Z3_OP_EXTRACT,
1081  Z3_OP_REPEAT,
1082 
1083  Z3_OP_BREDOR,
1084  Z3_OP_BREDAND,
1085  Z3_OP_BCOMP,
1086 
1087  Z3_OP_BSHL,
1088  Z3_OP_BLSHR,
1089  Z3_OP_BASHR,
1094 
1095  Z3_OP_INT2BV,
1096  Z3_OP_BV2INT,
1097  Z3_OP_CARRY,
1098  Z3_OP_XOR3,
1099 
1100  // Proofs
1101  Z3_OP_PR_UNDEF = 0x500,
1102  Z3_OP_PR_TRUE,
1104  Z3_OP_PR_GOAL,
1121  Z3_OP_PR_DER,
1124  Z3_OP_PR_LEMMA,
1141 
1142  // Sequences
1143  Z3_OP_RA_STORE = 0x600,
1146  Z3_OP_RA_JOIN,
1156  Z3_OP_FD_LT,
1157 
1158  // Auxiliary
1159  Z3_OP_LABEL = 0x700,
1161 
1162  // Datatypes
1163  Z3_OP_DT_CONSTRUCTOR=0x800,
1167 
1168  // Pseudo Booleans
1169  Z3_OP_PB_AT_MOST=0x900,
1170  Z3_OP_PB_LE,
1171  Z3_OP_PB_GE,
1172 
1173  // Floating-Point Arithmetic
1179 
1180  Z3_OP_FPA_NUM,
1183  Z3_OP_FPA_NAN,
1186 
1187  Z3_OP_FPA_ADD,
1188  Z3_OP_FPA_SUB,
1189  Z3_OP_FPA_NEG,
1190  Z3_OP_FPA_MUL,
1191  Z3_OP_FPA_DIV,
1192  Z3_OP_FPA_REM,
1193  Z3_OP_FPA_ABS,
1194  Z3_OP_FPA_MIN,
1195  Z3_OP_FPA_MAX,
1196  Z3_OP_FPA_FMA,
1199 
1200  Z3_OP_FPA_EQ,
1201  Z3_OP_FPA_LT,
1202  Z3_OP_FPA_GT,
1203  Z3_OP_FPA_LE,
1204  Z3_OP_FPA_GE,
1212 
1213  Z3_OP_FPA_FP,
1219 
1221 
1223 } Z3_decl_kind;
Z3_decl_kind
The different kinds of interpreted function kinds.
Definition: z3_api.h:988

Z3 error codes (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 with Z3_inc_ref.
  • Z3_EXCEPTION: Internal Z3 exception. Additional details can be retrieved using Z3_get_error_msg.
Enumerator
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 

Definition at line 1311 of file z3_api.h.

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).
Enumerator
Z3_GOAL_PRECISE 
Z3_GOAL_UNDER 
Z3_GOAL_OVER 
Z3_GOAL_UNDER_OVER 

Definition at line 1385 of file z3_api.h.

1386 {
1387  Z3_GOAL_PRECISE,
1388  Z3_GOAL_UNDER,
1389  Z3_GOAL_OVER,
1391 } Z3_goal_prec;
Z3_goal_prec
A Goal is essentially a set of formulas. Z3 provide APIs for building strategies/tactics for solving ...
Definition: z3_api.h:1385
enum Z3_lbool

Lifted Boolean type: false, undefined, true.

Enumerator
Z3_L_FALSE 
Z3_L_UNDEF 
Z3_L_TRUE 

Definition at line 143 of file z3_api.h.

144 {
145  Z3_L_FALSE = -1,
146  Z3_L_UNDEF,
147  Z3_L_TRUE
148 } Z3_lbool;
Z3_lbool
Lifted Boolean type: false, undefined, true.
Definition: z3_api.h:143

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.
Enumerator
Z3_PK_UINT 
Z3_PK_BOOL 
Z3_PK_DOUBLE 
Z3_PK_SYMBOL 
Z3_PK_STRING 
Z3_PK_OTHER 
Z3_PK_INVALID 

Definition at line 1239 of file z3_api.h.

1239  {
1240  Z3_PK_UINT,
1241  Z3_PK_BOOL,
1242  Z3_PK_DOUBLE,
1243  Z3_PK_SYMBOL,
1244  Z3_PK_STRING,
1245  Z3_PK_OTHER,
1247 } Z3_param_kind;
Z3_param_kind
The different kinds of parameters that can be associated with parameter sets. (see Z3_mk_params)...
Definition: z3_api.h:1239

The different kinds of parameters that can be associated with function symbols.

See also
Z3_get_decl_num_parameters
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.
Enumerator
Z3_PARAMETER_INT 
Z3_PARAMETER_DOUBLE 
Z3_PARAMETER_RATIONAL 
Z3_PARAMETER_SYMBOL 
Z3_PARAMETER_SORT 
Z3_PARAMETER_AST 
Z3_PARAMETER_FUNC_DECL 

Definition at line 179 of file z3_api.h.

180 {
Z3_parameter_kind
The different kinds of parameters that can be associated with function symbols.
Definition: z3_api.h:179

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
Enumerator
Z3_NO_FAILURE 
Z3_UNKNOWN 
Z3_TIMEOUT 
Z3_MEMOUT_WATERMARK 
Z3_CANCELED 
Z3_NUM_CONFLICTS 
Z3_THEORY 
Z3_QUANTIFIERS 

Definition at line 1263 of file z3_api.h.

1263  {
1264  Z3_NO_FAILURE,
1265  Z3_UNKNOWN,
1266  Z3_TIMEOUT,
1268  Z3_CANCELED,
1270  Z3_THEORY,
Z3_search_failure
The different kinds of search failure types.
Definition: z3_api.h:1263

The different kinds of Z3 types (See Z3_get_sort_kind).

Enumerator
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 

Definition at line 194 of file z3_api.h.

The different kinds of symbol. In Z3, a symbol can be represented using integers and strings (See Z3_get_symbol_kind).

See also
Z3_mk_int_symbol
Z3_mk_string_symbol
Enumerator
Z3_INT_SYMBOL 
Z3_STRING_SYMBOL 

Definition at line 158 of file z3_api.h.

159 {
Z3_symbol_kind
The different kinds of symbol. In Z3, a symbol can be represented using integers and strings (See Z3_...
Definition: z3_api.h:158

Function Documentation

Z3_ast Z3_API Z3_algebraic_add ( Z3_context  c,
Z3_ast  a,
Z3_ast  b 
)

Return the value a + b.

Precondition
Z3_algebraic_is_value(c, a)
Z3_algebraic_is_value(c, b)
Postcondition
Z3_algebraic_is_value(c, result)
Z3_ast Z3_API Z3_algebraic_div ( Z3_context  c,
Z3_ast  a,
Z3_ast  b 
)

Return the value a / b.

Precondition
Z3_algebraic_is_value(c, a)
Z3_algebraic_is_value(c, b)
!Z3_algebraic_is_zero(c, b)
Postcondition
Z3_algebraic_is_value(c, result)
Z3_bool Z3_API Z3_algebraic_eq ( Z3_context  c,
Z3_ast  a,
Z3_ast  b 
)

Return Z3_TRUE if a == b, and Z3_FALSE otherwise.

Precondition
Z3_algebraic_is_value(c, a)
Z3_algebraic_is_value(c, b)
int Z3_API Z3_algebraic_eval ( Z3_context  c,
Z3_ast  p,
unsigned  n,
Z3_ast  a[] 
)

Given a multivariate polynomial p(x_0, ..., x_{n-1}), return the sign of p(a[0], ..., a[n-1]).

Precondition
p is a Z3 expression that contains only arithmetic terms and free variables.
forall i in [0, n) Z3_algebraic_is_value(c, a[i])
Z3_bool Z3_API Z3_algebraic_ge ( Z3_context  c,
Z3_ast  a,
Z3_ast  b 
)

Return Z3_TRUE if a >= b, and Z3_FALSE otherwise.

Precondition
Z3_algebraic_is_value(c, a)
Z3_algebraic_is_value(c, b)
Z3_bool Z3_API Z3_algebraic_gt ( Z3_context  c,
Z3_ast  a,
Z3_ast  b 
)

Return Z3_TRUE if a > b, and Z3_FALSE otherwise.

Precondition
Z3_algebraic_is_value(c, a)
Z3_algebraic_is_value(c, b)
Z3_bool Z3_API Z3_algebraic_is_neg ( Z3_context  c,
Z3_ast  a 
)

Return the Z3_TRUE if a is negative, and Z3_FALSE otherwise.

Precondition
Z3_algebraic_is_value(c, a)
Z3_bool Z3_API Z3_algebraic_is_pos ( Z3_context  c,
Z3_ast  a 
)

Return the Z3_TRUE if a is positive, and Z3_FALSE otherwise.

Precondition
Z3_algebraic_is_value(c, a)
Z3_bool Z3_API Z3_algebraic_is_value ( Z3_context  c,
Z3_ast  a 
)

Return Z3_TRUE if can be used as value in the Z3 real algebraic number package.

Z3_bool Z3_API Z3_algebraic_is_zero ( Z3_context  c,
Z3_ast  a 
)

Return the Z3_TRUE if a is zero, and Z3_FALSE otherwise.

Precondition
Z3_algebraic_is_value(c, a)
Z3_bool Z3_API Z3_algebraic_le ( Z3_context  c,
Z3_ast  a,
Z3_ast  b 
)

Return Z3_TRUE if a <= b, and Z3_FALSE otherwise.

Precondition
Z3_algebraic_is_value(c, a)
Z3_algebraic_is_value(c, b)
Z3_bool Z3_API Z3_algebraic_lt ( Z3_context  c,
Z3_ast  a,
Z3_ast  b 
)

Return Z3_TRUE if a < b, and Z3_FALSE otherwise.

Precondition
Z3_algebraic_is_value(c, a)
Z3_algebraic_is_value(c, b)
Z3_ast Z3_API Z3_algebraic_mul ( Z3_context  c,
Z3_ast  a,
Z3_ast  b 
)

Return the value a * b.

Precondition
Z3_algebraic_is_value(c, a)
Z3_algebraic_is_value(c, b)
Postcondition
Z3_algebraic_is_value(c, result)
Z3_bool Z3_API Z3_algebraic_neq ( Z3_context  c,
Z3_ast  a,
Z3_ast  b 
)

Return Z3_TRUE if a != b, and Z3_FALSE otherwise.

Precondition
Z3_algebraic_is_value(c, a)
Z3_algebraic_is_value(c, b)
Z3_ast Z3_API Z3_algebraic_power ( Z3_context  c,
Z3_ast  a,
unsigned  k 
)

Return the a^k.

Precondition
Z3_algebraic_is_value(c, a)
Postcondition
Z3_algebraic_is_value(c, result)
Z3_ast Z3_API Z3_algebraic_root ( Z3_context  c,
Z3_ast  a,
unsigned  k 
)

Return the a^(1/k)

Precondition
Z3_algebraic_is_value(c, a)
k is even => !Z3_algebraic_is_neg(c, a)
Postcondition
Z3_algebraic_is_value(c, result)
Z3_ast_vector Z3_API Z3_algebraic_roots ( Z3_context  c,
Z3_ast  p,
unsigned  n,
Z3_ast  a[] 
)

Given a multivariate polynomial p(x_0, ..., x_{n-1}, x_n), returns the roots of the univariate polynomial p(a[0], ..., a[n-1], x_n).

Precondition
p is a Z3 expression that contains only arithmetic terms and free variables.
forall i in [0, n) Z3_algebraic_is_value(c, a[i])
Postcondition
forall r in result Z3_algebraic_is_value(c, result)
int Z3_API Z3_algebraic_sign ( Z3_context  c,
Z3_ast  a 
)

Return 1 if a is positive, 0 if a is zero, and -1 if a is negative.

Precondition
Z3_algebraic_is_value(c, a)
Z3_ast Z3_API Z3_algebraic_sub ( Z3_context  c,
Z3_ast  a,
Z3_ast  b 
)

Return the value a - b.

Precondition
Z3_algebraic_is_value(c, a)
Z3_algebraic_is_value(c, b)
Postcondition
Z3_algebraic_is_value(c, result)
Z3_ast Z3_API Z3_app_to_ast ( Z3_context  c,
Z3_app  a 
)

Convert a Z3_app into Z3_ast. This is just type casting.

void Z3_API Z3_append_log ( Z3_string  string)

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.

Referenced by z3py::append_log().

Z3_model Z3_API Z3_apply_result_convert_model ( Z3_context  c,
Z3_apply_result  r,
unsigned  i,
Z3_model  m 
)

Convert a model for the subgoal Z3_apply_result_get_subgoal(c, r, i) into a model for the original goal g. Where g is the goal used to create r using Z3_tactic_apply(c, t, g).

Referenced by apply_result::convert_model(), and ApplyResult::convert_model().

void Z3_API Z3_apply_result_dec_ref ( Z3_context  c,
Z3_apply_result  r 
)

Decrement the reference counter of the given Z3_apply_result object.

Referenced by ApplyResult::__del__(), apply_result::operator=(), and apply_result::~apply_result().

unsigned Z3_API Z3_apply_result_get_num_subgoals ( Z3_context  c,
Z3_apply_result  r 
)

Return the number of subgoals in the Z3_apply_result object returned by Z3_tactic_apply.

Referenced by ApplyResult::__len__(), and apply_result::size().

Z3_goal Z3_API Z3_apply_result_get_subgoal ( Z3_context  c,
Z3_apply_result  r,
unsigned  i 
)

Return one of the subgoals in the Z3_apply_result object returned by Z3_tactic_apply.

Precondition
i < Z3_apply_result_get_num_subgoals(c, r)

Referenced by ApplyResult::__getitem__(), and apply_result::operator[]().

void Z3_API Z3_apply_result_inc_ref ( Z3_context  c,
Z3_apply_result  r 
)

Increment the reference counter of the given Z3_apply_result object.

Referenced by apply_result::operator=().

Z3_string Z3_API Z3_apply_result_to_string ( Z3_context  c,
Z3_apply_result  r 
)

Convert the Z3_apply_result object returned by Z3_tactic_apply into a string.

Referenced by ApplyResult::sexpr().

void Z3_API Z3_assert_cnstr ( Z3_context  c,
Z3_ast  a 
)

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.

See also
Z3_check
Z3_check_and_get_model
Deprecated:
Subsumed by Z3_solver_assert
Z3_bool Z3_API Z3_ast_map_contains ( Z3_context  c,
Z3_ast_map  m,
Z3_ast  k 
)

Return true if the map m contains the AST key k.

void Z3_API Z3_ast_map_dec_ref ( Z3_context  c,
Z3_ast_map  m 
)

Decrement the reference counter of the given AST map.

void Z3_API Z3_ast_map_erase ( Z3_context  c,
Z3_ast_map  m,
Z3_ast  k 
)

Erase a key from the map.

Z3_ast Z3_API Z3_ast_map_find ( Z3_context  c,
Z3_ast_map  m,
Z3_ast  k 
)

Return the value associated with the key k.

The procedure invokes the error handler if k is not in the map.

void Z3_API Z3_ast_map_inc_ref ( Z3_context  c,
Z3_ast_map  m 
)

Increment the reference counter of the given AST map.

void Z3_API Z3_ast_map_insert ( Z3_context  c,
Z3_ast_map  m,
Z3_ast  k,
Z3_ast  v 
)

Store/Replace a new key, value pair in the given map.

Z3_ast_vector Z3_API Z3_ast_map_keys ( Z3_context  c,
Z3_ast_map  m 
)

Return the keys stored in the given map.

void Z3_API Z3_ast_map_reset ( Z3_context  c,
Z3_ast_map  m 
)

Remove all keys from the given map.

unsigned Z3_API Z3_ast_map_size ( Z3_context  c,
Z3_ast_map  m 
)

Return the size of the given map.

Z3_string Z3_API Z3_ast_map_to_string ( Z3_context  c,
Z3_ast_map  m 
)

Convert the given map into a string.

Z3_string Z3_API Z3_ast_to_string ( Z3_context  c,
Z3_ast  a 
)

Convert the given AST node into a string.

Warning
The result buffer is statically allocated by Z3. It will be automatically deallocated when Z3_del_context is invoked. So, the buffer is invalidated in the next call to Z3_ast_to_string.
See also
Z3_pattern_to_string
Z3_sort_to_string

Referenced by AstRef::sexpr().

void Z3_API Z3_ast_vector_dec_ref ( Z3_context  c,
Z3_ast_vector  v 
)

Decrement the reference counter of the given AST vector.

Referenced by ast_vector_tpl< T >::operator=(), and ast_vector_tpl< T >::~ast_vector_tpl().

Z3_ast Z3_API Z3_ast_vector_get ( Z3_context  c,
Z3_ast_vector  v,
unsigned  i 
)

Return the AST at position i in the AST vector v.

Precondition
i < Z3_ast_vector_size(c, v)

Referenced by ast_vector_tpl< T >::operator[]().

void Z3_API Z3_ast_vector_inc_ref ( Z3_context  c,
Z3_ast_vector  v 
)

Increment the reference counter of the given AST vector.

Referenced by ast_vector_tpl< T >::ast_vector_tpl(), cast_ast< func_decl >::operator()(), and ast_vector_tpl< T >::operator=().

void Z3_API Z3_ast_vector_push ( Z3_context  c,
Z3_ast_vector  v,
Z3_ast  a 
)

Add the AST a in the end of the AST vector v. The size of v is increased by one.

Referenced by ast_vector_tpl< T >::push_back().

void Z3_API Z3_ast_vector_resize ( Z3_context  c,
Z3_ast_vector  v,
unsigned  n 
)

Resize the AST vector v.

Referenced by ast_vector_tpl< T >::resize().

void Z3_API Z3_ast_vector_set ( Z3_context  c,
Z3_ast_vector  v,
unsigned  i,
Z3_ast  a 
)

Update position i of the AST vector v with the AST a.

Precondition
i < Z3_ast_vector_size(c, v)
unsigned Z3_API Z3_ast_vector_size ( Z3_context  c,
Z3_ast_vector  v 
)

Return the size of the given AST vector.

Referenced by ast_vector_tpl< T >::size().

Z3_string Z3_API Z3_ast_vector_to_string ( Z3_context  c,
Z3_ast_vector  v 
)

Convert AST vector into a string.

Z3_ast_vector Z3_API Z3_ast_vector_translate ( Z3_context  s,
Z3_ast_vector  v,
Z3_context  t 
)

Translate the AST vector v from context s into an AST vector in context t.

Z3_string Z3_API Z3_benchmark_to_smtlib_string ( Z3_context  c,
Z3_string  name,
Z3_string  logic,
Z3_string  status,
Z3_string  attributes,
unsigned  num_assumptions,
Z3_ast const  assumptions[],
Z3_ast  formula 
)

Convert the given benchmark into SMT-LIB formatted string.

Warning
The result buffer is statically allocated by Z3. It will be automatically deallocated when Z3_del_context is invoked. So, the buffer is invalidated in the next call to Z3_benchmark_to_smtlib_string.
Parameters
c- context.
name- name of benchmark. The argument is optional.
logic- the benchmark logic.
status- the status string (sat, unsat, or unknown)
attributes- other attributes, such as source, difficulty or category.
num_assumptions- number of assumptions.
assumptions- auxiliary assumptions.
formula- formula to be checked for consistency in conjunction with assumptions.

Referenced by solver::to_smt2(), and Solver::to_smt2().

void Z3_API Z3_block_literals ( Z3_context  c,
Z3_literals  lbls 
)

Block subsequent checks using the remaining enabled labels.

Deprecated:
This procedure is based on the old Solver API.
Z3_lbool Z3_API Z3_check ( Z3_context  c)

Check whether the given logical context is consistent or not.

The function Z3_check_and_get_model should be used when models are needed.

See also
Z3_check_and_get_model
Deprecated:
Subsumed by Z3_solver_check
Z3_lbool Z3_API Z3_check_and_get_model ( Z3_context  c,
Z3_model *  m 
)

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 Z3_L_FALSE) and model construction is enabled (see Z3_mk_config), then a model is stored in m. Otherwise, the value NULL is stored in m. The caller is responsible for deleting the model using the function Z3_del_model.

Remarks
In contrast with the rest of the Z3 API, the reference counter of the model is incremented. This is to guarantee backward compatibility. In previous versions, models did not support reference counting.
Model construction must be enabled using configuration parameters (See, Z3_mk_config).
See also
Z3_check
Z3_del_model
Deprecated:
Subsumed by Z3_solver_check
Z3_lbool Z3_API Z3_check_assumptions ( Z3_context  c,
unsigned  num_assumptions,
Z3_ast const  assumptions[],
Z3_model *  m,
Z3_ast *  proof,
unsigned *  core_size,
Z3_ast  core[] 
)

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 Z3_L_FALSE), a non-NULL model argument is passed in, and model construction is enabled (see Z3_mk_config), then a model is stored in m. Otherwise, m is left unchanged. The caller is responsible for deleting the model using the function Z3_del_model.

Remarks
If the model argument is non-NULL, then model construction must be enabled using configuration parameters (See, Z3_mk_config).
Parameters
clogical context.
num_assumptionsnumber of auxiliary assumptions.
assumptionsarray of auxiliary assumptions
moptional pointer to a model.
proofoptional pointer to a proof term.
core_sizesize of unsatisfiable core.
corepointer 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 core array is not populated if core_size is set to 0.
Precondition
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.
Remarks
In constrast with the rest of the Z3 API, the reference counter of the model is incremented. This is to guarantee backward compatibility. In previous versions, models did not support reference counting.
See also
Z3_check
Z3_del_model
Deprecated:
Subsumed by Z3_solver_check_assumptions
int Z3_API Z3_check_interpolant ( Z3_context  ctx,
unsigned  num,
Z3_ast  cnsts[],
unsigned  parents[],
Z3_ast *  interps,
Z3_string_ptr  error,
unsigned  num_theory,
Z3_ast  theory[] 
)

Check the correctness of an interpolant. The Z3 context must have no constraints asserted when this call is made. That means that after interpolating, you must first fully pop the Z3 context before calling this. See Z3_interpolate for meaning of parameters.

Parameters
ctxThe Z3 context. Must be generated by Z3_mk_interpolation_context
numThe number of constraints in the sequence
cnstsArray of constraints (AST's in context ctx)
parentsThe parents vector (or NULL for sequence)
interpsThe interpolant to check
errorReturns an error message if interpolant incorrect (do not free the string)
num_theoryNumber of theory terms
theoryTheory terms

Return value is Z3_L_TRUE if interpolant is verified, Z3_L_FALSE if incorrect, and Z3_L_UNDEF if unknown.

void Z3_API Z3_close_log ( void  )

Close interaction log.

Z3_lbool Z3_API Z3_compute_interpolant ( Z3_context  c,
Z3_ast  pat,
Z3_params  p,
Z3_ast_vector *  interp,
Z3_model *  model 
)
Z3_string Z3_API Z3_context_to_string ( Z3_context  c)

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.

Warning
The result buffer is statically allocated by Z3. It will be automatically deallocated when Z3_del_context is invoked. So, the buffer is invalidated in the next call to Z3_context_to_string.
Deprecated:
This method is obsolete. It just displays the internal representation of the global solver available for backward compatibility reasons.
Z3_ast Z3_API Z3_datatype_update_field ( Z3_context  c,
Z3_func_decl  field_access,
Z3_ast  t,
Z3_ast  value 
)

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

See also
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).
Precondition
Z3_get_sort_kind(Z3_get_sort(c, t)) == Z3_get_domain(c, field_access, 1) == Z3_DATATYPE_SORT
Z3_get_sort(c, value) == Z3_get_range(c, field_access)
void Z3_API Z3_dec_ref ( Z3_context  c,
Z3_ast  a 
)

Decrement the reference counter of the given AST. The context c should have been created using Z3_mk_context_rc. This function is a NOOP if c was created using Z3_mk_context.

Referenced by AstRef::__del__(), ast::operator=(), and ast::~ast().

void Z3_API Z3_del_config ( Z3_config  c)

Delete the given configuration object.

See also
Z3_mk_config

Referenced by config::~config().

void Z3_API Z3_del_constructor ( Z3_context  c,
Z3_constructor  constr 
)

Reclaim memory allocated to constructor.

Parameters
clogical context.
constrconstructor.
void Z3_API Z3_del_constructor_list ( Z3_context  c,
Z3_constructor_list  clist 
)

Reclaim memory allocated for constructor list.

Each constructor inside the constructor list must be independently reclaimed using Z3_del_constructor.

Parameters
clogical context.
clistconstructor list container.
void Z3_API Z3_del_context ( Z3_context  c)

Delete the given logical context.

See also
Z3_mk_context

Referenced by context::~context().

void Z3_API Z3_del_literals ( Z3_context  c,
Z3_literals  lbls 
)

Delete a labels context.

See also
Z3_get_relevant_labels
Deprecated:
This procedure is based on the old Solver API.
void Z3_API Z3_del_model ( Z3_context  c,
Z3_model  m 
)

Delete a model object.

See also
Z3_check_and_get_model
Remarks
The Z3_check_and_get_model automatically increments a reference count on the model. The expected usage is that models created by that method are deleted using Z3_del_model. This is for backwards compatibility and in contrast to the rest of the API where callers are responsible for managing reference counts.
Deprecated:
Subsumed by Z3_solver API
void Z3_API Z3_disable_literal ( Z3_context  c,
Z3_literals  lbls,
unsigned  idx 
)

Disable label.

The disabled label is not going to be used when blocking the subsequent search.

See also
Z3_block_literals
Deprecated:
This procedure is based on the old Solver API.
void Z3_API Z3_disable_trace ( Z3_string  tag)

Disable tracing messages tagged as tag when Z3 is compiled in debug mode. It is a NOOP otherwise.

Referenced by z3py::disable_trace().

void Z3_API Z3_enable_trace ( Z3_string  tag)

Enable tracing messages tagged as tag when Z3 is compiled in debug mode. It is a NOOP otherwise.

Referenced by z3py::enable_trace().

Z3_bool Z3_API Z3_eval ( Z3_context  c,
Z3_model  m,
Z3_ast  t,
Z3_ast *  v 
)

Evaluate the AST node t in the given model. Return Z3_TRUE if succeeded, and store the result in v.The evaluation may fail for the following reasons:

  • t contains a quantifier.
  • the model m is partial, that is, it doesn't have a complete interpretation for uninterpreted functions. That is, the option MODEL_PARTIAL=true was used.
  • t is type incorrect.
Deprecated:
Use Z3_model_eval
Z3_bool Z3_API Z3_eval_decl ( Z3_context  c,
Z3_model  m,
Z3_func_decl  d,
unsigned  num_args,
Z3_ast const  args[],
Z3_ast *  v 
)

Evaluate declaration given values.

Provides direct way to evaluate declarations without going over terms.

Deprecated:
Consider using Z3_model_eval and Z3_substitute_vars
Z3_bool Z3_API Z3_eval_func_decl ( Z3_context  c,
Z3_model  m,
Z3_func_decl  decl,
Z3_ast *  v 
)

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
void Z3_API Z3_finalize_memory ( void  )

Destroy all allocated resources.

Any pointers previously returned by the API become invalid. Can be used for memory leak detection.

void Z3_API Z3_fixedpoint_add_cover ( Z3_context  c,
Z3_fixedpoint  d,
int  level,
Z3_func_decl  pred,
Z3_ast  property 
)

Add property about the predicate pred. Add a property of predicate pred at level. It gets pushed forward when possible.

Note: level = -1 is treated as the fixedpoint. So passing -1 for the level means that the property is true of the fixed-point unfolding with respect to pred.

Note: this functionality is PDR specific.

Referenced by Fixedpoint::add_cover().

void Z3_API Z3_fixedpoint_add_fact ( Z3_context  c,
Z3_fixedpoint  d,
Z3_func_decl  r,
unsigned  num_args,
unsigned  args[] 
)

Add a Database fact.

Parameters
c- context
d- fixed point context
r- relation signature for the row.
num_args- number of columns for the given row.
args- array of the row elements.

The number of arguments num_args should be equal to the number of sorts in the domain of 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 r is applied to the arguments.

void Z3_API Z3_fixedpoint_add_rule ( Z3_context  c,
Z3_fixedpoint  d,
Z3_ast  rule,
Z3_symbol  name 
)

Add a universal Horn clause as a named rule. The horn_rule should be of the form:

1 horn_rule ::= (forall (bound-vars) horn_rule)
2  | (=> atoms horn_rule)
3  | atom

Referenced by Fixedpoint::add_rule().

void Z3_API Z3_fixedpoint_assert ( Z3_context  c,
Z3_fixedpoint  d,
Z3_ast  axiom 
)

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.

Referenced by Fixedpoint::assert_exprs().

void Z3_API Z3_fixedpoint_dec_ref ( Z3_context  c,
Z3_fixedpoint  d 
)

Decrement the reference counter of the given fixedpoint context.

Referenced by Fixedpoint::__del__().

Z3_ast_vector Z3_API Z3_fixedpoint_from_file ( Z3_context  c,
Z3_fixedpoint  f,
Z3_string  s 
)

Parse an SMT-LIB2 file with fixedpoint rules. Add the rules to the current fixedpoint context. Return the set of queries in the file.

Parameters
c- context.
f- fixedpoint context.
s- string containing SMT2 specification.

Referenced by Fixedpoint::parse_file().

Z3_ast_vector Z3_API Z3_fixedpoint_from_string ( Z3_context  c,
Z3_fixedpoint  f,
Z3_string  s 
)

Parse an SMT-LIB2 string with fixedpoint rules. Add the rules to the current fixedpoint context. Return the set of queries in the string.

Parameters
c- context.
f- fixedpoint context.
s- string containing SMT2 specification.

Referenced by Fixedpoint::parse_string().

Z3_ast Z3_API Z3_fixedpoint_get_answer ( Z3_context  c,
Z3_fixedpoint  d 
)

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.

Referenced by Fixedpoint::get_answer().

Z3_ast_vector Z3_API Z3_fixedpoint_get_assertions ( Z3_context  c,
Z3_fixedpoint  f 
)

Retrieve set of background assertions from fixedpoint context.

Referenced by Fixedpoint::get_assertions().

Z3_ast Z3_API Z3_fixedpoint_get_cover_delta ( Z3_context  c,
Z3_fixedpoint  d,
int  level,
Z3_func_decl  pred 
)

Retrieve the current cover of pred up to level unfoldings. Return just the delta that is known at level. To obtain the full set of properties of pred one should query at level+1 , level+2 etc, and include level=-1.

Note: this functionality is PDR specific.

Referenced by Fixedpoint::get_cover_delta().

Z3_string Z3_API Z3_fixedpoint_get_help ( Z3_context  c,
Z3_fixedpoint  f 
)

Return a string describing all fixedpoint available parameters.

Referenced by Fixedpoint::help().

unsigned Z3_API Z3_fixedpoint_get_num_levels ( Z3_context  c,
Z3_fixedpoint  d,
Z3_func_decl  pred 
)

Query the PDR engine for the maximal levels properties are known about predicate.

This call retrieves the maximal number of relevant unfoldings of pred with respect to the current exploration state. Note: this functionality is PDR specific.

Referenced by Fixedpoint::get_num_levels().

Z3_param_descrs Z3_API Z3_fixedpoint_get_param_descrs ( Z3_context  c,
Z3_fixedpoint  f 
)

Return the parameter description set for the given fixedpoint object.

Referenced by Fixedpoint::param_descrs().

Z3_string Z3_API Z3_fixedpoint_get_reason_unknown ( Z3_context  c,
Z3_fixedpoint  d 
)

Retrieve a string that describes the last status returned by Z3_fixedpoint_query.

Use this method when Z3_fixedpoint_query returns Z3_L_UNDEF.

Referenced by Fixedpoint::reason_unknown().

Z3_ast_vector Z3_API Z3_fixedpoint_get_rules ( Z3_context  c,
Z3_fixedpoint  f 
)

Retrieve set of rules from fixedpoint context.

Referenced by Fixedpoint::get_rules().

Z3_stats Z3_API Z3_fixedpoint_get_statistics ( Z3_context  c,
Z3_fixedpoint  d 
)

Retrieve statistics information from the last call to Z3_fixedpoint_query.

Referenced by Fixedpoint::statistics().

void Z3_API Z3_fixedpoint_inc_ref ( Z3_context  c,
Z3_fixedpoint  d 
)

Increment the reference counter of the given fixedpoint context.

void Z3_API Z3_fixedpoint_init ( Z3_context  c,
Z3_fixedpoint  d,
void *  state 
)

Initialize the context with a user-defined state.

void Z3_API Z3_fixedpoint_pop ( Z3_context  c,
Z3_fixedpoint  d 
)

Backtrack one backtracking point.

See also
Z3_fixedpoint_push
Precondition
The number of calls to pop cannot exceed calls to push.

Referenced by Fixedpoint::pop().

void Z3_API Z3_fixedpoint_push ( Z3_context  c,
Z3_fixedpoint  d 
)

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.

See also
Z3_fixedpoint_pop

Referenced by Fixedpoint::push().

Z3_lbool Z3_API Z3_fixedpoint_query ( Z3_context  c,
Z3_fixedpoint  d,
Z3_ast  query 
)

Pose a query against the asserted rules.

1 query ::= (exists (bound-vars) query)
2  | literals

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.

Referenced by Fixedpoint::query().

Z3_lbool Z3_API Z3_fixedpoint_query_relations ( Z3_context  c,
Z3_fixedpoint  d,
unsigned  num_relations,
Z3_func_decl const  relations[] 
)

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.

Referenced by Fixedpoint::query().

void Z3_API Z3_fixedpoint_register_relation ( Z3_context  c,
Z3_fixedpoint  d,
Z3_func_decl  f 
)

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.

Referenced by Fixedpoint::register_relation().

void Z3_API Z3_fixedpoint_set_params ( Z3_context  c,
Z3_fixedpoint  f,
Z3_params  p 
)

Set parameters on fixedpoint context.

Referenced by Fixedpoint::set().

void Z3_API Z3_fixedpoint_set_predicate_representation ( Z3_context  c,
Z3_fixedpoint  d,
Z3_func_decl  f,
unsigned  num_relations,
Z3_symbol const  relation_kinds[] 
)

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.

Referenced by Fixedpoint::set_predicate_representation().

void Z3_API Z3_fixedpoint_set_reduce_app_callback ( Z3_context  c,
Z3_fixedpoint  d,
Z3_fixedpoint_reduce_app_callback_fptr  cb 
)

Register a callback for buildling terms based on the relational operators.

void Z3_API Z3_fixedpoint_set_reduce_assign_callback ( Z3_context  c,
Z3_fixedpoint  d,
Z3_fixedpoint_reduce_assign_callback_fptr  cb 
)

Register a callback to destructive updates.

Registers are identified with terms encoded as fresh constants,

Z3_string Z3_API Z3_fixedpoint_to_string ( Z3_context  c,
Z3_fixedpoint  f,
unsigned  num_queries,
Z3_ast  queries[] 
)

Print the current rules and background axioms as a string.

Parameters
c- context.
f- fixedpoint context.
num_queries- number of additional queries to print.
queries- additional queries.

Referenced by Fixedpoint::sexpr(), and Fixedpoint::to_string().

void Z3_API Z3_fixedpoint_update_rule ( Z3_context  c,
Z3_fixedpoint  d,
Z3_ast  a,
Z3_symbol  name 
)

Update a named rule. A rule with the same name must have been previously created.

Referenced by Fixedpoint::update_rule().

unsigned Z3_API Z3_fpa_get_ebits ( Z3_context  c,
Z3_sort  s 
)

Retrieves the number of bits reserved for the exponent in a FloatingPoint sort.

Parameters
clogical context
sFloatingPoint sort
Z3_bool Z3_API Z3_fpa_get_numeral_exponent_int64 ( Z3_context  c,
Z3_ast  t,
__int64 n 
)

Return the exponent value of a floating-point numeral as a signed 64-bit integer.

Parameters
clogical context
ta floating-point numeral
nexponent
Z3_string Z3_API Z3_fpa_get_numeral_exponent_string ( Z3_context  c,
Z3_ast  t 
)

Return the exponent value of a floating-point numeral as a string.

Parameters
clogical context
ta floating-point numeral
Z3_bool Z3_API Z3_fpa_get_numeral_sign ( Z3_context  c,
Z3_ast  t,
int *  sgn 
)

Retrieves the sign of a floating-point literal.

Parameters
clogical context
ta floating-point numeral
sgnsign

Remarks: sets sgn to 0 if the literal is NaN or positive and to 1 otherwise.

Z3_string Z3_API Z3_fpa_get_numeral_significand_string ( Z3_context  c,
Z3_ast  t 
)

Return the significand value of a floating-point numeral as a string.

Parameters
clogical context
ta floating-point numeral

Remarks: The significand s is always 0 < s < 2.0; the resulting string is long enough to represent the real significand precisely.

Z3_bool Z3_API Z3_fpa_get_numeral_significand_uint64 ( Z3_context  c,
Z3_ast  t,
__uint64 n 
)

Return the significand value of a floating-point numeral as a uint64.

Parameters
clogical context
ta floating-point numeral

Remarks: This function extracts the significand bits in t, without the hidden bit or normalization. Sets the Z3_INVALID_ARG error code if the significand does not fit into a uint64.

unsigned Z3_API Z3_fpa_get_sbits ( Z3_context  c,
Z3_sort  s 
)

Retrieves the number of bits reserved for the significand in a FloatingPoint sort.

Parameters
clogical context
sFloatingPoint sort
Z3_ast Z3_API Z3_func_decl_to_ast ( Z3_context  c,
Z3_func_decl  f 
)

Convert a Z3_func_decl into Z3_ast. This is just type casting.

Referenced by FuncDeclRef::as_ast().

Z3_string Z3_API Z3_func_decl_to_string ( Z3_context  c,
Z3_func_decl  d 
)
void Z3_API Z3_func_entry_dec_ref ( Z3_context  c,
Z3_func_entry  e 
)

Decrement the reference counter of the given Z3_func_entry object.

Referenced by func_entry::operator=(), and func_entry::~func_entry().

Z3_ast Z3_API Z3_func_entry_get_arg ( Z3_context  c,
Z3_func_entry  e,
unsigned  i 
)

Return an argument of a Z3_func_entry object.

Precondition
i < Z3_func_entry_get_num_args(c, e)
See also
Z3_func_interp_get_entry

Referenced by func_entry::arg().

unsigned Z3_API Z3_func_entry_get_num_args ( Z3_context  c,
Z3_func_entry  e 
)

Return the number of arguments in a Z3_func_entry object.

See also
Z3_func_interp_get_entry

Referenced by func_entry::num_args().

Z3_ast Z3_API Z3_func_entry_get_value ( Z3_context  c,
Z3_func_entry  e 
)

Return the value of this point.

A Z3_func_entry object represents an element in the finite map used to encode a function interpretation.

See also
Z3_func_interp_get_entry

Referenced by func_entry::value().

void Z3_API Z3_func_entry_inc_ref ( Z3_context  c,
Z3_func_entry  e 
)

Increment the reference counter of the given Z3_func_entry object.

Referenced by func_entry::operator=().

void Z3_API Z3_func_interp_dec_ref ( Z3_context  c,
Z3_func_interp  f 
)

Decrement the reference counter of the given Z3_func_interp object.

Referenced by func_interp::operator=(), and func_interp::~func_interp().

unsigned Z3_API Z3_func_interp_get_arity ( Z3_context  c,
Z3_func_interp  f 
)

Return the arity (number of arguments) of the given function interpretation.

Z3_ast Z3_API Z3_func_interp_get_else ( Z3_context  c,
Z3_func_interp  f 
)

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.

Referenced by func_interp::else_value().

Z3_func_entry Z3_API Z3_func_interp_get_entry ( Z3_context  c,
Z3_func_interp  f,
unsigned  i 
)

Return a "point" of the given function intepretation. It represents the value of f in a particular point.

Precondition
i < Z3_func_interp_get_num_entries(c, f)
See also
Z3_func_interp_get_num_entries

Referenced by func_interp::entry().

unsigned Z3_API Z3_func_interp_get_num_entries ( Z3_context  c,
Z3_func_interp  f 
)

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 f.

Referenced by func_interp::num_entries().

void Z3_API Z3_func_interp_inc_ref ( Z3_context  c,
Z3_func_interp  f 
)

Increment the reference counter of the given Z3_func_interp object.

Referenced by func_interp::operator=().

Z3_ast Z3_API Z3_get_algebraic_number_lower ( Z3_context  c,
Z3_ast  a,
unsigned  precision 
)

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.

Precondition
Z3_is_algebraic_number(c, a)
Z3_ast Z3_API Z3_get_algebraic_number_upper ( Z3_context  c,
Z3_ast  a,
unsigned  precision 
)

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.

Precondition
Z3_is_algebraic_number(c, a)
Z3_ast Z3_API Z3_get_app_arg ( Z3_context  c,
Z3_app  a,
unsigned  i 
)

Return the i-th argument of the given application.

Precondition
i < Z3_get_num_args(c, a)

Referenced by expr::arg(), and ExprRef::arg().

Z3_func_decl Z3_API Z3_get_app_decl ( Z3_context  c,
Z3_app  a 
)

Return the declaration of a constant or function application.

Referenced by expr::decl(), and ExprRef::decl().

unsigned Z3_API Z3_get_app_num_args ( Z3_context  c,
Z3_app  a 
)

Return the number of argument of an application. If t is an constant, then the number of arguments is 0.

Referenced by expr::num_args(), and ExprRef::num_args().

unsigned Z3_API Z3_get_arity ( Z3_context  c,
Z3_func_decl  d 
)

Alias for Z3_get_domain_size.

See also
Z3_get_domain_size

Referenced by func_decl::arity(), and FuncDeclRef::arity().

Z3_sort Z3_API Z3_get_array_sort_domain ( Z3_context  c,
Z3_sort  t 
)

Return the domain of the given array sort.

Precondition
Z3_get_sort_kind(c, t) == Z3_ARRAY_SORT
See also
Z3_mk_array_sort
Z3_get_sort_kind

Referenced by sort::array_domain().

Z3_sort Z3_API Z3_get_array_sort_range ( Z3_context  c,
Z3_sort  t 
)

Return the range of the given array sort.

Precondition
Z3_get_sort_kind(c, t) == Z3_ARRAY_SORT
See also
Z3_mk_array_sort
Z3_get_sort_kind

Referenced by sort::array_range().

void Z3_API Z3_get_array_value ( Z3_context  c,
Z3_model  m,
Z3_ast  v,
unsigned  num_entries,
Z3_ast  indices[],
Z3_ast  values[],
Z3_ast *  else_value 
)

An array values is represented as a dictionary plus a default (else) value. This function returns the array graph.

Precondition
Z3_TRUE == Z3_is_array_value(c, v, &num_entries)
Deprecated:
Use Z3_func_interp objects and Z3_get_as_array_func_decl
Z3_func_decl Z3_API Z3_get_as_array_func_decl ( Z3_context  c,
Z3_ast  a 
)

Return the function declaration f associated with a (_ as_array f) node.

See also
Z3_is_as_array
unsigned Z3_API Z3_get_ast_hash ( Z3_context  c,
Z3_ast  a 
)

Return a hash code for the given AST. The hash code is structural. You can use Z3_get_ast_id interchangably with this function.

Referenced by ast::hash(), and AstRef::hash().

unsigned Z3_API Z3_get_ast_id ( Z3_context  c,
Z3_ast  t 
)

Return a unique identifier for 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.

Referenced by AstRef::get_id(), SortRef::get_id(), FuncDeclRef::get_id(), and ExprRef::get_id().

Z3_ast_kind Z3_API Z3_get_ast_kind ( Z3_context  c,
Z3_ast  a 
)
Z3_lbool Z3_API Z3_get_bool_value ( Z3_context  c,
Z3_ast  a 
)

Return Z3_L_TRUE if a is true, Z3_L_FALSE if it is false, and Z3_L_UNDEF otherwise.

unsigned Z3_API Z3_get_bv_sort_size ( Z3_context  c,
Z3_sort  t 
)

Return the size of the given bit-vector sort.

Precondition
Z3_get_sort_kind(c, t) == Z3_BV_SORT
See also
Z3_mk_bv_sort
Z3_get_sort_kind

Referenced by sort::bv_size().

Z3_ast Z3_API Z3_get_context_assignment ( Z3_context  c)

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.
Z3_func_decl Z3_API Z3_get_datatype_sort_constructor ( Z3_context  c,
Z3_sort  t,
unsigned  idx 
)

Return idx'th constructor.

Precondition
Z3_get_sort_kind(t) == Z3_DATATYPE_SORT
idx < Z3_get_datatype_sort_num_constructors(c, t)
See also
Z3_get_datatype_sort_num_constructors
Z3_get_datatype_sort_recognizer
Z3_get_datatype_sort_constructor_accessor
Z3_func_decl Z3_API Z3_get_datatype_sort_constructor_accessor ( Z3_context  c,
Z3_sort  t,
unsigned  idx_c,
unsigned  idx_a 
)

Return idx_a'th accessor for the idx_c'th constructor.

Precondition
Z3_get_sort_kind(t) == Z3_DATATYPE_SORT
idx_c < Z3_get_datatype_sort_num_constructors(c, t)
idx_a < Z3_get_domain_size(c, Z3_get_datatype_sort_constructor(c, idx_c))
See also
Z3_get_datatype_sort_num_constructors
Z3_get_datatype_sort_constructor
Z3_get_datatype_sort_recognizer
unsigned Z3_API Z3_get_datatype_sort_num_constructors ( Z3_context  c,
Z3_sort  t 
)

Return number of constructors for datatype.

Precondition
Z3_get_sort_kind(t) == Z3_DATATYPE_SORT
See also
Z3_get_datatype_sort_constructor
Z3_get_datatype_sort_recognizer
Z3_get_datatype_sort_constructor_accessor
Z3_func_decl Z3_API Z3_get_datatype_sort_recognizer ( Z3_context  c,
Z3_sort  t,
unsigned  idx 
)

Return idx'th recognizer.

Precondition
Z3_get_sort_kind(t) == Z3_DATATYPE_SORT
idx < Z3_get_datatype_sort_num_constructors(c, t)
See also
Z3_get_datatype_sort_num_constructors
Z3_get_datatype_sort_constructor
Z3_get_datatype_sort_constructor_accessor
Z3_ast Z3_API Z3_get_decl_ast_parameter ( Z3_context  c,
Z3_func_decl  d,
unsigned  idx 
)

Return the expresson value associated with an expression parameter.

Precondition
Z3_get_decl_parameter_kind(c, d, idx) == Z3_PARAMETER_AST
double Z3_API Z3_get_decl_double_parameter ( Z3_context  c,
Z3_func_decl  d,
unsigned  idx 
)

Return the double value associated with an double parameter.

Precondition
Z3_get_decl_parameter_kind(c, d, idx) == Z3_PARAMETER_DOUBLE
Z3_func_decl Z3_API Z3_get_decl_func_decl_parameter ( Z3_context  c,
Z3_func_decl  d,
unsigned  idx 
)

Return the expresson value associated with an expression parameter.

Precondition
Z3_get_decl_parameter_kind(c, d, idx) == Z3_PARAMETER_FUNC_DECL
int Z3_API Z3_get_decl_int_parameter ( Z3_context  c,
Z3_func_decl  d,
unsigned  idx 
)

Return the integer value associated with an integer parameter.

Precondition
Z3_get_decl_parameter_kind(c, d, idx) == Z3_PARAMETER_INT

Referenced by expr::hi(), and expr::lo().

Z3_decl_kind Z3_API Z3_get_decl_kind ( Z3_context  c,
Z3_func_decl  d 
)

Return declaration kind corresponding to declaration.

Referenced by func_decl::decl_kind(), and FuncDeclRef::kind().

Z3_symbol Z3_API Z3_get_decl_name ( Z3_context  c,
Z3_func_decl  d 
)

Return the constant declaration name as a symbol.

Referenced by func_decl::name(), and FuncDeclRef::name().

unsigned Z3_API Z3_get_decl_num_parameters ( Z3_context  c,
Z3_func_decl  d 
)

Return the number of parameters associated with a declaration.

Referenced by expr::hi(), and expr::lo().

Z3_parameter_kind Z3_API Z3_get_decl_parameter_kind ( Z3_context  c,
Z3_func_decl  d,
unsigned  idx 
)

Return the parameter type associated with a declaration.

Parameters
cthe context
dthe function declaration
idxis the index of the named parameter it should be between 0 and the number of parameters.
Z3_string Z3_API Z3_get_decl_rational_parameter ( Z3_context  c,
Z3_func_decl  d,
unsigned  idx 
)

Return the rational value, as a string, associated with a rational parameter.

Precondition
Z3_get_decl_parameter_kind(c, d, idx) == Z3_PARAMETER_RATIONAL
Z3_sort Z3_API Z3_get_decl_sort_parameter ( Z3_context  c,
Z3_func_decl  d,
unsigned  idx 
)

Return the sort value associated with a sort parameter.

Precondition
Z3_get_decl_parameter_kind(c, d, idx) == Z3_PARAMETER_SORT
Z3_symbol Z3_API Z3_get_decl_symbol_parameter ( Z3_context  c,
Z3_func_decl  d,
unsigned  idx 
)

Return the double value associated with an double parameter.

Precondition
Z3_get_decl_parameter_kind(c, d, idx) == Z3_PARAMETER_SYMBOL
Z3_ast Z3_API Z3_get_denominator ( Z3_context  c,
Z3_ast  a 
)

Return the denominator (as a numeral AST) of a numeral AST of sort Real.

Precondition
Z3_get_ast_kind(c, a) == Z3_NUMERAL_AST
Z3_sort Z3_API Z3_get_domain ( Z3_context  c,
Z3_func_decl  d,
unsigned  i 
)

Return the sort of the i-th parameter of the given function declaration.

Precondition
i < Z3_get_domain_size(d)
See also
Z3_get_domain_size

Referenced by func_decl::domain(), and FuncDeclRef::domain().

unsigned Z3_API Z3_get_domain_size ( Z3_context  c,
Z3_func_decl  d 
)

Return the number of parameters of the given declaration.

See also
Z3_get_arity
Z3_error_code Z3_API Z3_get_error_code ( Z3_context  c)

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.

See also
Z3_set_error_handler

Referenced by context::check_error().

Z3_string Z3_API Z3_get_error_msg ( Z3_error_code  err)

Return a string describing the given error code.

Deprecated:
Use Z3_get_error_msg_ex instead.
BEGIN_MLAPI_EXCLUDE Z3_string Z3_API Z3_get_error_msg_ex ( Z3_context  c,
Z3_error_code  err 
)

Return a string describing the given error code.

Referenced by context::check_error().

Z3_bool Z3_API Z3_get_finite_domain_sort_size ( Z3_context  c,
Z3_sort  s,
unsigned __int64 r 
)

Store the size of the sort in r. Return Z3_FALSE if the call failed. That is, Z3_get_sort_kind(s) == Z3_FINITE_DOMAIN_SORT.

Referenced by FiniteDomainSortRef::size().

unsigned Z3_API Z3_get_func_decl_id ( Z3_context  c,
Z3_func_decl  f 
)

Return a unique identifier for f.

Z3_literals Z3_API Z3_get_guessed_literals ( Z3_context  c)

Retrieve the set of literals that whose assignment were guess, but not propagated during the search.

See also
Z3_del_literals
Z3_get_num_literals
Z3_get_label_symbol
Z3_get_literal
Deprecated:
This procedure is based on the old Solver API.
Z3_lbool Z3_API Z3_get_implied_equalities ( Z3_context  c,
Z3_solver  s,
unsigned  num_terms,
Z3_ast const  terms[],
unsigned  class_ids[] 
)

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.

See also
Z3_check_and_get_model
Z3_check
Deprecated:
To be moved outside of API.
unsigned Z3_API Z3_get_index_value ( Z3_context  c,
Z3_ast  a 
)

Return index of de-Brujin bound variable.

Precondition
Z3_get_ast_kind(a) == Z3_VAR_AST

Referenced by z3py::get_var_index().

Z3_ast_vector Z3_API Z3_get_interpolant ( Z3_context  c,
Z3_ast  pf,
Z3_ast  pat,
Z3_params  p 
)

Compute an interpolant from a refutation. This takes a proof of "false" from a set of formulas C, and an interpolation pattern. The pattern pat is a formula combining the formulas in C using logical conjunction and the "interp" operator (see Z3_mk_interpolant). This interp operator is logically the identity operator. It marks the sub-formulas of the pattern for which interpolants should be computed. The interpolant is a map sigma from marked subformulas to formulas, such that, for each marked subformula phi of pat (where phi sigma is phi with sigma(psi) substituted for each subformula psi of phi such that psi in dom(sigma)):

1) phi sigma implies sigma(phi), and

2) sigma(phi) is in the common uninterpreted vocabulary between the formulas of C occurring in phi and those not occurring in phi

and moreover pat sigma implies false. In the simplest case an interpolant for the pattern "(and (interp A) B)" maps A to an interpolant for A /\ B.

The return value is a vector of formulas representing sigma. The vector contains sigma(phi) for each marked subformula of pat, in pre-order traversal. This means that subformulas of phi occur before phi in the vector. Also, subformulas that occur multiply in pat will occur multiply in the result vector.

In particular, calling Z3_get_interpolant on a pattern of the form (interp ... (interp (and (interp A_1) A_2)) ... A_N) will result in a sequence interpolant for A_1, A_2,... A_N.

Neglecting interp markers, the pattern must be a conjunction of formulas in C, the set of premises of the proof. Otherwise an error is flagged.

Any premises of the proof not present in the pattern are treated as "background theory". Predicate and function symbols occurring in the background theory are treated as interpreted and thus always allowed in the interpolant.

Interpolant may not necessarily be computable from all proofs. To be sure an interpolant can be computed, the proof must be generated by an SMT solver for which interpoaltion is supported, and the premises must be expressed using only theories and operators for which interpolation is supported.

Currently, the only SMT solver that is supported is the legacy SMT solver. Such a solver is available as the default solver in #Z3_context objects produced by Z3_mk_interpolation_context. Currently, the theories supported are equality with uninterpreted functions, linear integer arithmetic, and the theory of arrays (in SMT-LIB terms, this is AUFLIA). Quantifiers are allowed. Use of any other operators (including "labels") may result in failure to compute an interpolant from a proof.

Parameters:

Parameters
clogical context.
pfa refutation from premises (assertions) C
patan interpolation pattern over C
pparameters
Z3_symbol Z3_API Z3_get_label_symbol ( Z3_context  c,
Z3_literals  lbls,
unsigned  idx 
)

Retrieve label symbol at idx.

Deprecated:
This procedure is based on the old Solver API.
Z3_ast Z3_API Z3_get_literal ( Z3_context  c,
Z3_literals  lbls,
unsigned  idx 
)

Retrieve literal expression at idx.

Deprecated:
This procedure is based on the old Solver API.
Z3_func_decl Z3_API Z3_get_model_constant ( Z3_context  c,
Z3_model  m,
unsigned  i 
)

Return the i-th constant in the given model.

Precondition
i < Z3_get_model_num_constants(c, m)
Deprecated:
use Z3_model_get_const_decl
Z3_func_decl Z3_API Z3_get_model_func_decl ( Z3_context  c,
Z3_model  m,
unsigned  i 
)

Return the declaration of the i-th function in the given model.

Precondition
i < Z3_get_model_num_funcs(c, m)
See also
Z3_get_model_num_funcs
Deprecated:
use Z3_model_get_func_decl
Z3_ast Z3_API Z3_get_model_func_else ( Z3_context  c,
Z3_model  m,
unsigned  i 
)

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.

Precondition
i < Z3_get_model_num_funcs(c, m)
See also
Z3_get_model_num_funcs
Z3_get_model_func_num_entries
Z3_get_model_func_entry_num_args
Z3_get_model_func_entry_arg
Deprecated:
Use Z3_func_interp objects
Z3_ast Z3_API Z3_get_model_func_entry_arg ( Z3_context  c,
Z3_model  m,
unsigned  i,
unsigned  j,
unsigned  k 
)

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. That is: it has the following format f(args[0],...,args[num_args - 1]) = val.

Precondition
i < Z3_get_model_num_funcs(c, m)
j < Z3_get_model_func_num_entries(c, m, i)
k < Z3_get_model_func_entry_num_args(c, m, i, j)
See also
Z3_get_model_num_funcs
Z3_get_model_func_num_entries
Z3_get_model_func_entry_num_args
Deprecated:
Use Z3_func_interp objects
unsigned Z3_API Z3_get_model_func_entry_num_args ( Z3_context  c,
Z3_model  m,
unsigned  i,
unsigned  j 
)

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. That is: it has the following format f(args[0],...,args[num_args - 1]) = val.

Precondition
i < Z3_get_model_num_funcs(c, m)
j < Z3_get_model_func_num_entries(c, m, i)
See also
Z3_get_model_num_funcs
Z3_get_model_func_num_entries
Z3_get_model_func_entry_arg
Deprecated:
Use Z3_func_interp objects
Z3_ast Z3_API Z3_get_model_func_entry_value ( Z3_context  c,
Z3_model  m,
unsigned  i,
unsigned  j 
)

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. That is: it has the following format f(args[0],...,args[num_args - 1]) = val.

Precondition
i < Z3_get_model_num_funcs(c, m)
j < Z3_get_model_func_num_entries(c, m, i)
See also
Z3_get_model_num_funcs
Z3_get_model_func_num_entries
Deprecated:
Use Z3_func_interp objects
unsigned Z3_API Z3_get_model_func_num_entries ( Z3_context  c,
Z3_model  m,
unsigned  i 
)

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.

Precondition
i < Z3_get_model_num_funcs(c, m)
See also
Z3_get_model_num_funcs
Z3_get_model_func_else
Z3_get_model_func_entry_num_args
Z3_get_model_func_entry_arg
Deprecated:
Use Z3_func_interp objects
unsigned Z3_API Z3_get_model_num_constants ( Z3_context  c,
Z3_model  m 
)

Return the number of constants assigned by the given model.

See also
Z3_get_model_constant
Deprecated:
use Z3_model_get_num_consts
unsigned Z3_API Z3_get_model_num_funcs ( Z3_context  c,
Z3_model  m 
)

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
unsigned Z3_API Z3_get_num_literals ( Z3_context  c,
Z3_literals  lbls 
)

Retrieve the number of label symbols that were returned.

See also
Z3_get_relevant_labels
Deprecated:
This procedure is based on the old Solver API.
unsigned Z3_API Z3_get_num_probes ( Z3_context  c)

Return the number of builtin probes available in Z3.

Referenced by z3py::probes().

unsigned Z3_API Z3_get_num_scopes ( Z3_context  c)

Retrieve the current scope level.

It retrieves the number of scopes that have been pushed, but not yet popped.

See also
Z3_push
Z3_pop
Deprecated:
Subsumed by Z3_solver_get_num_scopes.
unsigned Z3_API Z3_get_num_tactics ( Z3_context  c)

Return the number of builtin tactics available in Z3.

Referenced by z3py::tactics().

Z3_string Z3_API Z3_get_numeral_decimal_string ( Z3_context  c,
Z3_ast  a,
unsigned  precision 
)

Return numeral as a string in decimal notation. The result has at most precision decimal places.

Precondition
Z3_get_ast_kind(c, a) == Z3_NUMERAL_AST || Z3_is_algebraic_number(c, a)
Z3_bool Z3_API Z3_get_numeral_int ( Z3_context  c,
Z3_ast  v,
int *  i 
)

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.

Precondition
Z3_get_ast_kind(c, v) == Z3_NUMERAL_AST
See also
Z3_get_numeral_string
Z3_bool Z3_API Z3_get_numeral_int64 ( Z3_context  c,
Z3_ast  v,
__int64 i 
)

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.

Precondition
Z3_get_ast_kind(c, v) == Z3_NUMERAL_AST
See also
Z3_get_numeral_string
Z3_bool Z3_API Z3_get_numeral_rational_int64 ( Z3_context  c,
Z3_ast  v,
__int64 num,
__int64 den 
)

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.

Precondition
Z3_get_ast_kind(c, v) == Z3_NUMERAL_AST
See also
Z3_get_numeral_string
Z3_bool Z3_API Z3_get_numeral_small ( Z3_context  c,
Z3_ast  a,
__int64 num,
__int64 den 
)

Return numeral value, as a pair of 64 bit numbers if the representation fits.

Parameters
clogical context.
aterm.
numnumerator.
dendenominator.

Return Z3_TRUE if the numeral value fits in 64 bit numerals, Z3_FALSE otherwise.

Precondition
Z3_get_ast_kind(a) == Z3_NUMERAL_AST
Z3_string Z3_API Z3_get_numeral_string ( Z3_context  c,
Z3_ast  a 
)

Return numeral value, as a string of a numeric constant term.

Precondition
Z3_get_ast_kind(c, a) == Z3_NUMERAL_AST
Z3_bool Z3_API Z3_get_numeral_uint ( Z3_context  c,
Z3_ast  v,
unsigned *  u 
)

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.

Precondition
Z3_get_ast_kind(c, v) == Z3_NUMERAL_AST
See also
Z3_get_numeral_string
Z3_bool Z3_API Z3_get_numeral_uint64 ( Z3_context  c,
Z3_ast  v,
unsigned __int64 u 
)

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.

Precondition
Z3_get_ast_kind(c, v) == Z3_NUMERAL_AST
See also
Z3_get_numeral_string
Z3_ast Z3_API Z3_get_numerator ( Z3_context  c,
Z3_ast  a 
)

Return the numerator (as a numeral AST) of a numeral AST of sort Real.

Precondition
Z3_get_ast_kind(c, a) == Z3_NUMERAL_AST
Z3_ast Z3_API Z3_get_pattern ( Z3_context  c,
Z3_pattern  p,
unsigned  idx 
)

Return i'th ast in pattern.

unsigned Z3_API Z3_get_pattern_num_terms ( Z3_context  c,
Z3_pattern  p 
)

Return number of terms in pattern.

Z3_string Z3_API Z3_get_probe_name ( Z3_context  c,
unsigned  i 
)

Return the name of the i probe.

Precondition
i < Z3_get_num_probes(c)

Referenced by z3py::probes().

Z3_ast Z3_API Z3_get_quantifier_body ( Z3_context  c,
Z3_ast  a 
)

Return body of quantifier.

Precondition
Z3_get_ast_kind(a) == Z3_QUANTIFIER_AST

Referenced by expr::body().

Z3_symbol Z3_API Z3_get_quantifier_bound_name ( Z3_context  c,
Z3_ast  a,
unsigned  i 
)

Return symbol of the i'th bound variable.

Precondition
Z3_get_ast_kind(a) == Z3_QUANTIFIER_AST
Z3_sort Z3_API Z3_get_quantifier_bound_sort ( Z3_context  c,
Z3_ast  a,
unsigned  i 
)

Return sort of the i'th bound variable.

Precondition
Z3_get_ast_kind(a) == Z3_QUANTIFIER_AST
Z3_ast Z3_API Z3_get_quantifier_no_pattern_ast ( Z3_context  c,
Z3_ast  a,
unsigned  i 
)

Return i'th no_pattern.

Precondition
Z3_get_ast_kind(a) == Z3_QUANTIFIER_AST
unsigned Z3_API Z3_get_quantifier_num_bound ( Z3_context  c,
Z3_ast  a 
)

Return number of bound variables of quantifier.

Precondition
Z3_get_ast_kind(a) == Z3_QUANTIFIER_AST
unsigned Z3_API Z3_get_quantifier_num_no_patterns ( Z3_context  c,
Z3_ast  a 
)

Return number of no_patterns used in quantifier.

Precondition
Z3_get_ast_kind(a) == Z3_QUANTIFIER_AST
unsigned Z3_API Z3_get_quantifier_num_patterns ( Z3_context  c,
Z3_ast  a 
)

Return number of patterns used in quantifier.

Precondition
Z3_get_ast_kind(a) == Z3_QUANTIFIER_AST
Z3_pattern Z3_API Z3_get_quantifier_pattern_ast ( Z3_context  c,
Z3_ast  a,
unsigned  i 
)

Return i'th pattern.

Precondition
Z3_get_ast_kind(a) == Z3_QUANTIFIER_AST
unsigned Z3_API Z3_get_quantifier_weight ( Z3_context  c,
Z3_ast  a 
)

Obtain weight of quantifier.

Precondition
Z3_get_ast_kind(a) == Z3_QUANTIFIER_AST
Z3_sort Z3_API Z3_get_range ( Z3_context  c,
Z3_func_decl  d 
)

Return the range of the given declaration.

If d is a constant (i.e., has zero arguments), then this function returns the sort of the constant.

Referenced by func_decl::range(), and FuncDeclRef::range().

unsigned Z3_API Z3_get_relation_arity ( Z3_context  c,
Z3_sort  s 
)

Return arity of relation.

Precondition
Z3_get_sort_kind(s) == Z3_RELATION_SORT
See also
Z3_get_relation_column
Z3_sort Z3_API Z3_get_relation_column ( Z3_context  c,
Z3_sort  s,
unsigned  col 
)

Return sort at i'th column of relation sort.

Precondition
Z3_get_sort_kind(c, s) == Z3_RELATION_SORT
col < Z3_get_relation_arity(c, s)
See also
Z3_get_relation_arity
Z3_literals Z3_API Z3_get_relevant_labels ( Z3_context  c)

Retrieve the set of labels that were relevant in the context of the current satisfied context.

See also
Z3_del_literals
Z3_get_num_literals
Z3_get_label_symbol
Z3_get_literal
Deprecated:
This procedure is based on the old Solver API.
Z3_literals Z3_API Z3_get_relevant_literals ( Z3_context  c)

Retrieve the set of literals that satisfy the current context.

See also
Z3_del_literals
Z3_get_num_literals
Z3_get_label_symbol
Z3_get_literal
Deprecated:
This procedure is based on the old Solver API.
Z3_search_failure Z3_API Z3_get_search_failure ( Z3_context  c)

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
Z3_ast Z3_API Z3_get_smtlib_assumption ( Z3_context  c,
unsigned  i 
)

Return the i-th assumption parsed by the last call to Z3_parse_smtlib_string or Z3_parse_smtlib_file.

Precondition
i < Z3_get_smtlib_num_assumptions(c)
Z3_func_decl Z3_API Z3_get_smtlib_decl ( Z3_context  c,
unsigned  i 
)

Return the i-th declaration parsed by the last call to Z3_parse_smtlib_string or Z3_parse_smtlib_file.

Precondition
i < Z3_get_smtlib_num_decls(c)
BEGIN_MLAPI_EXCLUDE Z3_string Z3_API Z3_get_smtlib_error ( Z3_context  c)

Retrieve that last error message information generated from parsing.

Z3_ast Z3_API Z3_get_smtlib_formula ( Z3_context  c,
unsigned  i 
)

Return the i-th formula parsed by the last call to Z3_parse_smtlib_string or Z3_parse_smtlib_file.

Precondition
i < Z3_get_smtlib_num_formulas(c)
unsigned Z3_API Z3_get_smtlib_num_assumptions ( Z3_context  c)

Return the number of SMTLIB assumptions parsed by Z3_parse_smtlib_string or Z3_parse_smtlib_file.

unsigned Z3_API Z3_get_smtlib_num_decls ( Z3_context  c)

Return the number of declarations parsed by Z3_parse_smtlib_string or Z3_parse_smtlib_file.

unsigned Z3_API Z3_get_smtlib_num_formulas ( Z3_context  c)

Return the number of SMTLIB formulas parsed by the last call to Z3_parse_smtlib_string or Z3_parse_smtlib_file.

unsigned Z3_API Z3_get_smtlib_num_sorts ( Z3_context  c)

Return the number of sorts parsed by Z3_parse_smtlib_string or Z3_parse_smtlib_file.

Z3_sort Z3_API Z3_get_smtlib_sort ( Z3_context  c,
unsigned  i 
)

Return the i-th sort parsed by the last call to Z3_parse_smtlib_string or Z3_parse_smtlib_file.

Precondition
i < Z3_get_smtlib_num_sorts(c)
Z3_sort Z3_API Z3_get_sort ( Z3_context  c,
Z3_ast  a 
)

Return the sort of an AST node.

The AST node must be a constant, application, numeral, bound variable, or quantifier.

Referenced by ExprRef::children(), expr::get_sort(), z3py::is_sort(), and BoolRef::sort().

unsigned Z3_API Z3_get_sort_id ( Z3_context  c,
Z3_sort  s 
)

Return a unique identifier for s.

Z3_sort_kind Z3_API Z3_get_sort_kind ( Z3_context  c,
Z3_sort  t 
)

Return the sort kind (e.g., array, tuple, int, bool, etc).

See also
Z3_sort_kind

Referenced by ExprRef::children(), z3py::eq(), and sort::sort_kind().

Z3_symbol Z3_API Z3_get_sort_name ( Z3_context  c,
Z3_sort  d 
)

Return the sort name as a symbol.

Referenced by SortRef::name().

int Z3_API Z3_get_symbol_int ( Z3_context  c,
Z3_symbol  s 
)

Return the symbol int value.

Precondition
Z3_get_symbol_kind(s) == Z3_INT_SYMBOL
See also
Z3_mk_int_symbol

Referenced by symbol::to_int(), and z3py::to_symbol().

Z3_symbol_kind Z3_API Z3_get_symbol_kind ( Z3_context  c,
Z3_symbol  s 
)

Return Z3_INT_SYMBOL if the symbol was constructed using Z3_mk_int_symbol, and Z3_STRING_SYMBOL if the symbol was constructed using Z3_mk_string_symbol.

Referenced by symbol::kind(), and z3py::to_symbol().

Z3_string Z3_API Z3_get_symbol_string ( Z3_context  c,
Z3_symbol  s 
)

Return the symbol name.

Precondition
Z3_get_symbol_string(s) == Z3_STRING_SYMBOL
Warning
The returned buffer is statically allocated by Z3. It will be automatically deallocated when Z3_del_context is invoked. So, the buffer is invalidated in the next call to Z3_get_symbol_string.
See also
Z3_mk_string_symbol

Referenced by symbol::str(), and z3py::to_symbol().

Z3_string Z3_API Z3_get_tactic_name ( Z3_context  c,
unsigned  i 
)

Return the name of the idx tactic.

Precondition
i < Z3_get_num_tactics(c)

Referenced by z3py::tactics().

Z3_func_decl Z3_API Z3_get_tuple_sort_field_decl ( Z3_context  c,
Z3_sort  t,
unsigned  i 
)

Return the i-th field declaration (i.e., projection function declaration) of the given tuple sort.

Precondition
Z3_get_sort_kind(t) == Z3_DATATYPE_SORT
i < Z3_get_tuple_sort_num_fields(c, t)
See also
Z3_mk_tuple_sort
Z3_get_sort_kind
Z3_func_decl Z3_API Z3_get_tuple_sort_mk_decl ( Z3_context  c,
Z3_sort  t 
)

Return the constructor declaration of the given tuple sort.

Precondition
Z3_get_sort_kind(c, t) == Z3_DATATYPE_SORT
See also
Z3_mk_tuple_sort
Z3_get_sort_kind
unsigned Z3_API Z3_get_tuple_sort_num_fields ( Z3_context  c,
Z3_sort  t 
)

Return the number of fields of the given tuple sort.

Precondition
Z3_get_sort_kind(c, t) == Z3_DATATYPE_SORT
See also
Z3_mk_tuple_sort
Z3_get_sort_kind
void Z3_API Z3_get_version ( unsigned *  major,
unsigned *  minor,
unsigned *  build_number,
unsigned *  revision_number 
)

Return Z3 version number information.

Referenced by z3py::get_version(), and z3py::get_version_string().

Z3_bool Z3_API Z3_global_param_get ( Z3_string  param_id,
Z3_string_ptr  param_value 
)

Get a global (or module) parameter.

Returns Z3_FALSE if the parameter value does not exist.

See also
Z3_global_param_set
Remarks
This function cannot be invoked simultaneously from different threads without synchronization. The result string stored in param_value is stored in shared location.

Referenced by z3py::get_param().

void Z3_API Z3_global_param_reset_all ( void  )

Restore the value of all global (and module) parameters. This command will not affect already created objects (such as tactics and solvers).

See also
Z3_global_param_set

Referenced by z3::reset_params(), and z3py::reset_params().

void Z3_API Z3_global_param_set ( Z3_string  param_id,
Z3_string  param_value 
)

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.

Referenced by z3::set_param(), and z3py::set_param().

void Z3_API Z3_goal_assert ( Z3_context  c,
Z3_goal  g,
Z3_ast  a 
)

Add a new formula a to the given goal.

Referenced by goal::add().

void Z3_API Z3_goal_dec_ref ( Z3_context  c,
Z3_goal  g 
)

Decrement the reference counter of the given goal.

Referenced by goal::operator=(), and goal::~goal().

unsigned Z3_API Z3_goal_depth ( Z3_context  c,
Z3_goal  g 
)

Return the depth of the given goal. It tracks how many transformations were applied to it.

Referenced by goal::depth().

Z3_ast Z3_API Z3_goal_formula ( Z3_context  c,
Z3_goal  g,
unsigned  idx 
)

Return a formula from the given goal.

Precondition
idx < Z3_goal_size(c, g)

Referenced by goal::operator[]().

void Z3_API Z3_goal_inc_ref ( Z3_context  c,
Z3_goal  g 
)

Increment the reference counter of the given goal.

Referenced by goal::operator=().

Z3_bool Z3_API Z3_goal_inconsistent ( Z3_context  c,
Z3_goal  g 
)

Return true if the given goal contains the formula false.

Referenced by goal::inconsistent().

Z3_bool Z3_API Z3_goal_is_decided_sat ( Z3_context  c,
Z3_goal  g 
)

Return true if the goal is empty, and it is precise or the product of a under approximation.

Referenced by goal::is_decided_sat().

Z3_bool Z3_API Z3_goal_is_decided_unsat ( Z3_context  c,
Z3_goal  g 
)

Return true if the goal contains false, and it is precise or the product of an over approximation.

Referenced by goal::is_decided_unsat().

unsigned Z3_API Z3_goal_num_exprs ( Z3_context  c,
Z3_goal  g 
)

Return the number of formulas, subformulas and terms in the given goal.

Referenced by goal::num_exprs().

Z3_goal_prec Z3_API Z3_goal_precision ( Z3_context  c,
Z3_goal  g 
)

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.

Referenced by goal::precision().

void Z3_API Z3_goal_reset ( Z3_context  c,
Z3_goal  g 
)

Erase all formulas from the given goal.

Referenced by goal::reset().

unsigned Z3_API Z3_goal_size ( Z3_context  c,
Z3_goal  g 
)

Return the number of formulas in the given goal.

Referenced by goal::size().

Z3_string Z3_API Z3_goal_to_string ( Z3_context  c,
Z3_goal  g 
)

Convert a goal into a string.

Z3_goal Z3_API Z3_goal_translate ( Z3_context  source,
Z3_goal  g,
Z3_context  target 
)

Copy a goal g from the context source to a the context target.

void Z3_API Z3_inc_ref ( Z3_context  c,
Z3_ast  a 
)

Increment the reference counter of the given AST. The context c should have been created using Z3_mk_context_rc. This function is a NOOP if c was created using Z3_mk_context.

Referenced by ast::ast(), and ast::operator=().

Z3_string Z3_API Z3_interpolation_profile ( Z3_context  ctx)

Return a string summarizing cumulative time used for interpolation. This string is purely for entertainment purposes and has no semantics.

Parameters
ctxThe context (currently ignored)
void Z3_API Z3_interrupt ( Z3_context  c)

Interrupt the execution of a Z3 procedure. This procedure can be used to interrupt: solvers, simplifiers and tactics.

Referenced by context::interrupt(), and Context::interrupt().

Z3_bool Z3_API Z3_is_algebraic_number ( Z3_context  c,
Z3_ast  a 
)

Return true if the give AST is a real algebraic number.

Z3_bool Z3_API Z3_is_app ( Z3_context  c,
Z3_ast  a 
)
Z3_bool Z3_API Z3_is_array_value ( Z3_context  c,
Z3_model  m,
Z3_ast  v,
unsigned *  num_entries 
)

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
Z3_bool Z3_API Z3_is_as_array ( Z3_context  c,
Z3_ast  a 
)

The (_ as-array f) AST node is a construct for assigning interpretations for arrays in Z3. It is the array such that forall indices i we have that (select (_ as-array f) i) is equal to (f i). This procedure returns Z3_TRUE if the a is an as-array AST node.

Z3 current solvers have minimal support for as_array nodes.

See also
Z3_get_as_array_func_decl
Z3_bool Z3_API Z3_is_eq_ast ( Z3_context  c,
Z3_ast  t1,
Z3_ast  t2 
)

compare terms.

Referenced by AstRef::eq(), and z3::eq().

Z3_bool Z3_API Z3_is_eq_func_decl ( Z3_context  c,
Z3_func_decl  f1,
Z3_func_decl  f2 
)

compare terms.

Z3_bool Z3_API Z3_is_eq_sort ( Z3_context  c,
Z3_sort  s1,
Z3_sort  s2 
)

compare sorts.

Referenced by SortRef::__eq__(), and SortRef::__ne__().

Z3_bool Z3_API Z3_is_numeral_ast ( Z3_context  c,
Z3_ast  a 
)
Z3_bool Z3_API Z3_is_quantifier_forall ( Z3_context  c,
Z3_ast  a 
)

Determine if quantifier is universal.

Precondition
Z3_get_ast_kind(a) == Z3_QUANTIFIER_AST
Z3_bool Z3_API Z3_is_well_sorted ( Z3_context  c,
Z3_ast  t 
)

Return true if the given expression t is well sorted.

Referenced by expr::is_well_sorted().

Z3_ast Z3_API Z3_mk_add ( Z3_context  c,
unsigned  num_args,
Z3_ast const  args[] 
)

Create an AST node representing args[0] + ... + args[num_args-1].The array args must have num_args elements. All arguments must have int or real sort.

Remarks
The number of arguments must be greater than zero.

Referenced by z3py::Sum().

Z3_ast Z3_API Z3_mk_and ( Z3_context  c,
unsigned  num_args,
Z3_ast const  args[] 
)

Create an AST node representing args[0] and ... and args[num_args-1].The array args must have num_args elements. All arguments must have Boolean sort.

Remarks
The number of arguments must be greater than zero.

Referenced by goal::as_expr().

Z3_ast Z3_API Z3_mk_app ( Z3_context  c,
Z3_func_decl  d,
unsigned  num_args,
Z3_ast const  args[] 
)

Create a constant or function application.

See also
Z3_mk_func_decl

Referenced by FuncDeclRef::__call__(), and func_decl::operator()().

Z3_ast Z3_API Z3_mk_array_default ( Z3_context  c,
Z3_ast  array 
)

Access the array default value. Produces the default range value, for arrays that can be represented as finite maps with a default range value.

Parameters
clogical context.
arrayarray value whose default range value is accessed.
Z3_sort Z3_API Z3_mk_array_sort ( Z3_context  c,
Z3_sort  domain,
Z3_sort  range 
)

Create an array type.

We usually represent the array type as: [domain -> range]. Arrays are usually used to model the heap/memory in software verification.

See also
Z3_mk_select
Z3_mk_store

Referenced by context::array_sort().

Z3_ast_map Z3_API Z3_mk_ast_map ( Z3_context  c)

Return an empty mapping from AST to AST.

Remarks
Reference counting must be used to manage AST maps, even when the Z3_context was created using Z3_mk_context instead of Z3_mk_context_rc.
Z3_ast_vector Z3_API Z3_mk_ast_vector ( Z3_context  c)

Return an empty AST vector.

Remarks
Reference counting must be used to manage AST vectors, even when the Z3_context was created using Z3_mk_context instead of Z3_mk_context_rc.

Referenced by ast_vector_tpl< T >::ast_vector_tpl().

Z3_ast Z3_API Z3_mk_atmost ( Z3_context  c,
unsigned  num_args,
Z3_ast const  args[],
unsigned  k 
)

Pseudo-Boolean relations.

Encode p1 + p2 + ... + pn <= k

Z3_sort Z3_API Z3_mk_bool_sort ( Z3_context  c)

Create the Boolean type.

This type is used to create propositional variables and predicates.

Referenced by context::bool_sort().

Z3_ast Z3_API Z3_mk_bound ( Z3_context  c,
unsigned  index,
Z3_sort  ty 
)

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.

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))

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.

Parameters
clogical context
indexde-Bruijn index
tysort of the bound variable
See also
Z3_mk_forall
Z3_mk_exists

Referenced by z3py::Var().

Z3_ast Z3_API Z3_mk_bv2int ( Z3_context  c,
Z3_ast  t1,
Z3_bool  is_signed 
)

Create an integer from the bit-vector argument t1. If is_signed is false, then the bit-vector t1 is treated as unsigned. So the result is non-negative and in the range [0..2^N-1], where N are the number of bits in t1. If is_signed is true, t1 is treated as a signed bit-vector.

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 t1 must have a bit-vector sort.

Z3_sort Z3_API Z3_mk_bv_sort ( Z3_context  c,
unsigned  sz 
)

Create a bit-vector type of the given size.

This type can also be seen as a machine integer.

Remarks
The size of the bitvector type must be greater than zero.

Referenced by context::bv_sort().

Z3_ast Z3_API Z3_mk_bvadd ( Z3_context  c,
Z3_ast  t1,
Z3_ast  t2 
)

Standard two's complement addition.

The nodes t1 and t2 must have the same bit-vector sort.

Z3_ast Z3_API Z3_mk_bvadd_no_overflow ( Z3_context  c,
Z3_ast  t1,
Z3_ast  t2,
Z3_bool  is_signed 
)

Create a predicate that checks that the bit-wise addition of t1 and t2 does not overflow.

The nodes t1 and t2 must have the same bit-vector sort.

Z3_ast Z3_API Z3_mk_bvadd_no_underflow ( Z3_context  c,
Z3_ast  t1,
Z3_ast  t2 
)

Create a predicate that checks that the bit-wise signed addition of t1 and t2 does not underflow.

The nodes t1 and t2 must have the same bit-vector sort.

Z3_ast Z3_API Z3_mk_bvand ( Z3_context  c,
Z3_ast  t1,
Z3_ast  t2 
)

Bitwise and.

The nodes t1 and t2 must have the same bit-vector sort.

Z3_ast Z3_API Z3_mk_bvashr ( Z3_context  c,
Z3_ast  t1,
Z3_ast  t2 
)

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 t1 and t2 must have the same bit-vector sort.

Z3_ast Z3_API Z3_mk_bvlshr ( Z3_context  c,
Z3_ast  t1,
Z3_ast  t2 
)

Logical shift right.

It is equivalent to unsigned division by 2^x where 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 t1 and t2 must have the same bit-vector sort.

Z3_ast Z3_API Z3_mk_bvmul ( Z3_context  c,
Z3_ast  t1,
Z3_ast  t2 
)

Standard two's complement multiplication.

The nodes t1 and t2 must have the same bit-vector sort.

Z3_ast Z3_API Z3_mk_bvmul_no_overflow ( Z3_context  c,
Z3_ast  t1,
Z3_ast  t2,
Z3_bool  is_signed 
)

Create a predicate that checks that the bit-wise multiplication of t1 and t2 does not overflow.

The nodes t1 and t2 must have the same bit-vector sort.

Z3_ast Z3_API Z3_mk_bvmul_no_underflow ( Z3_context  c,
Z3_ast  t1,
Z3_ast  t2 
)

Create a predicate that checks that the bit-wise signed multiplication of t1 and t2 does not underflow.

The nodes t1 and t2 must have the same bit-vector sort.

Z3_ast Z3_API Z3_mk_bvnand ( Z3_context  c,
Z3_ast  t1,
Z3_ast  t2 
)

Bitwise nand.

The nodes t1 and t2 must have the same bit-vector sort.

Z3_ast Z3_API Z3_mk_bvneg ( Z3_context  c,
Z3_ast  t1 
)

Standard two's complement unary minus.

The node t1 must have bit-vector sort.

Z3_ast Z3_API Z3_mk_bvneg_no_overflow ( Z3_context  c,
Z3_ast  t1 
)

Check that bit-wise negation does not overflow when t1 is interpreted as a signed bit-vector.

The node t1 must have bit-vector sort.

Z3_ast Z3_API Z3_mk_bvnor ( Z3_context  c,
Z3_ast  t1,
Z3_ast  t2 
)

Bitwise nor.

The nodes t1 and t2 must have the same bit-vector sort.

Z3_ast Z3_API Z3_mk_bvnot ( Z3_context  c,
Z3_ast  t1 
)

Bitwise negation.

The node t1 must have a bit-vector sort.

Z3_ast Z3_API Z3_mk_bvor ( Z3_context  c,
Z3_ast  t1,
Z3_ast  t2 
)

Bitwise or.

The nodes t1 and t2 must have the same bit-vector sort.

Z3_ast Z3_API Z3_mk_bvredand ( Z3_context  c,
Z3_ast  t1 
)

Take conjunction of bits in vector, return vector of length 1.

The node t1 must have a bit-vector sort.

Z3_ast Z3_API Z3_mk_bvredor ( Z3_context  c,
Z3_ast  t1 
)

Take disjunction of bits in vector, return vector of length 1.

The node t1 must have a bit-vector sort.

Z3_ast Z3_API Z3_mk_bvsdiv ( Z3_context  c,
Z3_ast  t1,
Z3_ast  t2 
)

Two's complement signed division.

It is defined in the following way:

  • The floor of t1/t2 if t2 is different from zero, and t1*t2 >= 0.
  • The ceiling of t1/t2 if t2 is different from zero, and t1*t2 < 0.

If t2 is zero, then the result is undefined.

The nodes t1 and t2 must have the same bit-vector sort.

Z3_ast Z3_API Z3_mk_bvsdiv_no_overflow ( Z3_context  c,
Z3_ast  t1,
Z3_ast  t2 
)

Create a predicate that checks that the bit-wise signed division of t1 and t2 does not overflow.

The nodes t1 and t2 must have the same bit-vector sort.

Z3_ast Z3_API Z3_mk_bvsge ( Z3_context  c,
Z3_ast  t1,
Z3_ast  t2 
)

Two's complement signed greater than or equal to.

The nodes t1 and t2 must have the same bit-vector sort.

Z3_ast Z3_API Z3_mk_bvsgt ( Z3_context  c,
Z3_ast  t1,
Z3_ast  t2 
)

Two's complement signed greater than.

The nodes t1 and t2 must have the same bit-vector sort.

Z3_ast Z3_API Z3_mk_bvshl ( Z3_context  c,
Z3_ast  t1,
Z3_ast  t2 
)

Shift left.

It is equivalent to multiplication by 2^x where 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 t1 and t2 must have the same bit-vector sort.

Z3_ast Z3_API Z3_mk_bvsle ( Z3_context  c,
Z3_ast  t1,
Z3_ast  t2 
)

Two's complement signed less than or equal to.

The nodes t1 and t2 must have the same bit-vector sort.

Z3_ast Z3_API Z3_mk_bvslt ( Z3_context  c,
Z3_ast  t1,
Z3_ast  t2 
)

Two's complement signed less than.

It abbreviates:

1 (or (and (= (extract[|m-1|:|m-1|] t1) bit1)
2  (= (extract[|m-1|:|m-1|] t2) bit0))
3  (and (= (extract[|m-1|:|m-1|] t1) (extract[|m-1|:|m-1|] t2))
4  (bvult t1 t2)))

The nodes t1 and t2 must have the same bit-vector sort.

Z3_ast Z3_API Z3_mk_bvsmod ( Z3_context  c,
Z3_ast  t1,
Z3_ast  t2 
)

Two's complement signed remainder (sign follows divisor).

If t2 is zero, then the result is undefined.

The nodes t1 and t2 must have the same bit-vector sort.

See also
Z3_mk_bvsrem
Z3_ast Z3_API Z3_mk_bvsrem ( Z3_context  c,
Z3_ast  t1,
Z3_ast  t2 
)

Two's complement signed remainder (sign follows dividend).

It is defined as t1 - (t1 /s t2) * t2, where /s represents signed division. The most significant bit (sign) of the result is equal to the most significant bit of t1.

If t2 is zero, then the result is undefined.

The nodes t1 and t2 must have the same bit-vector sort.

See also
Z3_mk_bvsmod
Z3_ast Z3_API Z3_mk_bvsub ( Z3_context  c,
Z3_ast  t1,
Z3_ast  t2 
)

Standard two's complement subtraction.

The nodes t1 and t2 must have the same bit-vector sort.

Z3_ast Z3_API Z3_mk_bvsub_no_overflow ( Z3_context  c,
Z3_ast  t1,
Z3_ast  t2 
)

Create a predicate that checks that the bit-wise signed subtraction of t1 and t2 does not overflow.

The nodes t1 and t2 must have the same bit-vector sort.

Z3_ast Z3_API Z3_mk_bvsub_no_underflow ( Z3_context  c,
Z3_ast  t1,
Z3_ast  t2,
Z3_bool  is_signed 
)

Create a predicate that checks that the bit-wise subtraction of t1 and t2 does not underflow.

The nodes t1 and t2 must have the same bit-vector sort.

Z3_ast Z3_API Z3_mk_bvudiv ( Z3_context  c,
Z3_ast  t1,
Z3_ast  t2 
)

Unsigned division.

It is defined as the floor of t1/t2 if t2 is different from zero. If t2 is zero, then the result is undefined.

The nodes t1 and t2 must have the same bit-vector sort.

Referenced by z3::udiv().

Z3_ast Z3_API Z3_mk_bvuge ( Z3_context  c,
Z3_ast  t1,
Z3_ast  t2 
)

Unsigned greater than or equal to.

The nodes t1 and t2 must have the same bit-vector sort.

Referenced by z3::uge().

Z3_ast Z3_API Z3_mk_bvugt ( Z3_context  c,
Z3_ast  t1,
Z3_ast  t2 
)

Unsigned greater than.

The nodes t1 and t2 must have the same bit-vector sort.

Referenced by z3::ugt().

Z3_ast Z3_API Z3_mk_bvule ( Z3_context  c,
Z3_ast  t1,
Z3_ast  t2 
)

Unsigned less than or equal to.

The nodes t1 and t2 must have the same bit-vector sort.

Referenced by z3::ule().

Z3_ast Z3_API Z3_mk_bvult ( Z3_context  c,
Z3_ast  t1,
Z3_ast  t2 
)

Unsigned less than.

The nodes t1 and t2 must have the same bit-vector sort.

Referenced by z3::ult().

Z3_ast Z3_API Z3_mk_bvurem ( Z3_context  c,
Z3_ast  t1,
Z3_ast  t2 
)

Unsigned remainder.

It is defined as t1 - (t1 /u t2) * t2, where /u represents unsigned division.

If t2 is zero, then the result is undefined.

The nodes t1 and t2 must have the same bit-vector sort.

Z3_ast Z3_API Z3_mk_bvxnor ( Z3_context  c,
Z3_ast  t1,
Z3_ast  t2 
)

Bitwise xnor.

The nodes t1 and t2 must have the same bit-vector sort.

Z3_ast Z3_API Z3_mk_bvxor ( Z3_context  c,
Z3_ast  t1,
Z3_ast  t2 
)

Bitwise exclusive-or.

The nodes t1 and t2 must have the same bit-vector sort.

Z3_ast Z3_API Z3_mk_concat ( Z3_context  c,
Z3_ast  t1,
Z3_ast  t2 
)

Concatenate the given bit-vectors.

The nodes t1 and t2 must have (possibly different) bit-vector sorts

The result is a bit-vector of size n1+n2, where n1 (n2) is the size of t1 (t2).

Referenced by z3::concat().

Z3_config Z3_API Z3_mk_config ( void  )

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:

Z3_set_param_value(cfg, "proof", "true")

Remarks
In previous versions of Z3, the Z3_config was used to store global and module configurations. Now, we should use 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
See also
Z3_set_param_value
Z3_del_config

Referenced by Context::__init__(), and config::config().

Z3_ast Z3_API Z3_mk_const ( Z3_context  c,
Z3_symbol  s,
Z3_sort  ty 
)

Declare and create a constant.

This function is a shorthand for:

1 \conly Z3_func_decl d = Z3_mk_func_decl(c, s, 0, 0, ty);
2 \conly Z3_ast n = Z3_mk_app(c, d, 0, 0);
3 \conly
See also
Z3_mk_func_decl
Z3_mk_app

Referenced by z3py::Const(), and context::constant().

Z3_ast Z3_API Z3_mk_const_array ( Z3_context  c,
Z3_sort  domain,
Z3_ast  v 
)

Create the constant array.

The resulting term is an array, such that a select on an arbitrary index produces the value v.

Parameters
clogical context.
domaindomain sort for the array.
vvalue that the array maps to.

Referenced by z3::const_array().

BEGIN_MLAPI_EXCLUDE Z3_constructor Z3_API Z3_mk_constructor ( Z3_context  c,
Z3_symbol  name,
Z3_symbol  recognizer,
unsigned  num_fields,
Z3_symbol const  field_names[],
Z3_sort_opt const  sorts[],
unsigned  sort_refs[] 
)

Create a constructor.

Parameters
clogical context.
nameconstructor name.
recognizername of recognizer function.
num_fieldsnumber of fields in constructor.
field_namesnames of the constructor fields.
sortsfield sorts, 0 if the field sort refers to a recursive sort.
sort_refsreference to datatype sort that is an argument to the constructor; if the corresponding sort reference is 0, then the value in sort_refs should be an index referring to one of the recursive datatypes that is declared.
Z3_constructor_list Z3_API Z3_mk_constructor_list ( Z3_context  c,
unsigned  num_constructors,
Z3_constructor const  constructors[] 
)

Create list of constructors.

Parameters
clogical context.
num_constructorsnumber of constructors in list.
constructorslist of constructors.
Z3_context Z3_API Z3_mk_context ( Z3_config  c)

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 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.

See also
Z3_del_context
Deprecated:
Use Z3_mk_context_rc
Z3_context Z3_API Z3_mk_context_rc ( Z3_config  c)

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 Z3_context.

Z3_sort Z3_API Z3_mk_datatype ( Z3_context  c,
Z3_symbol  name,
unsigned  num_constructors,
Z3_constructor  constructors[] 
)

Create datatype, such as lists, trees, records, enumerations or unions of records. The datatype may be recursive. Return the datatype sort.

Parameters
clogical context.
namename of datatype.
num_constructorsnumber of constructors passed in.
constructorsarray of constructor containers.
void Z3_API Z3_mk_datatypes ( Z3_context  c,
unsigned  num_sorts,
Z3_symbol const  sort_names[],
Z3_sort  sorts[],
Z3_constructor_list  constructor_lists[] 
)

Create mutually recursive datatypes.

Parameters
clogical context.
num_sortsnumber of datatype sorts.
sort_namesnames of datatype sorts.
sortsarray of datatype sorts.
constructor_listslist of constructors, one list per sort.
Z3_ast Z3_API Z3_mk_distinct ( Z3_context  c,
unsigned  num_args,
Z3_ast const  args[] 
)

Create an AST node representing distinct(args[0], ..., args[num_args-1]).The distinct construct is used for declaring the arguments pairwise distinct. That is, Forall 0 <= i < j < num_args. not args[i] = args[j].

All arguments must have the same sort.

Remarks
The number of arguments of a distinct construct must be greater than one.

Referenced by ExprRef::__ne__(), z3::distinct(), and z3py::Distinct().

Z3_ast Z3_API Z3_mk_div ( Z3_context  c,
Z3_ast  arg1,
Z3_ast  arg2 
)

Create an AST node representing arg1 div arg2.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.

Z3_ast Z3_API Z3_mk_empty_set ( Z3_context  c,
Z3_sort  domain 
)

Create the empty set.

Z3_sort Z3_API Z3_mk_enumeration_sort ( Z3_context  c,
Z3_symbol  name,
unsigned  n,
Z3_symbol const  enum_names[],
Z3_func_decl  enum_consts[],
Z3_func_decl  enum_testers[] 
)

Create a enumeration sort.

An enumeration sort with n elements. This function will also declare the functions corresponding to the enumerations.

Parameters
clogical context
namename of the enumeration sort.
nnumber of elemenets in enumeration sort.
enum_namesnames of the enumerated elements.
enum_constsconstants corresponding to the enumerated elements.
enum_testerspredicates 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 s is a sort whose name is S, and the function returns three terms corresponding to A, B, C in enum_consts. The array enum_testers has three predicates of type (s -> Bool). The first predicate (corresponding to A) is true when applied to A, and false otherwise. Similarly for the other predicates.

Referenced by context::enumeration_sort().

Z3_ast Z3_API Z3_mk_eq ( Z3_context  c,
Z3_ast  l,
Z3_ast  r 
)

Create an AST node representing l = r.

The nodes l and r must have the same type.

Referenced by ExprRef::__eq__().

Z3_ast Z3_API Z3_mk_exists ( Z3_context  c,
unsigned  weight,
unsigned  num_patterns,
Z3_pattern const  patterns[],
unsigned  num_decls,
Z3_sort const  sorts[],
Z3_symbol const  decl_names[],
Z3_ast  body 
)

Create an exists formula. Similar to Z3_mk_forall.

See also
Z3_mk_pattern
Z3_mk_bound
Z3_mk_forall
Z3_mk_quantifier
Z3_ast Z3_API Z3_mk_exists_const ( Z3_context  c,
unsigned  weight,
unsigned  num_bound,
Z3_app const  bound[],
unsigned  num_patterns,
Z3_pattern const  patterns[],
Z3_ast  body 
)

Similar to Z3_mk_forall_const.

Create an existential quantifier using a list of constants that will form the set of bound variables.

Parameters
clogical context.
weightquantifiers are associated with weights indicating the importance of using the quantifier during instantiation. By default, pass the weight 0.
num_boundnumber of constants to be abstracted into bound variables.
boundarray of constants to be abstracted into bound variables.
num_patternsnumber of patterns.
patternsarray containing the patterns created using Z3_mk_pattern.
bodythe body of the quantifier.
See also
Z3_mk_pattern
Z3_mk_forall_const

Referenced by z3::exists().

Z3_ast Z3_API Z3_mk_ext_rotate_left ( Z3_context  c,
Z3_ast  t1,
Z3_ast  t2 
)

Rotate bits of t1 to the left t2 times.

The nodes t1 and t2 must have the same bit-vector sort.

Z3_ast Z3_API Z3_mk_ext_rotate_right ( Z3_context  c,
Z3_ast  t1,
Z3_ast  t2 
)

Rotate bits of t1 to the right t2 times.

The nodes t1 and t2 must have the same bit-vector sort.

Z3_ast Z3_API Z3_mk_extract ( Z3_context  c,
unsigned  high,
unsigned  low,
Z3_ast  t1 
)

Extract the bits high down to low from a bitvector of size m to yield a new bitvector of size n, where n = high - low + 1.

The node t1 must have a bit-vector sort.

Referenced by expr::extract().

Z3_ast Z3_API Z3_mk_false ( Z3_context  c)

Create an AST node representing false.

Referenced by context::bool_val().

Z3_sort Z3_API Z3_mk_finite_domain_sort ( Z3_context  c,
Z3_symbol  name,
unsigned __int64  size 
)

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.

See also
Z3_get_finite_domain_sort_size

Referenced by z3py::FiniteDomainSort().

Z3_fixedpoint Z3_API Z3_mk_fixedpoint ( Z3_context  c)

Create a new fixedpoint context.

Remarks
User must use Z3_fixedpoint_inc_ref and Z3_fixedpoint_dec_ref to manage fixedpoint objects. Even if the context was created using Z3_mk_context instead of Z3_mk_context_rc.
Z3_ast Z3_API Z3_mk_forall ( Z3_context  c,
unsigned  weight,
unsigned  num_patterns,
Z3_pattern const  patterns[],
unsigned  num_decls,
Z3_sort const  sorts[],
Z3_symbol const  decl_names[],
Z3_ast  body 
)

Create a forall formula. It takes an expression body that contains bound variables of the same sorts as the sorts listed in the array sorts. The bound variables are de-Bruijn indices created using Z3_mk_bound. The array decl_names contains the names that the quantified formula uses for the bound variables. Z3 applies the convention that the last element in the decl_names and sorts array refers to the variable with index 0, the second to last element of decl_names and sorts refers to the variable with index 1, etc.

Parameters
clogical context.
weightquantifiers are associated with weights indicating the importance of using the quantifier during instantiation. By default, pass the weight 0.
num_patternsnumber of patterns.
patternsarray containing the patterns created using Z3_mk_pattern.
num_declsnumber of variables to be bound.
sortsthe sorts of the bound variables.
decl_namesnames of the bound variables
bodythe body of the quantifier.
See also
Z3_mk_pattern
Z3_mk_bound
Z3_mk_exists
Z3_ast Z3_API Z3_mk_forall_const ( Z3_context  c,
unsigned  weight,
unsigned  num_bound,
Z3_app const  bound[],
unsigned  num_patterns,
Z3_pattern const  patterns[],
Z3_ast  body 
)

Create a universal quantifier using a list of constants that will form the set of bound variables.

Parameters
clogical context.
weightquantifiers are associated with weights indicating the importance of using the quantifier during instantiation. By default, pass the weight 0.
num_boundnumber of constants to be abstracted into bound variables.
boundarray of constants to be abstracted into bound variables.
num_patternsnumber of patterns.
patternsarray containing the patterns created using Z3_mk_pattern.
bodythe body of the quantifier.
See also
Z3_mk_pattern
Z3_mk_exists_const

Referenced by z3::forall().

Z3_ast Z3_API Z3_mk_fpa_abs ( Z3_context  c,
Z3_ast  t 
)

Floating-point absolute value.

Parameters
clogical context
tterm of FloatingPoint sort
Z3_ast Z3_API Z3_mk_fpa_add ( Z3_context  c,
Z3_ast  rm,
Z3_ast  t1,
Z3_ast  t2 
)

Floating-point addition.

Parameters
clogical context
rmterm of RoundingMode sort
t1term of FloatingPoint sort
t2term of FloatingPoint sort

rm must be of RoundingMode sort, t1 and t2 must have the same FloatingPoint sort.

Z3_ast Z3_API Z3_mk_fpa_div ( Z3_context  c,
Z3_ast  rm,
Z3_ast  t1,
Z3_ast  t2 
)

Floating-point division.

Parameters
clogical context
rmterm of RoundingMode sort
t1term of FloatingPoint sort.
t2term of FloatingPoint sort

The nodes rm must be of RoundingMode sort t1 and t2 must have the same FloatingPoint sort.

Z3_ast Z3_API Z3_mk_fpa_eq ( Z3_context  c,
Z3_ast  t1,
Z3_ast  t2 
)

Floating-point equality.

Parameters
clogical context
t1term of FloatingPoint sort
t2term of FloatingPoint sort

Note that this is IEEE 754 equality (as opposed to SMT-LIB =).

t1 and t2 must have the same FloatingPoint sort.

Z3_ast Z3_API Z3_mk_fpa_fma ( Z3_context  c,
Z3_ast  rm,
Z3_ast  t1,
Z3_ast  t2,
Z3_ast  t3 
)

Floating-point fused multiply-add.

Parameters
clogical context
rmterm of RoundingMode sort
t1term of FloatingPoint sort
t2term of FloatingPoint sor
t3term of FloatingPoint sort

The result is round((t1 * t2) + t3)

rm must be of RoundingMode sort, t1, t2, and t3 must have the same FloatingPoint sort.

Z3_ast Z3_API Z3_mk_fpa_fp ( Z3_context  c,
Z3_ast  sgn,
Z3_ast  exp,
Z3_ast  sig 
)

Create an expression of FloatingPoint sort from three bit-vector expressions.

This is the operator named `fp' in the SMT FP theory definition. Note that sign is required to be a bit-vector of size 1. Significand and exponent are required to be greater than 1 and 2 respectively. The FloatingPoint sort of the resulting expression is automatically determined from the bit-vector sizes of the arguments.

Parameters
clogical context
sgnsign
expexponent
sigsignificand
Z3_ast Z3_API Z3_mk_fpa_geq ( Z3_context  c,
Z3_ast  t1,
Z3_ast  t2 
)

Floating-point greater than or equal.

Parameters
clogical context
t1term of FloatingPoint sort
t2term of FloatingPoint sort

t1 and t2 must have the same FloatingPoint sort.

Z3_ast Z3_API Z3_mk_fpa_gt ( Z3_context  c,
Z3_ast  t1,
Z3_ast  t2 
)

Floating-point greater than.

Parameters
clogical context
t1term of FloatingPoint sort
t2term of FloatingPoint sort

t1 and t2 must have the same FloatingPoint sort.

Z3_ast Z3_API Z3_mk_fpa_inf ( Z3_context  c,
Z3_sort  s,
Z3_bool  negative 
)

Create a floating-point infinity of sort s.

Parameters
clogical context
starget sort
negativeindicates whether the result should be negative

When negative is true, -oo will be generated instead of +oo.

Z3_ast Z3_API Z3_mk_fpa_is_infinite ( Z3_context  c,
Z3_ast  t 
)

Predicate indicating whether t is a floating-point number representing +oo or -oo.

Parameters
clogical context
tterm of FloatingPoint sort

t must have FloatingPoint sort.

Z3_ast Z3_API Z3_mk_fpa_is_nan ( Z3_context  c,
Z3_ast  t 
)

Predicate indicating whether t is a NaN.

Parameters
clogical context
tterm of FloatingPoint sort

t must have FloatingPoint sort.

Z3_ast Z3_API Z3_mk_fpa_is_negative ( Z3_context  c,
Z3_ast  t 
)

Predicate indicating whether t is a negative floating-point number.

Parameters
clogical context
tterm of FloatingPoint sort

t must have FloatingPoint sort.

Z3_ast Z3_API Z3_mk_fpa_is_normal ( Z3_context  c,
Z3_ast  t 
)

Predicate indicating whether t is a normal floating-point number.

Parameters
clogical context
tterm of FloatingPoint sort

t must have FloatingPoint sort.

Z3_ast Z3_API Z3_mk_fpa_is_positive ( Z3_context  c,
Z3_ast  t 
)

Predicate indicating whether t is a positive floating-point number.

Parameters
clogical context
tterm of FloatingPoint sort

t must have FloatingPoint sort.

Z3_ast Z3_API Z3_mk_fpa_is_subnormal ( Z3_context  c,
Z3_ast  t 
)

Predicate indicating whether t is a subnormal floating-point number.

Parameters
clogical context
tterm of FloatingPoint sort

t must have FloatingPoint sort.

Z3_ast Z3_API Z3_mk_fpa_is_zero ( Z3_context  c,
Z3_ast  t 
)

Predicate indicating whether t is a floating-point number with zero value, i.e., +zero or -zero.

Parameters
clogical context
tterm of FloatingPoint sort

t must have FloatingPoint sort.

Z3_ast Z3_API Z3_mk_fpa_leq ( Z3_context  c,
Z3_ast  t1,
Z3_ast  t2 
)

Floating-point less than or equal.

Parameters
clogical context
t1term of FloatingPoint sort
t2term of FloatingPoint sort

t1 and t2 must have the same FloatingPoint sort.

Z3_ast Z3_API Z3_mk_fpa_lt ( Z3_context  c,
Z3_ast  t1,
Z3_ast  t2 
)

Floating-point less than.

Parameters
clogical context
t1term of FloatingPoint sort
t2term of FloatingPoint sort

t1 and t2 must have the same FloatingPoint sort.

Z3_ast Z3_API Z3_mk_fpa_max ( Z3_context  c,
Z3_ast  t1,
Z3_ast  t2 
)

Maximum of floating-point numbers.

Parameters
clogical context
t1term of FloatingPoint sort
t2term of FloatingPoint sort

t1, t2 must have the same FloatingPoint sort.

Z3_ast Z3_API Z3_mk_fpa_min ( Z3_context  c,
Z3_ast  t1,
Z3_ast  t2 
)

Minimum of floating-point numbers.

Parameters
clogical context
t1term of FloatingPoint sort
t2term of FloatingPoint sort

t1, t2 must have the same FloatingPoint sort.

Z3_ast Z3_API Z3_mk_fpa_mul ( Z3_context  c,
Z3_ast  rm,
Z3_ast  t1,
Z3_ast  t2 
)

Floating-point multiplication.

Parameters
clogical context
rmterm of RoundingMode sort
t1term of FloatingPoint sort
t2term of FloatingPoint sort

rm must be of RoundingMode sort, t1 and t2 must have the same FloatingPoint sort.

Z3_ast Z3_API Z3_mk_fpa_nan ( Z3_context  c,
Z3_sort  s 
)

Create a floating-point NaN of sort s.

Parameters
clogical context
starget sort
Z3_ast Z3_API Z3_mk_fpa_neg ( Z3_context  c,
Z3_ast  t 
)

Floating-point negation.

Parameters
clogical context
tterm of FloatingPoint sort
Z3_ast Z3_API Z3_mk_fpa_numeral_double ( Z3_context  c,
double  v,
Z3_sort  ty 
)

Create a numeral of FloatingPoint sort from a double.

This function is used to create numerals that fit in a double value. It is slightly faster than Z3_mk_numeral since it is not necessary to parse a string.

Parameters
clogical context
vvalue
tysort

ty must be a FloatingPoint sort

See also
Z3_mk_numeral
Z3_ast Z3_API Z3_mk_fpa_numeral_float ( Z3_context  c,
float  v,
Z3_sort  ty 
)

Create a numeral of FloatingPoint sort from a float.

This function is used to create numerals that fit in a float value. It is slightly faster than Z3_mk_numeral since it is not necessary to parse a string.

Parameters
clogical context
vvalue
tysort

ty must be a FloatingPoint sort

See also
Z3_mk_numeral
Z3_ast Z3_API Z3_mk_fpa_numeral_int ( Z3_context  c,
signed  v,
Z3_sort  ty 
)

Create a numeral of FloatingPoint sort from a signed integer.

Parameters
clogical context
vvalue
tyresult sort

ty must be a FloatingPoint sort

See also
Z3_mk_numeral
Z3_ast Z3_API Z3_mk_fpa_numeral_int64_uint64 ( Z3_context  c,
Z3_bool  sgn,
__int64  exp,
__uint64  sig,
Z3_sort  ty 
)

Create a numeral of FloatingPoint sort from a sign bit and two 64-bit integers.

Parameters
clogical context
sgnsign bit (true == negative)
sigsignificand
expexponent
tyresult sort

ty must be a FloatingPoint sort

See also
Z3_mk_numeral
Z3_ast Z3_API Z3_mk_fpa_numeral_int_uint ( Z3_context  c,
Z3_bool  sgn,
signed  exp,
unsigned  sig,
Z3_sort  ty 
)

Create a numeral of FloatingPoint sort from a sign bit and two integers.

Parameters
clogical context
sgnsign bit (true == negative)
sigsignificand
expexponent
tyresult sort

ty must be a FloatingPoint sort

See also
Z3_mk_numeral
Z3_ast Z3_API Z3_mk_fpa_rem ( Z3_context  c,
Z3_ast  t1,
Z3_ast  t2 
)

Floating-point remainder.

Parameters
clogical context
t1term of FloatingPoint sort
t2term of FloatingPoint sort

t1 and t2 must have the same FloatingPoint sort.

Z3_ast Z3_API Z3_mk_fpa_rna ( Z3_context  c)

Create a numeral of RoundingMode sort which represents the NearestTiesToAway rounding mode.

Parameters
clogical context
Z3_ast Z3_API Z3_mk_fpa_rne ( Z3_context  c)

Create a numeral of RoundingMode sort which represents the NearestTiesToEven rounding mode.

Parameters
clogical context
Z3_ast Z3_API Z3_mk_fpa_round_nearest_ties_to_away ( Z3_context  c)

Create a numeral of RoundingMode sort which represents the NearestTiesToAway rounding mode.

Parameters
clogical context
Z3_ast Z3_API Z3_mk_fpa_round_nearest_ties_to_even ( Z3_context  c)

Create a numeral of RoundingMode sort which represents the NearestTiesToEven rounding mode.

Parameters
clogical context
Z3_ast Z3_API Z3_mk_fpa_round_to_integral ( Z3_context  c,
Z3_ast  rm,
Z3_ast  t 
)

Floating-point roundToIntegral. Rounds a floating-point number to the closest integer, again represented as a floating-point number.

Parameters
clogical context
rmterm of RoundingMode sort
tterm of FloatingPoint sort

t must be of FloatingPoint sort.

Z3_ast Z3_API Z3_mk_fpa_round_toward_negative ( Z3_context  c)

Create a numeral of RoundingMode sort which represents the TowardNegative rounding mode.

Parameters
clogical context
Z3_ast Z3_API Z3_mk_fpa_round_toward_positive ( Z3_context  c)

Create a numeral of RoundingMode sort which represents the TowardPositive rounding mode.

Parameters
clogical context
Z3_ast Z3_API Z3_mk_fpa_round_toward_zero ( Z3_context  c)

Create a numeral of RoundingMode sort which represents the TowardZero rounding mode.

Parameters
clogical context
Z3_sort Z3_API Z3_mk_fpa_rounding_mode_sort ( Z3_context  c)

Create the RoundingMode sort.

Parameters
clogical context
Z3_ast Z3_API Z3_mk_fpa_rtn ( Z3_context  c)

Create a numeral of RoundingMode sort which represents the TowardNegative rounding mode.

Parameters
clogical context
Z3_ast Z3_API Z3_mk_fpa_rtp ( Z3_context  c)

Create a numeral of RoundingMode sort which represents the TowardPositive rounding mode.

Parameters
clogical context
Z3_ast Z3_API Z3_mk_fpa_rtz ( Z3_context  c)

Create a numeral of RoundingMode sort which represents the TowardZero rounding mode.

Parameters
clogical context
Z3_sort Z3_API Z3_mk_fpa_sort ( Z3_context  c,
unsigned  ebits,
unsigned  sbits 
)

Create a FloatingPoint sort.

Parameters
clogical context
ebitsnumber of exponent bits
sbitsnumber of significand bits
Remarks
ebits must be larger than 1 and sbits must be larger than 2.
Z3_sort Z3_API Z3_mk_fpa_sort_128 ( Z3_context  c)

Create the quadruple-precision (128-bit) FloatingPoint sort.

Parameters
clogical context
Z3_sort Z3_API Z3_mk_fpa_sort_16 ( Z3_context  c)

Create the half-precision (16-bit) FloatingPoint sort.

Parameters
clogical context
Z3_sort Z3_API Z3_mk_fpa_sort_32 ( Z3_context  c)

Create the single-precision (32-bit) FloatingPoint sort.

Parameters
clogical context
Z3_sort Z3_API Z3_mk_fpa_sort_64 ( Z3_context  c)

Create the double-precision (64-bit) FloatingPoint sort.

Parameters
clogical context
Z3_sort Z3_API Z3_mk_fpa_sort_double ( Z3_context  c)

Create the double-precision (64-bit) FloatingPoint sort.

Parameters
clogical context
Z3_sort Z3_API Z3_mk_fpa_sort_half ( Z3_context  c)

Create the half-precision (16-bit) FloatingPoint sort.

Parameters
clogical context
Z3_sort Z3_API Z3_mk_fpa_sort_quadruple ( Z3_context  c)

Create the quadruple-precision (128-bit) FloatingPoint sort.

Parameters
clogical context
Z3_sort Z3_API Z3_mk_fpa_sort_single ( Z3_context  c)

Create the single-precision (32-bit) FloatingPoint sort.

Parameters
clogical context.
Z3_ast Z3_API Z3_mk_fpa_sqrt ( Z3_context  c,
Z3_ast  rm,
Z3_ast  t 
)

Floating-point square root.

Parameters
clogical context
rmterm of RoundingMode sort
tterm of FloatingPoint sort

rm must be of RoundingMode sort, t must have FloatingPoint sort.

Z3_ast Z3_API Z3_mk_fpa_sub ( Z3_context  c,
Z3_ast  rm,
Z3_ast  t1,
Z3_ast  t2 
)

Floating-point subtraction.

Parameters
clogical context
rmterm of RoundingMode sort
t1term of FloatingPoint sort
t2term of FloatingPoint sort

rm must be of RoundingMode sort, t1 and t2 must have the same FloatingPoint sort.

Z3_ast Z3_API Z3_mk_fpa_to_fp_bv ( Z3_context  c,
Z3_ast  bv,
Z3_sort  s 
)

Conversion of a single IEEE 754-2008 bit-vector into a floating-point number.

Produces a term that represents the conversion of a bit-vector term bv to a floating-point term of sort s.

Parameters
clogical context
bva bit-vector term
sfloating-point sort

s must be a FloatingPoint sort, t must be of bit-vector sort, and the bit-vector size of bv must be equal to ebits+sbits of s. The format of the bit-vector is as defined by the IEEE 754-2008 interchange format.

Z3_ast Z3_API Z3_mk_fpa_to_fp_float ( Z3_context  c,
Z3_ast  rm,
Z3_ast  t,
Z3_sort  s 
)

Conversion of a FloatingPoint term into another term of different FloatingPoint sort.

Produces a term that represents the conversion of a floating-point term t to a floating-point term of sort s. If necessary, the result will be rounded according to rounding mode rm.

Parameters
clogical context
rmterm of RoundingMode sort
tterm of FloatingPoint sort
sfloating-point sort

s must be a FloatingPoint sort, rm must be of RoundingMode sort, t must be of floating-point sort.

Z3_ast Z3_API Z3_mk_fpa_to_fp_int_real ( Z3_context  c,
Z3_ast  rm,
Z3_ast  exp,
Z3_ast  sig,
Z3_sort  s 
)

Conversion of a real-sorted significand and an integer-sorted exponent into a term of FloatingPoint sort.

Produces a term that represents the conversion of sig * 2^exp into a floating-point term of sort s. If necessary, the result will be rounded according to rounding mode rm.

Parameters
clogical context
rmterm of RoundingMode sort
expexponent term of Int sort
sigsignificand term of Real sort
sFloatingPoint sort

s must be a FloatingPoint sort, rm must be of RoundingMode sort, exp must be of int sort, sig must be of real sort.

Z3_ast Z3_API Z3_mk_fpa_to_fp_real ( Z3_context  c,
Z3_ast  rm,
Z3_ast  t,
Z3_sort  s 
)

Conversion of a term of real sort into a term of FloatingPoint sort.

Produces a term that represents the conversion of term t of real sort into a floating-point term of sort s. If necessary, the result will be rounded according to rounding mode rm.

Parameters
clogical context
rmterm of RoundingMode sort
tterm of Real sort
sfloating-point sort

s must be a FloatingPoint sort, rm must be of RoundingMode sort, t must be of real sort.

Z3_ast Z3_API Z3_mk_fpa_to_fp_signed ( Z3_context  c,
Z3_ast  rm,
Z3_ast  t,
Z3_sort  s 
)

Conversion of a 2's complement signed bit-vector term into a term of FloatingPoint sort.

Produces a term that represents the conversion of the bit-vector term t into a floating-point term of sort s. The bit-vector t is taken to be in signed 2's complement format. If necessary, the result will be rounded according to rounding mode rm.

Parameters
clogical context
rmterm of RoundingMode sort
tterm of bit-vector sort
sfloating-point sort

s must be a FloatingPoint sort, rm must be of RoundingMode sort, t must be of bit-vector sort.

Z3_ast Z3_API Z3_mk_fpa_to_fp_unsigned ( Z3_context  c,
Z3_ast  rm,
Z3_ast  t,
Z3_sort  s 
)

Conversion of a 2's complement unsigned bit-vector term into a term of FloatingPoint sort.

Produces a term that represents the conversion of the bit-vector term t into a floating-point term of sort s. The bit-vector t is taken to be in unsigned 2's complement format. If necessary, the result will be rounded according to rounding mode rm.

Parameters
clogical context
rmterm of RoundingMode sort
tterm of bit-vector sort
sfloating-point sort

s must be a FloatingPoint sort, rm must be of RoundingMode sort, t must be of bit-vector sort.

Z3_ast Z3_API Z3_mk_fpa_to_ieee_bv ( Z3_context  c,
Z3_ast  t 
)

Conversion of a floating-point term into a bit-vector term in IEEE 754-2008 format.

Parameters
clogical context
tterm of FloatingPoint sort

t must have FloatingPoint sort. The size of the resulting bit-vector is automatically determined.

Note that IEEE 754-2008 allows multiple different representations of NaN. This conversion knows only one NaN and it will always produce the same bit-vector represenatation of that NaN.

Z3_ast Z3_API Z3_mk_fpa_to_real ( Z3_context  c,
Z3_ast  t 
)

Conversion of a floating-point term into a real-numbered term.

Produces a term that represents the conversion of the floating-poiunt term t into a real number. Note that this type of conversion will often result in non-linear constraints over real terms.

Parameters
clogical context
tterm of FloatingPoint sort
Z3_ast Z3_API Z3_mk_fpa_to_sbv ( Z3_context  c,
Z3_ast  rm,
Z3_ast  t,
unsigned  sz 
)

Conversion of a floating-point term into a signed bit-vector.

Produces a term that represents the conversion of the floating-poiunt term t into a bit-vector term of size sz in signed 2's complement format. If necessary, the result will be rounded according to rounding mode rm.

Parameters
clogical context
rmterm of RoundingMode sort
tterm of FloatingPoint sort
szsize of the resulting bit-vector
Z3_ast Z3_API Z3_mk_fpa_to_ubv ( Z3_context  c,
Z3_ast  rm,
Z3_ast  t,
unsigned  sz 
)

Conversion of a floating-point term into an unsigned bit-vector.

Produces a term that represents the conversion of the floating-poiunt term t into a bit-vector term of size sz in unsigned 2's complement format. If necessary, the result will be rounded according to rounding mode rm.

Parameters
clogical context
rmterm of RoundingMode sort
tterm of FloatingPoint sort
szsize of the resulting bit-vector
Z3_ast Z3_API Z3_mk_fpa_zero ( Z3_context  c,
Z3_sort  s,
Z3_bool  negative 
)

Create a floating-point zero of sort s.

Parameters
clogical context
starget sort
negativeindicates whether the result should be negative

When negative is true, -zero will be generated instead of +zero.

Z3_ast Z3_API Z3_mk_fresh_const ( Z3_context  c,
Z3_string  prefix,
Z3_sort  ty 
)

Declare and create a fresh constant.

This function is a shorthand for:

1 Z3_func_decl d = Z3_mk_fresh_func_decl(c, prefix, 0, 0, ty); Z3_ast n = Z3_mk_app(c, d, 0, 0);
Remarks
If prefix is NULL, then it is assumed to be the empty string.
See also
Z3_mk_func_decl
Z3_mk_app
Z3_func_decl Z3_API Z3_mk_fresh_func_decl ( Z3_context  c,
Z3_string  prefix,
unsigned  domain_size,
Z3_sort const  domain[],
Z3_sort  range 
)

Declare a fresh constant or function.

Z3 will generate an unique name for this function declaration. If prefix is different from NULL, then the name generate by Z3 will start with prefix.

Remarks
If prefix is NULL, then it is assumed to be the empty string.
See also
Z3_mk_func_decl
Z3_ast Z3_API Z3_mk_full_set ( Z3_context  c,
Z3_sort  domain 
)

Create the full set.

Z3_func_decl Z3_API Z3_mk_func_decl ( Z3_context  c,
Z3_symbol  s,
unsigned  domain_size,
Z3_sort const  domain[],
Z3_sort  range 
)

Declare a constant or function.

Parameters
clogical context.
sname of the constant or function.
domain_sizenumber of arguments. It is 0 when declaring a constant.
domainarray containing the sort of each argument. The array must contain domain_size elements. It is 0 when declaring a constant.
rangesort 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.

See also
Z3_mk_app

Referenced by context::function(), and z3py::Function().

Z3_ast Z3_API Z3_mk_ge ( Z3_context  c,
Z3_ast  t1,
Z3_ast  t2 
)

Create greater than or equal to.

The nodes t1 and t2 must have the same sort, and must be int or real.

Z3_goal Z3_API Z3_mk_goal ( Z3_context  c,
Z3_bool  models,
Z3_bool  unsat_cores,
Z3_bool  proofs 
)

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.

Remarks
Reference counting must be used to manage goals, even when the Z3_context was created using Z3_mk_context instead of Z3_mk_context_rc.

Referenced by goal::goal().

Z3_ast Z3_API Z3_mk_gt ( Z3_context  c,
Z3_ast  t1,
Z3_ast  t2 
)

Create greater than.

The nodes t1 and t2 must have the same sort, and must be int or real.

Z3_ast Z3_API Z3_mk_iff ( Z3_context  c,
Z3_ast  t1,
Z3_ast  t2 
)

Create an AST node representing t1 iff t2.

The nodes t1 and t2 must have Boolean sort.

Z3_ast Z3_API Z3_mk_implies ( Z3_context  c,
Z3_ast  t1,
Z3_ast  t2 
)

Create an AST node representing t1 implies t2.

The nodes t1 and t2 must have Boolean sort.

Z3_func_decl Z3_API Z3_mk_injective_function ( Z3_context  c,
Z3_symbol  s,
unsigned  domain_size,
Z3_sort const  domain[],
Z3_sort  range 
)

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.
Z3_ast Z3_API Z3_mk_int ( Z3_context  c,
int  v,
Z3_sort  ty 
)

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.

See also
Z3_mk_numeral

Referenced by context::bv_val(), context::int_val(), context::num_val(), and context::real_val().

Z3_ast Z3_API Z3_mk_int2bv ( Z3_context  c,
unsigned  n,
Z3_ast  t1 
)

Create an n bit bit-vector from the integer argument 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 t1 must have integer sort.

Z3_ast Z3_API Z3_mk_int2real ( Z3_context  c,
Z3_ast  t1 
)

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 k and and asserting mk_int2real(k) <= t1 < mk_int2real(k)+1.

The node t1 must have sort integer.

See also
Z3_mk_real2int
Z3_mk_is_int

Referenced by z3::to_real().

Z3_ast Z3_API Z3_mk_int64 ( Z3_context  c,
__int64  v,
Z3_sort  ty 
)

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.

See also
Z3_mk_numeral

Referenced by context::bv_val(), context::int_val(), and context::real_val().

Z3_sort Z3_API Z3_mk_int_sort ( Z3_context  c)

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.

See also
Z3_mk_bv_sort

Referenced by context::int_sort().

Z3_symbol Z3_API Z3_mk_int_symbol ( Z3_context  c,
int  i 
)

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.

See also
Z3_mk_string_symbol

Referenced by context::int_symbol(), and z3py::to_symbol().

Z3_ast Z3_API Z3_mk_interpolant ( Z3_context  c,
Z3_ast  a 
)

Create an AST node marking a formula position for interpolation.

The node a must have Boolean sort.

Z3_context Z3_API Z3_mk_interpolation_context ( Z3_config  cfg)

This function generates a Z3 context suitable for generation of interpolants. Formulas can be generated as abstract syntax trees in this context using the Z3 C API.

Interpolants are also generated as AST's in this context.

If cfg is non-null, it will be used as the base configuration for the Z3 context. This makes it possible to set Z3 options to be used during interpolation. This feature should be used with some caution however, as it may be that certain Z3 options are incompatible with interpolation.

Z3_ast Z3_API Z3_mk_is_int ( Z3_context  c,
Z3_ast  t1 
)

Check if a real number is an integer.

See also
Z3_mk_int2real
Z3_mk_real2int
Z3_ast Z3_API Z3_mk_ite ( Z3_context  c,
Z3_ast  t1,
Z3_ast  t2,
Z3_ast  t3 
)

Create an AST node representing an if-then-else: ite(t1, t2, t3).

The node t1 must have Boolean sort, t2 and t3 must have the same sort. The sort of the new node is equal to the sort of t2 and t3.

Referenced by z3py::If(), and z3::ite().

Z3_ast Z3_API Z3_mk_label ( Z3_context  c,
Z3_symbol  s,
Z3_bool  is_pos,
Z3_ast  f 
)

Create a labeled formula.

Parameters
clogical context.
sname of the label.
is_poslabel polarity.
fformula 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.
Z3_ast Z3_API Z3_mk_le ( Z3_context  c,
Z3_ast  t1,
Z3_ast  t2 
)

Create less than or equal to.

The nodes t1 and t2 must have the same sort, and must be int or real.

Z3_sort Z3_API Z3_mk_list_sort ( Z3_context  c,
Z3_symbol  name,
Z3_sort  elem_sort,
Z3_func_decl *  nil_decl,
Z3_func_decl *  is_nil_decl,
Z3_func_decl *  cons_decl,
Z3_func_decl *  is_cons_decl,
Z3_func_decl *  head_decl,
Z3_func_decl *  tail_decl 
)

Create a list sort.

A list sort over elem_sort This function declares the corresponding constructors and testers for lists.

Parameters
clogical context
namename of the list sort.
elem_sortsort of list elements.
nil_decldeclaration for the empty list.
is_nil_decltest for the empty list.
cons_decldeclaration for a cons cell.
is_cons_declcons cell test.
head_decllist head.
tail_decllist tail.
Z3_ast Z3_API Z3_mk_lt ( Z3_context  c,
Z3_ast  t1,
Z3_ast  t2 
)

Create less than.

The nodes t1 and t2 must have the same sort, and must be int or real.

Z3_ast Z3_API Z3_mk_map ( Z3_context  c,
Z3_func_decl  f,
unsigned  n,
Z3_ast const *  args 
)

map f on the the argument arrays.

The n nodes args must be of array sorts [domain_i -> range_i]. The function declaration f must have type range_1 .. range_n -> range. v must have sort range. The sort of the result is [domain_i -> range].

See also
Z3_mk_array_sort
Z3_mk_store
Z3_mk_select
Z3_ast Z3_API Z3_mk_mod ( Z3_context  c,
Z3_ast  arg1,
Z3_ast  arg2 
)

Create an AST node representing arg1 mod arg2.The arguments must have int type.

Z3_ast Z3_API Z3_mk_mul ( Z3_context  c,
unsigned  num_args,
Z3_ast const  args[] 
)

Create an AST node representing args[0] * ... * args[num_args-1].The array args must have num_args elements. All arguments must have int or real sort.

Remarks
Z3 has limited support for non-linear arithmetic.
The number of arguments must be greater than zero.

Referenced by z3py::Product().

Z3_ast Z3_API Z3_mk_not ( Z3_context  c,
Z3_ast  a 
)

Create an AST node representing not(a).

The node a must have Boolean sort.

Z3_ast Z3_API Z3_mk_numeral ( Z3_context  c,
Z3_string  numeral,
Z3_sort  ty 
)

Create a numeral of a given sort.

Parameters
clogical context.
numeralA 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 [num]* / [num]*.
tyThe sort of the numeral. In the current implementation, the given sort can be an int, real, finite-domain, or bit-vectors of arbitrary size.
See also
Z3_mk_int
Z3_mk_unsigned_int

Referenced by context::bv_val(), context::int_val(), and context::real_val().

Z3_optimize Z3_API Z3_mk_optimize ( Z3_context  c)

Create a new optimize context.

Remarks
User must use Z3_optimize_inc_ref and Z3_optimize_dec_ref to manage optimize objects. Even if the context was created using Z3_mk_context instead of Z3_mk_context_rc.

Referenced by optimize::optimize().

Z3_ast Z3_API Z3_mk_or ( Z3_context  c,
unsigned  num_args,
Z3_ast const  args[] 
)

Create an AST node representing args[0] or ... or args[num_args-1].The array args must have num_args elements. All arguments must have Boolean sort.

Remarks
The number of arguments must be greater than zero.
Z3_params Z3_API Z3_mk_params ( Z3_context  c)

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.

Remarks
Reference counting must be used to manage parameter sets, even when the Z3_context was created using Z3_mk_context instead of Z3_mk_context_rc.

Referenced by params::params().

Z3_pattern Z3_API Z3_mk_pattern ( Z3_context  c,
unsigned  num_patterns,
Z3_ast const  terms[] 
)

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.

See also
Z3_mk_forall
Z3_mk_exists
Z3_ast Z3_API Z3_mk_pble ( Z3_context  c,
unsigned  num_args,
Z3_ast const  args[],
int  coeffs[],
int  k 
)

Pseudo-Boolean relations.

Encode k1*p1 + k2*p2 + ... + kn*pn <= k

Z3_ast Z3_API Z3_mk_power ( Z3_context  c,
Z3_ast  arg1,
Z3_ast  arg2 
)

Create an AST node representing arg1^arg2.

The arguments must have int or real type.

Referenced by z3::pw().

Z3_probe Z3_API Z3_mk_probe ( Z3_context  c,
Z3_string  name 
)

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 (help-tactics) 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.

Referenced by probe::probe().

Z3_ast Z3_API Z3_mk_quantifier ( Z3_context  c,
Z3_bool  is_forall,
unsigned  weight,
unsigned  num_patterns,
Z3_pattern const  patterns[],
unsigned  num_decls,
Z3_sort const  sorts[],
Z3_symbol const  decl_names[],
Z3_ast  body 
)

Create a quantifier - universal or existential, with pattern hints. See the documentation for Z3_mk_forall for an explanation of the parameters.

Parameters
clogical context.
is_forallflag to indicate if this is a universal or existential quantifier.
weightquantifiers are associated with weights indicating the importance of using the quantifier during instantiation. By default, pass the weight 0.
num_patternsnumber of patterns.
patternsarray containing the patterns created using Z3_mk_pattern.
num_declsnumber of variables to be bound.
sortsarray of sorts of the bound variables.
decl_namesnames of the bound variables.
bodythe body of the quantifier.
See also
Z3_mk_pattern
Z3_mk_bound
Z3_mk_forall
Z3_mk_exists
Z3_ast Z3_API Z3_mk_quantifier_const ( Z3_context  c,
Z3_bool  is_forall,
unsigned  weight,
unsigned  num_bound,
Z3_app const  bound[],
unsigned  num_patterns,
Z3_pattern const  patterns[],
Z3_ast  body 
)

Create a universal or existential quantifier using a list of constants that will form the set of bound variables.

Z3_ast Z3_API Z3_mk_quantifier_const_ex ( Z3_context  c,
Z3_bool  is_forall,
unsigned  weight,
Z3_symbol  quantifier_id,
Z3_symbol  skolem_id,
unsigned  num_bound,
Z3_app const  bound[],
unsigned  num_patterns,
Z3_pattern const  patterns[],
unsigned  num_no_patterns,
Z3_ast const  no_patterns[],
Z3_ast  body 
)

Create a universal or existential quantifier using a list of constants that will form the set of bound variables.

Z3_ast Z3_API Z3_mk_quantifier_ex ( Z3_context  c,
Z3_bool  is_forall,
unsigned  weight,
Z3_symbol  quantifier_id,
Z3_symbol  skolem_id,
unsigned  num_patterns,
Z3_pattern const  patterns[],
unsigned  num_no_patterns,
Z3_ast const  no_patterns[],
unsigned  num_decls,
Z3_sort const  sorts[],
Z3_symbol const  decl_names[],
Z3_ast  body 
)

Create a quantifier - universal or existential, with pattern hints, no patterns, and attributes.

Parameters
clogical context.
is_forallflag to indicate if this is a universal or existential quantifier.
quantifier_ididentifier to identify quantifier
skolem_ididentifier to identify skolem constants introduced by quantifier.
weightquantifiers are associated with weights indicating the importance of using the quantifier during instantiation. By default, pass the weight 0.
num_patternsnumber of patterns.
patternsarray containing the patterns created using Z3_mk_pattern.
num_no_patternsnumber of no_patterns.
no_patternsarray containing subexpressions to be excluded from inferred patterns.
num_declsnumber of variables to be bound.
sortsarray of sorts of the bound variables.
decl_namesnames of the bound variables.
bodythe body of the quantifier.
See also
Z3_mk_pattern
Z3_mk_bound
Z3_mk_forall
Z3_mk_exists
Z3_ast Z3_API Z3_mk_real ( Z3_context  c,
int  num,
int  den 
)

Create a real from a fraction.

Parameters
clogical context.
numnumerator of rational.
dendenomerator of rational.
Precondition
den != 0
See also
Z3_mk_numeral
Z3_mk_int
Z3_mk_unsigned_int

Referenced by context::real_val().

Z3_ast Z3_API Z3_mk_real2int ( Z3_context  c,
Z3_ast  t1 
)

Coerce a real to an integer.

The semantics of this function follows the SMT-LIB standard for the function to_int

See also
Z3_mk_int2real
Z3_mk_is_int
Z3_sort Z3_API Z3_mk_real_sort ( Z3_context  c)

Create the real type.

Note that this type is not a floating point number.

Referenced by context::real_sort().

Z3_ast Z3_API Z3_mk_rem ( Z3_context  c,
Z3_ast  arg1,
Z3_ast  arg2 
)

Create an AST node representing arg1 rem arg2.The arguments must have int type.

Z3_ast Z3_API Z3_mk_repeat ( Z3_context  c,
unsigned  i,
Z3_ast  t1 
)

Repeat the given bit-vector up length i.

The node t1 must have a bit-vector sort.

Z3_ast Z3_API Z3_mk_rotate_left ( Z3_context  c,
unsigned  i,
Z3_ast  t1 
)

Rotate bits of t1 to the left i times.

The node t1 must have a bit-vector sort.

Z3_ast Z3_API Z3_mk_rotate_right ( Z3_context  c,
unsigned  i,
Z3_ast  t1 
)

Rotate bits of t1 to the right i times.

The node t1 must have a bit-vector sort.

Z3_ast Z3_API Z3_mk_select ( Z3_context  c,
Z3_ast  a,
Z3_ast  i 
)

Array read. The argument a is the array and i is the index of the array that gets read.

The node a must have an array sort [domain -> range], and i must have the sort domain. The sort of the result is range.

See also
Z3_mk_array_sort
Z3_mk_store

Referenced by z3::select().

Z3_ast Z3_API Z3_mk_set_add ( Z3_context  c,
Z3_ast  set,
Z3_ast  elem 
)

Add an element to a set.

The first argument must be a set, the second an element.

Z3_ast Z3_API Z3_mk_set_complement ( Z3_context  c,
Z3_ast  arg 
)

Take the complement of a set.

Z3_ast Z3_API Z3_mk_set_del ( Z3_context  c,
Z3_ast  set,
Z3_ast  elem 
)

Remove an element to a set.

The first argument must be a set, the second an element.

Z3_ast Z3_API Z3_mk_set_difference ( Z3_context  c,
Z3_ast  arg1,
Z3_ast  arg2 
)

Take the set difference between two sets.

Z3_ast Z3_API Z3_mk_set_intersect ( Z3_context  c,
unsigned  num_args,
Z3_ast const  args[] 
)

Take the intersection of a list of sets.

Z3_ast Z3_API Z3_mk_set_member ( Z3_context  c,
Z3_ast  elem,
Z3_ast  set 
)

Check for set membership.

The first argument should be an element type of the set.

Z3_sort Z3_API Z3_mk_set_sort ( Z3_context  c,
Z3_sort  ty 
)

Create Set type.

Z3_ast Z3_API Z3_mk_set_subset ( Z3_context  c,
Z3_ast  arg1,
Z3_ast  arg2 
)

Check for subsetness of sets.

Z3_ast Z3_API Z3_mk_set_union ( Z3_context  c,
unsigned  num_args,
Z3_ast const  args[] 
)

Take the union of a list of sets.

Z3_ast Z3_API Z3_mk_sign_ext ( Z3_context  c,
unsigned  i,
Z3_ast  t1 
)

Sign-extend of the given bit-vector to the (signed) equivalent bitvector of size m+i, where m is the size of the given bit-vector.

The node t1 must have a bit-vector sort.

Z3_solver Z3_API Z3_mk_simple_solver ( Z3_context  c)

Create a new (incremental) solver.

The function Z3_solver_get_model retrieves a model if the assertions is satisfiable (i.e., the result is Z3_L_TRUE) and model construction is enabled. The function Z3_solver_get_model can also be used even if the result is Z3_L_UNDEF, but the returned model is not guaranteed to satisfy quantified assertions.

Referenced by z3py::SimpleSolver().

Z3_solver Z3_API Z3_mk_solver ( Z3_context  c)

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.

Remarks
User must use Z3_solver_inc_ref and Z3_solver_dec_ref to manage solver objects. Even if the context was created using Z3_mk_context instead of Z3_mk_context_rc.

Referenced by solver::solver().

Z3_solver Z3_API Z3_mk_solver_for_logic ( Z3_context  c,
Z3_symbol  logic 
)

Create a new solver customized for the given logic. It behaves like Z3_mk_solver if the logic is unknown or unsupported.

Remarks
User must use Z3_solver_inc_ref and Z3_solver_dec_ref to manage solver objects. Even if the context was created using Z3_mk_context instead of Z3_mk_context_rc.

Referenced by solver::solver(), and z3py::SolverFor().

Z3_solver Z3_API Z3_mk_solver_from_tactic ( Z3_context  c,
Z3_tactic  t 
)

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.

Referenced by tactic::mk_solver(), and Tactic::solver().

Z3_ast Z3_API Z3_mk_store ( Z3_context  c,
Z3_ast  a,
Z3_ast  i,
Z3_ast  v 
)

Array update.

The node a must have an array sort [domain -> range], i must have sort domain, v must have sort range. The sort of the result is [domain -> range]. 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 a (with respect to select) on all indices except for i, where it maps to v (and the select of a with respect to i may be a different value).

See also
Z3_mk_array_sort
Z3_mk_select

Referenced by z3::store().

Z3_symbol Z3_API Z3_mk_string_symbol ( Z3_context  c,
Z3_string  s 
)

Create a Z3 symbol using a C string.

Symbols are used to name several term and type constructors.

See also
Z3_mk_int_symbol

Referenced by context::enumeration_sort(), context::str_symbol(), z3py::to_symbol(), and context::uninterpreted_sort().

Z3_ast Z3_API Z3_mk_sub ( Z3_context  c,
unsigned  num_args,
Z3_ast const  args[] 
)

Create an AST node representing args[0] - ... - args[num_args - 1].The array args must have num_args elements. All arguments must have int or real sort.

Remarks
The number of arguments must be greater than zero.
Z3_tactic Z3_API Z3_mk_tactic ( Z3_context  c,
Z3_string  name 
)

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 (help-tactics) in the SMT 2.0 front-end.

Tactics are the basic building block for creating custom solvers for specific problem domains.

Referenced by tactic::tactic().

Z3_theory Z3_API Z3_mk_theory ( Z3_context  c,
Z3_string  th_name,
Z3_theory_data  data 
)

Create a new user defined theory. The new theory will be identified by the name th_name. A theory must be created before asserting any assertion to the given context. Return NULL in case of failure.

data is a pointer to an external data-structure that may be used to store theory specific additional data.

Z3_ast Z3_API Z3_mk_true ( Z3_context  c)

Create an AST node representing true.

Referenced by context::bool_val().

Z3_sort Z3_API Z3_mk_tuple_sort ( Z3_context  c,
Z3_symbol  mk_tuple_name,
unsigned  num_fields,
Z3_symbol const  field_names[],
Z3_sort const  field_sorts[],
Z3_func_decl *  mk_tuple_decl,
Z3_func_decl  proj_decl[] 
)

Create a tuple type.

A tuple with n fields has a constructor and n projections. This function will also declare the constructor and projection functions.

Parameters
clogical context
mk_tuple_namename of the constructor function associated with the tuple type.
num_fieldsnumber of fields in the tuple type.
field_namesname of the projection functions.
field_sortstype of the tuple fields.
mk_tuple_decloutput parameter that will contain the constructor declaration.
proj_decloutput parameter that will contain the projection function declarations. This field must be a buffer of size num_fields allocated by the user.
Z3_ast Z3_API Z3_mk_unary_minus ( Z3_context  c,
Z3_ast  arg 
)

Create an AST node representing -arg.The arguments must have int or real type.

Z3_sort Z3_API Z3_mk_uninterpreted_sort ( Z3_context  c,
Z3_symbol  s 
)

Create a free (uninterpreted) type using the given name (symbol).

Two free types are considered the same iff the have the same name.

Referenced by z3py::DeclareSort(), and context::uninterpreted_sort().

Z3_ast Z3_API Z3_mk_unsigned_int ( Z3_context  c,
unsigned  v,
Z3_sort  ty 
)

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.

See also
Z3_mk_numeral

Referenced by context::bv_val(), context::int_val(), and context::real_val().

Z3_ast Z3_API Z3_mk_unsigned_int64 ( Z3_context  c,
unsigned __int64  v,
Z3_sort  ty 
)

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.

See also
Z3_mk_numeral

Referenced by context::bv_val(), context::int_val(), and context::real_val().

Z3_ast Z3_API Z3_mk_xor ( Z3_context  c,
Z3_ast  t1,
Z3_ast  t2 
)

Create an AST node representing t1 xor t2.

The nodes t1 and t2 must have Boolean sort.

Z3_ast Z3_API Z3_mk_zero_ext ( Z3_context  c,
unsigned  i,
Z3_ast  t1 
)

Extend the given bit-vector with zeros to the (unsigned) equivalent bitvector of size m+i, where m is the size of the given bit-vector.

The node t1 must have a bit-vector sort.

void Z3_API Z3_model_dec_ref ( Z3_context  c,
Z3_model  m 
)

Decrement the reference counter of the given model.

Referenced by model::operator=(), and model::~model().

Z3_bool Z3_API Z3_model_eval ( Z3_context  c,
Z3_model  m,
Z3_ast  t,
Z3_bool  model_completion,
Z3_ast *  v 
)

Evaluate the AST node t in the given model. Return Z3_TRUE if succeeded, and store the result in v.If model_completion is Z3_TRUE, then Z3 will assign an interpretation for any constant or function that does not have an interpretation in m. These constants and functions were essentially don't cares.

The evaluation may fail for the following reasons:

  • t contains a quantifier.
  • the model m is partial, that is, it doesn't have a complete interpretation for uninterpreted functions. That is, the option MODEL_PARTIAL=true was used.
  • t is type incorrect.

Referenced by model::eval().

Z3_func_decl Z3_API Z3_model_get_const_decl ( Z3_context  c,
Z3_model  m,
unsigned  i 
)

Return the i-th constant in the given model.

Precondition
i < Z3_model_get_num_consts(c, m)
See also
Z3_model_eval

Referenced by model::get_const_decl().

Z3_ast Z3_API Z3_model_get_const_interp ( Z3_context  c,
Z3_model  m,
Z3_func_decl  a 
)

Return the interpretation (i.e., assignment) of constant a in the model m. Return NULL, if the model does not assign an interpretation for a. That should be interpreted as: the value of a does not matter.

Precondition
Z3_get_arity(c, a) == 0

Referenced by model::get_const_interp().

Z3_func_decl Z3_API Z3_model_get_func_decl ( Z3_context  c,
Z3_model  m,
unsigned  i 
)

Return the declaration of the i-th function in the given model.

Precondition
i < Z3_model_get_num_funcs(c, m)
See also
Z3_model_get_num_funcs

Referenced by model::get_func_decl().

Z3_func_interp Z3_API Z3_model_get_func_interp ( Z3_context  c,
Z3_model  m,
Z3_func_decl  f 
)

Return the interpretation of the function f in the model m. Return NULL, if the model does not assign an interpretation for f. That should be interpreted as: the f does not matter.

Precondition
Z3_get_arity(c, f) > 0
Remarks
Reference counting must be used to manage Z3_func_interp objects, even when the Z3_context was created using Z3_mk_context instead of Z3_mk_context_rc.

Referenced by model::get_func_interp().

unsigned Z3_API Z3_model_get_num_consts ( Z3_context  c,
Z3_model  m 
)

Return the number of constants assigned by the given model.

See also
Z3_model_get_const_decl

Referenced by model::num_consts().

unsigned Z3_API Z3_model_get_num_funcs ( Z3_context  c,
Z3_model  m 
)

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.

Referenced by model::num_funcs().

unsigned Z3_API Z3_model_get_num_sorts ( Z3_context  c,
Z3_model  m 
)

Return the number of uninterpreted sorts that m assigs an interpretation to.

Z3 also provides an intepretation for uninterpreted sorts used in a formua. The interpretation for a sort s is a finite set of distinct values. We say this finite set is the "universe" of s.

See also
Z3_model_get_sort
Z3_model_get_sort_universe
Z3_sort Z3_API Z3_model_get_sort ( Z3_context  c,
Z3_model  m,
unsigned  i 
)

Return a uninterpreted sort that m assigns an interpretation.

Precondition
i < Z3_model_get_num_sorts(c, m)
See also
Z3_model_get_num_sorts
Z3_model_get_sort_universe
Z3_ast_vector Z3_API Z3_model_get_sort_universe ( Z3_context  c,
Z3_model  m,
Z3_sort  s 
)

Return the finite set of distinct values that represent the interpretation for sort s.

See also
Z3_model_get_num_sorts
Z3_model_get_sort
Z3_bool Z3_API Z3_model_has_interp ( Z3_context  c,
Z3_model  m,
Z3_func_decl  a 
)

Test if there exists an interpretation (i.e., assignment) for a in the model m.

void Z3_API Z3_model_inc_ref ( Z3_context  c,
Z3_model  m 
)

Increment the reference counter of the given model.

Referenced by model::operator=().

Z3_string Z3_API Z3_model_to_string ( Z3_context  c,
Z3_model  m 
)

Convert the given model into a string.

Warning
The result buffer is statically allocated by Z3. It will be automatically deallocated when Z3_del_context is invoked. So, the buffer is invalidated in the next call to Z3_model_to_string.
Z3_bool Z3_API Z3_open_log ( Z3_string  filename)

Log interaction to a file.

Referenced by z3py::open_log().

void Z3_API Z3_optimize_assert ( Z3_context  c,
Z3_optimize  o,
Z3_ast  a 
)

Assert hard constraint to the optimization context.

Referenced by optimize::add(), and Optimize::assert_exprs().

unsigned Z3_API Z3_optimize_assert_soft ( Z3_context  c,
Z3_optimize  o,
Z3_ast  a,
Z3_string  weight,
Z3_symbol  id 
)

Assert soft constraint to the optimization context.

Parameters
c- context
o- optimization context
a- formula
weight- a positive weight, penalty for violating soft constraint
id- optional identifier to group soft constraints

Referenced by optimize::add(), and Optimize::add_soft().

Z3_lbool Z3_API Z3_optimize_check ( Z3_context  c,
Z3_optimize  o 
)

Check consistency and produce optimal values.

Parameters
c- context
o- optimization context

Referenced by optimize::check(), and Optimize::check().

void Z3_API Z3_optimize_dec_ref ( Z3_context  c,
Z3_optimize  d 
)

Decrement the reference counter of the given optimize context.

Referenced by Optimize::__del__(), and optimize::~optimize().

Z3_string Z3_API Z3_optimize_get_help ( Z3_context  c,
Z3_optimize  t 
)

Return a string containing a description of parameters accepted by optimize.

Referenced by optimize::help(), and Optimize::help().

Z3_ast Z3_API Z3_optimize_get_lower ( Z3_context  c,
Z3_optimize  o,
unsigned  idx 
)

Retrieve lower bound value or approximation for the i'th optimization objective.

Parameters
c- context
o- optimization context
idx- index of optimization objective

Referenced by optimize::lower(), and OptimizeObjective::lower().

Z3_model Z3_API Z3_optimize_get_model ( Z3_context  c,
Z3_optimize  o 
)

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 Z3_L_FALSE.

Referenced by optimize::get_model(), and Optimize::model().

Z3_param_descrs Z3_API Z3_optimize_get_param_descrs ( Z3_context  c,
Z3_optimize  o 
)

Return the parameter description set for the given optimize object.

Parameters
c- context
o- optimization context

Referenced by Optimize::param_descrs().

Z3_string Z3_API Z3_optimize_get_reason_unknown ( Z3_context  c,
Z3_optimize  d 
)

Retrieve a string that describes the last status returned by Z3_optimize_check.

Use this method when Z3_optimize_check returns Z3_L_UNDEF.

Referenced by Optimize::reason_unknown().

Z3_stats Z3_API Z3_optimize_get_statistics ( Z3_context  c,
Z3_optimize  d 
)

Retrieve statistics information from the last call to Z3_optimize_check.

Referenced by optimize::statistics(), and Optimize::statistics().

Z3_ast Z3_API Z3_optimize_get_upper ( Z3_context  c,
Z3_optimize  o,
unsigned  idx 
)

Retrieve upper bound value or approximation for the i'th optimization objective.

Parameters
c- context
o- optimization context
idx- index of optimization objective

Referenced by optimize::upper(), and OptimizeObjective::upper().

void Z3_API Z3_optimize_inc_ref ( Z3_context  c,
Z3_optimize  d 
)

Increment the reference counter of the given optimize context.

Referenced by optimize::optimize().

unsigned Z3_API Z3_optimize_maximize ( Z3_context  c,
Z3_optimize  o,
Z3_ast  t 
)

Add a maximization constraint.

Parameters
c- context
o- optimization context
a- arithmetical term

Referenced by optimize::maximize(), and Optimize::maximize().

unsigned Z3_API Z3_optimize_minimize ( Z3_context  c,
Z3_optimize  o,
Z3_ast  t 
)

Add a minimization constraint.

Parameters
c- context
o- optimization context
a- arithmetical term

Referenced by optimize::minimize(), and Optimize::minimize().

void Z3_API Z3_optimize_pop ( Z3_context  c,
Z3_optimize  d 
)

Backtrack one level.

See also
Z3_optimize_push
Precondition
The number of calls to pop cannot exceed calls to push.

Referenced by optimize::pop(), and Optimize::pop().

void Z3_API Z3_optimize_push ( Z3_context  c,
Z3_optimize  d 
)

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.

See also
Z3_optimize_pop

Referenced by optimize::push(), and Optimize::push().

void Z3_API Z3_optimize_set_params ( Z3_context  c,
Z3_optimize  o,
Z3_params  p 
)

Set parameters on optimization context.

Parameters
c- context
o- optimization context
p- parameters

Referenced by optimize::set(), and Optimize::set().

Z3_string Z3_API Z3_optimize_to_string ( Z3_context  c,
Z3_optimize  o 
)

Print the current context as a string.

Parameters
c- context.
o- optimization context.

Referenced by Optimize::sexpr().

void Z3_API Z3_param_descrs_dec_ref ( Z3_context  c,
Z3_param_descrs  p 
)

Decrement the reference counter of the given parameter description set.

Z3_param_kind Z3_API Z3_param_descrs_get_kind ( Z3_context  c,
Z3_param_descrs  p,
Z3_symbol  n 
)

Return the kind associated with the given parameter name n.

Z3_symbol Z3_API Z3_param_descrs_get_name ( Z3_context  c,
Z3_param_descrs  p,
unsigned  i 
)

Return the number of parameters in the given parameter description set.

Precondition
i < Z3_param_descrs_size(c, p)
void Z3_API Z3_param_descrs_inc_ref ( Z3_context  c,
Z3_param_descrs  p 
)

Increment the reference counter of the given parameter description set.

unsigned Z3_API Z3_param_descrs_size ( Z3_context  c,
Z3_param_descrs  p 
)

Return the number of parameters in the given parameter description set.

Z3_string Z3_API Z3_param_descrs_to_string ( Z3_context  c,
Z3_param_descrs  p 
)

Convert a parameter description set into a string. This function is mainly used for printing the contents of a parameter description set.

void Z3_API Z3_params_dec_ref ( Z3_context  c,
Z3_params  p 
)

Decrement the reference counter of the given parameter set.

Referenced by params::operator=(), and params::~params().

void Z3_API Z3_params_inc_ref ( Z3_context  c,
Z3_params  p 
)

Increment the reference counter of the given parameter set.

Referenced by params::operator=(), and params::params().

void Z3_API Z3_params_set_bool ( Z3_context  c,
Z3_params  p,
Z3_symbol  k,
Z3_bool  v 
)

Add a Boolean parameter k with value v to the parameter set p.

Referenced by params::set().

void Z3_API Z3_params_set_double ( Z3_context  c,
Z3_params  p,
Z3_symbol  k,
double  v 
)

Add a double parameter k with value v to the parameter set p.

Referenced by params::set().

void Z3_API Z3_params_set_symbol ( Z3_context  c,
Z3_params  p,
Z3_symbol  k,
Z3_symbol  v 
)

Add a symbol parameter k with value v to the parameter set p.

Referenced by params::set().

void Z3_API Z3_params_set_uint ( Z3_context  c,
Z3_params  p,
Z3_symbol  k,
unsigned  v 
)

Add a unsigned parameter k with value v to the parameter set p.

Referenced by params::set().

Z3_string Z3_API Z3_params_to_string ( Z3_context  c,
Z3_params  p 
)

Convert a parameter set into a string. This function is mainly used for printing the contents of a parameter set.

void Z3_API Z3_params_validate ( Z3_context  c,
Z3_params  p,
Z3_param_descrs  d 
)

Validate the parameter set p against the parameter description set d.

The procedure invokes the error handler if p is invalid.

Z3_ast Z3_API Z3_parse_smtlib2_file ( Z3_context  c,
Z3_string  file_name,
unsigned  num_sorts,
Z3_symbol const  sort_names[],
Z3_sort const  sorts[],
unsigned  num_decls,
Z3_symbol const  decl_names[],
Z3_func_decl const  decls[] 
)

Similar to Z3_parse_smtlib2_string, but reads the benchmark from a file.

Z3_ast Z3_API Z3_parse_smtlib2_string ( Z3_context  c,
Z3_string  str,
unsigned  num_sorts,
Z3_symbol const  sort_names[],
Z3_sort const  sorts[],
unsigned  num_decls,
Z3_symbol const  decl_names[],
Z3_func_decl const  decls[] 
)

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.

void Z3_API Z3_parse_smtlib_file ( Z3_context  c,
Z3_string  file_name,
unsigned  num_sorts,
Z3_symbol const  sort_names[],
Z3_sort const  sorts[],
unsigned  num_decls,
Z3_symbol const  decl_names[],
Z3_func_decl const  decls[] 
)

Similar to Z3_parse_smtlib_string, but reads the benchmark from a file.

void Z3_API Z3_parse_smtlib_string ( Z3_context  c,
Z3_string  str,
unsigned  num_sorts,
Z3_symbol const  sort_names[],
Z3_sort const  sorts[],
unsigned  num_decls,
Z3_symbol const  decl_names[],
Z3_func_decl const  decls[] 
)

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 sort_names and decl_names don't need to match the names of the sorts and declarations in the arrays sorts and 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 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.

Z3_ast Z3_API Z3_pattern_to_ast ( Z3_context  c,
Z3_pattern  p 
)

Convert a Z3_pattern into Z3_ast. This is just type casting.

Z3_string Z3_API Z3_pattern_to_string ( Z3_context  c,
Z3_pattern  p 
)
void Z3_API Z3_persist_ast ( Z3_context  c,
Z3_ast  a,
unsigned  num_scopes 
)

Persist AST through num_scopes pops. This function is only relevant if c was created using Z3_mk_context. If c was created using Z3_mk_context_rc, this function is a NOOP.

Normally, for contexts created using Z3_mk_context, references to terms are no longer valid when popping scopes beyond the level where the terms are created. If you want to reference a term below the scope where it was created, use this method to specify how many pops the term should survive. The num_scopes should be at most equal to the number of calls to Z3_push subtracted with the calls to Z3_pop.

Deprecated:
Z3 users should move to Z3_mk_context_rc and use the reference counting APIs for managing AST nodes.
Z3_ast_vector Z3_API Z3_polynomial_subresultants ( Z3_context  c,
Z3_ast  p,
Z3_ast  q,
Z3_ast  x 
)

Return the nonzero subresultants of p and q with respect to the "variable" x.

Precondition
p, q and x are Z3 expressions where p and q are arithmetic terms. Note that, any subterm that cannot be viewed as a polynomial is assumed to be a variable. Example: f(a) is a considered to be a variable in the polynomial

f(a)*f(a) + 2*f(a) + 1

void Z3_API Z3_pop ( Z3_context  c,
unsigned  num_scopes 
)

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 Z3_pop operators are flushed, and the context is completely restored to what it was right before the Z3_push.

See also
Z3_push
Deprecated:
Subsumed by Z3_solver_pop
Z3_probe Z3_API Z3_probe_and ( Z3_context  x,
Z3_probe  p1,
Z3_probe  p2 
)

Return a probe that evaluates to "true" when p1 and p2 evaluates to true.

Remarks
For probes, "true" is any value different from 0.0.
double Z3_API Z3_probe_apply ( Z3_context  c,
Z3_probe  p,
Z3_goal  g 
)

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.

Referenced by Probe::__call__(), and probe::apply().

Z3_probe Z3_API Z3_probe_const ( Z3_context  x,
double  val 
)

Return a probe that always evaluates to val.

Referenced by probe::probe().

void Z3_API Z3_probe_dec_ref ( Z3_context  c,
Z3_probe  p 
)

Decrement the reference counter of the given probe.

Referenced by Probe::__del__(), probe::operator=(), and probe::~probe().

Z3_probe Z3_API Z3_probe_eq ( Z3_context  x,
Z3_probe  p1,
Z3_probe  p2 
)

Return a probe that evaluates to "true" when the value returned by p1 is equal to the value returned by p2.

Remarks
For probes, "true" is any value different from 0.0.

Referenced by Probe::__eq__().

Z3_probe Z3_API Z3_probe_ge ( Z3_context  x,
Z3_probe  p1,
Z3_probe  p2 
)

Return a probe that evaluates to "true" when the value returned by p1 is greater than or equal to the value returned by p2.

Remarks
For probes, "true" is any value different from 0.0.

Referenced by Probe::__ge__().

Z3_string Z3_API Z3_probe_get_descr ( Z3_context  c,
Z3_string  name 
)

Return a string containing a description of the probe with the given name.

Referenced by z3py::probe_description().

Z3_probe Z3_API Z3_probe_gt ( Z3_context  x,
Z3_probe  p1,
Z3_probe  p2 
)

Return a probe that evaluates to "true" when the value returned by p1 is greater than the value returned by p2.

Remarks
For probes, "true" is any value different from 0.0.

Referenced by Probe::__gt__().

void Z3_API Z3_probe_inc_ref ( Z3_context  c,
Z3_probe  p 
)

Increment the reference counter of the given probe.

Referenced by probe::operator=().

Z3_probe Z3_API Z3_probe_le ( Z3_context  x,
Z3_probe  p1,
Z3_probe  p2 
)

Return a probe that evaluates to "true" when the value returned by p1 is less than or equal to the value returned by p2.

Remarks
For probes, "true" is any value different from 0.0.

Referenced by Probe::__le__().

Z3_probe Z3_API Z3_probe_lt ( Z3_context  x,
Z3_probe  p1,
Z3_probe  p2 
)

Return a probe that evaluates to "true" when the value returned by p1 is less than the value returned by p2.

Remarks
For probes, "true" is any value different from 0.0.

Referenced by Probe::__lt__().

Z3_probe Z3_API Z3_probe_not ( Z3_context  x,
Z3_probe  p 
)

Return a probe that evaluates to "true" when p does not evaluate to true.

Remarks
For probes, "true" is any value different from 0.0.

Referenced by Probe::__ne__().

Z3_probe Z3_API Z3_probe_or ( Z3_context  x,
Z3_probe  p1,
Z3_probe  p2 
)

Return a probe that evaluates to "true" when p1 or p2 evaluates to true.

Remarks
For probes, "true" is any value different from 0.0.
void Z3_API Z3_push ( Z3_context  c)

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.

See also
Z3_pop
Deprecated:
Subsumed by Z3_solver_push
void Z3_API Z3_query_constructor ( Z3_context  c,
Z3_constructor  constr,
unsigned  num_fields,
Z3_func_decl *  constructor,
Z3_func_decl *  tester,
Z3_func_decl  accessors[] 
)

Query constructor for declared functions.

Parameters
clogical context.
constrconstructor container. The container must have been passed in to a Z3_mk_datatype call.
num_fieldsnumber of accessor fields in the constructor.
constructorconstructor function declaration.
testerconstructor test function declaration.
accessorsarray of accessor function declarations.
Z3_rcf_num Z3_API Z3_rcf_add ( Z3_context  c,
Z3_rcf_num  a,
Z3_rcf_num  b 
)

Return the value a + b.

void Z3_API Z3_rcf_del ( Z3_context  c,
Z3_rcf_num  a 
)

Delete a RCF numeral created using the RCF API.

Z3_rcf_num Z3_API Z3_rcf_div ( Z3_context  c,
Z3_rcf_num  a,
Z3_rcf_num  b 
)

Return the value a / b.

Z3_bool Z3_API Z3_rcf_eq ( Z3_context  c,
Z3_rcf_num  a,
Z3_rcf_num  b 
)

Return Z3_TRUE if a == b.

Z3_bool Z3_API Z3_rcf_ge ( Z3_context  c,
Z3_rcf_num  a,
Z3_rcf_num  b 
)

Return Z3_TRUE if a >= b.

void Z3_API Z3_rcf_get_numerator_denominator ( Z3_context  c,
Z3_rcf_num  a,
Z3_rcf_num *  n,
Z3_rcf_num *  d 
)

Extract the "numerator" and "denominator" of the given RCF numeral. We have that a = n/d, moreover n and d are not represented using rational functions.

Z3_bool Z3_API Z3_rcf_gt ( Z3_context  c,
Z3_rcf_num  a,
Z3_rcf_num  b 
)

Return Z3_TRUE if a > b.

Z3_rcf_num Z3_API Z3_rcf_inv ( Z3_context  c,
Z3_rcf_num  a 
)

Return the value 1/a.

Z3_bool Z3_API Z3_rcf_le ( Z3_context  c,
Z3_rcf_num  a,
Z3_rcf_num  b 
)

Return Z3_TRUE if a <= b.

Z3_bool Z3_API Z3_rcf_lt ( Z3_context  c,
Z3_rcf_num  a,
Z3_rcf_num  b 
)

Return Z3_TRUE if a < b.

Z3_rcf_num Z3_API Z3_rcf_mk_e ( Z3_context  c)

Return e (Euler's constant)

Z3_rcf_num Z3_API Z3_rcf_mk_infinitesimal ( Z3_context  c)

Return a new infinitesimal that is smaller than all elements in the Z3 field.

Z3_rcf_num Z3_API Z3_rcf_mk_pi ( Z3_context  c)

Return Pi.

Z3_rcf_num Z3_API Z3_rcf_mk_rational ( Z3_context  c,
Z3_string  val 
)

Return a RCF rational using the given string.

unsigned Z3_API Z3_rcf_mk_roots ( Z3_context  c,
unsigned  n,
Z3_rcf_num const  a[],
Z3_rcf_num  roots[] 
)

Store in roots the roots of the polynomial a[n-1]*x^{n-1} + ... + a[0]. The output vector roots must have size n. It returns the number of roots of the polynomial.

Precondition
The input polynomial is not the zero polynomial.
Z3_rcf_num Z3_API Z3_rcf_mk_small_int ( Z3_context  c,
int  val 
)

Return a RCF small integer.

Z3_rcf_num Z3_API Z3_rcf_mul ( Z3_context  c,
Z3_rcf_num  a,
Z3_rcf_num  b 
)

Return the value a * b.

Z3_rcf_num Z3_API Z3_rcf_neg ( Z3_context  c,
Z3_rcf_num  a 
)

Return the value -a.

Z3_bool Z3_API Z3_rcf_neq ( Z3_context  c,
Z3_rcf_num  a,
Z3_rcf_num  b 
)

Return Z3_TRUE if a != b.

Z3_string Z3_API Z3_rcf_num_to_decimal_string ( Z3_context  c,
Z3_rcf_num  a,
unsigned  prec 
)

Convert the RCF numeral into a string in decimal notation.

Z3_string Z3_API Z3_rcf_num_to_string ( Z3_context  c,
Z3_rcf_num  a,
Z3_bool  compact,
Z3_bool  html 
)

Convert the RCF numeral into a string.

Z3_rcf_num Z3_API Z3_rcf_power ( Z3_context  c,
Z3_rcf_num  a,
unsigned  k 
)

Return the value a^k.

Z3_rcf_num Z3_API Z3_rcf_sub ( Z3_context  c,
Z3_rcf_num  a,
Z3_rcf_num  b 
)

Return the value a - b.

int Z3_API Z3_read_interpolation_problem ( Z3_context  ctx,
unsigned *  num,
Z3_ast *  cnsts[],
unsigned *  parents[],
Z3_string  filename,
Z3_string_ptr  error,
unsigned *  num_theory,
Z3_ast *  theory[] 
)

Read an interpolation problem from file.

Parameters
ctxThe Z3 context. This resets the error handler of ctx.
filenameThe file name to read.
numReturns length of sequence.
cnstsReturns sequence of formulas (do not free)
parentsReturns the parents vector (or NULL for sequence)
errorReturns an error message in case of failure (do not free the string)
num_theoryNumber of theory terms
theoryTheory terms

Returns true on success.

File formats: Currently two formats are supported, based on SMT-LIB2. For sequence interpolants, the sequence of constraints is represented by the sequence of "assert" commands in the file.

For tree interpolants, one symbol of type bool is associated to each vertex of the tree. For each vertex v there is an "assert" of the form:

(implies (and c1 ... cn f) v)

where c1 .. cn are the children of v (which must precede v in the file) and f is the formula assiciated to node v. The last formula in the file is the root vertex, and is represented by the predicate "false".

A solution to a tree interpolation problem can be thought of as a valuation of the vertices that makes all the implications true where each value is represented using the common symbols between the formulas in the subtree and the remainder of the formulas.

void Z3_API Z3_reset_memory ( void  )

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.

void Z3_API Z3_set_ast_print_mode ( Z3_context  c,
Z3_ast_print_mode  mode 
)

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.

See also
Z3_ast_to_string
Z3_pattern_to_string
Z3_func_decl_to_string
void Z3_API Z3_set_delete_callback ( Z3_theory  t,
Z3_theory_callback_fptr  f 
)

Set a callback that is invoked when theory t is deleted. This callback should be used to delete external data-structures associated with the given theory.

The callback has the form f(t), where

  • t is the given theory
See also
Z3_mk_theory
Z3_theory_get_ext_data
void Z3_API Z3_set_error ( Z3_context  c,
Z3_error_code  e 
)

Set an error.

void Z3_API Z3_set_error_handler ( Z3_context  c,
Z3_error_handler  h 
)

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. To disable the use of the error handler, simply register with h=NULL.

Warning
Log files, created using Z3_open_log, may be potentially incomplete/incorrect if error handlers are used.
See also
Z3_get_error_code
void Z3_API Z3_set_final_check_callback ( Z3_theory  t,
Z3_theory_final_check_callback_fptr  f 
)

Set a callback that is invoked before Z3 starts building a model. A theory may use this callback to perform expensive operations.

The callback has the form f(t), where

  • t is the given theory

If the theory returns 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_init_search_callback ( Z3_theory  t,
Z3_theory_callback_fptr  f 
)

Set a callback that is invoked when Z3 starts searching for a satisfying assignment.

The callback has the form f(t), where

  • t is the given theory
Z3_bool Z3_API Z3_set_logic ( Z3_context  c,
Z3_string  logic 
)

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 Z3_TRUE if the logic was changed successfully, and Z3_FALSE otherwise.

Deprecated:
Subsumed by Z3_mk_solver_for_logic
void Z3_API Z3_set_new_app_callback ( Z3_theory  t,
Z3_theory_ast_callback_fptr  f 
)

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.

The callback has the form f(t, n), where

  • t is the given theory
  • n is a theory application, that is, an expression of the form g(...) where g is a theory operator.
Remarks
An expression n added to the logical context at search level n, will remain in the logical context until this level is backtracked.
void Z3_API Z3_set_new_assignment_callback ( Z3_theory  t,
Z3_theory_ast_bool_callback_fptr  f 
)

Set a callback that is invoked when a theory predicate is assigned to true/false by Z3.

The callback has the form f(t, p, v), where:

  • t is the given theory
  • p is the assigned predicate.
  • v is the value (true/false) assigned to p.
void Z3_API Z3_set_new_diseq_callback ( Z3_theory  t,
Z3_theory_ast_ast_callback_fptr  f 
)

Set a callback that is invoked when a disequality s_1 != s_2 is found by the logical context.

The callback has the form f(t, s_1, s_2), where:

  • t is the given theory
  • s_1 is the left-hand-side
  • s_2 is the right-hand-side
void Z3_API Z3_set_new_elem_callback ( Z3_theory  t,
Z3_theory_ast_callback_fptr  f 
)

Set a callback that is invoked when an expression of sort s, where s is an interpreted sort of the theory 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.

The callback has the form f(t, n), where

  • t is the given theory
  • n is an expression of sort s, where s is an interpreted sort of t.
Remarks
An expression n added to the logical context at search level n, will remain in the logical context until this level is backtracked.
void Z3_API Z3_set_new_eq_callback ( Z3_theory  t,
Z3_theory_ast_ast_callback_fptr  f 
)

Set a callback that is invoked when an equality s_1 = s_2 is found by the logical context.

The callback has the form f(t, s_1, s_2), where:

  • t is the given theory
  • s_1 is the left-hand-side
  • s_2 is the right-hand-side
void Z3_API Z3_set_new_relevant_callback ( Z3_theory  t,
Z3_theory_ast_callback_fptr  f 
)

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.

The callback has the form f(t, n), where:

  • t is the given theory
  • n is the relevant expression
void Z3_API Z3_set_param_value ( Z3_config  c,
Z3_string  param_id,
Z3_string  param_value 
)

Set a configuration parameter.

The following parameters can be set for

See also
Z3_mk_config

Referenced by Context::__init__(), and config::set().

void Z3_API Z3_set_pop_callback ( Z3_theory  t,
Z3_theory_callback_fptr  f 
)

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.

The callback has the form f(t), where

  • t is the given theory
void Z3_API Z3_set_push_callback ( Z3_theory  t,
Z3_theory_callback_fptr  f 
)

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.

The callback has the form f(t), where

  • t is the given theory
void Z3_API Z3_set_reduce_app_callback ( Z3_theory  t,
Z3_reduce_app_callback_fptr  f 
)

Set a callback for simplifying operators of the given theory. The callback f is invoked by Z3's simplifier.

It is of the form f(t, d, n, args, r), where:

  • t is the given theory
  • d is the declaration of the theory operator
  • n is the number of arguments in the array args
  • args are arguments for the theory operator
  • r should contain the result: an expression equivalent to d(args[0], ..., args[n-1]).

If f(t, d, n, args, r) returns false, then r is ignored, and Z3 assumes that no simplification was performed.

void Z3_API Z3_set_reduce_distinct_callback ( Z3_theory  t,
Z3_reduce_distinct_callback_fptr  f 
)

Set a callback for simplifying the atom distinct(s_1, ..., s_n), when the sort of s_1, ..., s_n is an interpreted sort of the given theory. The callback f is invoked by Z3's simplifier.

It has the form f(t, n, args, r), where:

  • t is the given theory
  • n is the number of arguments in the array args
  • args are arguments for distinct.
  • r should contain the result: an expression equivalent to distinct(s_1, ..., s_n).

If f(t, n, args, r) returns false, then r is ignored, and Z3 assumes that no simplification was performed.

void Z3_API Z3_set_reduce_eq_callback ( Z3_theory  t,
Z3_reduce_eq_callback_fptr  f 
)

Set a callback for simplifying the atom s_1 = s_2, when the sort of s_1 and s_2 is an interpreted sort of the given theory. The callback f is invoked by Z3's simplifier.

It has the form f(t, s_1, s_2, r), where:

  • t is the given theory
  • s_1 is the left-hand-side
  • s_2 is the right-hand-side
  • r should contain the result: an expression equivalent to s_1 = s_2.

If f(t, s_1, s_2, r) returns false, then r is ignored, and Z3 assumes that no simplification was performed.

void Z3_API Z3_set_reset_callback ( Z3_theory  t,
Z3_theory_callback_fptr  f 
)

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.

The callback has the form f(t), where

  • t is the given theory
void Z3_API Z3_set_restart_callback ( Z3_theory  t,
Z3_theory_callback_fptr  f 
)

Set a callback that is invoked when Z3 restarts the search for a satisfying assignment.

The callback has the form f(t), where

  • t is the given theory
Z3_ast Z3_API Z3_simplify ( Z3_context  c,
Z3_ast  a 
)

Interface to simplifier.

Provides an interface to the AST simplifier used by Z3.

Referenced by expr::simplify(), and z3py::simplify().

Z3_ast Z3_API Z3_simplify_ex ( Z3_context  c,
Z3_ast  a,
Z3_params  p 
)

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.

Referenced by expr::simplify(), and z3py::simplify().

Z3_string Z3_API Z3_simplify_get_help ( Z3_context  c)

Return a string describing all available parameters.

Referenced by z3py::help_simplify().

Z3_param_descrs Z3_API Z3_simplify_get_param_descrs ( Z3_context  c)

Return the parameter description set for the simplify procedure.

Referenced by z3py::simplify_param_descrs().

void Z3_API Z3_soft_check_cancel ( Z3_context  c)

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.
void Z3_API Z3_solver_assert ( Z3_context  c,
Z3_solver  s,
Z3_ast  a 
)

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.

Referenced by solver::add().

void Z3_API Z3_solver_assert_and_track ( Z3_context  c,
Z3_solver  s,
Z3_ast  a,
Z3_ast  p 
)

Assert a constraint a into the solver, and track it (in the unsat) core using the Boolean constant p.

This API is an alternative to Z3_solver_check_assumptions for extracting unsat cores. Both APIs can be used in the same solver. The unsat core will contain a combination of the Boolean variables provided using Z3_solver_assert_and_track and the Boolean literals provided using Z3_solver_check_assumptions.

Precondition
a must be a Boolean expression
p must be a Boolean constant (aka variable).

Referenced by solver::add().

Z3_lbool Z3_API Z3_solver_check ( Z3_context  c,
Z3_solver  s 
)

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 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 Z3_L_FALSE).

Referenced by solver::check().

Z3_lbool Z3_API Z3_solver_check_assumptions ( Z3_context  c,
Z3_solver  s,
unsigned  num_assumptions,
Z3_ast const  assumptions[] 
)

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.

See also
Z3_solver_check

Referenced by solver::check().

void Z3_API Z3_solver_dec_ref ( Z3_context  c,
Z3_solver  s 
)

Decrement the reference counter of the given solver.

Referenced by solver::operator=(), and solver::~solver().

Z3_ast_vector Z3_API Z3_solver_get_assertions ( Z3_context  c,
Z3_solver  s 
)

Return the set of asserted formulas as a goal object.

Referenced by solver::assertions().

Z3_string Z3_API Z3_solver_get_help ( Z3_context  c,
Z3_solver  s 
)

Return a string describing all solver available parameters.

Z3_model Z3_API Z3_solver_get_model ( Z3_context  c,
Z3_solver  s 
)

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 Z3_L_FALSE.

Referenced by solver::get_model().

unsigned Z3_API Z3_solver_get_num_scopes ( Z3_context  c,
Z3_solver  s 
)

Return the number of backtracking points.

See also
Z3_solver_push
Z3_solver_pop
Z3_param_descrs Z3_API Z3_solver_get_param_descrs ( Z3_context  c,
Z3_solver  s 
)

Return the parameter description set for the given solver object.

Z3_ast Z3_API Z3_solver_get_proof ( Z3_context  c,
Z3_solver  s 
)

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 Z3_L_FALSE.

Referenced by solver::proof().

Z3_string Z3_API Z3_solver_get_reason_unknown ( Z3_context  c,
Z3_solver  s 
)

Return a brief justification for an "unknown" result (i.e., Z3_L_UNDEF) for the commands Z3_solver_check and Z3_solver_check_assumptions.

Referenced by solver::reason_unknown().

Z3_stats Z3_API Z3_solver_get_statistics ( Z3_context  c,
Z3_solver  s 
)

Return statistics for the given solver.

Remarks
User must use Z3_stats_inc_ref and Z3_stats_dec_ref to manage Z3_stats objects.

Referenced by solver::statistics().

Z3_ast_vector Z3_API Z3_solver_get_unsat_core ( Z3_context  c,
Z3_solver  s 
)

Retrieve the unsat core for the last Z3_solver_check_assumptions The unsat core is a subset of the assumptions a.

Referenced by solver::unsat_core().

void Z3_API Z3_solver_inc_ref ( Z3_context  c,
Z3_solver  s 
)

Increment the reference counter of the given solver.

Referenced by solver::operator=().

void Z3_API Z3_solver_pop ( Z3_context  c,
Z3_solver  s,
unsigned  n 
)

Backtrack n backtracking points.

See also
Z3_solver_push
Precondition
n <= Z3_solver_get_num_scopes(c, s)

Referenced by solver::pop().

void Z3_API Z3_solver_push ( Z3_context  c,
Z3_solver  s 
)

Create a backtracking point.

The solver contains a stack of assertions.

See also
Z3_solver_pop

Referenced by solver::push().

void Z3_API Z3_solver_reset ( Z3_context  c,
Z3_solver  s 
)

Remove all assertions from the solver.

Referenced by solver::reset().

void Z3_API Z3_solver_set_params ( Z3_context  c,
Z3_solver  s,
Z3_params  p 
)

Set the given solver using the given parameters.

Referenced by solver::set().

Z3_string Z3_API Z3_solver_to_string ( Z3_context  c,
Z3_solver  s 
)

Convert a solver into a string.

Z3_ast Z3_API Z3_sort_to_ast ( Z3_context  c,
Z3_sort  s 
)

Convert a Z3_sort into Z3_ast. This is just type casting.

Referenced by SortRef::as_ast().

Z3_string Z3_API Z3_sort_to_string ( Z3_context  c,
Z3_sort  s 
)
Z3_string Z3_API Z3_statistics_to_string ( Z3_context  c)

Return runtime statistics as a string.

This function is mainly used for debugging purposes. It displays statistics of the search activity.

Warning
The result buffer is statically allocated by Z3. It will be automatically deallocated when Z3_del_context is invoked. So, the buffer is invalidated in the next call to 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.
void Z3_API Z3_stats_dec_ref ( Z3_context  c,
Z3_stats  s 
)

Decrement the reference counter of the given statistics object.

Referenced by stats::operator=(), and stats::~stats().

double Z3_API Z3_stats_get_double_value ( Z3_context  c,
Z3_stats  s,
unsigned  idx 
)

Return the double value of the given statistical data.

Precondition
idx < Z3_stats_size(c, s) && Z3_stats_is_double(c, s)

Referenced by stats::double_value().

Z3_string Z3_API Z3_stats_get_key ( Z3_context  c,
Z3_stats  s,
unsigned  idx 
)

Return the key (a string) for a particular statistical data.

Precondition
idx < Z3_stats_size(c, s)

Referenced by stats::key().

unsigned Z3_API Z3_stats_get_uint_value ( Z3_context  c,
Z3_stats  s,
unsigned  idx 
)

Return the unsigned value of the given statistical data.

Precondition
idx < Z3_stats_size(c, s) && Z3_stats_is_uint(c, s)

Referenced by stats::uint_value().

void Z3_API Z3_stats_inc_ref ( Z3_context  c,
Z3_stats  s 
)

Increment the reference counter of the given statistics object.

Referenced by stats::operator=().

Z3_bool Z3_API Z3_stats_is_double ( Z3_context  c,
Z3_stats  s,
unsigned  idx 
)

Return Z3_TRUE if the given statistical data is a double.

Precondition
idx < Z3_stats_size(c, s)

Referenced by stats::is_double().

Z3_bool Z3_API Z3_stats_is_uint ( Z3_context  c,
Z3_stats  s,
unsigned  idx 
)

Return Z3_TRUE if the given statistical data is a unsigned integer.

Precondition
idx < Z3_stats_size(c, s)

Referenced by stats::is_uint().

unsigned Z3_API Z3_stats_size ( Z3_context  c,
Z3_stats  s 
)

Return the number of statistical data in s.

Referenced by stats::size().

Z3_string Z3_API Z3_stats_to_string ( Z3_context  c,
Z3_stats  s 
)

Convert a statistics into a string.

Z3_ast Z3_API Z3_substitute ( Z3_context  c,
Z3_ast  a,
unsigned  num_exprs,
Z3_ast const  from[],
Z3_ast const  to[] 
)

Substitute every occurrence of from[i] in a with to[i], for i smaller than num_exprs. The result is the new AST. The arrays from and to must have size num_exprs. For every i smaller than num_exprs, we must have that sort of from[i] must be equal to sort of to[i].

Referenced by expr::substitute(), and z3py::substitute().

Z3_ast Z3_API Z3_substitute_vars ( Z3_context  c,
Z3_ast  a,
unsigned  num_exprs,
Z3_ast const  to[] 
)

Substitute the free variables in a with the expressions in to. For every i smaller than num_exprs, the variable with de-Bruijn index i is replaced with term to[i].

Referenced by expr::substitute(), and z3py::substitute_vars().

Z3_tactic Z3_API Z3_tactic_and_then ( Z3_context  c,
Z3_tactic  t1,
Z3_tactic  t2 
)

Return a tactic that applies t1 to a given goal and t2 to every subgoal produced by t1.

Referenced by Tactic::param_descrs().

Z3_apply_result Z3_API Z3_tactic_apply ( Z3_context  c,
Z3_tactic  t,
Z3_goal  g 
)

Apply tactic t to the goal g.

Referenced by tactic::apply(), and Tactic::apply().

Z3_apply_result Z3_API Z3_tactic_apply_ex ( Z3_context  c,
Z3_tactic  t,
Z3_goal  g,
Z3_params  p 
)

Apply tactic t to the goal g using the parameter set p.

Referenced by Tactic::apply().

Z3_tactic Z3_API Z3_tactic_cond ( Z3_context  c,
Z3_probe  p,
Z3_tactic  t1,
Z3_tactic  t2 
)

Return a tactic that applies t1 to a given goal if the probe p evaluates to true, and t2 if p evaluates to false.

Referenced by z3::cond(), and z3py::Cond().

void Z3_API Z3_tactic_dec_ref ( Z3_context  c,
Z3_tactic  g 
)

Decrement the reference counter of the given tactic.

Referenced by Tactic::__del__(), tactic::operator=(), and tactic::~tactic().

Z3_tactic Z3_API Z3_tactic_fail ( Z3_context  c)

Return a tactic that always fails.

Z3_tactic Z3_API Z3_tactic_fail_if ( Z3_context  c,
Z3_probe  p 
)

Return a tactic that fails if the probe p evaluates to false.

Referenced by z3::fail_if(), and z3py::FailIf().

Z3_tactic Z3_API Z3_tactic_fail_if_not_decided ( Z3_context  c)

Return a tactic that fails if the goal is not trivially satisfiable (i.e., empty) or trivially unsatisfiable (i.e., contains false).

Z3_string Z3_API Z3_tactic_get_descr ( Z3_context  c,
Z3_string  name 
)

Return a string containing a description of the tactic with the given name.

Referenced by z3py::tactic_description().

Z3_string Z3_API Z3_tactic_get_help ( Z3_context  c,
Z3_tactic  t 
)

Return a string containing a description of parameters accepted by the given tactic.

Referenced by tactic::help(), and Tactic::help().

Z3_param_descrs Z3_API Z3_tactic_get_param_descrs ( Z3_context  c,
Z3_tactic  t 
)

Return the parameter description set for the given tactic object.

Referenced by Tactic::param_descrs().

void Z3_API Z3_tactic_inc_ref ( Z3_context  c,
Z3_tactic  t 
)

Increment the reference counter of the given tactic.

Referenced by tactic::operator=().

Z3_tactic Z3_API Z3_tactic_or_else ( Z3_context  c,
Z3_tactic  t1,
Z3_tactic  t2 
)

Return a tactic that first applies t1 to a given goal, if it fails then returns the result of t2 applied to the given goal.

Referenced by Tactic::param_descrs().

Z3_tactic Z3_API Z3_tactic_par_and_then ( Z3_context  c,
Z3_tactic  t1,
Z3_tactic  t2 
)

Return a tactic that applies t1 to a given goal and then t2 to every subgoal produced by t1. The subgoals are processed in parallel.

Referenced by z3py::ParThen().

Z3_tactic Z3_API Z3_tactic_par_or ( Z3_context  c,
unsigned  num,
Z3_tactic const  ts[] 
)

Return a tactic that applies the given tactics in parallel.

Referenced by z3py::ParOr().

Z3_tactic Z3_API Z3_tactic_repeat ( Z3_context  c,
Z3_tactic  t,
unsigned  max 
)

Return a tactic that keeps applying t until the goal is not modified anymore or the maximum number of iterations max is reached.

Referenced by z3::repeat(), and z3py::Repeat().

Z3_tactic Z3_API Z3_tactic_skip ( Z3_context  c)

Return a tactic that just return the given goal.

Z3_tactic Z3_API Z3_tactic_try_for ( Z3_context  c,
Z3_tactic  t,
unsigned  ms 
)

Return a tactic that applies t to a given goal for ms milliseconds. If t does not terminate in ms milliseconds, then it fails.

Referenced by z3::try_for(), and z3py::TryFor().

Z3_tactic Z3_API Z3_tactic_using_params ( Z3_context  c,
Z3_tactic  t,
Z3_params  p 
)

Return a tactic that applies t using the given set of parameters.

Referenced by z3::with(), and z3py::With().

Z3_tactic Z3_API Z3_tactic_when ( Z3_context  c,
Z3_probe  p,
Z3_tactic  t 
)

Return a tactic that applies t to a given goal is the probe p evaluates to true. If p evaluates to false, then the new tactic behaves like the skip tactic.

Referenced by z3::when(), and z3py::When().

void Z3_API Z3_theory_assert_axiom ( Z3_theory  t,
Z3_ast  ax 
)

Assert a theory axiom/lemmas during the search.

An axiom added at search level n will remain in the logical context until level 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_assume_eq ( Z3_theory  t,
Z3_ast  lhs,
Z3_ast  rhs 
)

Inform to the logical context that lhs and rhs have the same interpretation in the model being built by theory 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_enable_axiom_simplification ( Z3_theory  t,
Z3_bool  flag 
)

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.

Z3_ast Z3_API Z3_theory_get_app ( Z3_theory  t,
unsigned  i 
)

Return the i-th application of the given theory in the logical context.

See also
Z3_theory_get_num_apps
Z3_context Z3_API Z3_theory_get_context ( Z3_theory  t)

Return the context where the given theory is installed.

Z3_ast Z3_API Z3_theory_get_elem ( Z3_theory  t,
unsigned  i 
)

Return the i-th elem of the given theory in the logical context.

See also
Z3_theory_get_num_elems
Z3_ast Z3_API Z3_theory_get_eqc_next ( Z3_theory  t,
Z3_ast  n 
)

Return the next element in the equivalence class containing 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.

1 Z3_ast curr = n;
2 do
3  curr = Z3_theory_get_eqc_next(theory, curr);
4 while (curr != n);
Z3_ast Z3_API Z3_theory_get_eqc_root ( Z3_theory  t,
Z3_ast  n 
)

Return the root of the equivalence class containing n.

Z3_theory_data Z3_API Z3_theory_get_ext_data ( Z3_theory  t)

Return a pointer to the external data-structure supplied to the function Z3_mk_theory.

See also
Z3_mk_theory
unsigned Z3_API Z3_theory_get_num_apps ( Z3_theory  t)

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_elems ( Z3_theory  t)

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_parents ( Z3_theory  t,
Z3_ast  n 
)

Return the number of parents of n that are operators of the given theory.

Z3_ast Z3_API Z3_theory_get_parent ( Z3_theory  t,
Z3_ast  n,
unsigned  i 
)

Return the i-th parent of n. See Z3_theory_get_num_parents.

Z3_bool Z3_API Z3_theory_is_decl ( Z3_theory  t,
Z3_func_decl  d 
)

Return Z3_TRUE if d is an interpreted theory declaration.

Z3_bool Z3_API Z3_theory_is_value ( Z3_theory  t,
Z3_ast  n 
)

Return Z3_TRUE if n is an interpreted theory value.

Z3_ast Z3_API Z3_theory_mk_constant ( Z3_context  c,
Z3_theory  t,
Z3_symbol  n,
Z3_sort  s 
)

Create an interpreted constant for the given theory.

Z3_func_decl Z3_API Z3_theory_mk_func_decl ( Z3_context  c,
Z3_theory  t,
Z3_symbol  n,
unsigned  domain_size,
Z3_sort const  domain[],
Z3_sort  range 
)

Create an interpreted function declaration for the given theory.

Z3_sort Z3_API Z3_theory_mk_sort ( Z3_context  c,
Z3_theory  t,
Z3_symbol  s 
)

Create an interpreted theory sort.

Z3_ast Z3_API Z3_theory_mk_value ( Z3_context  c,
Z3_theory  t,
Z3_symbol  n,
Z3_sort  s 
)

Create an interpreted theory constant value. Values are assumed to be different from each other.

Z3_app Z3_API Z3_to_app ( Z3_context  c,
Z3_ast  a 
)

Convert an ast into an APP_AST. This is just type casting.

Precondition
1 Z3_get_ast_kind(c, a) == \c Z3_APP_AST
Z3_func_decl Z3_API Z3_to_func_decl ( Z3_context  c,
Z3_ast  a 
)

Convert an AST into a FUNC_DECL_AST. This is just type casting.

Precondition
1 Z3_get_ast_kind(c, a) == Z3_FUNC_DECL_AST
void Z3_API Z3_toggle_warning_messages ( Z3_bool  enabled)

Enable/disable printing warning messages to the console.

Warnings are printed after passing true, warning messages are suppressed after calling this method with false.

Z3_ast Z3_API Z3_translate ( Z3_context  source,
Z3_ast  a,
Z3_context  target 
)

Translate/Copy the AST a from context source to context target. AST a must have been created using context source.

Precondition
source != target

Referenced by AstRef::translate().

void Z3_API Z3_update_param_value ( Z3_context  c,
Z3_string  param_id,
Z3_string  param_value 
)

Set a value of a context parameter.

See also
Z3_global_param_set

Referenced by context::set().

Z3_ast Z3_API Z3_update_term ( Z3_context  c,
Z3_ast  a,
unsigned  num_args,
Z3_ast const  args[] 
)

Update the arguments of term a using the arguments args. The number of arguments num_args should coincide with the number of arguments to a. If a is a quantifier, then num_args has to be 1.

void Z3_API Z3_write_interpolation_problem ( Z3_context  ctx,
unsigned  num,
Z3_ast  cnsts[],
unsigned  parents[],
Z3_string  filename,
unsigned  num_theory,
Z3_ast  theory[] 
)

Write an interpolation problem to file suitable for reading with Z3_read_interpolation_problem. The output file is a sequence of SMT-LIB2 format commands, suitable for reading with command-line Z3 or other interpolating solvers.

Parameters
ctxThe Z3 context. Must be generated by z3_mk_interpolation_context
numThe number of constraints in the sequence
cnstsArray of constraints
parentsThe parents vector (or NULL for sequence)
filenameThe file name to write
num_theoryNumber of theory terms
theoryTheory terms