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

Constructor & Destructor Documentation

◆ __init__()

__init__ ( self,
s,
ctx = None )

Definition at line 12451 of file z3py.py.

12451 def __init__(self, s, ctx=None):
12452 assert s is None or ctx is None
12453 ensure_prop_closures()
12454 self.solver = s
12455 self._ctx = None
12456 self.fresh_ctx = None
12457 self.cb = None
12458 self.id = _prop_closures.insert(self)
12459 self.fixed = None
12460 self.final = None
12461 self.eq = None
12462 self.diseq = None
12463 self.decide = None
12464 self.created = None
12465 self.binding = None
12466 if ctx:
12467 self.fresh_ctx = ctx
12468 if s:
12469 Z3_solver_propagate_init(self.ctx_ref(),
12470 s.solver,
12471 ctypes.c_void_p(self.id),
12472 _user_prop_push,
12473 _user_prop_pop,
12474 _user_prop_fresh)
12475
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 12476 of file z3py.py.

12476 def __del__(self):
12477 if self._ctx:
12478 self._ctx.ctx = None
12479

Member Function Documentation

◆ add()

add ( self,
e )

Definition at line 12561 of file z3py.py.

12561 def add(self, e):
12562 if self._ctx:
12563 raise Z3Exception("context already initialized")
12564 if self.solver:
12565 Z3_solver_propagate_register(self.ctx_ref(), self.solver.solver, e.ast)
12566 else:
12567 Z3_solver_propagate_register_cb(self.ctx_ref(), ctypes.c_void_p(self.cb), e.ast)
12568
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 12498 of file z3py.py.

12498 def add_created(self, created):
12499 if self.created:
12500 raise Z3Exception("created callback already registered")
12501 if self._ctx:
12502 raise Z3Exception("context already initialized")
12503 if self.solver:
12504 Z3_solver_propagate_created(self.ctx_ref(), self.solver.solver, _user_prop_created)
12505 self.created = created
12506
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 12534 of file z3py.py.

12534 def add_decide(self, decide):
12535 if self.decide:
12536 raise Z3Exception("decide callback already registered")
12537 if self._ctx:
12538 raise Z3Exception("context already initialized")
12539 if self.solver:
12540 Z3_solver_propagate_decide(self.ctx_ref(), self.solver.solver, _user_prop_decide)
12541 self.decide = decide
12542
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 12525 of file z3py.py.

12525 def add_diseq(self, diseq):
12526 if self.diseq:
12527 raise Z3Exception("diseq callback already registered")
12528 if self._ctx:
12529 raise Z3Exception("context already initialized")
12530 if self.solver:
12531 Z3_solver_propagate_diseq(self.ctx_ref(), self.solver.solver, _user_prop_diseq)
12532 self.diseq = diseq
12533
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 12516 of file z3py.py.

12516 def add_eq(self, eq):
12517 if self.eq:
12518 raise Z3Exception("eq callback already registered")
12519 if self._ctx:
12520 raise Z3Exception("context already initialized")
12521 if self.solver:
12522 Z3_solver_propagate_eq(self.ctx_ref(), self.solver.solver, _user_prop_eq)
12523 self.eq = eq
12524
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 12507 of file z3py.py.

12507 def add_final(self, final):
12508 if self.final:
12509 raise Z3Exception("final callback already registered")
12510 if self._ctx:
12511 raise Z3Exception("context already initialized")
12512 if self.solver:
12513 Z3_solver_propagate_final(self.ctx_ref(), self.solver.solver, _user_prop_final)
12514 self.final = final
12515
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 12489 of file z3py.py.

12489 def add_fixed(self, fixed):
12490 if self.fixed:
12491 raise Z3Exception("fixed callback already registered")
12492 if self._ctx:
12493 raise Z3Exception("context already initialized")
12494 if self.solver:
12495 Z3_solver_propagate_fixed(self.ctx_ref(), self.solver.solver, _user_prop_fixed)
12496 self.fixed = fixed
12497
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 12543 of file z3py.py.

12543 def add_on_binding(self, binding):
12544 if self.binding:
12545 raise Z3Exception("binding callback already registered")
12546 if self._ctx:
12547 raise Z3Exception("context already initialized")
12548 if self.solver:
12549 Z3_solver_propagate_on_binding(self.ctx_ref(), self.solver.solver, _user_prop_binding)
12550 self.binding = binding
12551
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 12588 of file z3py.py.

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

◆ ctx()

ctx ( self)

Definition at line 12480 of file z3py.py.

12480 def ctx(self):
12481 if self.fresh_ctx:
12482 return self.fresh_ctx
12483 else:
12484 return self.solver.ctx
12485

◆ ctx_ref()

ctx_ref ( self)

Definition at line 12486 of file z3py.py.

12486 def ctx_ref(self):
12487 return self.ctx().ref()
12488

◆ fresh()

fresh ( self,
new_ctx )

Definition at line 12558 of file z3py.py.

12558 def fresh(self, new_ctx):
12559 raise Z3Exception("fresh needs to be overwritten")
12560

◆ next_split()

next_split ( self,
t,
idx,
phase )

Definition at line 12574 of file z3py.py.

12574 def next_split(self, t, idx, phase):
12575 return Z3_solver_next_split(self.ctx_ref(), ctypes.c_void_p(self.cb), t.ast, idx, phase)
12576
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 12555 of file z3py.py.

12555 def pop(self, num_scopes):
12556 raise Z3Exception("pop needs to be overwritten")
12557

◆ propagate()

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

Definition at line 12580 of file z3py.py.

12580 def propagate(self, e, ids, eqs=[]):
12581 _ids, num_fixed = _to_ast_array(ids)
12582 num_eqs = len(eqs)
12583 _lhs, _num_lhs = _to_ast_array([x for x, y in eqs])
12584 _rhs, _num_rhs = _to_ast_array([y for x, y in eqs])
12585 return Z3_solver_propagate_consequence(e.ctx.ref(), ctypes.c_void_p(
12586 self.cb), num_fixed, _ids, num_eqs, _lhs, _rhs, e.ast)
12587
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 12552 of file z3py.py.

12552 def push(self):
12553 raise Z3Exception("push needs to be overwritten")
12554

Field Documentation

◆ _ctx

_ctx = None
protected

Definition at line 12455 of file z3py.py.

◆ binding

binding = None

Definition at line 12465 of file z3py.py.

◆ cb

cb = None

Definition at line 12457 of file z3py.py.

◆ created

created = None

Definition at line 12464 of file z3py.py.

◆ decide

decide = None

Definition at line 12463 of file z3py.py.

◆ diseq

diseq = None

Definition at line 12462 of file z3py.py.

◆ eq

eq = None

Definition at line 12461 of file z3py.py.

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

◆ final

final = None

Definition at line 12460 of file z3py.py.

◆ fixed

fixed = None

Definition at line 12459 of file z3py.py.

◆ fresh_ctx

fresh_ctx = None

Definition at line 12456 of file z3py.py.

◆ id

id = _prop_closures.insert(self)

Definition at line 12458 of file z3py.py.

◆ solver

solver = s

Definition at line 12454 of file z3py.py.