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

Constructor & Destructor Documentation

◆ __init__()

__init__ ( self,
s,
ctx = None )

Definition at line 12436 of file z3py.py.

12436 def __init__(self, s, ctx=None):
12437 assert s is None or ctx is None
12438 ensure_prop_closures()
12439 self.solver = s
12440 self._ctx = None
12441 self.fresh_ctx = None
12442 self.cb = None
12443 self.id = _prop_closures.insert(self)
12444 self.fixed = None
12445 self.final = None
12446 self.eq = None
12447 self.diseq = None
12448 self.decide = None
12449 self.created = None
12450 self.binding = None
12451 if ctx:
12452 self.fresh_ctx = ctx
12453 if s:
12454 Z3_solver_propagate_init(self.ctx_ref(),
12455 s.solver,
12456 ctypes.c_void_p(self.id),
12457 _user_prop_push,
12458 _user_prop_pop,
12459 _user_prop_fresh)
12460
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 12461 of file z3py.py.

12461 def __del__(self):
12462 if self._ctx:
12463 self._ctx.ctx = None
12464

Member Function Documentation

◆ add()

add ( self,
e )

Definition at line 12546 of file z3py.py.

12546 def add(self, e):
12547 if self._ctx:
12548 raise Z3Exception("context already initialized")
12549 if self.solver:
12550 Z3_solver_propagate_register(self.ctx_ref(), self.solver.solver, e.ast)
12551 else:
12552 Z3_solver_propagate_register_cb(self.ctx_ref(), ctypes.c_void_p(self.cb), e.ast)
12553
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 12483 of file z3py.py.

12483 def add_created(self, created):
12484 if self.created:
12485 raise Z3Exception("created callback already registered")
12486 if self._ctx:
12487 raise Z3Exception("context already initialized")
12488 if self.solver:
12489 Z3_solver_propagate_created(self.ctx_ref(), self.solver.solver, _user_prop_created)
12490 self.created = created
12491
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 12519 of file z3py.py.

12519 def add_decide(self, decide):
12520 if self.decide:
12521 raise Z3Exception("decide callback already registered")
12522 if self._ctx:
12523 raise Z3Exception("context already initialized")
12524 if self.solver:
12525 Z3_solver_propagate_decide(self.ctx_ref(), self.solver.solver, _user_prop_decide)
12526 self.decide = decide
12527
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 12510 of file z3py.py.

12510 def add_diseq(self, diseq):
12511 if self.diseq:
12512 raise Z3Exception("diseq callback already registered")
12513 if self._ctx:
12514 raise Z3Exception("context already initialized")
12515 if self.solver:
12516 Z3_solver_propagate_diseq(self.ctx_ref(), self.solver.solver, _user_prop_diseq)
12517 self.diseq = diseq
12518
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 12501 of file z3py.py.

12501 def add_eq(self, eq):
12502 if self.eq:
12503 raise Z3Exception("eq callback already registered")
12504 if self._ctx:
12505 raise Z3Exception("context already initialized")
12506 if self.solver:
12507 Z3_solver_propagate_eq(self.ctx_ref(), self.solver.solver, _user_prop_eq)
12508 self.eq = eq
12509
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 12492 of file z3py.py.

12492 def add_final(self, final):
12493 if self.final:
12494 raise Z3Exception("final callback already registered")
12495 if self._ctx:
12496 raise Z3Exception("context already initialized")
12497 if self.solver:
12498 Z3_solver_propagate_final(self.ctx_ref(), self.solver.solver, _user_prop_final)
12499 self.final = final
12500
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 12474 of file z3py.py.

12474 def add_fixed(self, fixed):
12475 if self.fixed:
12476 raise Z3Exception("fixed callback already registered")
12477 if self._ctx:
12478 raise Z3Exception("context already initialized")
12479 if self.solver:
12480 Z3_solver_propagate_fixed(self.ctx_ref(), self.solver.solver, _user_prop_fixed)
12481 self.fixed = fixed
12482
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 12528 of file z3py.py.

12528 def add_on_binding(self, binding):
12529 if self.binding:
12530 raise Z3Exception("binding callback already registered")
12531 if self._ctx:
12532 raise Z3Exception("context already initialized")
12533 if self.solver:
12534 Z3_solver_propagate_on_binding(self.ctx_ref(), self.solver.solver, _user_prop_binding)
12535 self.binding = binding
12536
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 12573 of file z3py.py.

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

◆ ctx()

ctx ( self)

Definition at line 12465 of file z3py.py.

12465 def ctx(self):
12466 if self.fresh_ctx:
12467 return self.fresh_ctx
12468 else:
12469 return self.solver.ctx
12470

◆ ctx_ref()

ctx_ref ( self)

Definition at line 12471 of file z3py.py.

12471 def ctx_ref(self):
12472 return self.ctx().ref()
12473

◆ fresh()

fresh ( self,
new_ctx )

Definition at line 12543 of file z3py.py.

12543 def fresh(self, new_ctx):
12544 raise Z3Exception("fresh needs to be overwritten")
12545

◆ next_split()

next_split ( self,
t,
idx,
phase )

Definition at line 12559 of file z3py.py.

12559 def next_split(self, t, idx, phase):
12560 return Z3_solver_next_split(self.ctx_ref(), ctypes.c_void_p(self.cb), t.ast, idx, phase)
12561
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 12540 of file z3py.py.

12540 def pop(self, num_scopes):
12541 raise Z3Exception("pop needs to be overwritten")
12542

◆ propagate()

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

Definition at line 12565 of file z3py.py.

12565 def propagate(self, e, ids, eqs=[]):
12566 _ids, num_fixed = _to_ast_array(ids)
12567 num_eqs = len(eqs)
12568 _lhs, _num_lhs = _to_ast_array([x for x, y in eqs])
12569 _rhs, _num_rhs = _to_ast_array([y for x, y in eqs])
12570 return Z3_solver_propagate_consequence(e.ctx.ref(), ctypes.c_void_p(
12571 self.cb), num_fixed, _ids, num_eqs, _lhs, _rhs, e.ast)
12572
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 12537 of file z3py.py.

12537 def push(self):
12538 raise Z3Exception("push needs to be overwritten")
12539

Field Documentation

◆ _ctx

_ctx = None
protected

Definition at line 12440 of file z3py.py.

◆ binding

binding = None

Definition at line 12450 of file z3py.py.

◆ cb

cb = None

Definition at line 12442 of file z3py.py.

◆ created

created = None

Definition at line 12449 of file z3py.py.

◆ decide

decide = None

Definition at line 12448 of file z3py.py.

◆ diseq

diseq = None

Definition at line 12447 of file z3py.py.

◆ eq

eq = None

Definition at line 12446 of file z3py.py.

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

◆ final

final = None

Definition at line 12445 of file z3py.py.

◆ fixed

fixed = None

Definition at line 12444 of file z3py.py.

◆ fresh_ctx

fresh_ctx = None

Definition at line 12441 of file z3py.py.

◆ id

id = _prop_closures.insert(self)

Definition at line 12443 of file z3py.py.

◆ solver

solver = s

Definition at line 12439 of file z3py.py.