Z3
Public Member Functions
DatatypeSortRef Class Reference
+ Inheritance diagram for DatatypeSortRef:

Public Member Functions

def num_constructors (self)
 
def constructor (self, idx)
 
def recognizer (self, idx)
 
def accessor (self, i, j)
 
- Public Member Functions inherited from SortRef
def as_ast (self)
 
def get_id (self)
 
def kind (self)
 
def subsort (self, other)
 
def cast (self, val)
 
def name (self)
 
def __eq__ (self, other)
 
def __ne__ (self, other)
 
def __hash__ (self)
 
- Public Member Functions inherited from AstRef
def __init__ (self, ast, ctx=None)
 
def __del__ (self)
 
def __deepcopy__ (self, memo={})
 
def __str__ (self)
 
def __repr__ (self)
 
def __eq__ (self, other)
 
def __hash__ (self)
 
def __nonzero__ (self)
 
def __bool__ (self)
 
def sexpr (self)
 
def as_ast (self)
 
def get_id (self)
 
def ctx_ref (self)
 
def eq (self, other)
 
def translate (self, target)
 
def __copy__ (self)
 
def hash (self)
 
- Public Member Functions inherited from Z3PPObject
def use_pp (self)
 

Additional Inherited Members

- Data Fields inherited from AstRef
 ast
 
 ctx
 

Detailed Description

Datatype sorts.

Definition at line 4828 of file z3py.py.

Member Function Documentation

◆ accessor()

def accessor (   self,
  i,
  j 
)
In Z3, each constructor has 0 or more accessor. The number of accessors is equal to the arity of the constructor.

>>> List = Datatype('List')
>>> List.declare('cons', ('car', IntSort()), ('cdr', List))
>>> List.declare('nil')
>>> List = List.create()
>>> List.num_constructors()
2
>>> List.constructor(0)
cons
>>> num_accs = List.constructor(0).arity()
>>> num_accs
2
>>> List.accessor(0, 0)
car
>>> List.accessor(0, 1)
cdr
>>> List.constructor(1)
nil
>>> num_accs = List.constructor(1).arity()
>>> num_accs
0

Definition at line 4890 of file z3py.py.

4890  def accessor(self, i, j):
4891  """In Z3, each constructor has 0 or more accessor. The number of accessors is equal to the arity of the constructor.
4892 
4893  >>> List = Datatype('List')
4894  >>> List.declare('cons', ('car', IntSort()), ('cdr', List))
4895  >>> List.declare('nil')
4896  >>> List = List.create()
4897  >>> List.num_constructors()
4898  2
4899  >>> List.constructor(0)
4900  cons
4901  >>> num_accs = List.constructor(0).arity()
4902  >>> num_accs
4903  2
4904  >>> List.accessor(0, 0)
4905  car
4906  >>> List.accessor(0, 1)
4907  cdr
4908  >>> List.constructor(1)
4909  nil
4910  >>> num_accs = List.constructor(1).arity()
4911  >>> num_accs
4912  0
4913  """
4914  if __debug__:
4915  _z3_assert(i < self.num_constructors(), "Invalid constructor index")
4916  _z3_assert(j < self.constructor(i).arity(), "Invalid accessor index")
4917  return FuncDeclRef(Z3_get_datatype_sort_constructor_accessor(self.ctx_ref(), self.ast, i, j), self.ctx)
4918 
Z3_func_decl Z3_API Z3_get_datatype_sort_constructor_accessor(Z3_context c, Z3_sort t, unsigned idx_c, unsigned idx_a)
Return idx_a&#39;th accessor for the idx_c&#39;th constructor.

◆ constructor()

def constructor (   self,
  idx 
)
Return a constructor of the datatype `self`.

>>> List = Datatype('List')
>>> List.declare('cons', ('car', IntSort()), ('cdr', List))
>>> List.declare('nil')
>>> List = List.create()
>>> # List is now a Z3 declaration
>>> List.num_constructors()
2
>>> List.constructor(0)
cons
>>> List.constructor(1)
nil

Definition at line 4843 of file z3py.py.

4843  def constructor(self, idx):
4844  """Return a constructor of the datatype `self`.
4845 
4846  >>> List = Datatype('List')
4847  >>> List.declare('cons', ('car', IntSort()), ('cdr', List))
4848  >>> List.declare('nil')
4849  >>> List = List.create()
4850  >>> # List is now a Z3 declaration
4851  >>> List.num_constructors()
4852  2
4853  >>> List.constructor(0)
4854  cons
4855  >>> List.constructor(1)
4856  nil
4857  """
4858  if __debug__:
4859  _z3_assert(idx < self.num_constructors(), "Invalid constructor index")
4860  return FuncDeclRef(Z3_get_datatype_sort_constructor(self.ctx_ref(), self.ast, idx), self.ctx)
4861 
Z3_func_decl Z3_API Z3_get_datatype_sort_constructor(Z3_context c, Z3_sort t, unsigned idx)
Return idx&#39;th constructor.

◆ num_constructors()

def num_constructors (   self)
Return the number of constructors in the given Z3 datatype.

>>> List = Datatype('List')
>>> List.declare('cons', ('car', IntSort()), ('cdr', List))
>>> List.declare('nil')
>>> List = List.create()
>>> # List is now a Z3 declaration
>>> List.num_constructors()
2

Definition at line 4830 of file z3py.py.

4830  def num_constructors(self):
4831  """Return the number of constructors in the given Z3 datatype.
4832 
4833  >>> List = Datatype('List')
4834  >>> List.declare('cons', ('car', IntSort()), ('cdr', List))
4835  >>> List.declare('nil')
4836  >>> List = List.create()
4837  >>> # List is now a Z3 declaration
4838  >>> List.num_constructors()
4839  2
4840  """
4841  return int(Z3_get_datatype_sort_num_constructors(self.ctx_ref(), self.ast))
4842 
unsigned Z3_API Z3_get_datatype_sort_num_constructors(Z3_context c, Z3_sort t)
Return number of constructors for datatype.

◆ recognizer()

def recognizer (   self,
  idx 
)
In Z3, each constructor has an associated recognizer predicate.

If the constructor is named `name`, then the recognizer `is_name`.

>>> List = Datatype('List')
>>> List.declare('cons', ('car', IntSort()), ('cdr', List))
>>> List.declare('nil')
>>> List = List.create()
>>> # List is now a Z3 declaration
>>> List.num_constructors()
2
>>> List.recognizer(0)
is(cons)
>>> List.recognizer(1)
is(nil)
>>> simplify(List.is_nil(List.cons(10, List.nil)))
False
>>> simplify(List.is_cons(List.cons(10, List.nil)))
True
>>> l = Const('l', List)
>>> simplify(List.is_cons(l))
is(cons, l)

Definition at line 4862 of file z3py.py.

4862  def recognizer(self, idx):
4863  """In Z3, each constructor has an associated recognizer predicate.
4864 
4865  If the constructor is named `name`, then the recognizer `is_name`.
4866 
4867  >>> List = Datatype('List')
4868  >>> List.declare('cons', ('car', IntSort()), ('cdr', List))
4869  >>> List.declare('nil')
4870  >>> List = List.create()
4871  >>> # List is now a Z3 declaration
4872  >>> List.num_constructors()
4873  2
4874  >>> List.recognizer(0)
4875  is(cons)
4876  >>> List.recognizer(1)
4877  is(nil)
4878  >>> simplify(List.is_nil(List.cons(10, List.nil)))
4879  False
4880  >>> simplify(List.is_cons(List.cons(10, List.nil)))
4881  True
4882  >>> l = Const('l', List)
4883  >>> simplify(List.is_cons(l))
4884  is(cons, l)
4885  """
4886  if __debug__:
4887  _z3_assert(idx < self.num_constructors(), "Invalid recognizer index")
4888  return FuncDeclRef(Z3_get_datatype_sort_recognizer(self.ctx_ref(), self.ast, idx), self.ctx)
4889 
Z3_func_decl Z3_API Z3_get_datatype_sort_recognizer(Z3_context c, Z3_sort t, unsigned idx)
Return idx&#39;th recognizer.