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 11963 of file z3py.py.

Constructor & Destructor Documentation

◆ __init__()

__init__ ( self,
s,
ctx = None )

Definition at line 11972 of file z3py.py.

11972 def __init__(self, s, ctx=None):
11973 assert s is None or ctx is None
11974 ensure_prop_closures()
11975 self.solver = s
11976 self._ctx = None
11977 self.fresh_ctx = None
11978 self.cb = None
11979 self.id = _prop_closures.insert(self)
11980 self.fixed = None
11981 self.final = None
11982 self.eq = None
11983 self.diseq = None
11984 self.decide = None
11985 self.created = None
11986 self.binding = None
11987 if ctx:
11988 self.fresh_ctx = ctx
11989 if s:
11990 Z3_solver_propagate_init(self.ctx_ref(),
11991 s.solver,
11992 ctypes.c_void_p(self.id),
11993 _user_prop_push,
11994 _user_prop_pop,
11995 _user_prop_fresh)
11996
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 11997 of file z3py.py.

11997 def __del__(self):
11998 if self._ctx:
11999 self._ctx.ctx = None
12000

Member Function Documentation

◆ add()

add ( self,
e )

Definition at line 12068 of file z3py.py.

12068 def add(self, e):
12069 assert not self._ctx
12070 if self.solver:
12071 Z3_solver_propagate_register(self.ctx_ref(), self.solver.solver, e.ast)
12072 else:
12073 Z3_solver_propagate_register_cb(self.ctx_ref(), ctypes.c_void_p(self.cb), e.ast)
12074
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 12017 of file z3py.py.

12017 def add_created(self, created):
12018 assert not self.created
12019 assert not self._ctx
12020 if self.solver:
12021 Z3_solver_propagate_created(self.ctx_ref(), self.solver.solver, _user_prop_created)
12022 self.created = created
12023
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 12045 of file z3py.py.

12045 def add_decide(self, decide):
12046 assert not self.decide
12047 assert not self._ctx
12048 if self.solver:
12049 Z3_solver_propagate_decide(self.ctx_ref(), self.solver.solver, _user_prop_decide)
12050 self.decide = decide
12051
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 12038 of file z3py.py.

12038 def add_diseq(self, diseq):
12039 assert not self.diseq
12040 assert not self._ctx
12041 if self.solver:
12042 Z3_solver_propagate_diseq(self.ctx_ref(), self.solver.solver, _user_prop_diseq)
12043 self.diseq = diseq
12044
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 12031 of file z3py.py.

12031 def add_eq(self, eq):
12032 assert not self.eq
12033 assert not self._ctx
12034 if self.solver:
12035 Z3_solver_propagate_eq(self.ctx_ref(), self.solver.solver, _user_prop_eq)
12036 self.eq = eq
12037
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 12024 of file z3py.py.

12024 def add_final(self, final):
12025 assert not self.final
12026 assert not self._ctx
12027 if self.solver:
12028 Z3_solver_propagate_final(self.ctx_ref(), self.solver.solver, _user_prop_final)
12029 self.final = final
12030
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 12010 of file z3py.py.

12010 def add_fixed(self, fixed):
12011 assert not self.fixed
12012 assert not self._ctx
12013 if self.solver:
12014 Z3_solver_propagate_fixed(self.ctx_ref(), self.solver.solver, _user_prop_fixed)
12015 self.fixed = fixed
12016
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 12052 of file z3py.py.

12052 def add_on_binding(self, binding):
12053 assert not self.binding
12054 assert not self._ctx
12055 if self.solver:
12056 Z3_solver_propagate_on_binding(self.ctx_ref(), self.solver.solver, _user_prop_binding)
12057 self.binding = binding
12058
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 12094 of file z3py.py.

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

◆ ctx()

ctx ( self)

Definition at line 12001 of file z3py.py.

12001 def ctx(self):
12002 if self.fresh_ctx:
12003 return self.fresh_ctx
12004 else:
12005 return self.solver.ctx
12006

◆ ctx_ref()

ctx_ref ( self)

Definition at line 12007 of file z3py.py.

12007 def ctx_ref(self):
12008 return self.ctx().ref()
12009

◆ fresh()

fresh ( self,
new_ctx )

Definition at line 12065 of file z3py.py.

12065 def fresh(self, new_ctx):
12066 raise Z3Exception("fresh needs to be overwritten")
12067

◆ next_split()

next_split ( self,
t,
idx,
phase )

Definition at line 12080 of file z3py.py.

12080 def next_split(self, t, idx, phase):
12081 return Z3_solver_next_split(self.ctx_ref(), ctypes.c_void_p(self.cb), t.ast, idx, phase)
12082
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 12062 of file z3py.py.

12062 def pop(self, num_scopes):
12063 raise Z3Exception("pop needs to be overwritten")
12064

◆ propagate()

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

Definition at line 12086 of file z3py.py.

12086 def propagate(self, e, ids, eqs=[]):
12087 _ids, num_fixed = _to_ast_array(ids)
12088 num_eqs = len(eqs)
12089 _lhs, _num_lhs = _to_ast_array([x for x, y in eqs])
12090 _rhs, _num_rhs = _to_ast_array([y for x, y in eqs])
12091 return Z3_solver_propagate_consequence(e.ctx.ref(), ctypes.c_void_p(
12092 self.cb), num_fixed, _ids, num_eqs, _lhs, _rhs, e.ast)
12093
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 12059 of file z3py.py.

12059 def push(self):
12060 raise Z3Exception("push needs to be overwritten")
12061

Field Documentation

◆ _ctx

_ctx = None
protected

Definition at line 11976 of file z3py.py.

◆ binding

binding = None

Definition at line 11986 of file z3py.py.

◆ cb

cb = None

Definition at line 11978 of file z3py.py.

◆ created

created = None

Definition at line 11985 of file z3py.py.

◆ decide

decide = None

Definition at line 11984 of file z3py.py.

◆ diseq

diseq = None

Definition at line 11983 of file z3py.py.

◆ eq

eq = None

Definition at line 11982 of file z3py.py.

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

◆ final

final = None

Definition at line 11981 of file z3py.py.

◆ fixed

fixed = None

Definition at line 11980 of file z3py.py.

◆ fresh_ctx

fresh_ctx = None

Definition at line 11977 of file z3py.py.

◆ id

id = _prop_closures.insert(self)

Definition at line 11979 of file z3py.py.

◆ solver

solver = s

Definition at line 11975 of file z3py.py.