Z3
Data Structures | Public Member Functions | Friends
optimize Class Reference
+ Inheritance diagram for optimize:

Data Structures

class  handle
 

Public Member Functions

 optimize (context &c)
 
 optimize (optimize const &o)
 
 optimize (context &c, optimize &src)
 
optimizeoperator= (optimize const &o)
 
 ~optimize ()
 
 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)
 
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)
 
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 3247 of file z3++.h.

Constructor & Destructor Documentation

optimize ( context c)
inline

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

3257 :object(c) { m_opt = Z3_mk_optimize(c); Z3_optimize_inc_ref(c, m_opt); }
Z3_optimize Z3_API Z3_mk_optimize(Z3_context c)
Create a new optimize context.
void Z3_API Z3_optimize_inc_ref(Z3_context c, Z3_optimize d)
Increment the reference counter of the given optimize context.
object(context &c)
Definition: z3++.h:472
optimize ( optimize const &  o)
inline

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

3258  :object(o), m_opt(o.m_opt) {
3259  Z3_optimize_inc_ref(o.ctx(), o.m_opt);
3260  }
void Z3_API Z3_optimize_inc_ref(Z3_context c, Z3_optimize d)
Increment the reference counter of the given optimize context.
object(context &c)
Definition: z3++.h:472
optimize ( context c,
optimize src 
)
inline

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

3261  :object(c) {
3262  m_opt = Z3_mk_optimize(c);
3263  Z3_optimize_inc_ref(c, m_opt);
3264  add(expr_vector(c, src.assertions()));
3265  expr_vector v(c, src.objectives());
3266  for (expr_vector::iterator it = v.begin(); it != v.end(); ++it) minimize(*it);
3267  }
Z3_optimize Z3_API Z3_mk_optimize(Z3_context c)
Create a new optimize context.
void Z3_API Z3_optimize_inc_ref(Z3_context c, Z3_optimize d)
Increment the reference counter of the given optimize context.
void add(expr const &e)
Definition: z3++.h:3277
object(context &c)
Definition: z3++.h:472
handle minimize(expr const &e)
Definition: z3++.h:3307
ast_vector_tpl< expr > expr_vector
Definition: z3++.h:76
~optimize ( )
inline

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

3275 { Z3_optimize_dec_ref(ctx(), m_opt); }
context & ctx() const
Definition: z3++.h:473
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

void add ( expr const &  e)
inline

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

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

3277  {
3278  assert(e.is_bool());
3279  Z3_optimize_assert(ctx(), m_opt, e);
3280  }
void Z3_API Z3_optimize_assert(Z3_context c, Z3_optimize o, Z3_ast a)
Assert hard constraint to the optimization context.
context & ctx() const
Definition: z3++.h:473
void add ( expr_vector const &  es)
inline

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

3281  {
3282  for (expr_vector::iterator it = es.begin(); it != es.end(); ++it) add(*it);
3283  }
void add(expr const &e)
Definition: z3++.h:3277
void add ( expr const &  e,
expr const &  t 
)
inline

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

3284  {
3285  assert(e.is_bool());
3286  Z3_optimize_assert_and_track(ctx(), m_opt, e, t);
3287  }
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.
context & ctx() const
Definition: z3++.h:473
void add ( expr const &  e,
char const *  p 
)
inline

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

3288  {
3289  assert(e.is_bool());
3290  add(e, ctx().bool_const(p));
3291  }
context & ctx() const
Definition: z3++.h:473
void add(expr const &e)
Definition: z3++.h:3277
handle add ( expr const &  e,
unsigned  weight 
)
inline

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

3301  {
3302  return add_soft(e, weight);
3303  }
handle add_soft(expr const &e, unsigned weight)
Definition: z3++.h:3292
handle add_soft ( expr const &  e,
unsigned  weight 
)
inline

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

Referenced by optimize::add().

3292  {
3293  assert(e.is_bool());
3294  auto str = std::to_string(weight);
3295  return handle(Z3_optimize_assert_soft(ctx(), m_opt, e, str.c_str(), 0));
3296  }
context & ctx() const
Definition: z3++.h:473
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.
handle add_soft ( expr const &  e,
char const *  weight 
)
inline

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

3297  {
3298  assert(e.is_bool());
3299  return handle(Z3_optimize_assert_soft(ctx(), m_opt, e, weight, 0));
3300  }
context & ctx() const
Definition: z3++.h:473
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.
expr_vector assertions ( ) const
inline

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

Referenced by optimize::optimize().

3341 { Z3_ast_vector r = Z3_optimize_get_assertions(ctx(), m_opt); check_error(); return expr_vector(ctx(), r); }
Z3_error_code check_error() const
Definition: z3++.h:474
context & ctx() const
Definition: z3++.h:473
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.
ast_vector_tpl< expr > expr_vector
Definition: z3++.h:76
check_result check ( )
inline

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

3316 { Z3_lbool r = Z3_optimize_check(ctx(), m_opt, 0, 0); check_error(); return to_check_result(r); }
Z3_error_code check_error() const
Definition: z3++.h:474
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.
context & ctx() const
Definition: z3++.h:473
Z3_lbool
Lifted Boolean type: false, undefined, true.
Definition: z3_api.h:60
check_result to_check_result(Z3_lbool l)
Definition: z3++.h:147
check_result check ( expr_vector const &  asms)
inline

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

3317  {
3318  unsigned n = asms.size();
3319  array<Z3_ast> _asms(n);
3320  for (unsigned i = 0; i < n; i++) {
3321  check_context(*this, asms[i]);
3322  _asms[i] = asms[i];
3323  }
3324  Z3_lbool r = Z3_optimize_check(ctx(), m_opt, n, _asms.ptr());
3325  check_error();
3326  return to_check_result(r);
3327  }
Z3_error_code check_error() const
Definition: z3++.h:474
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.
context & ctx() const
Definition: z3++.h:473
Z3_lbool
Lifted Boolean type: false, undefined, true.
Definition: z3_api.h:60
friend void check_context(object const &a, object const &b)
Definition: z3++.h:477
check_result to_check_result(Z3_lbool l)
Definition: z3++.h:147
void from_file ( char const *  filename)
inline

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

3345 { Z3_optimize_from_file(ctx(), m_opt, filename); check_error(); }
Z3_error_code check_error() const
Definition: z3++.h:474
context & ctx() const
Definition: z3++.h:473
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. Add the parsed constraints and objectives to the optimization context.
void from_string ( char const *  constraints)
inline

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

3346 { Z3_optimize_from_string(ctx(), m_opt, constraints); check_error(); }
Z3_error_code check_error() const
Definition: z3++.h:474
context & ctx() const
Definition: z3++.h:473
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. Add the parsed constraints and objectives to the optimization context.
model get_model ( ) const
inline

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

3328 { Z3_model m = Z3_optimize_get_model(ctx(), m_opt); check_error(); return model(ctx(), m); }
Z3_error_code check_error() const
Definition: z3++.h:474
context & ctx() const
Definition: z3++.h:473
Z3_model Z3_API Z3_optimize_get_model(Z3_context c, Z3_optimize o)
Retrieve the model for the last Z3_optimize_check.
std::string help ( ) const
inline

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

3347 { char const * r = Z3_optimize_get_help(ctx(), m_opt); check_error(); return r; }
Z3_error_code check_error() const
Definition: z3++.h:474
context & ctx() const
Definition: z3++.h:473
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.
expr lower ( handle const &  h)
inline

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

3331  {
3332  Z3_ast r = Z3_optimize_get_lower(ctx(), m_opt, h.h());
3333  check_error();
3334  return expr(ctx(), r);
3335  }
Z3_error_code check_error() const
Definition: z3++.h:474
context & ctx() const
Definition: z3++.h:473
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.
handle maximize ( expr const &  e)
inline

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

3304  {
3305  return handle(Z3_optimize_maximize(ctx(), m_opt, e));
3306  }
context & ctx() const
Definition: z3++.h:473
unsigned Z3_API Z3_optimize_maximize(Z3_context c, Z3_optimize o, Z3_ast t)
Add a maximization constraint.
handle minimize ( expr const &  e)
inline

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

Referenced by optimize::optimize().

3307  {
3308  return handle(Z3_optimize_minimize(ctx(), m_opt, e));
3309  }
context & ctx() const
Definition: z3++.h:473
unsigned Z3_API Z3_optimize_minimize(Z3_context c, Z3_optimize o, Z3_ast t)
Add a minimization constraint.
expr_vector objectives ( ) const
inline

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

Referenced by optimize::optimize().

3342 { 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...
Z3_error_code check_error() const
Definition: z3++.h:474
context & ctx() const
Definition: z3++.h:473
ast_vector_tpl< expr > expr_vector
Definition: z3++.h:76
operator Z3_optimize ( ) const
inline

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

3276 { return m_opt; }
optimize& operator= ( optimize const &  o)
inline

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

3268  {
3269  Z3_optimize_inc_ref(o.ctx(), o.m_opt);
3270  Z3_optimize_dec_ref(ctx(), m_opt);
3271  m_opt = o.m_opt;
3272  object::operator=(o);
3273  return *this;
3274  }
void Z3_API Z3_optimize_inc_ref(Z3_context c, Z3_optimize d)
Increment the reference counter of the given optimize context.
context & ctx() const
Definition: z3++.h:473
void Z3_API Z3_optimize_dec_ref(Z3_context c, Z3_optimize d)
Decrement the reference counter of the given optimize context.
void pop ( )
inline

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

3313  {
3314  Z3_optimize_pop(ctx(), m_opt);
3315  }
context & ctx() const
Definition: z3++.h:473
void Z3_API Z3_optimize_pop(Z3_context c, Z3_optimize d)
Backtrack one level.
void push ( )
inline

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

3310  {
3311  Z3_optimize_push(ctx(), m_opt);
3312  }
context & ctx() const
Definition: z3++.h:473
void Z3_API Z3_optimize_push(Z3_context c, Z3_optimize d)
Create a backtracking point.
void set ( params const &  p)
inline

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

3330 { Z3_optimize_set_params(ctx(), m_opt, p); check_error(); }
Z3_error_code check_error() const
Definition: z3++.h:474
void Z3_API Z3_optimize_set_params(Z3_context c, Z3_optimize o, Z3_params p)
Set parameters on optimization context.
context & ctx() const
Definition: z3++.h:473
stats statistics ( ) const
inline

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

3343 { Z3_stats r = Z3_optimize_get_statistics(ctx(), m_opt); check_error(); return stats(ctx(), r); }
Z3_error_code check_error() const
Definition: z3++.h:474
context & ctx() const
Definition: z3++.h:473
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.
expr_vector unsat_core ( ) const
inline

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

3329 { Z3_ast_vector r = Z3_optimize_get_unsat_core(ctx(), m_opt); check_error(); return expr_vector(ctx(), r); }
Z3_error_code check_error() const
Definition: z3++.h:474
context & ctx() const
Definition: z3++.h:473
ast_vector_tpl< expr > expr_vector
Definition: z3++.h:76
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 ...
expr upper ( handle const &  h)
inline

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

3336  {
3337  Z3_ast r = Z3_optimize_get_upper(ctx(), m_opt, h.h());
3338  check_error();
3339  return expr(ctx(), r);
3340  }
Z3_error_code check_error() const
Definition: z3++.h:474
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.
context & ctx() const
Definition: z3++.h:473

Friends And Related Function Documentation

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

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

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