Z3
 
Loading...
Searching...
No Matches
user_propagator_base Class Referenceabstract

#include <z3++.h>

Public Member Functions

 user_propagator_base (context &c)
 
 user_propagator_base (solver *s)
 
virtual void push ()=0
 
virtual void pop (unsigned num_scopes)=0
 
virtual ~user_propagator_base ()
 
contextctx ()
 
virtual user_propagator_basefresh (context &ctx)=0
 user_propagators created using fresh() are created during search and their lifetimes are restricted to search time. They should be garbage collected by the propagator used to invoke fresh(). The life-time of the Z3_context object can only be assumed valid during callbacks, such as fixed(), which contains expressions based on the context.
 
void register_fixed (fixed_eh_t &f)
 register callbacks. Callbacks can only be registered with user_propagators that were created using a solver.
 
void register_fixed ()
 
void register_eq (eq_eh_t &f)
 
void register_eq ()
 
void register_final (final_eh_t &f)
 register a callback on final-check. During the final check stage, all propagations have been processed. This is an opportunity for the user-propagator to delay some analysis that could be expensive to perform incrementally. It is also an opportunity for the propagator to implement branch and bound optimization.
 
void register_final ()
 
void register_created (created_eh_t &c)
 
void register_created ()
 
void register_decide (decide_eh_t &c)
 
void register_decide ()
 
virtual void fixed (expr const &, expr const &)
 
virtual void eq (expr const &, expr const &)
 
virtual void final ()
 
virtual void created (expr const &)
 
virtual void decide (expr const &, unsigned, bool)
 
bool next_split (expr const &e, unsigned idx, Z3_lbool phase)
 
void add (expr const &e)
 tracks e by a unique identifier that is returned by the call.
 
void conflict (expr_vector const &fixed)
 
void conflict (expr_vector const &fixed, expr_vector const &lhs, expr_vector const &rhs)
 
bool propagate (expr_vector const &fixed, expr const &conseq)
 
bool propagate (expr_vector const &fixed, expr_vector const &lhs, expr_vector const &rhs, expr const &conseq)
 

Detailed Description

Definition at line 4291 of file z3++.h.

Constructor & Destructor Documentation

◆ user_propagator_base() [1/2]

Definition at line 4377 of file z3++.h.

4377: s(nullptr), c(&c) {}

Referenced by fresh().

◆ user_propagator_base() [2/2]

Definition at line 4379 of file z3++.h.

4379 : s(s), c(nullptr) {
4380 Z3_solver_propagate_init(ctx(), *s, this, push_eh, pop_eh, fresh_eh);
4381 }
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.

◆ ~user_propagator_base()

virtual ~user_propagator_base ( )
inlinevirtual

Definition at line 4386 of file z3++.h.

4386 {
4387 for (auto& subcontext : subcontexts) {
4388 subcontext->detach(); // detach first; the subcontexts will be freed internally!
4389 delete subcontext;
4390 }
4391 }

Member Function Documentation

◆ add()

void add ( expr const & e)
inline

tracks e by a unique identifier that is returned by the call.

If the fixed() callback is registered and if e is a Boolean or Bit-vector, the fixed() callback gets invoked when e is bound to a value. If the eq() callback is registered, then equalities between registered expressions are reported. A consumer can use the propagate or conflict functions to invoke propagations or conflicts as a consequence of these callbacks. These functions take a list of identifiers for registered expressions that have been fixed. The list of identifiers must correspond to already fixed values. Similarly, a list of propagated equalities can be supplied. These must correspond to equalities that have been registered during a callback.

Definition at line 4530 of file z3++.h.

4530 {
4531 if (cb)
4532 Z3_solver_propagate_register_cb(ctx(), cb, e);
4533 else if (s)
4534 Z3_solver_propagate_register(ctx(), *s, e);
4535 else
4536 assert(false);
4537 }
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...

◆ conflict() [1/2]

void conflict ( expr_vector const & fixed)
inline

Definition at line 4539 of file z3++.h.

4539 {
4540 assert(cb);
4541 expr conseq = ctx().bool_val(false);
4542 array<Z3_ast> _fixed(fixed);
4543 Z3_solver_propagate_consequence(ctx(), cb, fixed.size(), _fixed.ptr(), 0, nullptr, nullptr, conseq);
4544 }
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...

◆ conflict() [2/2]

void conflict ( expr_vector const & fixed,
expr_vector const & lhs,
expr_vector const & rhs )
inline

Definition at line 4546 of file z3++.h.

4546 {
4547 assert(cb);
4548 assert(lhs.size() == rhs.size());
4549 expr conseq = ctx().bool_val(false);
4550 array<Z3_ast> _fixed(fixed);
4551 array<Z3_ast> _lhs(lhs);
4552 array<Z3_ast> _rhs(rhs);
4553 Z3_solver_propagate_consequence(ctx(), cb, fixed.size(), _fixed.ptr(), lhs.size(), _lhs.ptr(), _rhs.ptr(), conseq);
4554 }

◆ created()

virtual void created ( expr const & )
inlinevirtual

Definition at line 4507 of file z3++.h.

4507{}

Referenced by register_created().

◆ ctx()

◆ decide()

virtual void decide ( expr const & ,
unsigned ,
bool  )
inlinevirtual

Definition at line 4509 of file z3++.h.

4509{}

Referenced by register_decide().

◆ eq()

virtual void eq ( expr const & ,
expr const &  )
inlinevirtual

Definition at line 4503 of file z3++.h.

4503{ }

Referenced by register_eq().

◆ final()

virtual void final ( )
inlinevirtual

Definition at line 4505 of file z3++.h.

4505{ }

◆ fixed()

virtual void fixed ( expr const & ,
expr const &  )
inlinevirtual

Definition at line 4501 of file z3++.h.

4501{ }

Referenced by conflict(), conflict(), propagate(), propagate(), and register_fixed().

◆ fresh()

virtual user_propagator_base * fresh ( context & ctx)
pure virtual

user_propagators created using fresh() are created during search and their lifetimes are restricted to search time. They should be garbage collected by the propagator used to invoke fresh(). The life-time of the Z3_context object can only be assumed valid during callbacks, such as fixed(), which contains expressions based on the context.

◆ next_split()

bool next_split ( expr const & e,
unsigned idx,
Z3_lbool phase )
inline

Definition at line 4511 of file z3++.h.

4511 {
4512 assert(cb);
4513 return Z3_solver_next_split(ctx(), cb, e, idx, phase);
4514 }
bool Z3_API Z3_solver_next_split(Z3_context c, Z3_solver_callback cb, Z3_ast t, unsigned idx, Z3_lbool phase)

◆ pop()

virtual void pop ( unsigned num_scopes)
pure virtual

◆ propagate() [1/2]

bool propagate ( expr_vector const & fixed,
expr const & conseq )
inline

Definition at line 4556 of file z3++.h.

4556 {
4557 assert(cb);
4558 assert((Z3_context)conseq.ctx() == (Z3_context)ctx());
4559 array<Z3_ast> _fixed(fixed);
4560 return Z3_solver_propagate_consequence(ctx(), cb, _fixed.size(), _fixed.ptr(), 0, nullptr, nullptr, conseq);
4561 }

◆ propagate() [2/2]

bool propagate ( expr_vector const & fixed,
expr_vector const & lhs,
expr_vector const & rhs,
expr const & conseq )
inline

Definition at line 4563 of file z3++.h.

4565 {
4566 assert(cb);
4567 assert((Z3_context)conseq.ctx() == (Z3_context)ctx());
4568 assert(lhs.size() == rhs.size());
4569 array<Z3_ast> _fixed(fixed);
4570 array<Z3_ast> _lhs(lhs);
4571 array<Z3_ast> _rhs(rhs);
4572
4573 return Z3_solver_propagate_consequence(ctx(), cb, _fixed.size(), _fixed.ptr(), lhs.size(), _lhs.ptr(), _rhs.ptr(), conseq);
4574 }

◆ push()

virtual void push ( )
pure virtual

◆ register_created() [1/2]

void register_created ( )
inline

Definition at line 4476 of file z3++.h.

4476 {
4477 m_created_eh = [this](expr const& e) {
4478 created(e);
4479 };
4480 if (s) {
4481 Z3_solver_propagate_created(ctx(), *s, created_eh);
4482 }
4483 }
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...

◆ register_created() [2/2]

void register_created ( created_eh_t & c)
inline

Definition at line 4469 of file z3++.h.

4469 {
4470 m_created_eh = c;
4471 if (s) {
4472 Z3_solver_propagate_created(ctx(), *s, created_eh);
4473 }
4474 }

◆ register_decide() [1/2]

void register_decide ( )
inline

Definition at line 4492 of file z3++.h.

4492 {
4493 m_decide_eh = [this](expr val, unsigned bit, bool is_pos) {
4494 decide(val, bit, is_pos);
4495 };
4496 if (s) {
4497 Z3_solver_propagate_decide(ctx(), *s, decide_eh);
4498 }
4499 }
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...

◆ register_decide() [2/2]

void register_decide ( decide_eh_t & c)
inline

Definition at line 4485 of file z3++.h.

4485 {
4486 m_decide_eh = c;
4487 if (s) {
4488 Z3_solver_propagate_decide(ctx(), *s, decide_eh);
4489 }
4490 }

◆ register_eq() [1/2]

void register_eq ( )
inline

Definition at line 4436 of file z3++.h.

4436 {
4437 m_eq_eh = [this](expr const& x, expr const& y) {
4438 eq(x, y);
4439 };
4440 if (s) {
4441 Z3_solver_propagate_eq(ctx(), *s, eq_eh);
4442 }
4443 }
void Z3_API Z3_solver_propagate_eq(Z3_context c, Z3_solver s, Z3_eq_eh eq_eh)
register a callback on expression equalities.
bool eq(AstRef a, AstRef b)
Definition z3py.py:486

◆ register_eq() [2/2]

void register_eq ( eq_eh_t & f)
inline

Definition at line 4429 of file z3++.h.

4429 {
4430 m_eq_eh = f;
4431 if (s) {
4432 Z3_solver_propagate_eq(ctx(), *s, eq_eh);
4433 }
4434 }

◆ register_final() [1/2]

void register_final ( )
inline

Definition at line 4460 of file z3++.h.

4460 {
4461 m_final_eh = [this]() {
4462 final();
4463 };
4464 if (s) {
4465 Z3_solver_propagate_final(ctx(), *s, final_eh);
4466 }
4467 }
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...

◆ register_final() [2/2]

void register_final ( final_eh_t & f)
inline

register a callback on final-check. During the final check stage, all propagations have been processed. This is an opportunity for the user-propagator to delay some analysis that could be expensive to perform incrementally. It is also an opportunity for the propagator to implement branch and bound optimization.

Definition at line 4453 of file z3++.h.

4453 {
4454 m_final_eh = f;
4455 if (s) {
4456 Z3_solver_propagate_final(ctx(), *s, final_eh);
4457 }
4458 }

◆ register_fixed() [1/2]

void register_fixed ( )
inline

Definition at line 4420 of file z3++.h.

4420 {
4421 m_fixed_eh = [this](expr const &id, expr const &e) {
4422 fixed(id, e);
4423 };
4424 if (s) {
4425 Z3_solver_propagate_fixed(ctx(), *s, fixed_eh);
4426 }
4427 }
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 ...

◆ register_fixed() [2/2]

void register_fixed ( fixed_eh_t & f)
inline

register callbacks. Callbacks can only be registered with user_propagators that were created using a solver.

Definition at line 4413 of file z3++.h.

4413 {
4414 m_fixed_eh = f;
4415 if (s) {
4416 Z3_solver_propagate_fixed(ctx(), *s, fixed_eh);
4417 }
4418 }