Z3
Public Member Functions | Data Fields
ParamDescrsRef Class Reference

Public Member Functions

def __init__ (self, descr, ctx=None)
 
def __deepcopy__ (self, memo={})
 
def __del__ (self)
 
def size (self)
 
def __len__ (self)
 
def get_name (self, i)
 
def get_kind (self, n)
 
def get_documentation (self, n)
 
def __getitem__ (self, arg)
 
def __repr__ (self)
 

Data Fields

 ctx
 
 descr
 

Detailed Description

Set of parameter descriptions for Solvers, Tactics and Simplifiers in Z3.

Definition at line 5072 of file z3py.py.

Constructor & Destructor Documentation

◆ __init__()

def __init__ (   self,
  descr,
  ctx = None 
)

Definition at line 5075 of file z3py.py.

5075  def __init__(self, descr, ctx=None):
5076  _z3_assert(isinstance(descr, ParamDescrs), "parameter description object expected")
5077  self.ctx = _get_ctx(ctx)
5078  self.descr = descr
5079  Z3_param_descrs_inc_ref(self.ctx.ref(), self.descr)
5080 
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.

◆ __del__()

def __del__ (   self)

Definition at line 5084 of file z3py.py.

5084  def __del__(self):
5085  if self.ctx.ref() is not None:
5086  Z3_param_descrs_dec_ref(self.ctx.ref(), self.descr)
5087 
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

◆ __deepcopy__()

def __deepcopy__ (   self,
  memo = {} 
)

Definition at line 5081 of file z3py.py.

5081  def __deepcopy__(self, memo={}):
5082  return ParamsDescrsRef(self.descr, self.ctx)
5083 

◆ __getitem__()

def __getitem__ (   self,
  arg 
)

Definition at line 5113 of file z3py.py.

5113  def __getitem__(self, arg):
5114  if _is_int(arg):
5115  return self.get_name(arg)
5116  else:
5117  return self.get_kind(arg)
5118 

◆ __len__()

def __len__ (   self)
Return the size of in the parameter description `self`.

Definition at line 5093 of file z3py.py.

5093  def __len__(self):
5094  """Return the size of in the parameter description `self`.
5095  """
5096  return self.size()
5097 

◆ __repr__()

def __repr__ (   self)

Definition at line 5119 of file z3py.py.

5119  def __repr__(self):
5120  return Z3_param_descrs_to_string(self.ctx.ref(), self.descr)
5121 
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...

◆ get_documentation()

def get_documentation (   self,
  n 
)
Return the documentation string of the parameter named `n`.

Definition at line 5108 of file z3py.py.

5108  def get_documentation(self, n):
5109  """Return the documentation string of the parameter named `n`.
5110  """
5111  return Z3_param_descrs_get_documentation(self.ctx.ref(), self.descr, to_symbol(n, self.ctx))
5112 
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.
def to_symbol(s, ctx=None)
Definition: z3py.py:111

◆ get_kind()

def get_kind (   self,
  n 
)
Return the kind of the parameter named `n`.

Definition at line 5103 of file z3py.py.

5103  def get_kind(self, n):
5104  """Return the kind of the parameter named `n`.
5105  """
5106  return Z3_param_descrs_get_kind(self.ctx.ref(), self.descr, to_symbol(n, self.ctx))
5107 
def to_symbol(s, ctx=None)
Definition: z3py.py:111
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.

◆ get_name()

def get_name (   self,
  i 
)
Return the i-th parameter name in the parameter description `self`.

Definition at line 5098 of file z3py.py.

5098  def get_name(self, i):
5099  """Return the i-th parameter name in the parameter description `self`.
5100  """
5101  return _symbol2py(self.ctx, Z3_param_descrs_get_name(self.ctx.ref(), self.descr, i))
5102 
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.

◆ size()

def size (   self)
Return the size of in the parameter description `self`.

Definition at line 5088 of file z3py.py.

5088  def size(self):
5089  """Return the size of in the parameter description `self`.
5090  """
5091  return int(Z3_param_descrs_size(self.ctx.ref(), self.descr))
5092 
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.

Field Documentation

◆ ctx

ctx

Definition at line 5077 of file z3py.py.

Referenced by Probe.__call__(), Fixedpoint.__deepcopy__(), Optimize.__deepcopy__(), ApplyResult.__deepcopy__(), Tactic.__deepcopy__(), Probe.__deepcopy__(), Fixedpoint.__del__(), Optimize.__del__(), ApplyResult.__del__(), Tactic.__del__(), Probe.__del__(), Probe.__eq__(), Probe.__ge__(), ApplyResult.__getitem__(), Probe.__gt__(), Probe.__le__(), ApplyResult.__len__(), Probe.__lt__(), Probe.__ne__(), Fixedpoint.add_cover(), Fixedpoint.add_rule(), Optimize.add_soft(), Tactic.apply(), ApplyResult.as_expr(), Optimize.assert_and_track(), Fixedpoint.assert_exprs(), Optimize.assert_exprs(), Optimize.assertions(), Optimize.check(), Optimize.from_file(), Optimize.from_string(), Fixedpoint.get_answer(), Fixedpoint.get_assertions(), Fixedpoint.get_cover_delta(), Fixedpoint.get_ground_sat_answer(), Fixedpoint.get_num_levels(), Fixedpoint.get_rule_names_along_trace(), Fixedpoint.get_rules(), Fixedpoint.get_rules_along_trace(), Fixedpoint.help(), Optimize.help(), Tactic.help(), Optimize.maximize(), Optimize.minimize(), Optimize.model(), Optimize.objectives(), Fixedpoint.param_descrs(), Optimize.param_descrs(), Tactic.param_descrs(), Fixedpoint.parse_file(), Fixedpoint.parse_string(), Optimize.pop(), Optimize.push(), Fixedpoint.query(), Fixedpoint.query_from_lvl(), Fixedpoint.reason_unknown(), Optimize.reason_unknown(), Fixedpoint.register_relation(), Fixedpoint.set(), Optimize.set(), Fixedpoint.set_predicate_representation(), Fixedpoint.sexpr(), Optimize.sexpr(), ApplyResult.sexpr(), Tactic.solver(), Fixedpoint.statistics(), Optimize.statistics(), Solver.to_smt2(), Fixedpoint.to_string(), Optimize.unsat_core(), and Fixedpoint.update_rule().

◆ descr

descr

Definition at line 5078 of file z3py.py.