Z3
Public Member Functions | Static Public Member Functions
param_descrs Class Reference
+ 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 500 of file z3++.h.

Constructor & Destructor Documentation

◆ param_descrs() [1/2]

param_descrs ( context c,
Z3_param_descrs  d 
)
inline

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

503 : object(c), m_descrs(d) { Z3_param_descrs_inc_ref(c, d); }
object(context &c)
Definition: z3++.h:472
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 param_descrs::global_param_descrs(), and param_descrs::simplify_param_descrs().

◆ param_descrs() [2/2]

param_descrs ( param_descrs const &  o)
inline

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

504 : object(o.ctx()), m_descrs(o.m_descrs) { Z3_param_descrs_inc_ref(ctx(), m_descrs); }
context & ctx() const
Definition: z3++.h:474

◆ ~param_descrs()

~param_descrs ( )
inlineoverride

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

512 { 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 519 of file z3++.h.

519 { char const* r = Z3_param_descrs_get_documentation(ctx(), m_descrs, s); check_error(); return r; }
Z3_error_code check_error() const
Definition: z3++.h:475
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()

static param_descrs global_param_descrs ( context c)
inlinestatic

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

514 { return param_descrs(c, Z3_get_global_param_descrs(c)); }
param_descrs(context &c, Z3_param_descrs d)
Definition: z3++.h:503
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 518 of file z3++.h.

518 { 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.

Referenced by ArithSortRef::is_int(), and ArithSortRef::is_real().

◆ name()

symbol name ( unsigned  i)
inline

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

517 { 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.

Referenced by Datatype::__deepcopy__(), and Datatype::__repr__().

◆ operator=()

param_descrs& operator= ( param_descrs const &  o)
inline

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

505  {
506  Z3_param_descrs_inc_ref(o.ctx(), o.m_descrs);
507  Z3_param_descrs_dec_ref(ctx(), m_descrs);
508  m_descrs = o.m_descrs;
509  object::operator=(o);
510  return *this;
511  }

◆ simplify_param_descrs()

static param_descrs simplify_param_descrs ( context c)
inlinestatic

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

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 516 of file z3++.h.

516 { 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.

Referenced by ParamDescrsRef::__len__(), Goal::__len__(), BitVecNumRef::as_signed_long(), and BitVecSortRef::subsort().

◆ to_string()

std::string to_string ( ) const
inline

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

520 { 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<<().