Z3
Loading...
Searching...
No Matches
optimize Class Reference

#include <z3++.h>

Inheritance diagram for optimize:

Data Structures

struct  translate
class  handle

Public Member Functions

 optimize (context &c)
 optimize (context &c, optimize const &src, translate)
 optimize (optimize const &o)
 optimize (context &c, optimize &src)
optimizeoperator= (optimize const &o)
 ~optimize () override
 operator Z3_optimize () const
void add (expr const &e)
void add (expr_vector const &es)
void add (expr const &e, expr const &t)
void add (expr const &e, char const *p)
handle add_soft (expr const &e, unsigned weight)
handle add_soft (expr const &e, char const *weight)
handle add (expr const &e, unsigned weight)
void set_initial_value (expr const &var, expr const &value)
void set_initial_value (expr const &var, int i)
void set_initial_value (expr const &var, bool b)
handle maximize (expr const &e)
handle minimize (expr const &e)
void push ()
void pop ()
check_result check ()
check_result check (expr_vector const &asms)
model get_model () const
expr_vector unsat_core () const
void set (params const &p)
expr lower (handle const &h)
expr upper (handle const &h)
expr_vector assertions () const
expr_vector objectives () const
stats statistics () const
void from_file (char const *filename)
void from_string (char const *constraints)
std::string help () const
Public Member Functions inherited from object
 object (context &c)
virtual ~object ()=default
contextctx () const
Z3_error_code check_error () const

Friends

std::ostream & operator<< (std::ostream &out, optimize const &s)

Additional Inherited Members

Protected Attributes inherited from object
contextm_ctx

Detailed Description

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

Constructor & Destructor Documentation

◆ optimize() [1/4]

optimize ( context & c)
inline

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

3512:object(c) { m_opt = Z3_mk_optimize(c); Z3_optimize_inc_ref(c, m_opt); }
void Z3_API Z3_optimize_inc_ref(Z3_context c, Z3_optimize d)
Increment the reference counter of the given optimize context.
Z3_optimize Z3_API Z3_mk_optimize(Z3_context c)
Create a new optimize context.

Referenced by operator<<, operator=(), optimize(), optimize(), and optimize().

◆ optimize() [2/4]

optimize ( context & c,
optimize const & src,
translate  )
inline

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

3513 : object(c) {
3514 Z3_optimize o = Z3_optimize_translate(src.ctx(), src, c);
3515 check_error();
3516 m_opt = o;
3517 Z3_optimize_inc_ref(c, m_opt);
3518 }
Z3_optimize Z3_API Z3_optimize_translate(Z3_context c, Z3_optimize o, Z3_context target)
Copy an optimization context from a source to a target context.

◆ optimize() [3/4]

optimize ( optimize const & o)
inline

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

3519 :object(o), m_opt(o.m_opt) {
3520 Z3_optimize_inc_ref(o.ctx(), o.m_opt);
3521 }

◆ optimize() [4/4]

optimize ( context & c,
optimize & src )
inline

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

3522 :object(c) {
3523 m_opt = Z3_mk_optimize(c);
3524 Z3_optimize_inc_ref(c, m_opt);
3525 add(expr_vector(c, src.assertions()));
3526 expr_vector v(c, src.objectives());
3527 for (expr_vector::iterator it = v.begin(); it != v.end(); ++it) minimize(*it);
3528 }
ast_vector_tpl< expr > expr_vector
Definition z3++.h:77

◆ ~optimize()

~optimize ( )
inlineoverride

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

3536{ Z3_optimize_dec_ref(ctx(), m_opt); }
void Z3_API Z3_optimize_dec_ref(Z3_context c, Z3_optimize d)
Decrement the reference counter of the given optimize context.

Member Function Documentation

◆ add() [1/5]

void add ( expr const & e)
inline

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

3538 {
3539 assert(e.is_bool());
3540 Z3_optimize_assert(ctx(), m_opt, e);
3541 }
void Z3_API Z3_optimize_assert(Z3_context c, Z3_optimize o, Z3_ast a)
Assert hard constraint to the optimization context.

Referenced by add(), add(), and optimize().

◆ add() [2/5]

void add ( expr const & e,
char const * p )
inline

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

3549 {
3550 assert(e.is_bool());
3551 add(e, ctx().bool_const(p));
3552 }

◆ add() [3/5]

void add ( expr const & e,
expr const & t )
inline

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

3545 {
3546 assert(e.is_bool());
3547 Z3_optimize_assert_and_track(ctx(), m_opt, e, t);
3548 }
void Z3_API Z3_optimize_assert_and_track(Z3_context c, Z3_optimize o, Z3_ast a, Z3_ast t)
Assert tracked hard constraint to the optimization context.

◆ add() [4/5]

handle add ( expr const & e,
unsigned weight )
inline

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

3562 {
3563 return add_soft(e, weight);
3564 }

◆ add() [5/5]

void add ( expr_vector const & es)
inline

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

3542 {
3543 for (expr_vector::iterator it = es.begin(); it != es.end(); ++it) add(*it);
3544 }

◆ add_soft() [1/2]

handle add_soft ( expr const & e,
char const * weight )
inline

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

3558 {
3559 assert(e.is_bool());
3560 return handle(Z3_optimize_assert_soft(ctx(), m_opt, e, weight, 0));
3561 }
unsigned Z3_API Z3_optimize_assert_soft(Z3_context c, Z3_optimize o, Z3_ast a, Z3_string weight, Z3_symbol id)
Assert soft constraint to the optimization context.

◆ add_soft() [2/2]

handle add_soft ( expr const & e,
unsigned weight )
inline

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

3553 {
3554 assert(e.is_bool());
3555 auto str = std::to_string(weight);
3556 return handle(Z3_optimize_assert_soft(ctx(), m_opt, e, str.c_str(), 0));
3557 }

Referenced by add().

◆ assertions()

expr_vector assertions ( ) const
inline

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

3613{ Z3_ast_vector r = Z3_optimize_get_assertions(ctx(), m_opt); check_error(); return expr_vector(ctx(), r); }
Z3_ast_vector Z3_API Z3_optimize_get_assertions(Z3_context c, Z3_optimize o)
Return the set of asserted formulas on the optimization context.

Referenced by optimize().

◆ check() [1/2]

check_result check ( )
inline

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

3588{ Z3_lbool r = Z3_optimize_check(ctx(), m_opt, 0, 0); check_error(); return to_check_result(r); }
Z3_lbool
Lifted Boolean type: false, undefined, true.
Definition z3_api.h:58
Z3_lbool Z3_API Z3_optimize_check(Z3_context c, Z3_optimize o, unsigned num_assumptions, Z3_ast const assumptions[])
Check consistency and produce optimal values.
check_result to_check_result(Z3_lbool l)
Definition z3++.h:178

◆ check() [2/2]

check_result check ( expr_vector const & asms)
inline

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

3589 {
3590 unsigned n = asms.size();
3591 array<Z3_ast> _asms(n);
3592 for (unsigned i = 0; i < n; ++i) {
3593 check_context(*this, asms[i]);
3594 _asms[i] = asms[i];
3595 }
3596 Z3_lbool r = Z3_optimize_check(ctx(), m_opt, n, _asms.ptr());
3597 check_error();
3598 return to_check_result(r);
3599 }
void check_context(object const &a, object const &b)
Definition z3++.h:548

◆ from_file()

void from_file ( char const * filename)
inline

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

3617{ Z3_optimize_from_file(ctx(), m_opt, filename); check_error(); }
void Z3_API Z3_optimize_from_file(Z3_context c, Z3_optimize o, Z3_string s)
Parse an SMT-LIB2 file with assertions, soft constraints and optimization objectives....

◆ from_string()

void from_string ( char const * constraints)
inline

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

3618{ Z3_optimize_from_string(ctx(), m_opt, constraints); check_error(); }
void Z3_API Z3_optimize_from_string(Z3_context c, Z3_optimize o, Z3_string s)
Parse an SMT-LIB2 string with assertions, soft constraints and optimization objectives....

◆ get_model()

model get_model ( ) const
inline

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

3600{ Z3_model m = Z3_optimize_get_model(ctx(), m_opt); check_error(); return model(ctx(), m); }
Z3_model Z3_API Z3_optimize_get_model(Z3_context c, Z3_optimize o)
Retrieve the model for the last Z3_optimize_check.

◆ help()

std::string help ( ) const
inline

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

3619{ char const * r = Z3_optimize_get_help(ctx(), m_opt); check_error(); return r; }
Z3_string Z3_API Z3_optimize_get_help(Z3_context c, Z3_optimize t)
Return a string containing a description of parameters accepted by optimize.

◆ lower()

expr lower ( handle const & h)
inline

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

3603 {
3604 Z3_ast r = Z3_optimize_get_lower(ctx(), m_opt, h.h());
3605 check_error();
3606 return expr(ctx(), r);
3607 }
Z3_ast Z3_API Z3_optimize_get_lower(Z3_context c, Z3_optimize o, unsigned idx)
Retrieve lower bound value or approximation for the i'th optimization objective.

◆ maximize()

handle maximize ( expr const & e)
inline

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

3576 {
3577 return handle(Z3_optimize_maximize(ctx(), m_opt, e));
3578 }
unsigned Z3_API Z3_optimize_maximize(Z3_context c, Z3_optimize o, Z3_ast t)
Add a maximization constraint.

◆ minimize()

handle minimize ( expr const & e)
inline

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

3579 {
3580 return handle(Z3_optimize_minimize(ctx(), m_opt, e));
3581 }
unsigned Z3_API Z3_optimize_minimize(Z3_context c, Z3_optimize o, Z3_ast t)
Add a minimization constraint.

Referenced by optimize().

◆ objectives()

expr_vector objectives ( ) const
inline

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

3614{ Z3_ast_vector r = Z3_optimize_get_objectives(ctx(), m_opt); check_error(); return expr_vector(ctx(), r); }
Z3_ast_vector Z3_API Z3_optimize_get_objectives(Z3_context c, Z3_optimize o)
Return objectives on the optimization context. If the objective function is a max-sat objective it is...

Referenced by optimize().

◆ operator Z3_optimize()

operator Z3_optimize ( ) const
inline

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

3537{ return m_opt; }

◆ operator=()

optimize & operator= ( optimize const & o)
inline

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

3529 {
3530 Z3_optimize_inc_ref(o.ctx(), o.m_opt);
3531 Z3_optimize_dec_ref(ctx(), m_opt);
3532 m_opt = o.m_opt;
3533 object::operator=(o);
3534 return *this;
3535 }

◆ pop()

void pop ( )
inline

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

3585 {
3586 Z3_optimize_pop(ctx(), m_opt);
3587 }
void Z3_API Z3_optimize_pop(Z3_context c, Z3_optimize d)
Backtrack one level.

◆ push()

void push ( )
inline

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

3582 {
3583 Z3_optimize_push(ctx(), m_opt);
3584 }
void Z3_API Z3_optimize_push(Z3_context c, Z3_optimize d)
Create a backtracking point.

◆ set()

void set ( params const & p)
inline

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

3602{ Z3_optimize_set_params(ctx(), m_opt, p); check_error(); }
void Z3_API Z3_optimize_set_params(Z3_context c, Z3_optimize o, Z3_params p)
Set parameters on optimization context.

◆ set_initial_value() [1/3]

void set_initial_value ( expr const & var,
bool b )
inline

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

3572 {
3573 set_initial_value(var, ctx().bool_val(b));
3574 }

◆ set_initial_value() [2/3]

void set_initial_value ( expr const & var,
expr const & value )
inline

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

3565 {
3566 Z3_optimize_set_initial_value(ctx(), m_opt, var, value);
3567 check_error();
3568 }
void Z3_API Z3_optimize_set_initial_value(Z3_context c, Z3_optimize o, Z3_ast v, Z3_ast val)
provide an initialization hint to the solver. The initialization hint is used to calibrate an initial...

Referenced by set_initial_value(), and set_initial_value().

◆ set_initial_value() [3/3]

void set_initial_value ( expr const & var,
int i )
inline

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

3569 {
3570 set_initial_value(var, ctx().num_val(i, var.get_sort()));
3571 }

◆ statistics()

stats statistics ( ) const
inline

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

3615{ Z3_stats r = Z3_optimize_get_statistics(ctx(), m_opt); check_error(); return stats(ctx(), r); }
Z3_stats Z3_API Z3_optimize_get_statistics(Z3_context c, Z3_optimize d)
Retrieve statistics information from the last call to Z3_optimize_check.

◆ unsat_core()

expr_vector unsat_core ( ) const
inline

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

3601{ Z3_ast_vector r = Z3_optimize_get_unsat_core(ctx(), m_opt); check_error(); return expr_vector(ctx(), r); }
Z3_ast_vector Z3_API Z3_optimize_get_unsat_core(Z3_context c, Z3_optimize o)
Retrieve the unsat core for the last Z3_optimize_check The unsat core is a subset of the assumptions ...

◆ upper()

expr upper ( handle const & h)
inline

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

3608 {
3609 Z3_ast r = Z3_optimize_get_upper(ctx(), m_opt, h.h());
3610 check_error();
3611 return expr(ctx(), r);
3612 }
Z3_ast Z3_API Z3_optimize_get_upper(Z3_context c, Z3_optimize o, unsigned idx)
Retrieve upper bound value or approximation for the i'th optimization objective.

◆ operator<<

std::ostream & operator<< ( std::ostream & out,
optimize const & s )
friend

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

3621{ out << Z3_optimize_to_string(s.ctx(), s.m_opt); return out; }
Z3_string Z3_API Z3_optimize_to_string(Z3_context c, Z3_optimize o)
Print the current context as a string.