context Class Reference

A Context manages all other Z3 objects, global configuration options, etc. More...

#include <z3++.h>

Public Member Functions
	context ()
	context (config &c)
	context (context &&other) noexcept
context &	operator= (context &&other) noexcept
	~context ()
	operator Z3_context () const
Z3_error_code	check_error () const
	Auxiliary method used to check for API usage errors.
void	check_parser_error () const
void	set_enable_exceptions (bool f)
	The C++ API uses by defaults exceptions on errors. For applications that don't work well with exceptions (there should be only few) you have the ability to turn off exceptions. The tradeoffs are that applications have to be very careful about using check_error() after calls that may result in an erroneous state.
bool	enable_exceptions () const
void	set (char const *param, char const *value)
	Update global parameter param with string value.
void	set (char const *param, bool value)
	Update global parameter param with Boolean value.
void	set (char const *param, int value)
	Update global parameter param with Integer value.
void	interrupt ()
	Interrupt the current procedure being executed by any object managed by this context. This is a soft interruption: there is no guarantee the object will actually stop.
symbol	str_symbol (char const *s)
	Create a Z3 symbol based on the given string.
symbol	int_symbol (int n)
	Create a Z3 symbol based on the given integer.
sort	bool_sort ()
	Return the Boolean sort.
sort	int_sort ()
	Return the integer sort.
sort	real_sort ()
	Return the Real sort.
sort	bv_sort (unsigned sz)
	Return the Bit-vector sort of size sz. That is, the sort for bit-vectors of size sz.
sort	char_sort ()
	Return the sort for Unicode characters.
sort	string_sort ()
	Return the sort for Unicode strings.
sort	seq_sort (sort &s)
	Return a sequence sort over base sort s.
sort	re_sort (sort &seq_sort)
	Return a regular expression sort over sequences seq_sort.
sort	finite_set_sort (sort &s)
	Return a finite set sort over element sort s.
sort	array_sort (sort d, sort r)
	Return an array sort for arrays from d to r.
sort	array_sort (sort_vector const &d, sort r)
sort	fpa_sort (unsigned ebits, unsigned sbits)
	Return a floating point sort. ebits is a number of exponent bits, sbits is a number of significand bits,.
template<size_t precision>
sort	fpa_sort ()
	Return a FloatingPoint sort with given precision bitwidth (16, 32, 64 or 128).
sort	fpa_rounding_mode_sort ()
	Return a RoundingMode sort.
void	set_rounding_mode (rounding_mode rm)
	Sets RoundingMode of FloatingPoints.
sort	enumeration_sort (char const *name, unsigned n, char const *const *enum_names, func_decl_vector &cs, func_decl_vector &ts)
	Return an enumeration sort: enum_names[0], ..., enum_names[n-1]. cs and ts are output parameters. The method stores in cs the constants corresponding to the enumerated elements, and in ts the predicates for testing if terms of the enumeration sort correspond to an enumeration.
func_decl	tuple_sort (char const *name, unsigned n, char const *const *names, sort const *sorts, func_decl_vector &projs)
	Return a tuple constructor. name is the name of the returned constructor, n are the number of arguments, names and sorts are their projected sorts. projs is an output parameter. It contains the set of projection functions.
sort	datatype (symbol const &name, constructors const &cs)
	Create a recursive datatype over a single sort. name is the name of the recursive datatype n - the number of constructors of the datatype cs - the n constructors used to define the datatype.
sort	datatype (symbol const &name, sort_vector const &params, constructors const &cs)
	Create a parametric recursive datatype. name is the name of the recursive datatype params - the sort parameters of the datatype cs - the n constructors used to define the datatype References to the datatype and mutually recursive datatypes can be created using datatype_sort.
sort_vector	datatypes (unsigned n, symbol const *names, constructor_list *const *cons)
	Create a set of mutually recursive datatypes. n - number of recursive datatypes names - array of names of length n cons - array of constructor lists of length n.
sort	datatype_sort (symbol const &name)
	a reference to a recursively defined datatype. Expect that it gets defined as a datatype.
sort	datatype_sort (symbol const &name, sort_vector const &params)
	a reference to a recursively defined parametric datatype. Expect that it gets defined as a datatype.
sort	uninterpreted_sort (char const *name)
	create an uninterpreted sort with the name given by the string or symbol.
sort	uninterpreted_sort (symbol const &name)
func_decl	function (symbol const &name, unsigned arity, sort const *domain, sort const &range)
func_decl	function (char const *name, unsigned arity, sort const *domain, sort const &range)
func_decl	function (symbol const &name, sort_vector const &domain, sort const &range)
func_decl	function (char const *name, sort_vector const &domain, sort const &range)
func_decl	function (char const *name, sort const &domain, sort const &range)
func_decl	function (char const *name, sort const &d1, sort const &d2, sort const &range)
func_decl	function (char const *name, sort const &d1, sort const &d2, sort const &d3, sort const &range)
func_decl	function (char const *name, sort const &d1, sort const &d2, sort const &d3, sort const &d4, sort const &range)
func_decl	function (char const *name, sort const &d1, sort const &d2, sort const &d3, sort const &d4, sort const &d5, sort const &range)
func_decl	recfun (symbol const &name, unsigned arity, sort const *domain, sort const &range)
func_decl	recfun (symbol const &name, const sort_vector &domain, sort const &range)
func_decl	recfun (char const *name, sort_vector const &domain, sort const &range)
func_decl	recfun (char const *name, unsigned arity, sort const *domain, sort const &range)
func_decl	recfun (char const *name, sort const &domain, sort const &range)
func_decl	recfun (char const *name, sort const &d1, sort const &d2, sort const &range)
void	recdef (func_decl decl, expr_vector const &args, expr const &body)
	add function definition body to declaration decl. decl needs to be declared using context::recfun.
func_decl	user_propagate_function (symbol const &name, sort_vector const &domain, sort const &range)
expr	constant (symbol const &name, sort const &s)
	create an uninterpreted constant.
expr	constant (char const *name, sort const &s)
expr	bool_const (char const *name)
	create uninterpreted constants of a given sort.
expr	int_const (char const *name)
expr	real_const (char const *name)
expr	string_const (char const *name)
expr	bv_const (char const *name, unsigned sz)
expr	fpa_const (char const *name, unsigned ebits, unsigned sbits)
template<size_t precision>
expr	fpa_const (char const *name)
expr	variable (unsigned index, sort const &s)
	create a de-Bruijn variable.
expr	fpa_rounding_mode ()
expr	bool_val (bool b)
expr	int_val (int n)
expr	int_val (unsigned n)
expr	int_val (int64_t n)
expr	int_val (uint64_t n)
expr	int_val (char const *n)
expr	real_val (int n)
expr	real_val (unsigned n)
expr	real_val (int64_t n)
expr	real_val (uint64_t n)
expr	real_val (int64_t n, int64_t d)
expr	real_val (char const *n)
expr	bv_val (int n, unsigned sz)
expr	bv_val (unsigned n, unsigned sz)
expr	bv_val (int64_t n, unsigned sz)
expr	bv_val (uint64_t n, unsigned sz)
expr	bv_val (char const *n, unsigned sz)
expr	bv_val (unsigned n, bool const *bits)
expr	fpa_val (double n)
expr	fpa_val (float n)
expr	fpa_nan (sort const &s)
expr	fpa_inf (sort const &s, bool sgn)
expr	string_val (char const *s)
expr	string_val (char const *s, unsigned n)
expr	string_val (std::string const &s)
expr	string_val (std::u32string const &s)
expr	num_val (int n, sort const &s)
expr_vector	parse_string (char const *s)
	parsing
expr_vector	parse_file (char const *file)
expr_vector	parse_string (char const *s, sort_vector const &sorts, func_decl_vector const &decls)
expr_vector	parse_file (char const *s, sort_vector const &sorts, func_decl_vector const &decls)
template<>
sort	fpa_sort ()
template<>
sort	fpa_sort ()
template<>
sort	fpa_sort ()
template<>
sort	fpa_sort ()

Friends
class	user_propagator_base

Detailed Description

A Context manages all other Z3 objects, global configuration options, etc.

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

Constructor & Destructor Documentation

context() [1/3]

context ( )

inline

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

{ config c; init(c); }

context() [2/3]

context ( config & c )

inline

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

{ init(c); }

context() [3/3]

context ( context && other )

inlinenoexcept

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

            : m_enable_exceptions(other.m_enable_exceptions),
              m_rounding_mode(other.m_rounding_mode),
              m_ctx(other.m_ctx) {
            other.m_ctx = nullptr;
        }

~context()

~context ( )

inline

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

{ if (m_ctx) Z3_del_context(m_ctx); }

Member Function Documentation

array_sort() [1/2]

sort array_sort ( sort d, sort r )

inline

Return an array sort for arrays from d to r.

Example: Given a context c, c.array_sort(c.int_sort(), c.bool_sort()) is an array sort from integer to Boolean.

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

{ Z3_sort s = Z3_mk_array_sort(m_ctx, d, r); check_error(); return sort(*this, s); }

array_sort() [2/2]

sort array_sort ( sort_vector const & d, sort r )

inline

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

                                                                {
        array<Z3_sort> dom(d);
        Z3_sort s = Z3_mk_array_sort_n(m_ctx, dom.size(), dom.ptr(), r); check_error(); return sort(*this, s);
    }

bool_const()

expr bool_const ( char const * name )

inline

create uninterpreted constants of a given sort.

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

{ return constant(name, bool_sort()); }

bool_sort()

sort bool_sort ( )

inline

Return the Boolean sort.

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

{ Z3_sort s = Z3_mk_bool_sort(m_ctx); check_error(); return sort(*this, s); }

Referenced by bool_const().

bool_val()

expr bool_val ( bool b )

inline

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

{ return b ? expr(*this, Z3_mk_true(m_ctx)) : expr(*this, Z3_mk_false(m_ctx)); }

Referenced by goal::as_expr(), user_propagator_base::conflict(), user_propagator_base::conflict(), expr::implies, expr::implies, expr::operator&&, expr::operator&&, expr::operator||, expr::operator||, and solver::to_smt2().

bv_const()

expr bv_const ( char const * name, unsigned sz )

inline

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

{ return constant(name, bv_sort(sz)); }

bv_sort()

sort bv_sort ( unsigned sz )

inline

Return the Bit-vector sort of size sz. That is, the sort for bit-vectors of size sz.

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

{ Z3_sort s = Z3_mk_bv_sort(m_ctx, sz); check_error(); return sort(*this, s); }

Referenced by bv_const(), bv_val(), bv_val(), bv_val(), bv_val(), and bv_val().

bv_val() [1/6]

expr bv_val ( char const * n, unsigned sz )

inline

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

{ sort s = bv_sort(sz); Z3_ast r = Z3_mk_numeral(m_ctx, n, s); check_error(); return expr(*this, r); }

bv_val() [2/6]

expr bv_val ( int n, unsigned sz )

inline

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

{ sort s = bv_sort(sz); Z3_ast r = Z3_mk_int(m_ctx, n, s); check_error(); return expr(*this, r); }

bv_val() [3/6]

expr bv_val ( int64_t n, unsigned sz )

inline

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

{ sort s = bv_sort(sz); Z3_ast r = Z3_mk_int64(m_ctx, n, s); check_error(); return expr(*this, r); }

bv_val() [4/6]

expr bv_val ( uint64_t n, unsigned sz )

inline

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

{ sort s = bv_sort(sz); Z3_ast r = Z3_mk_unsigned_int64(m_ctx, n, s); check_error(); return expr(*this, r); }

bv_val() [5/6]

expr bv_val ( unsigned n, bool const * bits )

inline

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

                                                            {
        array<bool> _bits(n);
        for (unsigned i = 0; i < n; ++i) _bits[i] = bits[i] ? 1 : 0;
        Z3_ast r = Z3_mk_bv_numeral(m_ctx, n, _bits.ptr()); check_error(); return expr(*this, r);
    }

bv_val() [6/6]

expr bv_val ( unsigned n, unsigned sz )

inline

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

{ sort s = bv_sort(sz); Z3_ast r = Z3_mk_unsigned_int(m_ctx, n, s); check_error(); return expr(*this, r); }

char_sort()

sort char_sort ( )

inline

Return the sort for Unicode characters.

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

{ Z3_sort s = Z3_mk_char_sort(m_ctx); check_error(); return sort(*this, s); }

check_error()

Z3_error_code check_error ( ) const

inline

Auxiliary method used to check for API usage errors.

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

                                          {
            Z3_error_code e = Z3_get_error_code(m_ctx);
            if (e != Z3_OK && enable_exceptions())
                Z3_THROW(exception(Z3_get_error_msg(m_ctx, e)));
            return e;
        }

Referenced by array_sort(), array_sort(), expr::bit2bool(), bool_sort(), bv_sort(), bv_val(), bv_val(), bv_val(), bv_val(), bv_val(), bv_val(), char_sort(), check_parser_error(), expr::concat, constant(), datatype(), datatype(), datatype_sort(), datatype_sort(), enumeration_sort(), expr::ext_rotate_left(), expr::ext_rotate_right(), expr::extract(), finite_set_sort(), z3::foldl(), z3::foldli(), fpa_inf(), fpa_nan(), fpa_rounding_mode_sort(), fpa_sort(), fpa_val(), fpa_val(), function(), function(), function(), function(), function(), function(), function(), int_sort(), int_symbol(), int_val(), int_val(), int_val(), int_val(), int_val(), z3::map(), z3::mapi(), num_val(), func_decl::operator()(), func_decl::operator()(), func_decl::operator()(), func_decl::operator()(), func_decl::operator()(), func_decl::operator()(), func_decl::operator()(), func_decl::operator()(), func_decl::operator()(), parse_file(), parse_file(), parse_string(), parse_string(), z3::re_diff(), z3::re_intersect(), re_sort(), real_sort(), real_val(), real_val(), real_val(), real_val(), real_val(), real_val(), recfun(), recfun(), expr::repeat(), expr::rotate_left(), expr::rotate_right(), seq_sort(), str_symbol(), string_sort(), string_val(), string_val(), string_val(), string_val(), z3::to_expr(), z3::to_func_decl(), z3::to_sort(), tuple_sort(), user_propagate_function(), and variable().

check_parser_error()

void check_parser_error ( ) const

inline

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

                                        {
            check_error();
        }

Referenced by solver::from_file(), and solver::from_string().

constant() [1/2]

expr constant ( char const * name, sort const & s )

inline

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

{ return constant(str_symbol(name), s); }

constant() [2/2]

expr constant ( symbol const & name, sort const & s )

inline

create an uninterpreted constant.

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

                                                                     {
        Z3_ast r = Z3_mk_const(m_ctx, name, s);
        check_error();
        return expr(*this, r);
    }

Referenced by bool_const(), bv_const(), constant(), fpa_const(), fpa_const(), int_const(), real_const(), and string_const().

datatype() [1/2]

sort datatype ( symbol const & name, constructors const & cs )

inline

Create a recursive datatype over a single sort. name is the name of the recursive datatype n - the number of constructors of the datatype cs - the n constructors used to define the datatype.

References to the datatype can be created using datatype_sort.

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

                                                                            {
        array<Z3_constructor> _cs(cs.size());
        for (unsigned i = 0; i < cs.size(); ++i) _cs[i] = cs[i];
        Z3_sort s = Z3_mk_datatype(*this, name, cs.size(), _cs.ptr());
        check_error();
        return sort(*this, s);
    }

datatype() [2/2]

sort datatype ( symbol const & name, sort_vector const & params, constructors const & cs )

inline

Create a parametric recursive datatype. name is the name of the recursive datatype params - the sort parameters of the datatype cs - the n constructors used to define the datatype References to the datatype and mutually recursive datatypes can be created using datatype_sort.

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

                                                                                                       {
        array<Z3_sort> _params(params);
        array<Z3_constructor> _cs(cs.size());
        for (unsigned i = 0; i < cs.size(); ++i)
            _cs[i] = cs[i];
        Z3_sort s = Z3_mk_polymorphic_datatype(*this, name, _params.size(), _params.ptr(), cs.size(), _cs.ptr());
        check_error();
        return sort(*this, s);
    }

datatype_sort() [1/2]

sort datatype_sort ( symbol const & name )

inline

a reference to a recursively defined datatype. Expect that it gets defined as a datatype.

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

                                                         {
        Z3_sort s = Z3_mk_datatype_sort(*this, name, 0, nullptr);
        check_error();
        return sort(*this, s);            
    }

datatype_sort() [2/2]

sort datatype_sort ( symbol const & name, sort_vector const & params )

inline

a reference to a recursively defined parametric datatype. Expect that it gets defined as a datatype.

Parameters

name	name of the datatype
params	sort parameters

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

                                                                                    {
        array<Z3_sort> _params(params);
        Z3_sort s = Z3_mk_datatype_sort(*this, name, _params.size(), _params.ptr());
        check_error();
        return sort(*this, s);            
    }

datatypes()

sort_vector datatypes ( unsigned n, symbol const * names, constructor_list *const * cons )

inline

Create a set of mutually recursive datatypes. n - number of recursive datatypes names - array of names of length n cons - array of constructor lists of length n.

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

                                       {
        sort_vector result(*this);
        array<Z3_symbol> _names(n);
        array<Z3_sort> _sorts(n);
        array<Z3_constructor_list> _cons(n);
        for (unsigned i = 0; i < n; ++i)
            _names[i] = names[i], _cons[i] = *cons[i];
        Z3_mk_datatypes(*this, n, _names.ptr(), _sorts.ptr(), _cons.ptr());
        for (unsigned i = 0; i < n; ++i)
            result.push_back(sort(*this, _sorts[i]));
        return result;
    }

enable_exceptions()

bool enable_exceptions ( ) const

inline

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

{ return m_enable_exceptions; }

Referenced by check_error().

enumeration_sort()

sort enumeration_sort ( char const * name, unsigned n, char const *const * enum_names, func_decl_vector & cs, func_decl_vector & ts )

inline

Return an enumeration sort: enum_names[0], ..., enum_names[n-1]. cs and ts are output parameters. The method stores in cs the constants corresponding to the enumerated elements, and in ts the predicates for testing if terms of the enumeration sort correspond to an enumeration.

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

                                                                                                                                                      {
        array<Z3_symbol> _enum_names(n);
        for (unsigned i = 0; i < n; ++i) { _enum_names[i] = Z3_mk_string_symbol(*this, enum_names[i]); }
        array<Z3_func_decl> _cs(n);
        array<Z3_func_decl> _ts(n);
        Z3_symbol _name = Z3_mk_string_symbol(*this, name);
        sort s = to_sort(*this, Z3_mk_enumeration_sort(*this, _name, n, _enum_names.ptr(), _cs.ptr(), _ts.ptr()));
        check_error();
        for (unsigned i = 0; i < n; ++i) { cs.push_back(func_decl(*this, _cs[i])); ts.push_back(func_decl(*this, _ts[i])); }
        return s;
    }

finite_set_sort()

sort finite_set_sort ( sort & s )

inline

Return a finite set sort over element sort s.

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

{ Z3_sort r = Z3_mk_finite_set_sort(m_ctx, s); check_error(); return sort(*this, r); }

fpa_const() [1/2]

template<size_t precision>

expr fpa_const ( char const * name )

inline

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

{ return constant(name, fpa_sort<precision>()); }

fpa_const() [2/2]

expr fpa_const ( char const * name, unsigned ebits, unsigned sbits )

inline

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

{ return constant(name, fpa_sort(ebits, sbits)); }

fpa_inf()

expr fpa_inf ( sort const & s, bool sgn )

inline

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

{ Z3_ast r = Z3_mk_fpa_inf(m_ctx, s, sgn); check_error(); return expr(*this, r); }

fpa_nan()

expr fpa_nan ( sort const & s )

inline

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

{ Z3_ast r = Z3_mk_fpa_nan(m_ctx, s); check_error(); return expr(*this, r); }

fpa_rounding_mode()

expr fpa_rounding_mode ( )

inline

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

                                           {
        switch (m_rounding_mode) {
        case RNA: return expr(*this, Z3_mk_fpa_rna(m_ctx));
        case RNE: return expr(*this, Z3_mk_fpa_rne(m_ctx));
        case RTP: return expr(*this, Z3_mk_fpa_rtp(m_ctx));
        case RTN: return expr(*this, Z3_mk_fpa_rtn(m_ctx));
        case RTZ: return expr(*this, Z3_mk_fpa_rtz(m_ctx));
        default: return expr(*this);
        }
    }

Referenced by expr::fpa_to_fpa, expr::fpa_to_sbv, expr::fpa_to_ubv, expr::operator*, expr::operator+, expr::operator-, expr::operator/, expr::round_fpa_to_closest_integer, expr::sbv_to_fpa, and expr::ubv_to_fpa.

fpa_rounding_mode_sort()

sort fpa_rounding_mode_sort ( )

inline

Return a RoundingMode sort.

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

{ Z3_sort r = Z3_mk_fpa_rounding_mode_sort(m_ctx); check_error(); return sort(*this, r); }

fpa_sort() [1/6]

template<>

sort fpa_sort ( )

inline

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

{ return fpa_sort(15, 113); }

Referenced by fpa_sort().

fpa_sort() [2/6]

template<>

sort fpa_sort ( )

inline

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

{ return fpa_sort(11, 53); }

Referenced by fpa_sort().

fpa_sort() [3/6]

template<>

sort fpa_sort ( )

inline

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

{ return fpa_sort(8, 24); }

Referenced by fpa_sort().

fpa_sort() [4/6]

template<>

sort fpa_sort ( )

inline

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

{ return fpa_sort(5, 11); }

Referenced by fpa_sort().

fpa_sort() [5/6]

template<size_t precision>

sort fpa_sort

(

)

Return a FloatingPoint sort with given precision bitwidth (16, 32, 64 or 128).

Referenced by fpa_const(), fpa_val(), and fpa_val().

fpa_sort() [6/6]

sort fpa_sort ( unsigned ebits, unsigned sbits )

inline

Return a floating point sort. ebits is a number of exponent bits, sbits is a number of significand bits,.

Precondition

where ebits must be larger than 1 and sbits must be larger than 2.

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

{ Z3_sort s = Z3_mk_fpa_sort(m_ctx, ebits, sbits); check_error(); return sort(*this, s); }

Referenced by fpa_const().

fpa_val() [1/2]

expr fpa_val ( double n )

inline

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

{ sort s = fpa_sort<64>(); Z3_ast r = Z3_mk_fpa_numeral_double(m_ctx, n, s); check_error(); return expr(*this, r); }

Referenced by z3::operator!=(), z3::operator!=(), z3::operator==(), and z3::operator==().

fpa_val() [2/2]

expr fpa_val ( float n )

inline

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

{ sort s = fpa_sort<32>(); Z3_ast r = Z3_mk_fpa_numeral_float(m_ctx, n, s); check_error(); return expr(*this, r); }

function() [1/9]

func_decl function ( char const * name, sort const & d1, sort const & d2, sort const & d3, sort const & d4, sort const & d5, sort const & range )

inline

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

                                                                                                                                                                 {
        check_context(d1, range); check_context(d2, range); check_context(d3, range); check_context(d4, range); check_context(d5, range);
        Z3_sort args[5] = { d1, d2, d3, d4, d5 };
        Z3_func_decl f = Z3_mk_func_decl(m_ctx, str_symbol(name), 5, args, range);
        check_error();
        return func_decl(*this, f);
    }

function() [2/9]

func_decl function ( char const * name, sort const & d1, sort const & d2, sort const & d3, sort const & d4, sort const & range )

inline

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

                                                                                                                                                {
        check_context(d1, range); check_context(d2, range); check_context(d3, range); check_context(d4, range);
        Z3_sort args[4] = { d1, d2, d3, d4 };
        Z3_func_decl f = Z3_mk_func_decl(m_ctx, str_symbol(name), 4, args, range);
        check_error();
        return func_decl(*this, f);
    }

function() [3/9]

func_decl function ( char const * name, sort const & d1, sort const & d2, sort const & d3, sort const & range )

inline

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

                                                                                                                               {
        check_context(d1, range); check_context(d2, range); check_context(d3, range);
        Z3_sort args[3] = { d1, d2, d3 };
        Z3_func_decl f = Z3_mk_func_decl(m_ctx, str_symbol(name), 3, args, range);
        check_error();
        return func_decl(*this, f);
    }

function() [4/9]

func_decl function ( char const * name, sort const & d1, sort const & d2, sort const & range )

inline

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

                                                                                                              {
        check_context(d1, range); check_context(d2, range);
        Z3_sort args[2] = { d1, d2 };
        Z3_func_decl f = Z3_mk_func_decl(m_ctx, str_symbol(name), 2, args, range);
        check_error();
        return func_decl(*this, f);
    }

function() [5/9]

func_decl function ( char const * name, sort const & domain, sort const & range )

inline

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

                                                                                                 {
        check_context(domain, range);
        Z3_sort args[1] = { domain };
        Z3_func_decl f = Z3_mk_func_decl(m_ctx, str_symbol(name), 1, args, range);
        check_error();
        return func_decl(*this, f);
    }

function() [6/9]

func_decl function ( char const * name, sort_vector const & domain, sort const & range )

inline

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

                                                                                                      {
        return function(range.ctx().str_symbol(name), domain, range);
    }

function() [7/9]

func_decl function ( char const * name, unsigned arity, sort const * domain, sort const & range )

inline

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

                                                                                                                 {
        return function(range.ctx().str_symbol(name), arity, domain, range);
    }

function() [8/9]

func_decl function ( symbol const & name, sort_vector const & domain, sort const & range )

inline

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

                                                                                                       {
        array<Z3_sort> args(domain.size());
        for (unsigned i = 0; i < domain.size(); ++i) {
            check_context(domain[i], range);
            args[i] = domain[i];
        }
        Z3_func_decl f = Z3_mk_func_decl(m_ctx, name, domain.size(), args.ptr(), range);
        check_error();
        return func_decl(*this, f);
    }

function() [9/9]

func_decl function ( symbol const & name, unsigned arity, sort const * domain, sort const & range )

inline

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

                                                                                                                   {
        array<Z3_sort> args(arity);
        for (unsigned i = 0; i < arity; ++i) {
            check_context(domain[i], range);
            args[i] = domain[i];
        }
        Z3_func_decl f = Z3_mk_func_decl(m_ctx, name, arity, args.ptr(), range);
        check_error();
        return func_decl(*this, f);
    }

Referenced by function(), and function().

int_const()

expr int_const ( char const * name )

inline

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

{ return constant(name, int_sort()); }

int_sort()

sort int_sort ( )

inline

Return the integer sort.

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

{ Z3_sort s = Z3_mk_int_sort(m_ctx); check_error(); return sort(*this, s); }

Referenced by int_const(), int_val(), int_val(), int_val(), int_val(), and int_val().

int_symbol()

symbol int_symbol ( int n )

inline

Create a Z3 symbol based on the given integer.

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

{ Z3_symbol r = Z3_mk_int_symbol(m_ctx, n); check_error(); return symbol(*this, r); }

int_val() [1/5]

expr int_val ( char const * n )

inline

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

{ Z3_ast r = Z3_mk_numeral(m_ctx, n, int_sort()); check_error(); return expr(*this, r); }

int_val() [2/5]

expr int_val ( int n )

inline

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

{ Z3_ast r = Z3_mk_int(m_ctx, n, int_sort()); check_error(); return expr(*this, r); }

Referenced by expr::abs.

int_val() [3/5]

expr int_val ( int64_t n )

inline

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

{ Z3_ast r = Z3_mk_int64(m_ctx, n, int_sort()); check_error(); return expr(*this, r); }

int_val() [4/5]

expr int_val ( uint64_t n )

inline

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

{ Z3_ast r = Z3_mk_unsigned_int64(m_ctx, n, int_sort()); check_error(); return expr(*this, r); }

int_val() [5/5]

expr int_val ( unsigned n )

inline

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

{ Z3_ast r = Z3_mk_unsigned_int(m_ctx, n, int_sort()); check_error(); return expr(*this, r); }

interrupt()

void interrupt ( )

inline

Interrupt the current procedure being executed by any object managed by this context. This is a soft interruption: there is no guarantee the object will actually stop.

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

{ Z3_interrupt(m_ctx); }

num_val()

expr num_val ( int n, sort const & s )

inline

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

{ Z3_ast r = Z3_mk_int(m_ctx, n, s); check_error(); return expr(*this, r); }

Referenced by z3::ashr(), z3::ashr(), z3::lshr(), z3::lshr(), expr::mod, expr::mod, expr::operator!=, expr::operator!=, expr::operator&, expr::operator&, func_decl::operator()(), func_decl::operator()(), func_decl::operator()(), expr::operator*, expr::operator*, expr::operator+, expr::operator+, expr::operator-, expr::operator-, expr::operator/, expr::operator/, expr::operator<, expr::operator<, expr::operator<=, expr::operator<=, expr::operator==, expr::operator==, expr::operator>, expr::operator>, expr::operator>=, expr::operator>=, expr::operator^, expr::operator^, expr::operator|, expr::operator|, expr::pw, expr::pw, expr::rem, expr::rem, z3::sdiv(), z3::sdiv(), z3::select(), z3::sge(), z3::sge(), z3::sgt(), z3::sgt(), z3::shl(), z3::shl(), z3::sle(), z3::sle(), z3::slt(), z3::slt(), z3::smod(), z3::smod(), z3::srem(), z3::srem(), z3::store(), z3::store(), z3::store(), z3::udiv(), z3::udiv(), z3::uge(), z3::uge(), z3::ugt(), z3::ugt(), z3::ule(), z3::ule(), z3::ult(), z3::ult(), z3::urem(), and z3::urem().

operator Z3_context()

operator Z3_context ( ) const

inline

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

{ return m_ctx; }

operator=()

context & operator= ( context && other )

inlinenoexcept

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

                                                     {
            if (this != &other) {
                if (m_ctx) Z3_del_context(m_ctx);
                m_enable_exceptions = other.m_enable_exceptions;
                m_rounding_mode = other.m_rounding_mode;
                m_ctx = other.m_ctx;
                other.m_ctx = nullptr;
            }
            return *this;
        }

parse_file() [1/2]

expr_vector parse_file ( char const * file )

inline

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

                                                        {
        Z3_ast_vector r = Z3_parse_smtlib2_file(*this, s, 0, 0, 0, 0, 0, 0);
        check_error();
        return expr_vector(*this, r);
    }

parse_file() [2/2]

expr_vector parse_file ( char const * s, sort_vector const & sorts, func_decl_vector const & decls )

inline

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

                                                                                                                 {
        array<Z3_symbol> sort_names(sorts.size());
        array<Z3_symbol> decl_names(decls.size());
        array<Z3_sort>   sorts1(sorts);
        array<Z3_func_decl> decls1(decls);
        for (unsigned i = 0; i < sorts.size(); ++i) {
            sort_names[i] = sorts[i].name();
        }
        for (unsigned i = 0; i < decls.size(); ++i) {
            decl_names[i] = decls[i].name();
        }
        Z3_ast_vector r = Z3_parse_smtlib2_file(*this, s, sorts.size(), sort_names.ptr(), sorts1.ptr(), decls.size(), decl_names.ptr(), decls1.ptr());
        check_error();
        return expr_vector(*this, r);
    }

parse_string() [1/2]

expr_vector parse_string ( char const * s )

inline

parsing

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

                                                          {
        Z3_ast_vector r = Z3_parse_smtlib2_string(*this, s, 0, 0, 0, 0, 0, 0);
        check_error();
        return expr_vector(*this, r);
 
    }

parse_string() [2/2]

expr_vector parse_string ( char const * s, sort_vector const & sorts, func_decl_vector const & decls )

inline

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

                                                                                                                   {
        array<Z3_symbol> sort_names(sorts.size());
        array<Z3_symbol> decl_names(decls.size());
        array<Z3_sort>   sorts1(sorts);
        array<Z3_func_decl> decls1(decls);
        for (unsigned i = 0; i < sorts.size(); ++i) {
            sort_names[i] = sorts[i].name();
        }
        for (unsigned i = 0; i < decls.size(); ++i) {
            decl_names[i] = decls[i].name();
        }
 
        Z3_ast_vector r = Z3_parse_smtlib2_string(*this, s, sorts.size(), sort_names.ptr(), sorts1.ptr(), decls.size(), decl_names.ptr(), decls1.ptr());
        check_error();
        return expr_vector(*this, r);
    }

re_sort()

sort re_sort ( sort & seq_sort )

inline

Return a regular expression sort over sequences seq_sort.

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

{ Z3_sort r = Z3_mk_re_sort(m_ctx, s); check_error(); return sort(*this, r); }

real_const()

expr real_const ( char const * name )

inline

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

{ return constant(name, real_sort()); }

real_sort()

sort real_sort ( )

inline

Return the Real sort.

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

{ Z3_sort s = Z3_mk_real_sort(m_ctx); check_error(); return sort(*this, s); }

Referenced by real_const(), real_val(), real_val(), real_val(), real_val(), and real_val().

real_val() [1/6]

expr real_val ( char const * n )

inline

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

{ Z3_ast r = Z3_mk_numeral(m_ctx, n, real_sort()); check_error(); return expr(*this, r); }

real_val() [2/6]

expr real_val ( int n )

inline

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

{ Z3_ast r = Z3_mk_int(m_ctx, n, real_sort()); check_error(); return expr(*this, r); }

Referenced by expr::abs.

real_val() [3/6]

expr real_val ( int64_t n )

inline

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

{ Z3_ast r = Z3_mk_int64(m_ctx, n, real_sort()); check_error(); return expr(*this, r); }

real_val() [4/6]

expr real_val ( int64_t n, int64_t d )

inline

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

{ Z3_ast r = Z3_mk_real_int64(m_ctx, n, d); check_error(); return expr(*this, r); }

real_val() [5/6]

expr real_val ( uint64_t n )

inline

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

{ Z3_ast r = Z3_mk_unsigned_int64(m_ctx, n, real_sort()); check_error(); return expr(*this, r); }

real_val() [6/6]

expr real_val ( unsigned n )

inline

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

{ Z3_ast r = Z3_mk_unsigned_int(m_ctx, n, real_sort()); check_error(); return expr(*this, r); }

recdef()

void recdef ( func_decl decl, expr_vector const & args, expr const & body )

inline

add function definition body to declaration decl. decl needs to be declared using context::recfun.

Parameters

decl
args
body

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

                                                                                      {
        check_context(f, args); check_context(f, body);
        array<Z3_ast> vars(args);
        Z3_add_rec_def(f.ctx(), f, vars.size(), vars.ptr(), body);
    }

recfun() [1/6]

func_decl recfun ( char const * name, sort const & d1, sort const & d2, sort const & range )

inline

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

                                                                                                          {
        sort dom[2] = { d1, d2 };
        return recfun(str_symbol(name), 2, dom, range);
    }

recfun() [2/6]

func_decl recfun ( char const * name, sort const & domain, sort const & range )

inline

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

                                                                                          {
        return recfun(str_symbol(name), 1, &d1, range);
    }

recfun() [3/6]

func_decl recfun ( char const * name, sort_vector const & domain, sort const & range )

inline

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

                                                                                                     {
        return recfun(str_symbol(name), domain, range);
 
    }

recfun() [4/6]

func_decl recfun ( char const * name, unsigned arity, sort const * domain, sort const & range )

inline

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

                                                                                                               {
        return recfun(str_symbol(name), arity, domain, range);
    }

recfun() [5/6]

func_decl recfun ( symbol const & name, const sort_vector & domain, sort const & range )

inline

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

                                                                                                       {
        check_context(domain, range);
        array<Z3_sort> domain1(domain);
        Z3_func_decl f = Z3_mk_rec_func_decl(m_ctx, name, domain1.size(), domain1.ptr(), range);
        check_error();
        return func_decl(*this, f);
    }

recfun() [6/6]

func_decl recfun ( symbol const & name, unsigned arity, sort const * domain, sort const & range )

inline

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

                                                                                                                 {
        array<Z3_sort> args(arity);
        for (unsigned i = 0; i < arity; ++i) {
            check_context(domain[i], range);
            args[i] = domain[i];
        }
        Z3_func_decl f = Z3_mk_rec_func_decl(m_ctx, name, arity, args.ptr(), range);
        check_error();
        return func_decl(*this, f);
 
    }

Referenced by recfun(), recfun(), recfun(), and recfun().

seq_sort()

sort seq_sort ( sort & s )

inline

Return a sequence sort over base sort s.

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

{ Z3_sort r = Z3_mk_seq_sort(m_ctx, s); check_error(); return sort(*this, r); }

set() [1/3]

void set ( char const * param, bool value )

inline

Update global parameter param with Boolean value.

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

{ Z3_update_param_value(m_ctx, param, value ? "true" : "false"); }

set() [2/3]

void set ( char const * param, char const * value )

inline

Update global parameter param with string value.

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

{ Z3_update_param_value(m_ctx, param, value); }

set() [3/3]

void set ( char const * param, int value )

inline

Update global parameter param with Integer value.

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

                                                {
            auto str = std::to_string(value);
            Z3_update_param_value(m_ctx, param, str.c_str());
        }

set_enable_exceptions()

void set_enable_exceptions ( bool f )

inline

The C++ API uses by defaults exceptions on errors. For applications that don't work well with exceptions (there should be only few) you have the ability to turn off exceptions. The tradeoffs are that applications have to be very careful about using check_error() after calls that may result in an erroneous state.

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

{ m_enable_exceptions = f; }

set_rounding_mode()

void set_rounding_mode ( rounding_mode rm )

inline

Sets RoundingMode of FloatingPoints.

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

{ m_rounding_mode = rm; }

str_symbol()

symbol str_symbol ( char const * s )

inline

Create a Z3 symbol based on the given string.

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

{ Z3_symbol r = Z3_mk_string_symbol(m_ctx, s); check_error(); return symbol(*this, r); }

Referenced by constant(), function(), function(), function(), function(), function(), recfun(), recfun(), recfun(), recfun(), and solver::solver().

string_const()

expr string_const ( char const * name )

inline

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

{ return constant(name, string_sort()); }

string_sort()

sort string_sort ( )

inline

Return the sort for Unicode strings.

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

{ Z3_sort s = Z3_mk_string_sort(m_ctx); check_error(); return sort(*this, s); }

Referenced by string_const().

string_val() [1/4]

expr string_val ( char const * s )

inline

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

{ Z3_ast r = Z3_mk_string(m_ctx, s); check_error(); return expr(*this, r); }

string_val() [2/4]

expr string_val ( char const * s, unsigned n )

inline

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

{ Z3_ast r = Z3_mk_lstring(m_ctx, n, s); check_error(); return expr(*this, r); }

string_val() [3/4]

expr string_val ( std::string const & s )

inline

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

{ Z3_ast r = Z3_mk_string(m_ctx, s.c_str()); check_error(); return expr(*this, r); }

string_val() [4/4]

expr string_val ( std::u32string const & s )

inline

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

{ Z3_ast r = Z3_mk_u32string(m_ctx, (unsigned)s.size(), (unsigned const*)s.c_str()); check_error(); return expr(*this, r); }

tuple_sort()

func_decl tuple_sort ( char const * name, unsigned n, char const *const * names, sort const * sorts, func_decl_vector & projs )

inline

Return a tuple constructor. name is the name of the returned constructor, n are the number of arguments, names and sorts are their projected sorts. projs is an output parameter. It contains the set of projection functions.

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

                                                                                                                                               {
        array<Z3_symbol> _names(n);
        array<Z3_sort> _sorts(n);
        for (unsigned i = 0; i < n; ++i) { _names[i] = Z3_mk_string_symbol(*this, names[i]); _sorts[i] = sorts[i]; }
        array<Z3_func_decl> _projs(n);
        Z3_symbol _name = Z3_mk_string_symbol(*this, name);
        Z3_func_decl tuple;
        sort _ignore_s = to_sort(*this, Z3_mk_tuple_sort(*this, _name, n, _names.ptr(), _sorts.ptr(), &tuple, _projs.ptr()));
        check_error();
        for (unsigned i = 0; i < n; ++i) { projs.push_back(func_decl(*this, _projs[i])); }
        return func_decl(*this, tuple);
    }

uninterpreted_sort() [1/2]

sort uninterpreted_sort ( char const * name )

inline

create an uninterpreted sort with the name given by the string or symbol.

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

                                                            {
        Z3_symbol _name = Z3_mk_string_symbol(*this, name);
        return to_sort(*this, Z3_mk_uninterpreted_sort(*this, _name));
    }

uninterpreted_sort() [2/2]

sort uninterpreted_sort ( symbol const & name )

inline

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

                                                              {
        return to_sort(*this, Z3_mk_uninterpreted_sort(*this, name));
    }

user_propagate_function()

func_decl user_propagate_function ( symbol const & name, sort_vector const & domain, sort const & range )

inline

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

                                                                                                                      {
        check_context(domain, range);
        array<Z3_sort> domain1(domain);
        Z3_func_decl f = Z3_solver_propagate_declare(range.ctx(), name, domain1.size(), domain1.ptr(), range);
        check_error();
        return func_decl(*this, f);
    }

variable()

expr variable ( unsigned index, sort const & s )

inline

create a de-Bruijn variable.

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

                                                             { 
        Z3_ast r = Z3_mk_bound(m_ctx, idx, s);
        check_error();
        return expr(*this, r);
    }

Friends And Related Symbol Documentation

user_propagator_base

friend class user_propagator_base

friend

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

Referenced by user_propagator_base.