Z3
Public Member Functions | Data Fields
ParamDescrsRef Class Reference

Public Member Functions

def __init__ (self, descr, ctx=None)
 
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 4666 of file z3py.py.

Constructor & Destructor Documentation

§ __init__()

def __init__ (   self,
  descr,
  ctx = None 
)

Definition at line 4669 of file z3py.py.

4669  def __init__(self, descr, ctx=None):
4670  _z3_assert(isinstance(descr, ParamDescrs), "parameter description object expected")
4671  self.ctx = _get_ctx(ctx)
4672  self.descr = descr
4673  Z3_param_descrs_inc_ref(self.ctx.ref(), self.descr)
4674 
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 4675 of file z3py.py.

4675  def __del__(self):
4676  if self.ctx.ref() is not None:
4677  Z3_param_descrs_dec_ref(self.ctx.ref(), self.descr)
4678 
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

§ __getitem__()

def __getitem__ (   self,
  arg 
)

Definition at line 4704 of file z3py.py.

4704  def __getitem__(self, arg):
4705  if _is_int(arg):
4706  return self.get_name(arg)
4707  else:
4708  return self.get_kind(arg)
4709 

§ __len__()

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

Definition at line 4684 of file z3py.py.

4684  def __len__(self):
4685  """Return the size of in the parameter description `self`.
4686  """
4687  return self.size()
4688 

§ __repr__()

def __repr__ (   self)

Definition at line 4710 of file z3py.py.

4710  def __repr__(self):
4711  return Z3_param_descrs_to_string(self.ctx.ref(), self.descr)
4712 
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 4699 of file z3py.py.

4699  def get_documentation(self, n):
4700  """Return the documentation string of the parameter named `n`.
4701  """
4702  return Z3_param_descrs_get_documentation(self.ctx.ref(), self.descr, to_symbol(n, self.ctx))
4703 
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:100

§ get_kind()

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

Definition at line 4694 of file z3py.py.

4694  def get_kind(self, n):
4695  """Return the kind of the parameter named `n`.
4696  """
4697  return Z3_param_descrs_get_kind(self.ctx.ref(), self.descr, to_symbol(n, self.ctx))
4698 
def to_symbol(s, ctx=None)
Definition: z3py.py:100
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 4689 of file z3py.py.

4689  def get_name(self, i):
4690  """Return the i-th parameter name in the parameter description `self`.
4691  """
4692  return _symbol2py(self.ctx, Z3_param_descrs_get_name(self.ctx.ref(), self.descr, i))
4693 
Z3_symbol Z3_API Z3_param_descrs_get_name(Z3_context c, Z3_param_descrs p, unsigned i)
Return the number of parameters in the given parameter description set.

§ size()

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

Definition at line 4679 of file z3py.py.

4679  def size(self):
4680  """Return the size of in the parameter description `self`.
4681  """
4682  return int(Z3_param_descrs_size(self.ctx.ref(), self.descr))
4683 
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

§ descr

descr

Definition at line 4672 of file z3py.py.