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 &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)
 
 object (object const &s)
 
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 2827 of file z3++.h.

Constructor & Destructor Documentation

◆ optimize() [1/3]

optimize ( context c)
inline

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

2837 :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:416

◆ optimize() [2/3]

optimize ( optimize o)
inline

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

2838  :object(o) {
2839  Z3_optimize_inc_ref(o.ctx(), o.m_opt);
2840  m_opt = o.m_opt;
2841  }
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:416

◆ optimize() [3/3]

optimize ( context c,
optimize src 
)
inline

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

2842  :object(c) {
2843  m_opt = Z3_mk_optimize(c);
2844  Z3_optimize_inc_ref(c, m_opt);
2845  add(expr_vector(c, src.assertions()));
2846  expr_vector v(c, src.objectives());
2847  for (expr_vector::iterator it = v.begin(); it != v.end(); ++it) minimize(*it);
2848  }
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:2858
object(context &c)
Definition: z3++.h:416
handle minimize(expr const &e)
Definition: z3++.h:2888
ast_vector_tpl< expr > expr_vector
Definition: z3++.h:72

◆ ~optimize()

~optimize ( )
inline

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

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

2858  {
2859  assert(e.is_bool());
2860  Z3_optimize_assert(ctx(), m_opt, e);
2861  }
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:418

◆ add() [2/5]

void add ( expr_vector const &  es)
inline

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

2862  {
2863  for (expr_vector::iterator it = es.begin(); it != es.end(); ++it) add(*it);
2864  }
void add(expr const &e)
Definition: z3++.h:2858

◆ add() [3/5]

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

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

2865  {
2866  assert(e.is_bool());
2867  Z3_optimize_assert_and_track(ctx(), m_opt, e, t);
2868  }
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:418

◆ add() [4/5]

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

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

2869  {
2870  assert(e.is_bool());
2871  add(e, ctx().bool_const(p));
2872  }
context & ctx() const
Definition: z3++.h:418
void add(expr const &e)
Definition: z3++.h:2858

◆ add() [5/5]

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

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

2882  {
2883  return add_soft(e, weight);
2884  }
handle add_soft(expr const &e, unsigned weight)
Definition: z3++.h:2873

◆ add_soft() [1/2]

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

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

2873  {
2874  assert(e.is_bool());
2875  auto str = std::to_string(weight);
2876  return handle(Z3_optimize_assert_soft(ctx(), m_opt, e, str.c_str(), 0));
2877  }
context & ctx() const
Definition: z3++.h:418
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,
char const *  weight 
)
inline

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

2878  {
2879  assert(e.is_bool());
2880  return handle(Z3_optimize_assert_soft(ctx(), m_opt, e, weight, 0));
2881  }
context & ctx() const
Definition: z3++.h:418
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.

◆ assertions()

expr_vector assertions ( ) const
inline

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

Referenced by optimize::optimize().

2922 { 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:419
context & ctx() const
Definition: z3++.h:418
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:72

◆ check() [1/2]

check_result check ( )
inline

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

2897 { 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:419
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:418
Z3_lbool
Lifted Boolean type: false, undefined, true.
Definition: z3_api.h:99
check_result to_check_result(Z3_lbool l)
Definition: z3++.h:143

◆ check() [2/2]

check_result check ( expr_vector const &  asms)
inline

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

2898  {
2899  unsigned n = asms.size();
2900  array<Z3_ast> _asms(n);
2901  for (unsigned i = 0; i < n; i++) {
2902  check_context(*this, asms[i]);
2903  _asms[i] = asms[i];
2904  }
2905  Z3_lbool r = Z3_optimize_check(ctx(), m_opt, n, _asms.ptr());
2906  check_error();
2907  return to_check_result(r);
2908  }
Z3_error_code check_error() const
Definition: z3++.h:419
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:418
Z3_lbool
Lifted Boolean type: false, undefined, true.
Definition: z3_api.h:99
friend void check_context(object const &a, object const &b)
Definition: z3++.h:422
check_result to_check_result(Z3_lbool l)
Definition: z3++.h:143

◆ from_file()

void from_file ( char const *  filename)
inline

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

2926 { Z3_optimize_from_file(ctx(), m_opt, filename); check_error(); }
Z3_error_code check_error() const
Definition: z3++.h:419
context & ctx() const
Definition: z3++.h:418
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.

◆ from_string()

void from_string ( char const *  constraints)
inline

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

2927 { Z3_optimize_from_string(ctx(), m_opt, constraints); check_error(); }
Z3_error_code check_error() const
Definition: z3++.h:419
context & ctx() const
Definition: z3++.h:418
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.

◆ get_model()

model get_model ( ) const
inline

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

2909 { 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:419
context & ctx() const
Definition: z3++.h:418
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 2928 of file z3++.h.

2928 { char const * r = Z3_optimize_get_help(ctx(), m_opt); check_error(); return r; }
Z3_error_code check_error() const
Definition: z3++.h:419
context & ctx() const
Definition: z3++.h:418
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 2912 of file z3++.h.

2912  {
2913  Z3_ast r = Z3_optimize_get_lower(ctx(), m_opt, h.h());
2914  check_error();
2915  return expr(ctx(), r);
2916  }
Z3_error_code check_error() const
Definition: z3++.h:419
context & ctx() const
Definition: z3++.h:418
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&#39;th optimization objective.

◆ maximize()

handle maximize ( expr const &  e)
inline

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

2885  {
2886  return handle(Z3_optimize_maximize(ctx(), m_opt, e));
2887  }
context & ctx() const
Definition: z3++.h:418
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 2888 of file z3++.h.

2888  {
2889  return handle(Z3_optimize_minimize(ctx(), m_opt, e));
2890  }
context & ctx() const
Definition: z3++.h:418
unsigned Z3_API Z3_optimize_minimize(Z3_context c, Z3_optimize o, Z3_ast t)
Add a minimization constraint.

◆ objectives()

expr_vector objectives ( ) const
inline

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

Referenced by optimize::optimize().

2923 { 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:419
context & ctx() const
Definition: z3++.h:418
ast_vector_tpl< expr > expr_vector
Definition: z3++.h:72

◆ operator Z3_optimize()

operator Z3_optimize ( ) const
inline

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

2857 { return m_opt; }

◆ operator=()

optimize& operator= ( optimize const &  o)
inline

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

2849  {
2850  Z3_optimize_inc_ref(o.ctx(), o.m_opt);
2851  Z3_optimize_dec_ref(ctx(), m_opt);
2852  m_opt = o.m_opt;
2853  m_ctx = o.m_ctx;
2854  return *this;
2855  }
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:418
void Z3_API Z3_optimize_dec_ref(Z3_context c, Z3_optimize d)
Decrement the reference counter of the given optimize context.
context * m_ctx
Definition: z3++.h:414

◆ pop()

void pop ( )
inline

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

2894  {
2895  Z3_optimize_pop(ctx(), m_opt);
2896  }
context & ctx() const
Definition: z3++.h:418
void Z3_API Z3_optimize_pop(Z3_context c, Z3_optimize d)
Backtrack one level.

◆ push()

void push ( )
inline

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

2891  {
2892  Z3_optimize_push(ctx(), m_opt);
2893  }
context & ctx() const
Definition: z3++.h:418
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 2911 of file z3++.h.

2911 { Z3_optimize_set_params(ctx(), m_opt, p); check_error(); }
Z3_error_code check_error() const
Definition: z3++.h:419
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:418

◆ statistics()

stats statistics ( ) const
inline

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

2924 { 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:419
context & ctx() const
Definition: z3++.h:418
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 2910 of file z3++.h.

2910 { 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:419
context & ctx() const
Definition: z3++.h:418
ast_vector_tpl< expr > expr_vector
Definition: z3++.h:72
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 2917 of file z3++.h.

2917  {
2918  Z3_ast r = Z3_optimize_get_upper(ctx(), m_opt, h.h());
2919  check_error();
2920  return expr(ctx(), r);
2921  }
Z3_error_code check_error() const
Definition: z3++.h:419
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&#39;th optimization objective.
context & ctx() const
Definition: z3++.h:418

Friends And Related Function Documentation

◆ operator<<

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

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

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