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

Protected Attributes

 _ctx = None

Detailed Description

Definition at line 12626 of file z3py.py.

Constructor & Destructor Documentation

◆ __init__()

__init__ ( self,
s,
ctx = None )

Definition at line 12635 of file z3py.py.

12635 def __init__(self, s, ctx=None):
12636 assert s is None or ctx is None
12637 ensure_prop_closures()
12638 self.solver = s
12639 self._ctx = None
12640 self.fresh_ctx = None
12641 self.cb = None
12642 self.id = _prop_closures.insert(self)
12643 self.fixed = None
12644 self.final = None
12645 self.eq = None
12646 self.diseq = None
12647 self.decide = None
12648 self.created = None
12649 self.binding = None
12650 if ctx:
12651 self.fresh_ctx = ctx
12652 if s:
12653 Z3_solver_propagate_init(self.ctx_ref(),
12654 s.solver,
12655 ctypes.c_void_p(self.id),
12656 _user_prop_push,
12657 _user_prop_pop,
12658 _user_prop_fresh)
12659
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 12660 of file z3py.py.

12660 def __del__(self):
12661 if self._ctx:
12662 self._ctx.ctx = None
12663

Member Function Documentation

◆ add()

add ( self,
e )

Definition at line 12745 of file z3py.py.

12745 def add(self, e):
12746 if self._ctx:
12747 raise Z3Exception("context already initialized")
12748 if self.solver:
12749 Z3_solver_propagate_register(self.ctx_ref(), self.solver.solver, e.ast)
12750 else:
12751 Z3_solver_propagate_register_cb(self.ctx_ref(), ctypes.c_void_p(self.cb), e.ast)
12752
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...

◆ add_created()

add_created ( self,
created )

Definition at line 12682 of file z3py.py.

12682 def add_created(self, created):
12683 if self.created:
12684 raise Z3Exception("created callback already registered")
12685 if self._ctx:
12686 raise Z3Exception("context already initialized")
12687 if self.solver:
12688 Z3_solver_propagate_created(self.ctx_ref(), self.solver.solver, _user_prop_created)
12689 self.created = created
12690
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 12718 of file z3py.py.

12718 def add_decide(self, decide):
12719 if self.decide:
12720 raise Z3Exception("decide callback already registered")
12721 if self._ctx:
12722 raise Z3Exception("context already initialized")
12723 if self.solver:
12724 Z3_solver_propagate_decide(self.ctx_ref(), self.solver.solver, _user_prop_decide)
12725 self.decide = decide
12726
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 12709 of file z3py.py.

12709 def add_diseq(self, diseq):
12710 if self.diseq:
12711 raise Z3Exception("diseq callback already registered")
12712 if self._ctx:
12713 raise Z3Exception("context already initialized")
12714 if self.solver:
12715 Z3_solver_propagate_diseq(self.ctx_ref(), self.solver.solver, _user_prop_diseq)
12716 self.diseq = diseq
12717
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 12700 of file z3py.py.

12700 def add_eq(self, eq):
12701 if self.eq:
12702 raise Z3Exception("eq callback already registered")
12703 if self._ctx:
12704 raise Z3Exception("context already initialized")
12705 if self.solver:
12706 Z3_solver_propagate_eq(self.ctx_ref(), self.solver.solver, _user_prop_eq)
12707 self.eq = eq
12708
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 12691 of file z3py.py.

12691 def add_final(self, final):
12692 if self.final:
12693 raise Z3Exception("final callback already registered")
12694 if self._ctx:
12695 raise Z3Exception("context already initialized")
12696 if self.solver:
12697 Z3_solver_propagate_final(self.ctx_ref(), self.solver.solver, _user_prop_final)
12698 self.final = final
12699
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 12673 of file z3py.py.

12673 def add_fixed(self, fixed):
12674 if self.fixed:
12675 raise Z3Exception("fixed callback already registered")
12676 if self._ctx:
12677 raise Z3Exception("context already initialized")
12678 if self.solver:
12679 Z3_solver_propagate_fixed(self.ctx_ref(), self.solver.solver, _user_prop_fixed)
12680 self.fixed = fixed
12681
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 12727 of file z3py.py.

12727 def add_on_binding(self, binding):
12728 if self.binding:
12729 raise Z3Exception("binding callback already registered")
12730 if self._ctx:
12731 raise Z3Exception("context already initialized")
12732 if self.solver:
12733 Z3_solver_propagate_on_binding(self.ctx_ref(), self.solver.solver, _user_prop_binding)
12734 self.binding = binding
12735
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 12772 of file z3py.py.

12772 def conflict(self, deps = [], eqs = []):
12773 self.propagate(BoolVal(False, self.ctx()), deps, eqs)
12774
12775

◆ ctx()

ctx ( self)

Definition at line 12664 of file z3py.py.

12664 def ctx(self):
12665 if self.fresh_ctx:
12666 return self.fresh_ctx
12667 else:
12668 return self.solver.ctx
12669

◆ ctx_ref()

ctx_ref ( self)

Definition at line 12670 of file z3py.py.

12670 def ctx_ref(self):
12671 return self.ctx().ref()
12672

◆ fresh()

fresh ( self,
new_ctx )

Definition at line 12742 of file z3py.py.

12742 def fresh(self, new_ctx):
12743 raise Z3Exception("fresh needs to be overwritten")
12744

◆ next_split()

next_split ( self,
t,
idx,
phase )

Definition at line 12758 of file z3py.py.

12758 def next_split(self, t, idx, phase):
12759 return Z3_solver_next_split(self.ctx_ref(), ctypes.c_void_p(self.cb), t.ast, idx, phase)
12760
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 12739 of file z3py.py.

12739 def pop(self, num_scopes):
12740 raise Z3Exception("pop needs to be overwritten")
12741

◆ propagate()

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

Definition at line 12764 of file z3py.py.

12764 def propagate(self, e, ids, eqs=[]):
12765 _ids, num_fixed = _to_ast_array(ids)
12766 num_eqs = len(eqs)
12767 _lhs, _num_lhs = _to_ast_array([x for x, y in eqs])
12768 _rhs, _num_rhs = _to_ast_array([y for x, y in eqs])
12769 return Z3_solver_propagate_consequence(e.ctx.ref(), ctypes.c_void_p(
12770 self.cb), num_fixed, _ids, num_eqs, _lhs, _rhs, e.ast)
12771
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 12736 of file z3py.py.

12736 def push(self):
12737 raise Z3Exception("push needs to be overwritten")
12738

Field Documentation

◆ _ctx

_ctx = None
protected

Definition at line 12639 of file z3py.py.

◆ binding

binding = None

Definition at line 12649 of file z3py.py.

◆ cb

cb = None

Definition at line 12641 of file z3py.py.

◆ created

created = None

Definition at line 12648 of file z3py.py.

◆ decide

decide = None

Definition at line 12647 of file z3py.py.

◆ diseq

diseq = None

Definition at line 12646 of file z3py.py.

◆ eq

eq = None

Definition at line 12645 of file z3py.py.

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

◆ final

final = None

Definition at line 12644 of file z3py.py.

◆ fixed

fixed = None

Definition at line 12643 of file z3py.py.

◆ fresh_ctx

fresh_ctx = None

Definition at line 12640 of file z3py.py.

◆ id

id = _prop_closures.insert(self)

Definition at line 12642 of file z3py.py.

◆ solver

solver = s

Definition at line 12638 of file z3py.py.