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

4633  def accessor(self, i, j):
4634  """In Z3, each constructor has 0 or more accessor. The number of accessors is equal to the arity of the constructor.
4635 
4636  >>> List = Datatype('List')
4637  >>> List.declare('cons', ('car', IntSort()), ('cdr', List))
4638  >>> List.declare('nil')
4639  >>> List = List.create()
4640  >>> List.num_constructors()
4641  2
4642  >>> List.constructor(0)
4643  cons
4644  >>> num_accs = List.constructor(0).arity()
4645  >>> num_accs
4646  2
4647  >>> List.accessor(0, 0)
4648  car
4649  >>> List.accessor(0, 1)
4650  cdr
4651  >>> List.constructor(1)
4652  nil
4653  >>> num_accs = List.constructor(1).arity()
4654  >>> num_accs
4655  0
4656  """
4657  if __debug__:
4658  _z3_assert(i < self.num_constructors(), "Invalid constructor index")
4659  _z3_assert(j < self.constructor(i).arity(), "Invalid accessor index")
4660  return FuncDeclRef(Z3_get_datatype_sort_constructor_accessor(self.ctx_ref(), self.ast, i, j), self.ctx)
4661 
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 4586 of file z3py.py.

4586  def constructor(self, idx):
4587  """Return a constructor of the datatype `self`.
4588 
4589  >>> List = Datatype('List')
4590  >>> List.declare('cons', ('car', IntSort()), ('cdr', List))
4591  >>> List.declare('nil')
4592  >>> List = List.create()
4593  >>> # List is now a Z3 declaration
4594  >>> List.num_constructors()
4595  2
4596  >>> List.constructor(0)
4597  cons
4598  >>> List.constructor(1)
4599  nil
4600  """
4601  if __debug__:
4602  _z3_assert(idx < self.num_constructors(), "Invalid constructor index")
4603  return FuncDeclRef(Z3_get_datatype_sort_constructor(self.ctx_ref(), self.ast, idx), self.ctx)
4604 
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 4573 of file z3py.py.

4573  def num_constructors(self):
4574  """Return the number of constructors in the given Z3 datatype.
4575 
4576  >>> List = Datatype('List')
4577  >>> List.declare('cons', ('car', IntSort()), ('cdr', List))
4578  >>> List.declare('nil')
4579  >>> List = List.create()
4580  >>> # List is now a Z3 declaration
4581  >>> List.num_constructors()
4582  2
4583  """
4584  return int(Z3_get_datatype_sort_num_constructors(self.ctx_ref(), self.ast))
4585 
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 4605 of file z3py.py.

4605  def recognizer(self, idx):
4606  """In Z3, each constructor has an associated recognizer predicate.
4607 
4608  If the constructor is named `name`, then the recognizer `is_name`.
4609 
4610  >>> List = Datatype('List')
4611  >>> List.declare('cons', ('car', IntSort()), ('cdr', List))
4612  >>> List.declare('nil')
4613  >>> List = List.create()
4614  >>> # List is now a Z3 declaration
4615  >>> List.num_constructors()
4616  2
4617  >>> List.recognizer(0)
4618  is_cons
4619  >>> List.recognizer(1)
4620  is_nil
4621  >>> simplify(List.is_nil(List.cons(10, List.nil)))
4622  False
4623  >>> simplify(List.is_cons(List.cons(10, List.nil)))
4624  True
4625  >>> l = Const('l', List)
4626  >>> simplify(List.is_cons(l))
4627  is_cons(l)
4628  """
4629  if __debug__:
4630  _z3_assert(idx < self.num_constructors(), "Invalid recognizer index")
4631  return FuncDeclRef(Z3_get_datatype_sort_recognizer(self.ctx_ref(), self.ast, idx), self.ctx)
4632 
Z3_func_decl Z3_API Z3_get_datatype_sort_recognizer(Z3_context c, Z3_sort t, unsigned idx)
Return idx&#39;th recognizer.