Z3
 
Loading...
Searching...
No Matches
fixedpoint Class Reference

#include <z3++.h>

+ Inheritance diagram for fixedpoint:

Public Member Functions

 fixedpoint (context &c)
 
 fixedpoint (fixedpoint const &o)
 
 ~fixedpoint () override
 
fixedpointoperator= (fixedpoint const &o)
 
 operator Z3_fixedpoint () const
 
expr_vector from_string (char const *s)
 
expr_vector 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)
 
- Public Member Functions inherited from object
 object (context &c)
 
virtual ~object ()=default
 
contextctx () const
 
Z3_error_code check_error () const
 

Additional Inherited Members

- Protected Attributes inherited from object
contextm_ctx
 

Detailed Description

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

Constructor & Destructor Documentation

◆ fixedpoint() [1/2]

fixedpoint ( context & c)
inline

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

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

◆ fixedpoint() [2/2]

fixedpoint ( fixedpoint const & o)
inline

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

3406:object(o), m_fp(o.m_fp) { Z3_fixedpoint_inc_ref(ctx(), m_fp); }
context & ctx() const
Definition z3++.h:474

◆ ~fixedpoint()

~fixedpoint ( )
inlineoverride

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

3407{ Z3_fixedpoint_dec_ref(ctx(), m_fp); }
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 3444 of file z3++.h.

3444{ Z3_fixedpoint_add_cover(ctx(), m_fp, level, p, property); check_error(); }
Z3_error_code check_error() const
Definition z3++.h:475
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 3427 of file z3++.h.

3427{ Z3_fixedpoint_add_fact(ctx(), m_fp, f, f.arity(), args); check_error(); }
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 3426 of file z3++.h.

3426{ 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:

◆ assertions()

expr_vector assertions ( ) const
inline

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

3447{ Z3_ast_vector r = Z3_fixedpoint_get_assertions(ctx(), m_fp); check_error(); return expr_vector(ctx(), r); }
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:76

◆ from_file()

expr_vector from_file ( char const * s)
inline

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

3421 {
3422 Z3_ast_vector r = Z3_fixedpoint_from_file(ctx(), m_fp, s);
3423 check_error();
3424 return expr_vector(ctx(), r);
3425 }
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()

expr_vector from_string ( char const * s)
inline

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

3416 {
3417 Z3_ast_vector r = Z3_fixedpoint_from_string(ctx(), m_fp, s);
3418 check_error();
3419 return expr_vector(ctx(), r);
3420 }
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....

◆ get_answer()

expr get_answer ( )
inline

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

3435{ Z3_ast r = Z3_fixedpoint_get_answer(ctx(), m_fp); check_error(); return expr(ctx(), r); }
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 3439 of file z3++.h.

3439 {
3440 Z3_ast r = Z3_fixedpoint_get_cover_delta(ctx(), m_fp, level, p);
3441 check_error();
3442 return expr(ctx(), r);
3443 }
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 3438 of file z3++.h.

3438{ unsigned r = Z3_fixedpoint_get_num_levels(ctx(), m_fp, p); check_error(); return r; }
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 3451 of file z3++.h.

3451{ return param_descrs(ctx(), Z3_fixedpoint_get_param_descrs(ctx(), m_fp)); }
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 3450 of file z3++.h.

3450{ return Z3_fixedpoint_get_help(ctx(), m_fp); }
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 3415 of file z3++.h.

3415{ return m_fp; }

◆ operator=()

fixedpoint & operator= ( fixedpoint const & o)
inline

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

3408 {
3409 Z3_fixedpoint_inc_ref(o.ctx(), o.m_fp);
3410 Z3_fixedpoint_dec_ref(ctx(), m_fp);
3411 m_fp = o.m_fp;
3412 object::operator=(o);
3413 return *this;
3414 }

◆ query() [1/2]

check_result query ( expr & q)
inline

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

3428{ Z3_lbool r = Z3_fixedpoint_query(ctx(), m_fp, q); check_error(); return to_check_result(r); }
Z3_lbool
Lifted Boolean type: false, undefined, true.
Definition z3_api.h:61
Z3_lbool Z3_API Z3_fixedpoint_query(Z3_context c, Z3_fixedpoint d, Z3_ast query)
Pose a query against the asserted rules.
check_result to_check_result(Z3_lbool l)
Definition z3++.h:147

◆ query() [2/2]

check_result query ( func_decl_vector & relations)
inline

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

3429 {
3430 array<Z3_func_decl> rs(relations);
3431 Z3_lbool r = Z3_fixedpoint_query_relations(ctx(), m_fp, rs.size(), rs.ptr());
3432 check_error();
3433 return to_check_result(r);
3434 }
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 3436 of file z3++.h.

3436{ return Z3_fixedpoint_get_reason_unknown(ctx(), m_fp); }
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 3446 of file z3++.h.

3446{ Z3_fixedpoint_register_relation(ctx(), m_fp, p); }
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 3448 of file z3++.h.

3448{ Z3_ast_vector r = Z3_fixedpoint_get_rules(ctx(), m_fp); check_error(); return expr_vector(ctx(), r); }
Z3_ast_vector Z3_API Z3_fixedpoint_get_rules(Z3_context c, Z3_fixedpoint f)
Retrieve set of rules from fixedpoint context.

◆ set()

void set ( params const & p)
inline

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

3449{ Z3_fixedpoint_set_params(ctx(), m_fp, p); check_error(); }
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 3445 of file z3++.h.

3445{ Z3_stats r = Z3_fixedpoint_get_statistics(ctx(), m_fp); check_error(); return stats(ctx(), r); }
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.

◆ to_string() [1/2]

std::string to_string ( )
inline

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

3452{ return Z3_fixedpoint_to_string(ctx(), m_fp, 0, 0); }
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 3453 of file z3++.h.

3453 {
3454 array<Z3_ast> qs(queries);
3455 return Z3_fixedpoint_to_string(ctx(), m_fp, qs.size(), qs.ptr());
3456 }

◆ update_rule()

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

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

3437{ Z3_fixedpoint_update_rule(ctx(), m_fp, rule, name); check_error(); }
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.