Z3
 
Loading...
Searching...
No Matches
Data Structures | Public Member Functions | Friends
optimize Class Reference

#include <z3++.h>

+ Inheritance diagram for optimize:

Data Structures

class  handle
 
struct  translate
 

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_vector lower_as_vector (handle const &h) const
 
expr upper (handle const &h)
 
expr_vector upper_as_vector (handle const &h) const
 
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 3629 of file z3++.h.

Constructor & Destructor Documentation

◆ optimize() [1/4]

optimize ( context c)
inline

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

3640:object(c) { m_opt = Z3_mk_optimize(c); Z3_optimize_inc_ref(c, m_opt); }
object(context &c)
Definition z3++.h:558
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.

◆ optimize() [2/4]

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

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

3641 : object(c) {
3642 Z3_optimize o = Z3_optimize_translate(src.ctx(), src, c);
3643 check_error();
3644 m_opt = o;
3645 Z3_optimize_inc_ref(c, m_opt);
3646 }
Z3_error_code check_error() const
Definition z3++.h:561
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 3647 of file z3++.h.

3647 :object(o), m_opt(o.m_opt) {
3648 Z3_optimize_inc_ref(o.ctx(), o.m_opt);
3649 }

◆ optimize() [4/4]

optimize ( context c,
optimize src 
)
inline

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

3650 :object(c) {
3651 m_opt = Z3_mk_optimize(c);
3652 Z3_optimize_inc_ref(c, m_opt);
3653 add(expr_vector(c, src.assertions()));
3654 expr_vector v(c, src.objectives());
3655 for (expr_vector::iterator it = v.begin(); it != v.end(); ++it) minimize(*it);
3656 }
void add(expr const &e)
Definition z3++.h:3666
handle minimize(expr const &e)
Definition z3++.h:3707
ast_vector_tpl< expr > expr_vector
Definition z3++.h:77

◆ ~optimize()

~optimize ( )
inlineoverride

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

3664{ Z3_optimize_dec_ref(ctx(), m_opt); }
context & ctx() const
Definition z3++.h:560
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 3666 of file z3++.h.

3666 {
3667 assert(e.is_bool());
3668 Z3_optimize_assert(ctx(), m_opt, e);
3669 }
void Z3_API Z3_optimize_assert(Z3_context c, Z3_optimize o, Z3_ast a)
Assert hard constraint to the optimization context.

Referenced by Solver::__iadd__(), optimize::add(), optimize::add(), and optimize::optimize().

◆ add() [2/5]

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

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

3677 {
3678 assert(e.is_bool());
3679 add(e, ctx().bool_const(p));
3680 }

Referenced by Solver::__iadd__().

◆ add() [3/5]

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

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

3673 {
3674 assert(e.is_bool());
3675 Z3_optimize_assert_and_track(ctx(), m_opt, e, t);
3676 }
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.

Referenced by Solver::__iadd__().

◆ add() [4/5]

handle add ( expr const e,
unsigned  weight 
)
inline

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

3690 {
3691 return add_soft(e, weight);
3692 }
handle add_soft(expr const &e, unsigned weight)
Definition z3++.h:3681

Referenced by Solver::__iadd__().

◆ add() [5/5]

void add ( expr_vector const es)
inline

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

3670 {
3671 for (expr_vector::iterator it = es.begin(); it != es.end(); ++it) add(*it);
3672 }

Referenced by Solver::__iadd__().

◆ add_soft() [1/2]

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

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

3686 {
3687 assert(e.is_bool());
3688 return handle(Z3_optimize_assert_soft(ctx(), m_opt, e, weight, 0));
3689 }
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 3681 of file z3++.h.

3681 {
3682 assert(e.is_bool());
3683 auto str = std::to_string(weight);
3684 return handle(Z3_optimize_assert_soft(ctx(), m_opt, e, str.c_str(), 0));
3685 }

Referenced by optimize::add().

◆ assertions()

expr_vector assertions ( ) const
inline

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

3751{ 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.
System.IntPtr Z3_ast_vector

◆ check() [1/2]

check_result check ( )
inline

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

3716{ 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 3717 of file z3++.h.

3717 {
3718 unsigned n = asms.size();
3719 array<Z3_ast> _asms(n);
3720 for (unsigned i = 0; i < n; ++i) {
3721 check_context(*this, asms[i]);
3722 _asms[i] = asms[i];
3723 }
3724 Z3_lbool r = Z3_optimize_check(ctx(), m_opt, n, _asms.ptr());
3725 check_error();
3726 return to_check_result(r);
3727 }
friend void check_context(object const &a, object const &b)
Definition z3++.h:564

◆ from_file()

void from_file ( char const filename)
inline

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

3755{ 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 3756 of file z3++.h.

3756{ 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 3728 of file z3++.h.

3728{ 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.
System.IntPtr Z3_model

◆ help()

std::string help ( ) const
inline

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

3757{ 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 3731 of file z3++.h.

3731 {
3732 Z3_ast r = Z3_optimize_get_lower(ctx(), m_opt, h.h());
3733 check_error();
3734 return expr(ctx(), r);
3735 }
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.
System.IntPtr Z3_ast

◆ lower_as_vector()

expr_vector lower_as_vector ( handle const h) const
inline

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

3736 {
3738 check_error();
3739 return expr_vector(ctx(), r);
3740 }
Z3_ast_vector Z3_API Z3_optimize_get_lower_as_vector(Z3_context c, Z3_optimize o, unsigned idx)
Retrieve lower bound value or approximation for the i'th optimization objective. The returned vector ...

◆ maximize()

handle maximize ( expr const e)
inline

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

3704 {
3705 return handle(Z3_optimize_maximize(ctx(), m_opt, e));
3706 }
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 3707 of file z3++.h.

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

Referenced by optimize::optimize().

◆ objectives()

expr_vector objectives ( ) const
inline

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

3752{ 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...

◆ operator Z3_optimize()

operator Z3_optimize ( ) const
inline

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

3665{ return m_opt; }

◆ operator=()

optimize & operator= ( optimize const o)
inline

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

3657 {
3658 Z3_optimize_inc_ref(o.ctx(), o.m_opt);
3659 Z3_optimize_dec_ref(ctx(), m_opt);
3660 m_opt = o.m_opt;
3661 object::operator=(o);
3662 return *this;
3663 }

◆ pop()

void pop ( )
inline

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

3713 {
3714 Z3_optimize_pop(ctx(), m_opt);
3715 }
void Z3_API Z3_optimize_pop(Z3_context c, Z3_optimize d)
Backtrack one level.

Referenced by Solver::__exit__().

◆ push()

void push ( )
inline

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

3710 {
3711 Z3_optimize_push(ctx(), m_opt);
3712 }
void Z3_API Z3_optimize_push(Z3_context c, Z3_optimize d)
Create a backtracking point.

Referenced by Solver::__enter__().

◆ set()

void set ( params const p)
inline

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

3730{ 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, including parameters for the underlying SMT solver.

◆ set_initial_value() [1/3]

void set_initial_value ( expr const var,
bool  b 
)
inline

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

3700 {
3701 set_initial_value(var, ctx().bool_val(b));
3702 }
void set_initial_value(expr const &var, expr const &value)
Definition z3++.h:3693

◆ set_initial_value() [2/3]

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

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

3693 {
3694 Z3_optimize_set_initial_value(ctx(), m_opt, var, value);
3695 check_error();
3696 }
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 optimize::set_initial_value(), and optimize::set_initial_value().

◆ set_initial_value() [3/3]

void set_initial_value ( expr const var,
int  i 
)
inline

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

3697 {
3698 set_initial_value(var, ctx().num_val(i, var.get_sort()));
3699 }

◆ statistics()

stats statistics ( ) const
inline

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

3753{ 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.
System.IntPtr Z3_stats

◆ unsat_core()

expr_vector unsat_core ( ) const
inline

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

3729{ 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 3741 of file z3++.h.

3741 {
3742 Z3_ast r = Z3_optimize_get_upper(ctx(), m_opt, h.h());
3743 check_error();
3744 return expr(ctx(), r);
3745 }
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.

◆ upper_as_vector()

expr_vector upper_as_vector ( handle const h) const
inline

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

3746 {
3748 check_error();
3749 return expr_vector(ctx(), r);
3750 }
Z3_ast_vector Z3_API Z3_optimize_get_upper_as_vector(Z3_context c, Z3_optimize o, unsigned idx)
Retrieve upper bound value or approximation for the i'th optimization objective.

Friends And Related Symbol Documentation

◆ operator<<

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

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

3759{ 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.