Z3
 
Loading...
Searching...
No Matches
Public Member Functions | Data Fields | Protected Attributes
UserPropagateBase Class Reference

Public Member Functions

 __init__ (self, s, ctx=None)
 
 __del__ (self)
 
 ctx (self)
 
 ctx_ref (self)
 
 add_fixed (self, fixed)
 
 add_created (self, created)
 
 add_final (self, final)
 
 add_eq (self, eq)
 
 add_diseq (self, diseq)
 
 add_decide (self, decide)
 
 add_on_binding (self, binding)
 
 push (self)
 
 pop (self, num_scopes)
 
 fresh (self, new_ctx)
 
 add (self, e)
 
 next_split (self, t, idx, phase)
 
 propagate (self, e, ids, eqs=[])
 
 conflict (self, deps=[], eqs=[])
 

Data Fields

 solver
 
 fresh_ctx
 
 cb
 
 id
 
 fixed
 
 final
 
 eq
 
 diseq
 
 decide
 
 created
 
 binding
 

Protected Attributes

 _ctx
 

Detailed Description

Definition at line 12012 of file z3py.py.

Constructor & Destructor Documentation

◆ __init__()

__init__ (   self,
  s,
  ctx = None 
)

Definition at line 12021 of file z3py.py.

12021 def __init__(self, s, ctx=None):
12022 assert s is None or ctx is None
12023 ensure_prop_closures()
12024 self.solver = s
12025 self._ctx = None
12026 self.fresh_ctx = None
12027 self.cb = None
12028 self.id = _prop_closures.insert(self)
12029 self.fixed = None
12030 self.final = None
12031 self.eq = None
12032 self.diseq = None
12033 self.decide = None
12034 self.created = None
12035 self.binding = None
12036 if ctx:
12037 self.fresh_ctx = ctx
12038 if s:
12039 Z3_solver_propagate_init(self.ctx_ref(),
12040 s.solver,
12041 ctypes.c_void_p(self.id),
12042 _user_prop_push,
12043 _user_prop_pop,
12044 _user_prop_fresh)
12045
Z3_solver_propagate_init
void Z3_API Z3_solver_propagate_init(Z3_context c, Z3_solver s, void *user_context, Z3_push_eh push_eh, Z3_pop_eh pop_eh, Z3_fresh_eh fresh_eh)
register a user-propagator with the solver.

◆ __del__()

__del__ (   self)

Definition at line 12046 of file z3py.py.

12046 def __del__(self):
12047 if self._ctx:
12048 self._ctx.ctx = None
12049

Member Function Documentation

◆ add()

add (   self,
  e 
)

Definition at line 12131 of file z3py.py.

12131 def add(self, e):
12132 if self._ctx:
12133 raise Z3Exception("context already initialized")
12134 if self.solver:
12135 Z3_solver_propagate_register(self.ctx_ref(), self.solver.solver, e.ast)
12136 else:
12137 Z3_solver_propagate_register_cb(self.ctx_ref(), ctypes.c_void_p(self.cb), e.ast)
12138
Z3_solver_propagate_register_cb
void Z3_API Z3_solver_propagate_register_cb(Z3_context c, Z3_solver_callback cb, Z3_ast e)
register an expression to propagate on with the solver. Only expressions of type Bool and type Bit-Ve...
Z3_solver_propagate_register
void Z3_API Z3_solver_propagate_register(Z3_context c, Z3_solver s, Z3_ast e)
register an expression to propagate on with the solver. Only expressions of type Bool and type Bit-Ve...

Referenced by Solver.__iadd__().

◆ add_created()

add_created (   self,
  created 
)

Definition at line 12068 of file z3py.py.

12068 def add_created(self, created):
12069 if self.created:
12070 raise Z3Exception("created callback already registered")
12071 if self._ctx:
12072 raise Z3Exception("context already initialized")
12073 if self.solver:
12074 Z3_solver_propagate_created(self.ctx_ref(), self.solver.solver, _user_prop_created)
12075 self.created = created
12076
Z3_solver_propagate_created
void Z3_API Z3_solver_propagate_created(Z3_context c, Z3_solver s, Z3_created_eh created_eh)
register a callback when a new expression with a registered function is used by the solver The regist...

◆ add_decide()

add_decide (   self,
  decide 
)

Definition at line 12104 of file z3py.py.

12104 def add_decide(self, decide):
12105 if self.decide:
12106 raise Z3Exception("decide callback already registered")
12107 if self._ctx:
12108 raise Z3Exception("context already initialized")
12109 if self.solver:
12110 Z3_solver_propagate_decide(self.ctx_ref(), self.solver.solver, _user_prop_decide)
12111 self.decide = decide
12112
Z3_solver_propagate_decide
void Z3_API Z3_solver_propagate_decide(Z3_context c, Z3_solver s, Z3_decide_eh decide_eh)
register a callback when the solver decides to split on a registered expression. The callback may cha...

◆ add_diseq()

add_diseq (   self,
  diseq 
)

Definition at line 12095 of file z3py.py.

12095 def add_diseq(self, diseq):
12096 if self.diseq:
12097 raise Z3Exception("diseq callback already registered")
12098 if self._ctx:
12099 raise Z3Exception("context already initialized")
12100 if self.solver:
12101 Z3_solver_propagate_diseq(self.ctx_ref(), self.solver.solver, _user_prop_diseq)
12102 self.diseq = diseq
12103
Z3_solver_propagate_diseq
void Z3_API Z3_solver_propagate_diseq(Z3_context c, Z3_solver s, Z3_eq_eh eq_eh)
register a callback on expression dis-equalities.

◆ add_eq()

add_eq (   self,
  eq 
)

Definition at line 12086 of file z3py.py.

12086 def add_eq(self, eq):
12087 if self.eq:
12088 raise Z3Exception("eq callback already registered")
12089 if self._ctx:
12090 raise Z3Exception("context already initialized")
12091 if self.solver:
12092 Z3_solver_propagate_eq(self.ctx_ref(), self.solver.solver, _user_prop_eq)
12093 self.eq = eq
12094
Z3_solver_propagate_eq
void Z3_API Z3_solver_propagate_eq(Z3_context c, Z3_solver s, Z3_eq_eh eq_eh)
register a callback on expression equalities.

◆ add_final()

add_final (   self,
  final 
)

Definition at line 12077 of file z3py.py.

12077 def add_final(self, final):
12078 if self.final:
12079 raise Z3Exception("final callback already registered")
12080 if self._ctx:
12081 raise Z3Exception("context already initialized")
12082 if self.solver:
12083 Z3_solver_propagate_final(self.ctx_ref(), self.solver.solver, _user_prop_final)
12084 self.final = final
12085
Z3_solver_propagate_final
void Z3_API Z3_solver_propagate_final(Z3_context c, Z3_solver s, Z3_final_eh final_eh)
register a callback on final check. This provides freedom to the propagator to delay actions or imple...

◆ add_fixed()

add_fixed (   self,
  fixed 
)

Definition at line 12059 of file z3py.py.

12059 def add_fixed(self, fixed):
12060 if self.fixed:
12061 raise Z3Exception("fixed callback already registered")
12062 if self._ctx:
12063 raise Z3Exception("context already initialized")
12064 if self.solver:
12065 Z3_solver_propagate_fixed(self.ctx_ref(), self.solver.solver, _user_prop_fixed)
12066 self.fixed = fixed
12067
Z3_solver_propagate_fixed
void Z3_API Z3_solver_propagate_fixed(Z3_context c, Z3_solver s, Z3_fixed_eh fixed_eh)
register a callback for when an expression is bound to a fixed value. The supported expression types ...

◆ add_on_binding()

add_on_binding (   self,
  binding 
)

Definition at line 12113 of file z3py.py.

12113 def add_on_binding(self, binding):
12114 if self.binding:
12115 raise Z3Exception("binding callback already registered")
12116 if self._ctx:
12117 raise Z3Exception("context already initialized")
12118 if self.solver:
12119 Z3_solver_propagate_on_binding(self.ctx_ref(), self.solver.solver, _user_prop_binding)
12120 self.binding = binding
12121
Z3_solver_propagate_on_binding
void Z3_API Z3_solver_propagate_on_binding(Z3_context c, Z3_solver s, Z3_on_binding_eh on_binding_eh)
register a callback when the solver instantiates a quantifier. If the callback returns false,...

◆ conflict()

conflict (   self,
  deps = [],
  eqs = [] 
)

Definition at line 12158 of file z3py.py.

12158 def conflict(self, deps = [], eqs = []):
12159 self.propagate(BoolVal(False, self.ctx()), deps, eqs)

◆ ctx()

ctx (   self)

Definition at line 12050 of file z3py.py.

12050 def ctx(self):
12051 if self.fresh_ctx:
12052 return self.fresh_ctx
12053 else:
12054 return self.solver.ctx
12055

Referenced by ArithRef.__add__(), BitVecRef.__add__(), BitVecRef.__and__(), FuncDeclRef.__call__(), AstMap.__contains__(), AstRef.__copy__(), Goal.__copy__(), AstVector.__copy__(), FuncInterp.__copy__(), ModelRef.__copy__(), AstRef.__deepcopy__(), Datatype.__deepcopy__(), ParamsRef.__deepcopy__(), ParamDescrsRef.__deepcopy__(), Goal.__deepcopy__(), AstVector.__deepcopy__(), AstMap.__deepcopy__(), FuncEntry.__deepcopy__(), FuncInterp.__deepcopy__(), ModelRef.__deepcopy__(), Statistics.__deepcopy__(), Context.__del__(), AstRef.__del__(), ScopedConstructor.__del__(), ScopedConstructorList.__del__(), ParamsRef.__del__(), ParamDescrsRef.__del__(), Goal.__del__(), AstVector.__del__(), AstMap.__del__(), FuncEntry.__del__(), FuncInterp.__del__(), ModelRef.__del__(), Statistics.__del__(), Solver.__del__(), ArithRef.__div__(), BitVecRef.__div__(), ExprRef.__eq__(), ArithRef.__ge__(), BitVecRef.__ge__(), AstVector.__getitem__(), ModelRef.__getitem__(), Statistics.__getitem__(), AstMap.__getitem__(), ArithRef.__gt__(), BitVecRef.__gt__(), BitVecRef.__invert__(), ArithRef.__le__(), BitVecRef.__le__(), AstVector.__len__(), AstMap.__len__(), ModelRef.__len__(), Statistics.__len__(), BitVecRef.__lshift__(), ArithRef.__lt__(), BitVecRef.__lt__(), ArithRef.__mod__(), BitVecRef.__mod__(), BoolRef.__mul__(), ArithRef.__mul__(), BitVecRef.__mul__(), ExprRef.__ne__(), ArithRef.__neg__(), BitVecRef.__neg__(), BitVecRef.__or__(), ArithRef.__pow__(), ArithRef.__radd__(), BitVecRef.__radd__(), BitVecRef.__rand__(), ArithRef.__rdiv__(), BitVecRef.__rdiv__(), ParamsRef.__repr__(), ParamDescrsRef.__repr__(), AstMap.__repr__(), Statistics.__repr__(), BitVecRef.__rlshift__(), ArithRef.__rmod__(), BitVecRef.__rmod__(), ArithRef.__rmul__(), BitVecRef.__rmul__(), BitVecRef.__ror__(), ArithRef.__rpow__(), BitVecRef.__rrshift__(), BitVecRef.__rshift__(), ArithRef.__rsub__(), BitVecRef.__rsub__(), BitVecRef.__rxor__(), AstVector.__setitem__(), AstMap.__setitem__(), ArithRef.__sub__(), BitVecRef.__sub__(), BitVecRef.__xor__(), DatatypeSortRef.accessor(), ExprRef.arg(), FuncEntry.arg_value(), FuncInterp.arity(), Goal.as_expr(), Solver.assert_and_track(), Goal.assert_exprs(), Solver.assert_exprs(), QuantifierRef.body(), Solver.check(), Goal.convert_model(), AstRef.ctx_ref(), ExprRef.decl(), ModelRef.decls(), ArrayRef.default(), RatNumRef.denominator(), Goal.depth(), Goal.dimacs(), FuncDeclRef.domain(), ArraySortRef.domain_n(), FuncInterp.else_value(), FuncInterp.entry(), AstMap.erase(), ModelRef.eval(), Goal.get(), ParamDescrsRef.get_documentation(), ModelRef.get_interp(), Statistics.get_key_value(), ParamDescrsRef.get_kind(), ParamDescrsRef.get_name(), ModelRef.get_sort(), ModelRef.get_universe(), Goal.inconsistent(), AstMap.keys(), Statistics.keys(), Solver.model(), SortRef.name(), QuantifierRef.no_pattern(), FuncEntry.num_args(), FuncInterp.num_entries(), Solver.num_scopes(), ModelRef.num_sorts(), FuncDeclRef.params(), QuantifierRef.pattern(), AlgebraicNumRef.poly(), Solver.pop(), Goal.prec(), ModelRef.project(), ModelRef.project_with_witness(), Solver.push(), AstVector.push(), QuantifierRef.qid(), FuncDeclRef.range(), ArraySortRef.range(), DatatypeSortRef.recognizer(), Context.ref(), AstMap.reset(), Solver.reset(), AstVector.resize(), Solver.set(), ParamsRef.set(), Goal.sexpr(), AstVector.sexpr(), ModelRef.sexpr(), ParamDescrsRef.size(), Goal.size(), QuantifierRef.skolem_id(), AstVector.translate(), AstRef.translate(), Goal.translate(), ModelRef.translate(), ExprRef.update(), DatatypeRef.update_field(), ParamsRef.validate(), FuncEntry.value(), QuantifierRef.var_name(), and QuantifierRef.var_sort().

◆ ctx_ref()

ctx_ref (   self)

Definition at line 12056 of file z3py.py.

12056 def ctx_ref(self):
12057 return self.ctx().ref()
12058

Referenced by BitVecRef.__add__(), BitVecRef.__and__(), FuncDeclRef.__call__(), ArithRef.__div__(), BitVecRef.__div__(), SortRef.__eq__(), ExprRef.__eq__(), ArithRef.__ge__(), BitVecRef.__ge__(), ArithRef.__gt__(), BitVecRef.__gt__(), BitVecRef.__invert__(), ArithRef.__le__(), BitVecRef.__le__(), BitVecRef.__lshift__(), ArithRef.__lt__(), BitVecRef.__lt__(), ArithRef.__mod__(), BitVecRef.__mod__(), BitVecRef.__mul__(), SortRef.__ne__(), ExprRef.__ne__(), ArithRef.__neg__(), BitVecRef.__neg__(), BitVecRef.__or__(), ArithRef.__pow__(), BitVecRef.__radd__(), BitVecRef.__rand__(), ArithRef.__rdiv__(), BitVecRef.__rdiv__(), BitVecRef.__rlshift__(), ArithRef.__rmod__(), BitVecRef.__rmod__(), BitVecRef.__rmul__(), BitVecRef.__ror__(), ArithRef.__rpow__(), BitVecRef.__rrshift__(), BitVecRef.__rshift__(), BitVecRef.__rsub__(), BitVecRef.__rxor__(), BitVecRef.__sub__(), BitVecRef.__xor__(), DatatypeSortRef.accessor(), ExprRef.arg(), FuncDeclRef.arity(), IntNumRef.as_binary_string(), BitVecNumRef.as_binary_string(), RatNumRef.as_decimal(), AlgebraicNumRef.as_decimal(), IntNumRef.as_string(), RatNumRef.as_string(), BitVecNumRef.as_string(), QuantifierRef.body(), ExprRef.decl(), ArrayRef.default(), RatNumRef.denominator(), FuncDeclRef.domain(), ArraySortRef.domain_n(), AstRef.eq(), AstRef.get_id(), SortRef.get_id(), FuncDeclRef.get_id(), ExprRef.get_id(), PatternRef.get_id(), QuantifierRef.get_id(), AstRef.hash(), AlgebraicNumRef.index(), QuantifierRef.is_exists(), QuantifierRef.is_lambda(), FuncDeclRef.kind(), SortRef.name(), QuantifierRef.no_pattern(), ExprRef.num_args(), QuantifierRef.num_no_patterns(), QuantifierRef.num_patterns(), QuantifierRef.num_vars(), FuncDeclRef.params(), QuantifierRef.pattern(), AlgebraicNumRef.poly(), RatNumRef.py_value(), QuantifierRef.qid(), FuncDeclRef.range(), ArraySortRef.range(), DatatypeSortRef.recognizer(), AstRef.sexpr(), QuantifierRef.skolem_id(), ExprRef.update(), DatatypeRef.update_field(), QuantifierRef.var_name(), QuantifierRef.var_sort(), and QuantifierRef.weight().

◆ fresh()

fresh (   self,
  new_ctx 
)

Definition at line 12128 of file z3py.py.

12128 def fresh(self, new_ctx):
12129 raise Z3Exception("fresh needs to be overwritten")
12130

◆ next_split()

next_split (   self,
  t,
  idx,
  phase 
)

Definition at line 12144 of file z3py.py.

12144 def next_split(self, t, idx, phase):
12145 return Z3_solver_next_split(self.ctx_ref(), ctypes.c_void_p(self.cb), t.ast, idx, phase)
12146
Z3_solver_next_split
bool Z3_API Z3_solver_next_split(Z3_context c, Z3_solver_callback cb, Z3_ast t, unsigned idx, Z3_lbool phase)

◆ pop()

pop (   self,
  num_scopes 
)

Definition at line 12125 of file z3py.py.

12125 def pop(self, num_scopes):
12126 raise Z3Exception("pop needs to be overwritten")
12127

Referenced by Solver.__exit__().

◆ propagate()

propagate (   self,
  e,
  ids,
  eqs = [] 
)

Definition at line 12150 of file z3py.py.

12150 def propagate(self, e, ids, eqs=[]):
12151 _ids, num_fixed = _to_ast_array(ids)
12152 num_eqs = len(eqs)
12153 _lhs, _num_lhs = _to_ast_array([x for x, y in eqs])
12154 _rhs, _num_rhs = _to_ast_array([y for x, y in eqs])
12155 return Z3_solver_propagate_consequence(e.ctx.ref(), ctypes.c_void_p(
12156 self.cb), num_fixed, _ids, num_eqs, _lhs, _rhs, e.ast)
12157
Z3_solver_propagate_consequence
bool Z3_API Z3_solver_propagate_consequence(Z3_context c, Z3_solver_callback cb, unsigned num_fixed, Z3_ast const *fixed, unsigned num_eqs, Z3_ast const *eq_lhs, Z3_ast const *eq_rhs, Z3_ast conseq)
propagate a consequence based on fixed values and equalities. A client may invoke it during the pro...

◆ push()

push (   self)

Definition at line 12122 of file z3py.py.

12122 def push(self):
12123 raise Z3Exception("push needs to be overwritten")
12124

Referenced by Solver.__enter__().

Field Documentation

◆ _ctx

_ctx
protected

Definition at line 12025 of file z3py.py.

◆ binding

binding

Definition at line 12035 of file z3py.py.

◆ cb

cb

Definition at line 12027 of file z3py.py.

◆ created

created

Definition at line 12034 of file z3py.py.

◆ decide

decide

Definition at line 12033 of file z3py.py.

◆ diseq

diseq

Definition at line 12032 of file z3py.py.

◆ eq

eq

Definition at line 12031 of file z3py.py.

Referenced by AstRef.__eq__(), and SortRef.cast().

◆ final

final

Definition at line 12030 of file z3py.py.

◆ fixed

fixed

Definition at line 12029 of file z3py.py.

◆ fresh_ctx

fresh_ctx

Definition at line 12026 of file z3py.py.

◆ id

id

Definition at line 12028 of file z3py.py.

◆ solver

solver

Definition at line 12024 of file z3py.py.

Referenced by Solver.__del__(), Solver.assert_and_track(), Solver.assert_exprs(), Solver.check(), Solver.model(), Solver.num_scopes(), Solver.pop(), Solver.push(), Solver.reset(), and Solver.set().

Generated on Thu Feb 19 2026 05:10:48 for Z3 by doxygen 1.9.8