Z3
Public Member Functions
fixedpoint Class Reference
+ Inheritance diagram for fixedpoint:

Public Member Functions

 fixedpoint (context &c)
 
 ~fixedpoint ()
 
 operator Z3_fixedpoint () const
 
void from_string (char const *s)
 
void from_file (char const *s)
 
void add_rule (expr &rule, symbol const &name)
 
void add_fact (func_decl &f, unsigned *args)
 
check_result query (expr &q)
 
check_result query (func_decl_vector &relations)
 
expr get_answer ()
 
std::string reason_unknown ()
 
void update_rule (expr &rule, symbol const &name)
 
unsigned get_num_levels (func_decl &p)
 
expr get_cover_delta (int level, func_decl &p)
 
void add_cover (int level, func_decl &p, expr &property)
 
stats statistics () const
 
void register_relation (func_decl &p)
 
expr_vector assertions () const
 
expr_vector rules () const
 
void set (params const &p)
 
std::string help () const
 
param_descrs get_param_descrs ()
 
std::string to_string ()
 
std::string to_string (expr_vector const &queries)
 
void push ()
 
void pop ()
 
- Public Member Functions inherited from object
 object (context &c)
 
 object (object const &s)
 
contextctx () const
 
Z3_error_code check_error () const
 

Additional Inherited Members

- Protected Attributes inherited from object
contextm_ctx
 

Detailed Description

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

Constructor & Destructor Documentation

◆ fixedpoint()

fixedpoint ( context c)
inline

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

2333 :object(c) { m_fp = Z3_mk_fixedpoint(c); Z3_fixedpoint_inc_ref(c, m_fp); }
Z3_fixedpoint Z3_API Z3_mk_fixedpoint(Z3_context c)
Create a new fixedpoint context.
void Z3_API Z3_fixedpoint_inc_ref(Z3_context c, Z3_fixedpoint d)
Increment the reference counter of the given fixedpoint context.
object(context &c)
Definition: z3++.h:362

◆ ~fixedpoint()

~fixedpoint ( )
inline

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

2334 { Z3_fixedpoint_dec_ref(ctx(), m_fp); }
context & ctx() const
Definition: z3++.h:364
void Z3_API Z3_fixedpoint_dec_ref(Z3_context c, Z3_fixedpoint d)
Decrement the reference counter of the given fixedpoint context.

Member Function Documentation

◆ add_cover()

void add_cover ( int  level,
func_decl p,
expr property 
)
inline

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

2356 { Z3_fixedpoint_add_cover(ctx(), m_fp, level, p, property); check_error(); }
Z3_error_code check_error() const
Definition: z3++.h:365
context & ctx() const
Definition: z3++.h:364
void Z3_API Z3_fixedpoint_add_cover(Z3_context c, Z3_fixedpoint d, int level, Z3_func_decl pred, Z3_ast property)
Add property about the predicate pred. Add a property of predicate pred at level. It gets pushed forw...

◆ add_fact()

void add_fact ( func_decl f,
unsigned *  args 
)
inline

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

2339 { Z3_fixedpoint_add_fact(ctx(), m_fp, f, f.arity(), args); check_error(); }
Z3_error_code check_error() const
Definition: z3++.h:365
context & ctx() const
Definition: z3++.h:364
void Z3_API Z3_fixedpoint_add_fact(Z3_context c, Z3_fixedpoint d, Z3_func_decl r, unsigned num_args, unsigned args[])
Add a Database fact.

◆ add_rule()

void add_rule ( expr rule,
symbol const &  name 
)
inline

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

2338 { Z3_fixedpoint_add_rule(ctx(), m_fp, rule, name); check_error(); }
void Z3_API Z3_fixedpoint_add_rule(Z3_context c, Z3_fixedpoint d, Z3_ast rule, Z3_symbol name)
Add a universal Horn clause as a named rule. The horn_rule should be of the form: ...
Z3_error_code check_error() const
Definition: z3++.h:365
context & ctx() const
Definition: z3++.h:364

◆ assertions()

expr_vector assertions ( ) const
inline

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

2359 { Z3_ast_vector r = Z3_fixedpoint_get_assertions(ctx(), m_fp); check_error(); return expr_vector(ctx(), r); }
Z3_error_code check_error() const
Definition: z3++.h:365
context & ctx() const
Definition: z3++.h:364
Z3_ast_vector Z3_API Z3_fixedpoint_get_assertions(Z3_context c, Z3_fixedpoint f)
Retrieve set of background assertions from fixedpoint context.
ast_vector_tpl< expr > expr_vector
Definition: z3++.h:68

◆ from_file()

void from_file ( char const *  s)
inline

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

2337 { Z3_fixedpoint_from_file(ctx(), m_fp, s); check_error(); }
Z3_error_code check_error() const
Definition: z3++.h:365
context & ctx() const
Definition: z3++.h:364
Z3_ast_vector Z3_API Z3_fixedpoint_from_file(Z3_context c, Z3_fixedpoint f, Z3_string s)
Parse an SMT-LIB2 file with fixedpoint rules. Add the rules to the current fixedpoint context...

◆ from_string()

void from_string ( char const *  s)
inline

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

2336 { Z3_fixedpoint_from_string(ctx(), m_fp, s); check_error(); }
Z3_error_code check_error() const
Definition: z3++.h:365
Z3_ast_vector Z3_API Z3_fixedpoint_from_string(Z3_context c, Z3_fixedpoint f, Z3_string s)
Parse an SMT-LIB2 string with fixedpoint rules. Add the rules to the current fixedpoint context...
context & ctx() const
Definition: z3++.h:364

◆ get_answer()

expr get_answer ( )
inline

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

2347 { Z3_ast r = Z3_fixedpoint_get_answer(ctx(), m_fp); check_error(); return expr(ctx(), r); }
Z3_error_code check_error() const
Definition: z3++.h:365
context & ctx() const
Definition: z3++.h:364
Z3_ast Z3_API Z3_fixedpoint_get_answer(Z3_context c, Z3_fixedpoint d)
Retrieve a formula that encodes satisfying answers to the query.

◆ get_cover_delta()

expr get_cover_delta ( int  level,
func_decl p 
)
inline

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

2351  {
2352  Z3_ast r = Z3_fixedpoint_get_cover_delta(ctx(), m_fp, level, p);
2353  check_error();
2354  return expr(ctx(), r);
2355  }
Z3_error_code check_error() const
Definition: z3++.h:365
context & ctx() const
Definition: z3++.h:364
Z3_ast Z3_API Z3_fixedpoint_get_cover_delta(Z3_context c, Z3_fixedpoint d, int level, Z3_func_decl pred)

◆ get_num_levels()

unsigned get_num_levels ( func_decl p)
inline

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

2350 { unsigned r = Z3_fixedpoint_get_num_levels(ctx(), m_fp, p); check_error(); return r; }
Z3_error_code check_error() const
Definition: z3++.h:365
context & ctx() const
Definition: z3++.h:364
unsigned Z3_API Z3_fixedpoint_get_num_levels(Z3_context c, Z3_fixedpoint d, Z3_func_decl pred)
Query the PDR engine for the maximal levels properties are known about predicate. ...

◆ get_param_descrs()

param_descrs get_param_descrs ( )
inline

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

2363 { return param_descrs(ctx(), Z3_fixedpoint_get_param_descrs(ctx(), m_fp)); }
context & ctx() const
Definition: z3++.h:364
Z3_param_descrs Z3_API Z3_fixedpoint_get_param_descrs(Z3_context c, Z3_fixedpoint f)
Return the parameter description set for the given fixedpoint object.

◆ help()

std::string help ( ) const
inline

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

2362 { return Z3_fixedpoint_get_help(ctx(), m_fp); }
context & ctx() const
Definition: z3++.h:364
Z3_string Z3_API Z3_fixedpoint_get_help(Z3_context c, Z3_fixedpoint f)
Return a string describing all fixedpoint available parameters.

◆ operator Z3_fixedpoint()

operator Z3_fixedpoint ( ) const
inline

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

2335 { return m_fp; }

◆ pop()

void pop ( )
inline

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

2370 { Z3_fixedpoint_pop(ctx(), m_fp); check_error(); }
Z3_error_code check_error() const
Definition: z3++.h:365
void Z3_API Z3_fixedpoint_pop(Z3_context c, Z3_fixedpoint d)
Backtrack one backtracking point.
context & ctx() const
Definition: z3++.h:364

◆ push()

void push ( )
inline

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

2369 { Z3_fixedpoint_push(ctx(), m_fp); check_error(); }
Z3_error_code check_error() const
Definition: z3++.h:365
void Z3_API Z3_fixedpoint_push(Z3_context c, Z3_fixedpoint d)
Create a backtracking point.
context & ctx() const
Definition: z3++.h:364

◆ query() [1/2]

check_result query ( expr q)
inline

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

2340 { Z3_lbool r = Z3_fixedpoint_query(ctx(), m_fp, q); check_error(); return to_check_result(r); }
Z3_error_code check_error() const
Definition: z3++.h:365
context & ctx() const
Definition: z3++.h:364
Z3_lbool
Lifted Boolean type: false, undefined, true.
Definition: z3_api.h:106
check_result to_check_result(Z3_lbool l)
Definition: z3++.h:130
Z3_lbool Z3_API Z3_fixedpoint_query(Z3_context c, Z3_fixedpoint d, Z3_ast query)
Pose a query against the asserted rules.

◆ query() [2/2]

check_result query ( func_decl_vector relations)
inline

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

2341  {
2342  array<Z3_func_decl> rs(relations);
2343  Z3_lbool r = Z3_fixedpoint_query_relations(ctx(), m_fp, rs.size(), rs.ptr());
2344  check_error();
2345  return to_check_result(r);
2346  }
Z3_error_code check_error() const
Definition: z3++.h:365
context & ctx() const
Definition: z3++.h:364
Z3_lbool
Lifted Boolean type: false, undefined, true.
Definition: z3_api.h:106
check_result to_check_result(Z3_lbool l)
Definition: z3++.h:130
Z3_lbool Z3_API Z3_fixedpoint_query_relations(Z3_context c, Z3_fixedpoint d, unsigned num_relations, Z3_func_decl const relations[])
Pose multiple queries against the asserted rules.

◆ reason_unknown()

std::string reason_unknown ( )
inline

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

2348 { return Z3_fixedpoint_get_reason_unknown(ctx(), m_fp); }
context & ctx() const
Definition: z3++.h:364
Z3_string Z3_API Z3_fixedpoint_get_reason_unknown(Z3_context c, Z3_fixedpoint d)
Retrieve a string that describes the last status returned by Z3_fixedpoint_query. ...

◆ register_relation()

void register_relation ( func_decl p)
inline

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

2358 { Z3_fixedpoint_register_relation(ctx(), m_fp, p); }
context & ctx() const
Definition: z3++.h:364
void Z3_API Z3_fixedpoint_register_relation(Z3_context c, Z3_fixedpoint d, Z3_func_decl f)
Register relation as Fixedpoint defined. Fixedpoint defined relations have least-fixedpoint semantics...

◆ rules()

expr_vector rules ( ) const
inline

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

2360 { Z3_ast_vector r = Z3_fixedpoint_get_rules(ctx(), m_fp); check_error(); return expr_vector(ctx(), r); }
Z3_error_code check_error() const
Definition: z3++.h:365
context & ctx() const
Definition: z3++.h:364
Z3_ast_vector Z3_API Z3_fixedpoint_get_rules(Z3_context c, Z3_fixedpoint f)
Retrieve set of rules from fixedpoint context.
ast_vector_tpl< expr > expr_vector
Definition: z3++.h:68

◆ set()

void set ( params const &  p)
inline

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

2361 { Z3_fixedpoint_set_params(ctx(), m_fp, p); check_error(); }
Z3_error_code check_error() const
Definition: z3++.h:365
context & ctx() const
Definition: z3++.h:364
void Z3_API Z3_fixedpoint_set_params(Z3_context c, Z3_fixedpoint f, Z3_params p)
Set parameters on fixedpoint context.

◆ statistics()

stats statistics ( ) const
inline

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

2357 { Z3_stats r = Z3_fixedpoint_get_statistics(ctx(), m_fp); check_error(); return stats(ctx(), r); }
Z3_error_code check_error() const
Definition: z3++.h:365
Z3_stats Z3_API Z3_fixedpoint_get_statistics(Z3_context c, Z3_fixedpoint d)
Retrieve statistics information from the last call to Z3_fixedpoint_query.
context & ctx() const
Definition: z3++.h:364

◆ to_string() [1/2]

std::string to_string ( )
inline

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

2364 { return Z3_fixedpoint_to_string(ctx(), m_fp, 0, 0); }
context & ctx() const
Definition: z3++.h:364
Z3_string Z3_API Z3_fixedpoint_to_string(Z3_context c, Z3_fixedpoint f, unsigned num_queries, Z3_ast queries[])
Print the current rules and background axioms as a string.

◆ to_string() [2/2]

std::string to_string ( expr_vector const &  queries)
inline

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

2365  {
2366  array<Z3_ast> qs(queries);
2367  return Z3_fixedpoint_to_string(ctx(), m_fp, qs.size(), qs.ptr());
2368  }
context & ctx() const
Definition: z3++.h:364
Z3_string Z3_API Z3_fixedpoint_to_string(Z3_context c, Z3_fixedpoint f, unsigned num_queries, Z3_ast queries[])
Print the current rules and background axioms as a string.

◆ update_rule()

void update_rule ( expr rule,
symbol const &  name 
)
inline

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

2349 { Z3_fixedpoint_update_rule(ctx(), m_fp, rule, name); check_error(); }
Z3_error_code check_error() const
Definition: z3++.h:365
context & ctx() const
Definition: z3++.h:364
void Z3_API Z3_fixedpoint_update_rule(Z3_context c, Z3_fixedpoint d, Z3_ast a, Z3_symbol name)
Update a named rule. A rule with the same name must have been previously created. ...