Z3
Data Structures | Public Member Functions | Friends
solver Class Reference

#include <z3++.h>

+ Inheritance diagram for solver:

Data Structures

class  cube_generator
 
class  cube_iterator
 
struct  simple
 
struct  translate
 

Public Member Functions

 solver (context &c)
 
 solver (context &c, simple)
 
 solver (context &c, Z3_solver s)
 
 solver (context &c, char const *logic)
 
 solver (context &c, solver const &src, translate)
 
 solver (solver const &s)
 
 ~solver ()
 
 operator Z3_solver () const
 
solveroperator= (solver const &s)
 
void set (params const &p)
 
void set (char const *k, bool v)
 
void set (char const *k, unsigned v)
 
void set (char const *k, double v)
 
void set (char const *k, symbol const &v)
 
void set (char const *k, char const *v)
 
void push ()
 
void pop (unsigned n=1)
 
void reset ()
 
void add (expr const &e)
 
void add (expr const &e, expr const &p)
 
void add (expr const &e, char const *p)
 
void from_file (char const *file)
 
void from_string (char const *s)
 
check_result check ()
 
check_result check (unsigned n, expr *const assumptions)
 
check_result check (expr_vector const &assumptions)
 
model get_model () const
 
check_result consequences (expr_vector &assumptions, expr_vector &vars, expr_vector &conseq)
 
std::string reason_unknown () const
 
stats statistics () const
 
expr_vector unsat_core () const
 
expr_vector assertions () const
 
expr_vector non_units () const
 
expr_vector units () const
 
expr_vector trail () const
 
expr_vector trail (array< unsigned > &levels) const
 
expr proof () const
 
std::string to_smt2 (char const *status="unknown")
 
std::string dimacs () const
 
param_descrs get_param_descrs ()
 
expr_vector cube (expr_vector &vars, unsigned cutoff)
 
cube_generator cubes ()
 
cube_generator cubes (expr_vector &vars)
 
- 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, solver const &s)
 

Additional Inherited Members

- Protected Attributes inherited from object
contextm_ctx
 

Detailed Description

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

Constructor & Destructor Documentation

◆ solver() [1/6]

solver ( context c)
inline

◆ solver() [2/6]

solver ( context c,
simple   
)
inline

◆ solver() [3/6]

solver ( context c,
Z3_solver  s 
)
inline

◆ solver() [4/6]

solver ( context c,
char const *  logic 
)
inline

◆ solver() [5/6]

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

◆ solver() [6/6]

solver ( solver const &  s)
inline

◆ ~solver()

~solver ( )
inline

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

2311{ Z3_solver_dec_ref(ctx(), m_solver); }
context & ctx() const
Definition: z3++.h:406
void Z3_API Z3_solver_dec_ref(Z3_context c, Z3_solver s)
Decrement the reference counter of the given solver.

Member Function Documentation

◆ add() [1/3]

void add ( expr const &  e)
inline

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

2329{ assert(e.is_bool()); Z3_solver_assert(ctx(), m_solver, e); check_error(); }
Z3_error_code check_error() const
Definition: z3++.h:407
void Z3_API Z3_solver_assert(Z3_context c, Z3_solver s, Z3_ast a)
Assert a constraint into the solver.

Referenced by Solver::__iadd__(), Fixedpoint::__iadd__(), Optimize::__iadd__(), and solver::add().

◆ add() [2/3]

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

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

2335 {
2336 add(e, ctx().bool_const(p));
2337 }
void add(expr const &e)
Definition: z3++.h:2329

Referenced by Solver::__iadd__(), Fixedpoint::__iadd__(), and Optimize::__iadd__().

◆ add() [3/3]

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

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

2330 {
2331 assert(e.is_bool()); assert(p.is_bool()); assert(p.is_const());
2332 Z3_solver_assert_and_track(ctx(), m_solver, e, p);
2333 check_error();
2334 }
void Z3_API Z3_solver_assert_and_track(Z3_context c, Z3_solver s, Z3_ast a, Z3_ast p)
Assert a constraint a into the solver, and track it (in the unsat) core using the Boolean constant p.

Referenced by Solver::__iadd__(), Fixedpoint::__iadd__(), and Optimize::__iadd__().

◆ assertions()

expr_vector assertions ( ) const
inline

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

2374{ Z3_ast_vector r = Z3_solver_get_assertions(ctx(), m_solver); check_error(); return expr_vector(ctx(), r); }
ast_vector_tpl< expr > expr_vector
Definition: z3++.h:71
Z3_ast_vector Z3_API Z3_solver_get_assertions(Z3_context c, Z3_solver s)
Return the set of asserted formulas on the solver.

Referenced by solver::to_smt2(), and Solver::to_smt2().

◆ check() [1/3]

check_result check ( )
inline

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

2343{ Z3_lbool r = Z3_solver_check(ctx(), m_solver); check_error(); return to_check_result(r); }
check_result to_check_result(Z3_lbool l)
Definition: z3++.h:141
Z3_lbool Z3_API Z3_solver_check(Z3_context c, Z3_solver s)
Check whether the assertions in a given solver are consistent or not.
Z3_lbool
Lifted Boolean type: false, undefined, true.
Definition: z3_api.h:100

◆ check() [2/3]

check_result check ( expr_vector const &  assumptions)
inline

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

2354 {
2355 unsigned n = assumptions.size();
2356 array<Z3_ast> _assumptions(n);
2357 for (unsigned i = 0; i < n; i++) {
2358 check_context(*this, assumptions[i]);
2359 _assumptions[i] = assumptions[i];
2360 }
2361 Z3_lbool r = Z3_solver_check_assumptions(ctx(), m_solver, n, _assumptions.ptr());
2362 check_error();
2363 return to_check_result(r);
2364 }
friend void check_context(object const &a, object const &b)
Definition: z3++.h:410
Z3_lbool Z3_API Z3_solver_check_assumptions(Z3_context c, Z3_solver s, unsigned num_assumptions, Z3_ast const assumptions[])
Check whether the assertions in the given solver and optional assumptions are consistent or not.

◆ check() [3/3]

check_result check ( unsigned  n,
expr *const  assumptions 
)
inline

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

2344 {
2345 array<Z3_ast> _assumptions(n);
2346 for (unsigned i = 0; i < n; i++) {
2347 check_context(*this, assumptions[i]);
2348 _assumptions[i] = assumptions[i];
2349 }
2350 Z3_lbool r = Z3_solver_check_assumptions(ctx(), m_solver, n, _assumptions.ptr());
2351 check_error();
2352 return to_check_result(r);
2353 }

◆ consequences()

check_result consequences ( expr_vector assumptions,
expr_vector vars,
expr_vector conseq 
)
inline

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

2366 {
2367 Z3_lbool r = Z3_solver_get_consequences(ctx(), m_solver, assumptions, vars, conseq);
2368 check_error();
2369 return to_check_result(r);
2370 }
Z3_lbool Z3_API Z3_solver_get_consequences(Z3_context c, Z3_solver s, Z3_ast_vector assumptions, Z3_ast_vector variables, Z3_ast_vector consequences)
retrieve consequences from solver that determine values of the supplied function symbols.

◆ cube()

expr_vector cube ( expr_vector vars,
unsigned  cutoff 
)
inline

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

2416 {
2417 Z3_ast_vector r = Z3_solver_cube(ctx(), m_solver, vars, cutoff);
2418 check_error();
2419 return expr_vector(ctx(), r);
2420 }
Z3_ast_vector Z3_API Z3_solver_cube(Z3_context c, Z3_solver s, Z3_ast_vector vars, unsigned backtrack_level)
extract a next cube for a solver. The last cube is the constant true or false. The number of (non-con...

◆ cubes() [1/2]

cube_generator cubes ( )
inline

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

2503{ return cube_generator(*this); }

◆ cubes() [2/2]

cube_generator cubes ( expr_vector vars)
inline

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

2504{ return cube_generator(*this, vars); }

◆ dimacs()

std::string dimacs ( ) const
inline

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

2411{ return std::string(Z3_solver_to_dimacs_string(ctx(), m_solver)); }
Z3_string Z3_API Z3_solver_to_dimacs_string(Z3_context c, Z3_solver s)
Convert a solver into a DIMACS formatted string.

◆ from_file()

void from_file ( char const *  file)
inline

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

2340{ Z3_solver_from_file(ctx(), m_solver, file); ctx().check_parser_error(); }
void check_parser_error() const
Definition: z3++.h:185
void Z3_API Z3_solver_from_file(Z3_context c, Z3_solver s, Z3_string file_name)
load solver assertions from a file.

◆ from_string()

void from_string ( char const *  s)
inline

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

2341{ Z3_solver_from_string(ctx(), m_solver, s); ctx().check_parser_error(); }
void Z3_API Z3_solver_from_string(Z3_context c, Z3_solver s, Z3_string file_name)
load solver assertions from a string.

◆ get_model()

model get_model ( ) const
inline

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

2365{ Z3_model m = Z3_solver_get_model(ctx(), m_solver); check_error(); return model(ctx(), m); }
Z3_model Z3_API Z3_solver_get_model(Z3_context c, Z3_solver s)
Retrieve the model for the last Z3_solver_check or Z3_solver_check_assumptions.

◆ get_param_descrs()

param_descrs get_param_descrs ( )
inline

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

2413{ return param_descrs(ctx(), Z3_solver_get_param_descrs(ctx(), m_solver)); }
Z3_param_descrs Z3_API Z3_solver_get_param_descrs(Z3_context c, Z3_solver s)
Return the parameter description set for the given solver object.

◆ non_units()

expr_vector non_units ( ) const
inline

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

2375{ Z3_ast_vector r = Z3_solver_get_non_units(ctx(), m_solver); check_error(); return expr_vector(ctx(), r); }
Z3_ast_vector Z3_API Z3_solver_get_non_units(Z3_context c, Z3_solver s)
Return the set of non units in the solver state.

◆ operator Z3_solver()

operator Z3_solver ( ) const
inline

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

2312{ return m_solver; }

◆ operator=()

solver & operator= ( solver const &  s)
inline

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

2313 {
2314 Z3_solver_inc_ref(s.ctx(), s.m_solver);
2315 Z3_solver_dec_ref(ctx(), m_solver);
2316 m_ctx = s.m_ctx;
2317 m_solver = s.m_solver;
2318 return *this;
2319 }
context * m_ctx
Definition: z3++.h:402
void Z3_API Z3_solver_inc_ref(Z3_context c, Z3_solver s)
Increment the reference counter of the given solver.

◆ pop()

void pop ( unsigned  n = 1)
inline

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

2327{ Z3_solver_pop(ctx(), m_solver, n); check_error(); }
void Z3_API Z3_solver_pop(Z3_context c, Z3_solver s, unsigned n)
Backtrack n backtracking points.

◆ proof()

expr proof ( ) const
inline

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

2388{ Z3_ast r = Z3_solver_get_proof(ctx(), m_solver); check_error(); return expr(ctx(), r); }
Z3_ast Z3_API Z3_solver_get_proof(Z3_context c, Z3_solver s)
Retrieve the proof for the last Z3_solver_check or Z3_solver_check_assumptions.

◆ push()

void push ( )
inline

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

2326{ Z3_solver_push(ctx(), m_solver); check_error(); }
void Z3_API Z3_solver_push(Z3_context c, Z3_solver s)
Create a backtracking point.

◆ reason_unknown()

std::string reason_unknown ( ) const
inline

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

2371{ Z3_string r = Z3_solver_get_reason_unknown(ctx(), m_solver); check_error(); return r; }
const char * Z3_string
Z3 string type. It is just an alias for const char *.
Definition: z3_api.h:82
Z3_string Z3_API Z3_solver_get_reason_unknown(Z3_context c, Z3_solver s)
Return a brief justification for an "unknown" result (i.e., Z3_L_UNDEF) for the commands Z3_solver_ch...

◆ reset()

void reset ( )
inline

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

2328{ Z3_solver_reset(ctx(), m_solver); check_error(); }
void Z3_API Z3_solver_reset(Z3_context c, Z3_solver s)
Remove all assertions from the solver.

◆ set() [1/6]

void set ( char const *  k,
bool  v 
)
inline

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

2321{ params p(ctx()); p.set(k, v); set(p); }
void set(params const &p)
Definition: z3++.h:2320

Referenced by solver::set().

◆ set() [2/6]

void set ( char const *  k,
char const *  v 
)
inline

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

2325{ params p(ctx()); p.set(k, v); set(p); }

Referenced by solver::set().

◆ set() [3/6]

void set ( char const *  k,
double  v 
)
inline

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

2323{ params p(ctx()); p.set(k, v); set(p); }

Referenced by solver::set().

◆ set() [4/6]

void set ( char const *  k,
symbol const &  v 
)
inline

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

2324{ params p(ctx()); p.set(k, v); set(p); }

Referenced by solver::set().

◆ set() [5/6]

void set ( char const *  k,
unsigned  v 
)
inline

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

2322{ params p(ctx()); p.set(k, v); set(p); }

Referenced by solver::set().

◆ set() [6/6]

void set ( params const &  p)
inline

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

2320{ Z3_solver_set_params(ctx(), m_solver, p); check_error(); }
void Z3_API Z3_solver_set_params(Z3_context c, Z3_solver s, Z3_params p)
Set the given solver using the given parameters.

◆ statistics()

stats statistics ( ) const
inline

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

2372{ Z3_stats r = Z3_solver_get_statistics(ctx(), m_solver); check_error(); return stats(ctx(), r); }
Z3_stats Z3_API Z3_solver_get_statistics(Z3_context c, Z3_solver s)
Return statistics for the given solver.

◆ to_smt2()

std::string to_smt2 ( char const *  status = "unknown")
inline

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

2391 {
2392 array<Z3_ast> es(assertions());
2393 Z3_ast const* fmls = es.ptr();
2394 Z3_ast fml = 0;
2395 unsigned sz = es.size();
2396 if (sz > 0) {
2397 --sz;
2398 fml = fmls[sz];
2399 }
2400 else {
2401 fml = ctx().bool_val(true);
2402 }
2403 return std::string(Z3_benchmark_to_smtlib_string(
2404 ctx(),
2405 "", "", status, "",
2406 sz,
2407 fmls,
2408 fml));
2409 }
expr bool_val(bool b)
Definition: z3++.h:3096
expr_vector assertions() const
Definition: z3++.h:2374
Z3_string Z3_API Z3_benchmark_to_smtlib_string(Z3_context c, Z3_string name, Z3_string logic, Z3_string status, Z3_string attributes, unsigned num_assumptions, Z3_ast const assumptions[], Z3_ast formula)
Convert the given benchmark into SMT-LIB formatted string.

◆ trail() [1/2]

expr_vector trail ( ) const
inline

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

2377{ Z3_ast_vector r = Z3_solver_get_trail(ctx(), m_solver); check_error(); return expr_vector(ctx(), r); }
Z3_ast_vector Z3_API Z3_solver_get_trail(Z3_context c, Z3_solver s)
Return the trail modulo model conversion, in order of decision level The decision level can be retrie...

Referenced by Solver::trail_levels().

◆ trail() [2/2]

expr_vector trail ( array< unsigned > &  levels) const
inline

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

2378 {
2379 Z3_ast_vector r = Z3_solver_get_trail(ctx(), m_solver);
2380 check_error();
2381 expr_vector result(ctx(), r);
2382 unsigned sz = result.size();
2383 levels.resize(sz);
2384 Z3_solver_get_levels(ctx(), m_solver, r, sz, levels.ptr());
2385 check_error();
2386 return result;
2387 }
void Z3_API Z3_solver_get_levels(Z3_context c, Z3_solver s, Z3_ast_vector literals, unsigned sz, unsigned levels[])
retrieve the decision depth of Boolean literals (variables or their negations). Assumes a check-sat c...

Referenced by Solver::trail_levels().

◆ units()

expr_vector units ( ) const
inline

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

2376{ Z3_ast_vector r = Z3_solver_get_units(ctx(), m_solver); check_error(); return expr_vector(ctx(), r); }
Z3_ast_vector Z3_API Z3_solver_get_units(Z3_context c, Z3_solver s)
Return the set of units modulo model conversion.

◆ unsat_core()

expr_vector unsat_core ( ) const
inline

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

2373{ Z3_ast_vector r = Z3_solver_get_unsat_core(ctx(), m_solver); check_error(); return expr_vector(ctx(), r); }
Z3_ast_vector Z3_API Z3_solver_get_unsat_core(Z3_context c, Z3_solver s)
Retrieve the unsat core for the last Z3_solver_check_assumptions The unsat core is a subset of the as...

Friends And Related Function Documentation

◆ operator<<

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

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

2507{ out << Z3_solver_to_string(s.ctx(), s); return out; }
Z3_string Z3_API Z3_solver_to_string(Z3_context c, Z3_solver s)
Convert a solver into a string.