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 4915 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 4977 of file z3py.py.

4977  def accessor(self, i, j):
4978  """In Z3, each constructor has 0 or more accessor. The number of accessors is equal to the arity of the constructor.
4979 
4980  >>> List = Datatype('List')
4981  >>> List.declare('cons', ('car', IntSort()), ('cdr', List))
4982  >>> List.declare('nil')
4983  >>> List = List.create()
4984  >>> List.num_constructors()
4985  2
4986  >>> List.constructor(0)
4987  cons
4988  >>> num_accs = List.constructor(0).arity()
4989  >>> num_accs
4990  2
4991  >>> List.accessor(0, 0)
4992  car
4993  >>> List.accessor(0, 1)
4994  cdr
4995  >>> List.constructor(1)
4996  nil
4997  >>> num_accs = List.constructor(1).arity()
4998  >>> num_accs
4999  0
5000  """
5001  if z3_debug():
5002  _z3_assert(i < self.num_constructors(), "Invalid constructor index")
5003  _z3_assert(j < self.constructor(i).arity(), "Invalid accessor index")
5004  return FuncDeclRef(Z3_get_datatype_sort_constructor_accessor(self.ctx_ref(), self.ast, i, j), self.ctx)
5005 

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

4930  def constructor(self, idx):
4931  """Return a constructor of the datatype `self`.
4932 
4933  >>> List = Datatype('List')
4934  >>> List.declare('cons', ('car', IntSort()), ('cdr', List))
4935  >>> List.declare('nil')
4936  >>> List = List.create()
4937  >>> # List is now a Z3 declaration
4938  >>> List.num_constructors()
4939  2
4940  >>> List.constructor(0)
4941  cons
4942  >>> List.constructor(1)
4943  nil
4944  """
4945  if z3_debug():
4946  _z3_assert(idx < self.num_constructors(), "Invalid constructor index")
4947  return FuncDeclRef(Z3_get_datatype_sort_constructor(self.ctx_ref(), self.ast, idx), self.ctx)
4948 

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

4917  def num_constructors(self):
4918  """Return the number of constructors in the given Z3 datatype.
4919 
4920  >>> List = Datatype('List')
4921  >>> List.declare('cons', ('car', IntSort()), ('cdr', List))
4922  >>> List.declare('nil')
4923  >>> List = List.create()
4924  >>> # List is now a Z3 declaration
4925  >>> List.num_constructors()
4926  2
4927  """
4928  return int(Z3_get_datatype_sort_num_constructors(self.ctx_ref(), self.ast))
4929 

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

4949  def recognizer(self, idx):
4950  """In Z3, each constructor has an associated recognizer predicate.
4951 
4952  If the constructor is named `name`, then the recognizer `is_name`.
4953 
4954  >>> List = Datatype('List')
4955  >>> List.declare('cons', ('car', IntSort()), ('cdr', List))
4956  >>> List.declare('nil')
4957  >>> List = List.create()
4958  >>> # List is now a Z3 declaration
4959  >>> List.num_constructors()
4960  2
4961  >>> List.recognizer(0)
4962  is(cons)
4963  >>> List.recognizer(1)
4964  is(nil)
4965  >>> simplify(List.is_nil(List.cons(10, List.nil)))
4966  False
4967  >>> simplify(List.is_cons(List.cons(10, List.nil)))
4968  True
4969  >>> l = Const('l', List)
4970  >>> simplify(List.is_cons(l))
4971  is(cons, l)
4972  """
4973  if z3_debug():
4974  _z3_assert(idx < self.num_constructors(), "Invalid recognizer index")
4975  return FuncDeclRef(Z3_get_datatype_sort_recognizer(self.ctx_ref(), self.ast, idx), self.ctx)
4976 
Z3_get_datatype_sort_num_constructors
unsigned Z3_API Z3_get_datatype_sort_num_constructors(Z3_context c, Z3_sort t)
Return number of constructors for datatype.
z3py.z3_debug
def z3_debug()
Definition: z3py.py:56
Z3_get_datatype_sort_constructor
Z3_func_decl Z3_API Z3_get_datatype_sort_constructor(Z3_context c, Z3_sort t, unsigned idx)
Return idx'th constructor.
Z3_get_datatype_sort_recognizer
Z3_func_decl Z3_API Z3_get_datatype_sort_recognizer(Z3_context c, Z3_sort t, unsigned idx)
Return idx'th recognizer.
Z3_get_datatype_sort_constructor_accessor
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.