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 __nonzero__ (self)
 
def __bool__ (self)
 
def sexpr (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 4878 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 4940 of file z3py.py.

4940  def accessor(self, i, j):
4941  """In Z3, each constructor has 0 or more accessor. The number of accessors is equal to the arity of the constructor.
4942 
4943  >>> List = Datatype('List')
4944  >>> List.declare('cons', ('car', IntSort()), ('cdr', List))
4945  >>> List.declare('nil')
4946  >>> List = List.create()
4947  >>> List.num_constructors()
4948  2
4949  >>> List.constructor(0)
4950  cons
4951  >>> num_accs = List.constructor(0).arity()
4952  >>> num_accs
4953  2
4954  >>> List.accessor(0, 0)
4955  car
4956  >>> List.accessor(0, 1)
4957  cdr
4958  >>> List.constructor(1)
4959  nil
4960  >>> num_accs = List.constructor(1).arity()
4961  >>> num_accs
4962  0
4963  """
4964  if z3_debug():
4965  _z3_assert(i < self.num_constructors(), "Invalid constructor index")
4966  _z3_assert(j < self.constructor(i).arity(), "Invalid accessor index")
4967  return FuncDeclRef(Z3_get_datatype_sort_constructor_accessor(self.ctx_ref(), self.ast, i, j), self.ctx)
4968 
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'th accessor for the idx_c'th constructor.
def z3_debug()
Definition: z3py.py:58

◆ 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 4893 of file z3py.py.

4893  def constructor(self, idx):
4894  """Return a constructor of the datatype `self`.
4895 
4896  >>> List = Datatype('List')
4897  >>> List.declare('cons', ('car', IntSort()), ('cdr', List))
4898  >>> List.declare('nil')
4899  >>> List = List.create()
4900  >>> # List is now a Z3 declaration
4901  >>> List.num_constructors()
4902  2
4903  >>> List.constructor(0)
4904  cons
4905  >>> List.constructor(1)
4906  nil
4907  """
4908  if z3_debug():
4909  _z3_assert(idx < self.num_constructors(), "Invalid constructor index")
4910  return FuncDeclRef(Z3_get_datatype_sort_constructor(self.ctx_ref(), self.ast, idx), self.ctx)
4911 
def z3_debug()
Definition: z3py.py:58
Z3_func_decl Z3_API Z3_get_datatype_sort_constructor(Z3_context c, Z3_sort t, unsigned idx)
Return idx'th constructor.

Referenced by DatatypeSortRef.accessor().

◆ 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 4880 of file z3py.py.

4880  def num_constructors(self):
4881  """Return the number of constructors in the given Z3 datatype.
4882 
4883  >>> List = Datatype('List')
4884  >>> List.declare('cons', ('car', IntSort()), ('cdr', List))
4885  >>> List.declare('nil')
4886  >>> List = List.create()
4887  >>> # List is now a Z3 declaration
4888  >>> List.num_constructors()
4889  2
4890  """
4891  return int(Z3_get_datatype_sort_num_constructors(self.ctx_ref(), self.ast))
4892 
unsigned Z3_API Z3_get_datatype_sort_num_constructors(Z3_context c, Z3_sort t)
Return number of constructors for datatype.

Referenced by DatatypeSortRef.accessor(), DatatypeSortRef.constructor(), and DatatypeSortRef.recognizer().

◆ 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 4912 of file z3py.py.

4912  def recognizer(self, idx):
4913  """In Z3, each constructor has an associated recognizer predicate.
4914 
4915  If the constructor is named `name`, then the recognizer `is_name`.
4916 
4917  >>> List = Datatype('List')
4918  >>> List.declare('cons', ('car', IntSort()), ('cdr', List))
4919  >>> List.declare('nil')
4920  >>> List = List.create()
4921  >>> # List is now a Z3 declaration
4922  >>> List.num_constructors()
4923  2
4924  >>> List.recognizer(0)
4925  is(cons)
4926  >>> List.recognizer(1)
4927  is(nil)
4928  >>> simplify(List.is_nil(List.cons(10, List.nil)))
4929  False
4930  >>> simplify(List.is_cons(List.cons(10, List.nil)))
4931  True
4932  >>> l = Const('l', List)
4933  >>> simplify(List.is_cons(l))
4934  is(cons, l)
4935  """
4936  if z3_debug():
4937  _z3_assert(idx < self.num_constructors(), "Invalid recognizer index")
4938  return FuncDeclRef(Z3_get_datatype_sort_recognizer(self.ctx_ref(), self.ast, idx), self.ctx)
4939 
Z3_func_decl Z3_API Z3_get_datatype_sort_recognizer(Z3_context c, Z3_sort t, unsigned idx)
Return idx'th recognizer.
def z3_debug()
Definition: z3py.py:58