Z3
 
Loading...
Searching...
No Matches
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)
 
 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 = s
 
 fresh_ctx = None
 
 cb = None
 
 id = _prop_closures.insert(self)
 
 fixed = None
 
 final = None
 
 eq = None
 
 diseq = None
 
 created = None
 
 decide = decide
 

Protected Attributes

 _ctx = None
 

Detailed Description

Definition at line 11700 of file z3py.py.

Constructor & Destructor Documentation

◆ __init__()

__init__ ( self,
s,
ctx = None )

Definition at line 11709 of file z3py.py.

11709 def __init__(self, s, ctx=None):
11710 assert s is None or ctx is None
11711 ensure_prop_closures()
11712 self.solver = s
11713 self._ctx = None
11714 self.fresh_ctx = None
11715 self.cb = None
11716 self.id = _prop_closures.insert(self)
11717 self.fixed = None
11718 self.final = None
11719 self.eq = None
11720 self.diseq = None
11721 self.created = None
11722 if ctx:
11723 self.fresh_ctx = ctx
11724 if s:
11725 Z3_solver_propagate_init(self.ctx_ref(),
11726 s.solver,
11727 ctypes.c_void_p(self.id),
11728 _user_prop_push,
11729 _user_prop_pop,
11730 _user_prop_fresh)
11731
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 11732 of file z3py.py.

11732 def __del__(self):
11733 if self._ctx:
11734 self._ctx.ctx = None
11735

Member Function Documentation

◆ add()

add ( self,
e )

Definition at line 11796 of file z3py.py.

11796 def add(self, e):
11797 assert not self._ctx
11798 if self.solver:
11799 Z3_solver_propagate_register(self.ctx_ref(), self.solver.solver, e.ast)
11800 else:
11801 Z3_solver_propagate_register_cb(self.ctx_ref(), ctypes.c_void_p(self.cb), e.ast)
11802
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...
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 11752 of file z3py.py.

11752 def add_created(self, created):
11753 assert not self.created
11754 assert not self._ctx
11755 if self.solver:
11756 Z3_solver_propagate_created(self.ctx_ref(), self.solver.solver, _user_prop_created)
11757 self.created = created
11758
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 11780 of file z3py.py.

11780 def add_decide(self, decide):
11781 assert not self.decide
11782 assert not self._ctx
11783 if self.solver:
11784 Z3_solver_propagate_decide(self.ctx_ref(), self.solver.solver, _user_prop_decide)
11785 self.decide = decide
11786
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 11773 of file z3py.py.

11773 def add_diseq(self, diseq):
11774 assert not self.diseq
11775 assert not self._ctx
11776 if self.solver:
11777 Z3_solver_propagate_diseq(self.ctx_ref(), self.solver.solver, _user_prop_diseq)
11778 self.diseq = diseq
11779
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 11766 of file z3py.py.

11766 def add_eq(self, eq):
11767 assert not self.eq
11768 assert not self._ctx
11769 if self.solver:
11770 Z3_solver_propagate_eq(self.ctx_ref(), self.solver.solver, _user_prop_eq)
11771 self.eq = eq
11772
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 11759 of file z3py.py.

11759 def add_final(self, final):
11760 assert not self.final
11761 assert not self._ctx
11762 if self.solver:
11763 Z3_solver_propagate_final(self.ctx_ref(), self.solver.solver, _user_prop_final)
11764 self.final = final
11765
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 11745 of file z3py.py.

11745 def add_fixed(self, fixed):
11746 assert not self.fixed
11747 assert not self._ctx
11748 if self.solver:
11749 Z3_solver_propagate_fixed(self.ctx_ref(), self.solver.solver, _user_prop_fixed)
11750 self.fixed = fixed
11751
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 ...

◆ conflict()

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

Definition at line 11822 of file z3py.py.

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

◆ ctx()

ctx ( self)

Definition at line 11736 of file z3py.py.

11736 def ctx(self):
11737 if self.fresh_ctx:
11738 return self.fresh_ctx
11739 else:
11740 return self.solver.ctx
11741

Referenced by ArithRef.__add__(), BitVecRef.__add__(), BitVecRef.__and__(), FuncDeclRef.__call__(), AstMap.__contains__(), AstRef.__copy__(), AstVector.__copy__(), FuncInterp.__copy__(), Goal.__copy__(), ModelRef.__copy__(), AstMap.__deepcopy__(), AstRef.__deepcopy__(), AstVector.__deepcopy__(), Datatype.__deepcopy__(), FuncEntry.__deepcopy__(), FuncInterp.__deepcopy__(), Goal.__deepcopy__(), ModelRef.__deepcopy__(), ParamDescrsRef.__deepcopy__(), ParamsRef.__deepcopy__(), Statistics.__deepcopy__(), AstMap.__del__(), AstRef.__del__(), AstVector.__del__(), Context.__del__(), FuncEntry.__del__(), FuncInterp.__del__(), Goal.__del__(), ModelRef.__del__(), ParamDescrsRef.__del__(), ParamsRef.__del__(), ScopedConstructor.__del__(), ScopedConstructorList.__del__(), Solver.__del__(), Statistics.__del__(), ArithRef.__div__(), BitVecRef.__div__(), ExprRef.__eq__(), ArithRef.__ge__(), BitVecRef.__ge__(), AstMap.__getitem__(), AstVector.__getitem__(), ModelRef.__getitem__(), Statistics.__getitem__(), ArithRef.__gt__(), BitVecRef.__gt__(), BitVecRef.__invert__(), ArithRef.__le__(), BitVecRef.__le__(), AstMap.__len__(), AstVector.__len__(), ModelRef.__len__(), Statistics.__len__(), BitVecRef.__lshift__(), ArithRef.__lt__(), BitVecRef.__lt__(), ArithRef.__mod__(), BitVecRef.__mod__(), ArithRef.__mul__(), BitVecRef.__mul__(), BoolRef.__mul__(), ExprRef.__ne__(), ArithRef.__neg__(), BitVecRef.__neg__(), BitVecRef.__or__(), ArithRef.__pow__(), ArithRef.__radd__(), BitVecRef.__radd__(), BitVecRef.__rand__(), ArithRef.__rdiv__(), BitVecRef.__rdiv__(), AstMap.__repr__(), ParamDescrsRef.__repr__(), ParamsRef.__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__(), AstMap.__setitem__(), AstVector.__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(), AstVector.push(), Solver.push(), QuantifierRef.qid(), ArraySortRef.range(), FuncDeclRef.range(), DatatypeSortRef.recognizer(), Context.ref(), AstMap.reset(), Solver.reset(), AstVector.resize(), ParamsRef.set(), Solver.set(), AstVector.sexpr(), Goal.sexpr(), ModelRef.sexpr(), Goal.size(), ParamDescrsRef.size(), QuantifierRef.skolem_id(), AstRef.translate(), AstVector.translate(), Goal.translate(), ModelRef.translate(), ParamsRef.validate(), FuncEntry.value(), QuantifierRef.var_name(), and QuantifierRef.var_sort().

◆ ctx_ref()

ctx_ref ( self)

Definition at line 11742 of file z3py.py.

11742 def ctx_ref(self):
11743 return self.ctx().ref()
11744

Referenced by BitVecRef.__add__(), BitVecRef.__and__(), FuncDeclRef.__call__(), ArithRef.__div__(), BitVecRef.__div__(), ExprRef.__eq__(), SortRef.__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__(), ExprRef.__ne__(), SortRef.__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(), BitVecNumRef.as_binary_string(), IntNumRef.as_binary_string(), AlgebraicNumRef.as_decimal(), RatNumRef.as_decimal(), BitVecNumRef.as_string(), IntNumRef.as_string(), RatNumRef.as_string(), QuantifierRef.body(), ExprRef.decl(), ArrayRef.default(), RatNumRef.denominator(), FuncDeclRef.domain(), ArraySortRef.domain_n(), AstRef.eq(), AstRef.get_id(), ExprRef.get_id(), FuncDeclRef.get_id(), PatternRef.get_id(), QuantifierRef.get_id(), SortRef.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(), QuantifierRef.qid(), ArraySortRef.range(), FuncDeclRef.range(), DatatypeSortRef.recognizer(), AstRef.sexpr(), QuantifierRef.skolem_id(), QuantifierRef.var_name(), QuantifierRef.var_sort(), and QuantifierRef.weight().

◆ fresh()

fresh ( self,
new_ctx )

Definition at line 11793 of file z3py.py.

11793 def fresh(self, new_ctx):
11794 raise Z3Exception("fresh needs to be overwritten")
11795

◆ next_split()

next_split ( self,
t,
idx,
phase )

Definition at line 11808 of file z3py.py.

11808 def next_split(self, t, idx, phase):
11809 return Z3_solver_next_split(self.ctx_ref(), ctypes.c_void_p(self.cb), t.ast, idx, phase)
11810
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 11790 of file z3py.py.

11790 def pop(self, num_scopes):
11791 raise Z3Exception("pop needs to be overwritten")
11792

Referenced by Solver.__exit__().

◆ propagate()

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

Definition at line 11814 of file z3py.py.

11814 def propagate(self, e, ids, eqs=[]):
11815 _ids, num_fixed = _to_ast_array(ids)
11816 num_eqs = len(eqs)
11817 _lhs, _num_lhs = _to_ast_array([x for x, y in eqs])
11818 _rhs, _num_rhs = _to_ast_array([y for x, y in eqs])
11819 return Z3_solver_propagate_consequence(e.ctx.ref(), ctypes.c_void_p(
11820 self.cb), num_fixed, _ids, num_eqs, _lhs, _rhs, e.ast)
11821
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 11787 of file z3py.py.

11787 def push(self):
11788 raise Z3Exception("push needs to be overwritten")
11789

Referenced by Solver.__enter__().

Field Documentation

◆ _ctx

_ctx = None
protected

Definition at line 11713 of file z3py.py.

◆ cb

cb = None

Definition at line 11715 of file z3py.py.

◆ created

created = None

Definition at line 11721 of file z3py.py.

◆ decide

decide = decide

Definition at line 11785 of file z3py.py.

◆ diseq

diseq = None

Definition at line 11720 of file z3py.py.

◆ eq

eq = None

Definition at line 11719 of file z3py.py.

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

◆ final

final = None

Definition at line 11718 of file z3py.py.

◆ fixed

fixed = None

Definition at line 11717 of file z3py.py.

◆ fresh_ctx

fresh_ctx = None

Definition at line 11714 of file z3py.py.

◆ id

id = _prop_closures.insert(self)

Definition at line 11716 of file z3py.py.

◆ solver