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

5363  def accessor(self, i, j):
5364  """In Z3, each constructor has 0 or more accessor.
5365  The number of accessors is equal to the arity of the constructor.
5366 
5367  >>> List = Datatype('List')
5368  >>> List.declare('cons', ('car', IntSort()), ('cdr', List))
5369  >>> List.declare('nil')
5370  >>> List = List.create()
5371  >>> List.num_constructors()
5372  2
5373  >>> List.constructor(0)
5374  cons
5375  >>> num_accs = List.constructor(0).arity()
5376  >>> num_accs
5377  2
5378  >>> List.accessor(0, 0)
5379  car
5380  >>> List.accessor(0, 1)
5381  cdr
5382  >>> List.constructor(1)
5383  nil
5384  >>> num_accs = List.constructor(1).arity()
5385  >>> num_accs
5386  0
5387  """
5388  if z3_debug():
5389  _z3_assert(i < self.num_constructors(), "Invalid constructor index")
5390  _z3_assert(j < self.constructor(i).arity(), "Invalid accessor index")
5391  return FuncDeclRef(
5392  Z3_get_datatype_sort_constructor_accessor(self.ctx_ref(), self.ast, i, j),
5393  ctx=self.ctx,
5394  )
5395 
5396 
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:62

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

5316  def constructor(self, idx):
5317  """Return a constructor of the datatype `self`.
5318 
5319  >>> List = Datatype('List')
5320  >>> List.declare('cons', ('car', IntSort()), ('cdr', List))
5321  >>> List.declare('nil')
5322  >>> List = List.create()
5323  >>> # List is now a Z3 declaration
5324  >>> List.num_constructors()
5325  2
5326  >>> List.constructor(0)
5327  cons
5328  >>> List.constructor(1)
5329  nil
5330  """
5331  if z3_debug():
5332  _z3_assert(idx < self.num_constructors(), "Invalid constructor index")
5333  return FuncDeclRef(Z3_get_datatype_sort_constructor(self.ctx_ref(), self.ast, idx), self.ctx)
5334 
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 5303 of file z3py.py.

5303  def num_constructors(self):
5304  """Return the number of constructors in the given Z3 datatype.
5305 
5306  >>> List = Datatype('List')
5307  >>> List.declare('cons', ('car', IntSort()), ('cdr', List))
5308  >>> List.declare('nil')
5309  >>> List = List.create()
5310  >>> # List is now a Z3 declaration
5311  >>> List.num_constructors()
5312  2
5313  """
5314  return int(Z3_get_datatype_sort_num_constructors(self.ctx_ref(), self.ast))
5315 
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 5335 of file z3py.py.

5335  def recognizer(self, idx):
5336  """In Z3, each constructor has an associated recognizer predicate.
5337 
5338  If the constructor is named `name`, then the recognizer `is_name`.
5339 
5340  >>> List = Datatype('List')
5341  >>> List.declare('cons', ('car', IntSort()), ('cdr', List))
5342  >>> List.declare('nil')
5343  >>> List = List.create()
5344  >>> # List is now a Z3 declaration
5345  >>> List.num_constructors()
5346  2
5347  >>> List.recognizer(0)
5348  is(cons)
5349  >>> List.recognizer(1)
5350  is(nil)
5351  >>> simplify(List.is_nil(List.cons(10, List.nil)))
5352  False
5353  >>> simplify(List.is_cons(List.cons(10, List.nil)))
5354  True
5355  >>> l = Const('l', List)
5356  >>> simplify(List.is_cons(l))
5357  is(cons, l)
5358  """
5359  if z3_debug():
5360  _z3_assert(idx < self.num_constructors(), "Invalid recognizer index")
5361  return FuncDeclRef(Z3_get_datatype_sort_recognizer(self.ctx_ref(), self.ast, idx), self.ctx)
5362 
Z3_func_decl Z3_API Z3_get_datatype_sort_recognizer(Z3_context c, Z3_sort t, unsigned idx)
Return idx'th recognizer.