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
 decide = None
 created = None

Protected Attributes

 _ctx = None

Detailed Description

Definition at line 11815 of file z3py.py.

Constructor & Destructor Documentation

◆ __init__()

__init__ ( self,
s,
ctx = None )

Definition at line 11824 of file z3py.py.

11824 def __init__(self, s, ctx=None):
11825 assert s is None or ctx is None
11826 ensure_prop_closures()
11827 self.solver = s
11828 self._ctx = None
11829 self.fresh_ctx = None
11830 self.cb = None
11831 self.id = _prop_closures.insert(self)
11832 self.fixed = None
11833 self.final = None
11834 self.eq = None
11835 self.diseq = None
11836 self.decide = None
11837 self.created = None
11838 if ctx:
11839 self.fresh_ctx = ctx
11840 if s:
11841 Z3_solver_propagate_init(self.ctx_ref(),
11842 s.solver,
11843 ctypes.c_void_p(self.id),
11844 _user_prop_push,
11845 _user_prop_pop,
11846 _user_prop_fresh)
11847
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 11848 of file z3py.py.

11848 def __del__(self):
11849 if self._ctx:
11850 self._ctx.ctx = None
11851

Member Function Documentation

◆ add()

add ( self,
e )

Definition at line 11912 of file z3py.py.

11912 def add(self, e):
11913 assert not self._ctx
11914 if self.solver:
11915 Z3_solver_propagate_register(self.ctx_ref(), self.solver.solver, e.ast)
11916 else:
11917 Z3_solver_propagate_register_cb(self.ctx_ref(), ctypes.c_void_p(self.cb), e.ast)
11918
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 11868 of file z3py.py.

11868 def add_created(self, created):
11869 assert not self.created
11870 assert not self._ctx
11871 if self.solver:
11872 Z3_solver_propagate_created(self.ctx_ref(), self.solver.solver, _user_prop_created)
11873 self.created = created
11874
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 11896 of file z3py.py.

11896 def add_decide(self, decide):
11897 assert not self.decide
11898 assert not self._ctx
11899 if self.solver:
11900 Z3_solver_propagate_decide(self.ctx_ref(), self.solver.solver, _user_prop_decide)
11901 self.decide = decide
11902
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 11889 of file z3py.py.

11889 def add_diseq(self, diseq):
11890 assert not self.diseq
11891 assert not self._ctx
11892 if self.solver:
11893 Z3_solver_propagate_diseq(self.ctx_ref(), self.solver.solver, _user_prop_diseq)
11894 self.diseq = diseq
11895
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 11882 of file z3py.py.

11882 def add_eq(self, eq):
11883 assert not self.eq
11884 assert not self._ctx
11885 if self.solver:
11886 Z3_solver_propagate_eq(self.ctx_ref(), self.solver.solver, _user_prop_eq)
11887 self.eq = eq
11888
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 11875 of file z3py.py.

11875 def add_final(self, final):
11876 assert not self.final
11877 assert not self._ctx
11878 if self.solver:
11879 Z3_solver_propagate_final(self.ctx_ref(), self.solver.solver, _user_prop_final)
11880 self.final = final
11881
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 11861 of file z3py.py.

11861 def add_fixed(self, fixed):
11862 assert not self.fixed
11863 assert not self._ctx
11864 if self.solver:
11865 Z3_solver_propagate_fixed(self.ctx_ref(), self.solver.solver, _user_prop_fixed)
11866 self.fixed = fixed
11867
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 11938 of file z3py.py.

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

◆ ctx()

ctx ( self)

Definition at line 11852 of file z3py.py.

11852 def ctx(self):
11853 if self.fresh_ctx:
11854 return self.fresh_ctx
11855 else:
11856 return self.solver.ctx
11857

◆ ctx_ref()

ctx_ref ( self)

Definition at line 11858 of file z3py.py.

11858 def ctx_ref(self):
11859 return self.ctx().ref()
11860

◆ fresh()

fresh ( self,
new_ctx )

Definition at line 11909 of file z3py.py.

11909 def fresh(self, new_ctx):
11910 raise Z3Exception("fresh needs to be overwritten")
11911

◆ next_split()

next_split ( self,
t,
idx,
phase )

Definition at line 11924 of file z3py.py.

11924 def next_split(self, t, idx, phase):
11925 return Z3_solver_next_split(self.ctx_ref(), ctypes.c_void_p(self.cb), t.ast, idx, phase)
11926
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 11906 of file z3py.py.

11906 def pop(self, num_scopes):
11907 raise Z3Exception("pop needs to be overwritten")
11908

◆ propagate()

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

Definition at line 11930 of file z3py.py.

11930 def propagate(self, e, ids, eqs=[]):
11931 _ids, num_fixed = _to_ast_array(ids)
11932 num_eqs = len(eqs)
11933 _lhs, _num_lhs = _to_ast_array([x for x, y in eqs])
11934 _rhs, _num_rhs = _to_ast_array([y for x, y in eqs])
11935 return Z3_solver_propagate_consequence(e.ctx.ref(), ctypes.c_void_p(
11936 self.cb), num_fixed, _ids, num_eqs, _lhs, _rhs, e.ast)
11937
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 11903 of file z3py.py.

11903 def push(self):
11904 raise Z3Exception("push needs to be overwritten")
11905

Field Documentation

◆ _ctx

_ctx = None
protected

Definition at line 11828 of file z3py.py.

◆ cb

cb = None

Definition at line 11830 of file z3py.py.

◆ created

created = None

Definition at line 11837 of file z3py.py.

◆ decide

decide = None

Definition at line 11836 of file z3py.py.

◆ diseq

diseq = None

Definition at line 11835 of file z3py.py.

◆ eq

eq = None

Definition at line 11834 of file z3py.py.

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

◆ final

final = None

Definition at line 11833 of file z3py.py.

◆ fixed

fixed = None

Definition at line 11832 of file z3py.py.

◆ fresh_ctx

fresh_ctx = None

Definition at line 11829 of file z3py.py.

◆ id

id = _prop_closures.insert(self)

Definition at line 11831 of file z3py.py.

◆ solver

solver = s

Definition at line 11827 of file z3py.py.