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

4655  def accessor(self, i, j):
4656  """In Z3, each constructor has 0 or more accessor. The number of accessors is equal to the arity of the constructor.
4657 
4658  >>> List = Datatype('List')
4659  >>> List.declare('cons', ('car', IntSort()), ('cdr', List))
4660  >>> List.declare('nil')
4661  >>> List = List.create()
4662  >>> List.num_constructors()
4663  2
4664  >>> List.constructor(0)
4665  cons
4666  >>> num_accs = List.constructor(0).arity()
4667  >>> num_accs
4668  2
4669  >>> List.accessor(0, 0)
4670  car
4671  >>> List.accessor(0, 1)
4672  cdr
4673  >>> List.constructor(1)
4674  nil
4675  >>> num_accs = List.constructor(1).arity()
4676  >>> num_accs
4677  0
4678  """
4679  if __debug__:
4680  _z3_assert(i < self.num_constructors(), "Invalid constructor index")
4681  _z3_assert(j < self.constructor(i).arity(), "Invalid accessor index")
4682  return FuncDeclRef(Z3_get_datatype_sort_constructor_accessor(self.ctx_ref(), self.ast, i, j), self.ctx)
4683 
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 4608 of file z3py.py.

4608  def constructor(self, idx):
4609  """Return a constructor of the datatype `self`.
4610 
4611  >>> List = Datatype('List')
4612  >>> List.declare('cons', ('car', IntSort()), ('cdr', List))
4613  >>> List.declare('nil')
4614  >>> List = List.create()
4615  >>> # List is now a Z3 declaration
4616  >>> List.num_constructors()
4617  2
4618  >>> List.constructor(0)
4619  cons
4620  >>> List.constructor(1)
4621  nil
4622  """
4623  if __debug__:
4624  _z3_assert(idx < self.num_constructors(), "Invalid constructor index")
4625  return FuncDeclRef(Z3_get_datatype_sort_constructor(self.ctx_ref(), self.ast, idx), self.ctx)
4626 
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 4595 of file z3py.py.

4595  def num_constructors(self):
4596  """Return the number of constructors in the given Z3 datatype.
4597 
4598  >>> List = Datatype('List')
4599  >>> List.declare('cons', ('car', IntSort()), ('cdr', List))
4600  >>> List.declare('nil')
4601  >>> List = List.create()
4602  >>> # List is now a Z3 declaration
4603  >>> List.num_constructors()
4604  2
4605  """
4606  return int(Z3_get_datatype_sort_num_constructors(self.ctx_ref(), self.ast))
4607 
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 4627 of file z3py.py.

4627  def recognizer(self, idx):
4628  """In Z3, each constructor has an associated recognizer predicate.
4629 
4630  If the constructor is named `name`, then the recognizer `is_name`.
4631 
4632  >>> List = Datatype('List')
4633  >>> List.declare('cons', ('car', IntSort()), ('cdr', List))
4634  >>> List.declare('nil')
4635  >>> List = List.create()
4636  >>> # List is now a Z3 declaration
4637  >>> List.num_constructors()
4638  2
4639  >>> List.recognizer(0)
4640  is(cons)
4641  >>> List.recognizer(1)
4642  is(nil)
4643  >>> simplify(List.is_nil(List.cons(10, List.nil)))
4644  False
4645  >>> simplify(List.is_cons(List.cons(10, List.nil)))
4646  True
4647  >>> l = Const('l', List)
4648  >>> simplify(List.is_cons(l))
4649  is(cons, l)
4650  """
4651  if __debug__:
4652  _z3_assert(idx < self.num_constructors(), "Invalid recognizer index")
4653  return FuncDeclRef(Z3_get_datatype_sort_recognizer(self.ctx_ref(), self.ast, idx), self.ctx)
4654 
Z3_func_decl Z3_API Z3_get_datatype_sort_recognizer(Z3_context c, Z3_sort t, unsigned idx)
Return idx&#39;th recognizer.