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

5253  def accessor(self, i, j):
5254  """In Z3, each constructor has 0 or more accessor.
5255  The number of accessors is equal to the arity of the constructor.
5256 
5257  >>> List = Datatype('List')
5258  >>> List.declare('cons', ('car', IntSort()), ('cdr', List))
5259  >>> List.declare('nil')
5260  >>> List = List.create()
5261  >>> List.num_constructors()
5262  2
5263  >>> List.constructor(0)
5264  cons
5265  >>> num_accs = List.constructor(0).arity()
5266  >>> num_accs
5267  2
5268  >>> List.accessor(0, 0)
5269  car
5270  >>> List.accessor(0, 1)
5271  cdr
5272  >>> List.constructor(1)
5273  nil
5274  >>> num_accs = List.constructor(1).arity()
5275  >>> num_accs
5276  0
5277  """
5278  if z3_debug():
5279  _z3_assert(i < self.num_constructors(), "Invalid constructor index")
5280  _z3_assert(j < self.constructor(i).arity(), "Invalid accessor index")
5281  return FuncDeclRef(
5282  Z3_get_datatype_sort_constructor_accessor(self.ctx_ref(), self.ast, i, j),
5283  ctx=self.ctx,
5284  )
5285 
5286 
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:64

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

5206  def constructor(self, idx):
5207  """Return a constructor of the datatype `self`.
5208 
5209  >>> List = Datatype('List')
5210  >>> List.declare('cons', ('car', IntSort()), ('cdr', List))
5211  >>> List.declare('nil')
5212  >>> List = List.create()
5213  >>> # List is now a Z3 declaration
5214  >>> List.num_constructors()
5215  2
5216  >>> List.constructor(0)
5217  cons
5218  >>> List.constructor(1)
5219  nil
5220  """
5221  if z3_debug():
5222  _z3_assert(idx < self.num_constructors(), "Invalid constructor index")
5223  return FuncDeclRef(Z3_get_datatype_sort_constructor(self.ctx_ref(), self.ast, idx), self.ctx)
5224 
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 5193 of file z3py.py.

5193  def num_constructors(self):
5194  """Return the number of constructors in the given Z3 datatype.
5195 
5196  >>> List = Datatype('List')
5197  >>> List.declare('cons', ('car', IntSort()), ('cdr', List))
5198  >>> List.declare('nil')
5199  >>> List = List.create()
5200  >>> # List is now a Z3 declaration
5201  >>> List.num_constructors()
5202  2
5203  """
5204  return int(Z3_get_datatype_sort_num_constructors(self.ctx_ref(), self.ast))
5205 
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 5225 of file z3py.py.

5225  def recognizer(self, idx):
5226  """In Z3, each constructor has an associated recognizer predicate.
5227 
5228  If the constructor is named `name`, then the recognizer `is_name`.
5229 
5230  >>> List = Datatype('List')
5231  >>> List.declare('cons', ('car', IntSort()), ('cdr', List))
5232  >>> List.declare('nil')
5233  >>> List = List.create()
5234  >>> # List is now a Z3 declaration
5235  >>> List.num_constructors()
5236  2
5237  >>> List.recognizer(0)
5238  is(cons)
5239  >>> List.recognizer(1)
5240  is(nil)
5241  >>> simplify(List.is_nil(List.cons(10, List.nil)))
5242  False
5243  >>> simplify(List.is_cons(List.cons(10, List.nil)))
5244  True
5245  >>> l = Const('l', List)
5246  >>> simplify(List.is_cons(l))
5247  is(cons, l)
5248  """
5249  if z3_debug():
5250  _z3_assert(idx < self.num_constructors(), "Invalid recognizer index")
5251  return FuncDeclRef(Z3_get_datatype_sort_recognizer(self.ctx_ref(), self.ast, idx), self.ctx)
5252 
Z3_func_decl Z3_API Z3_get_datatype_sort_recognizer(Z3_context c, Z3_sort t, unsigned idx)
Return idx'th recognizer.