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

#include <z3++.h>

Inheritance diagram for param_descrs:

Public Member Functions

 param_descrs (context &c, Z3_param_descrs d)
 param_descrs (param_descrs const &o)
param_descrsoperator= (param_descrs const &o)
 ~param_descrs () override
unsigned size ()
symbol name (unsigned i)
Z3_param_kind kind (symbol const &s)
std::string documentation (symbol const &s)
std::string to_string () const
Public Member Functions inherited from object
 object (context &c)
virtual ~object ()=default
contextctx () const
Z3_error_code check_error () const

Static Public Member Functions

static param_descrs simplify_param_descrs (context &c)
static param_descrs global_param_descrs (context &c)

Additional Inherited Members

Protected Attributes inherited from object
contextm_ctx

Detailed Description

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

Constructor & Destructor Documentation

◆ param_descrs() [1/2]

param_descrs ( context & c,
Z3_param_descrs d )
inline

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

589: object(c), m_descrs(d) { Z3_param_descrs_inc_ref(c, d); }
void Z3_API Z3_param_descrs_inc_ref(Z3_context c, Z3_param_descrs p)
Increment the reference counter of the given parameter description set.

Referenced by global_param_descrs(), operator=(), param_descrs(), and simplify_param_descrs().

◆ param_descrs() [2/2]

param_descrs ( param_descrs const & o)
inline

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

590: object(o.ctx()), m_descrs(o.m_descrs) { Z3_param_descrs_inc_ref(ctx(), m_descrs); }

◆ ~param_descrs()

~param_descrs ( )
inlineoverride

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

598{ Z3_param_descrs_dec_ref(ctx(), m_descrs); }
void Z3_API Z3_param_descrs_dec_ref(Z3_context c, Z3_param_descrs p)
Decrement the reference counter of the given parameter description set.

Member Function Documentation

◆ documentation()

std::string documentation ( symbol const & s)
inline

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

605{ char const* r = Z3_param_descrs_get_documentation(ctx(), m_descrs, s); check_error(); return r; }
Z3_string Z3_API Z3_param_descrs_get_documentation(Z3_context c, Z3_param_descrs p, Z3_symbol s)
Retrieve documentation string corresponding to parameter name s.

◆ global_param_descrs()

param_descrs global_param_descrs ( context & c)
inlinestatic

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

600{ return param_descrs(c, Z3_get_global_param_descrs(c)); }
Z3_param_descrs Z3_API Z3_get_global_param_descrs(Z3_context c)
Retrieve description of global parameters.

◆ kind()

Z3_param_kind kind ( symbol const & s)
inline

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

604{ return Z3_param_descrs_get_kind(ctx(), m_descrs, s); }
Z3_param_kind Z3_API Z3_param_descrs_get_kind(Z3_context c, Z3_param_descrs p, Z3_symbol n)
Return the kind associated with the given parameter name n.

◆ name()

symbol name ( unsigned i)
inline

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

603{ return symbol(ctx(), Z3_param_descrs_get_name(ctx(), m_descrs, i)); }
Z3_symbol Z3_API Z3_param_descrs_get_name(Z3_context c, Z3_param_descrs p, unsigned i)
Return the name of the parameter at given index i.

◆ operator=()

param_descrs & operator= ( param_descrs const & o)
inline

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

591 {
592 Z3_param_descrs_inc_ref(o.ctx(), o.m_descrs);
593 Z3_param_descrs_dec_ref(ctx(), m_descrs);
594 m_descrs = o.m_descrs;
595 object::operator=(o);
596 return *this;
597 }

◆ simplify_param_descrs()

param_descrs simplify_param_descrs ( context & c)
inlinestatic

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

599{ return param_descrs(c, Z3_simplify_get_param_descrs(c)); }
Z3_param_descrs Z3_API Z3_simplify_get_param_descrs(Z3_context c)
Return the parameter description set for the simplify procedure.

◆ size()

unsigned size ( )
inline

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

602{ return Z3_param_descrs_size(ctx(), m_descrs); }
unsigned Z3_API Z3_param_descrs_size(Z3_context c, Z3_param_descrs p)
Return the number of parameters in the given parameter description set.

◆ to_string()

std::string to_string ( ) const
inline

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

606{ return Z3_param_descrs_to_string(ctx(), m_descrs); }
Z3_string Z3_API Z3_param_descrs_to_string(Z3_context c, Z3_param_descrs p)
Convert a parameter description set into a string. This function is mainly used for printing the cont...

Referenced by z3::operator<<().