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

Constructor & Destructor Documentation

◆ __init__()

__init__ ( self,
s,
ctx = None )

Definition at line 11912 of file z3py.py.

11912 def __init__(self, s, ctx=None):
11913 assert s is None or ctx is None
11914 ensure_prop_closures()
11915 self.solver = s
11916 self._ctx = None
11917 self.fresh_ctx = None
11918 self.cb = None
11919 self.id = _prop_closures.insert(self)
11920 self.fixed = None
11921 self.final = None
11922 self.eq = None
11923 self.diseq = None
11924 self.decide = None
11925 self.created = None
11926 self.binding = None
11927 if ctx:
11928 self.fresh_ctx = ctx
11929 if s:
11930 Z3_solver_propagate_init(self.ctx_ref(),
11931 s.solver,
11932 ctypes.c_void_p(self.id),
11933 _user_prop_push,
11934 _user_prop_pop,
11935 _user_prop_fresh)
11936
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 11937 of file z3py.py.

11937 def __del__(self):
11938 if self._ctx:
11939 self._ctx.ctx = None
11940

Member Function Documentation

◆ add()

add ( self,
e )

Definition at line 12008 of file z3py.py.

12008 def add(self, e):
12009 assert not self._ctx
12010 if self.solver:
12011 Z3_solver_propagate_register(self.ctx_ref(), self.solver.solver, e.ast)
12012 else:
12013 Z3_solver_propagate_register_cb(self.ctx_ref(), ctypes.c_void_p(self.cb), e.ast)
12014
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 11957 of file z3py.py.

11957 def add_created(self, created):
11958 assert not self.created
11959 assert not self._ctx
11960 if self.solver:
11961 Z3_solver_propagate_created(self.ctx_ref(), self.solver.solver, _user_prop_created)
11962 self.created = created
11963
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 11985 of file z3py.py.

11985 def add_decide(self, decide):
11986 assert not self.decide
11987 assert not self._ctx
11988 if self.solver:
11989 Z3_solver_propagate_decide(self.ctx_ref(), self.solver.solver, _user_prop_decide)
11990 self.decide = decide
11991
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 11978 of file z3py.py.

11978 def add_diseq(self, diseq):
11979 assert not self.diseq
11980 assert not self._ctx
11981 if self.solver:
11982 Z3_solver_propagate_diseq(self.ctx_ref(), self.solver.solver, _user_prop_diseq)
11983 self.diseq = diseq
11984
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 11971 of file z3py.py.

11971 def add_eq(self, eq):
11972 assert not self.eq
11973 assert not self._ctx
11974 if self.solver:
11975 Z3_solver_propagate_eq(self.ctx_ref(), self.solver.solver, _user_prop_eq)
11976 self.eq = eq
11977
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 11964 of file z3py.py.

11964 def add_final(self, final):
11965 assert not self.final
11966 assert not self._ctx
11967 if self.solver:
11968 Z3_solver_propagate_final(self.ctx_ref(), self.solver.solver, _user_prop_final)
11969 self.final = final
11970
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 11950 of file z3py.py.

11950 def add_fixed(self, fixed):
11951 assert not self.fixed
11952 assert not self._ctx
11953 if self.solver:
11954 Z3_solver_propagate_fixed(self.ctx_ref(), self.solver.solver, _user_prop_fixed)
11955 self.fixed = fixed
11956
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 11992 of file z3py.py.

11992 def add_on_binding(self, binding):
11993 assert not self.binding
11994 assert not self._ctx
11995 if self.solver:
11996 Z3_solver_propagate_on_binding(self.ctx_ref(), self.solver.solver, _user_prop_binding)
11997 self.binding = binding
11998
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 12034 of file z3py.py.

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

◆ ctx()

ctx ( self)

Definition at line 11941 of file z3py.py.

11941 def ctx(self):
11942 if self.fresh_ctx:
11943 return self.fresh_ctx
11944 else:
11945 return self.solver.ctx
11946

◆ ctx_ref()

ctx_ref ( self)

Definition at line 11947 of file z3py.py.

11947 def ctx_ref(self):
11948 return self.ctx().ref()
11949

◆ fresh()

fresh ( self,
new_ctx )

Definition at line 12005 of file z3py.py.

12005 def fresh(self, new_ctx):
12006 raise Z3Exception("fresh needs to be overwritten")
12007

◆ next_split()

next_split ( self,
t,
idx,
phase )

Definition at line 12020 of file z3py.py.

12020 def next_split(self, t, idx, phase):
12021 return Z3_solver_next_split(self.ctx_ref(), ctypes.c_void_p(self.cb), t.ast, idx, phase)
12022
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 12002 of file z3py.py.

12002 def pop(self, num_scopes):
12003 raise Z3Exception("pop needs to be overwritten")
12004

◆ propagate()

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

Definition at line 12026 of file z3py.py.

12026 def propagate(self, e, ids, eqs=[]):
12027 _ids, num_fixed = _to_ast_array(ids)
12028 num_eqs = len(eqs)
12029 _lhs, _num_lhs = _to_ast_array([x for x, y in eqs])
12030 _rhs, _num_rhs = _to_ast_array([y for x, y in eqs])
12031 return Z3_solver_propagate_consequence(e.ctx.ref(), ctypes.c_void_p(
12032 self.cb), num_fixed, _ids, num_eqs, _lhs, _rhs, e.ast)
12033
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 11999 of file z3py.py.

11999 def push(self):
12000 raise Z3Exception("push needs to be overwritten")
12001

Field Documentation

◆ _ctx

_ctx = None
protected

Definition at line 11916 of file z3py.py.

◆ binding

binding = None

Definition at line 11926 of file z3py.py.

◆ cb

cb = None

Definition at line 11918 of file z3py.py.

◆ created

created = None

Definition at line 11925 of file z3py.py.

◆ decide

decide = None

Definition at line 11924 of file z3py.py.

◆ diseq

diseq = None

Definition at line 11923 of file z3py.py.

◆ eq

eq = None

Definition at line 11922 of file z3py.py.

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

◆ final

final = None

Definition at line 11921 of file z3py.py.

◆ fixed

fixed = None

Definition at line 11920 of file z3py.py.

◆ fresh_ctx

fresh_ctx = None

Definition at line 11917 of file z3py.py.

◆ id

id = _prop_closures.insert(self)

Definition at line 11919 of file z3py.py.

◆ solver

solver = s

Definition at line 11915 of file z3py.py.