Z3
 
Loading...
Searching...
No Matches
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 5245 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 5308 of file z3py.py.

5308 def accessor(self, i, j):
5309 """In Z3, each constructor has 0 or more accessor.
5310 The number of accessors is equal to the arity of the constructor.
5311
5312 >>> List = Datatype('List')
5313 >>> List.declare('cons', ('car', IntSort()), ('cdr', List))
5314 >>> List.declare('nil')
5315 >>> List = List.create()
5316 >>> List.num_constructors()
5317 2
5318 >>> List.constructor(0)
5319 cons
5320 >>> num_accs = List.constructor(0).arity()
5321 >>> num_accs
5322 2
5323 >>> List.accessor(0, 0)
5324 car
5325 >>> List.accessor(0, 1)
5326 cdr
5327 >>> List.constructor(1)
5328 nil
5329 >>> num_accs = List.constructor(1).arity()
5330 >>> num_accs
5331 0
5332 """
5333 if z3_debug():
5334 _z3_assert(i < self.num_constructors(), "Invalid constructor index")
5335 _z3_assert(j < self.constructor(i).arity(), "Invalid accessor index")
5336 return FuncDeclRef(
5337 Z3_get_datatype_sort_constructor_accessor(self.ctx_ref(), self.ast, i, j),
5338 ctx=self.ctx,
5339 )
5340
5341
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.

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

5261 def constructor(self, idx):
5262 """Return a constructor of the datatype `self`.
5263
5264 >>> List = Datatype('List')
5265 >>> List.declare('cons', ('car', IntSort()), ('cdr', List))
5266 >>> List.declare('nil')
5267 >>> List = List.create()
5268 >>> # List is now a Z3 declaration
5269 >>> List.num_constructors()
5270 2
5271 >>> List.constructor(0)
5272 cons
5273 >>> List.constructor(1)
5274 nil
5275 """
5276 if z3_debug():
5277 _z3_assert(idx < self.num_constructors(), "Invalid constructor index")
5278 return FuncDeclRef(Z3_get_datatype_sort_constructor(self.ctx_ref(), self.ast, idx), self.ctx)
5279
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 5248 of file z3py.py.

5248 def num_constructors(self):
5249 """Return the number of constructors in the given Z3 datatype.
5250
5251 >>> List = Datatype('List')
5252 >>> List.declare('cons', ('car', IntSort()), ('cdr', List))
5253 >>> List.declare('nil')
5254 >>> List = List.create()
5255 >>> # List is now a Z3 declaration
5256 >>> List.num_constructors()
5257 2
5258 """
5259 return int(Z3_get_datatype_sort_num_constructors(self.ctx_ref(), self.ast))
5260
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 5280 of file z3py.py.

5280 def recognizer(self, idx):
5281 """In Z3, each constructor has an associated recognizer predicate.
5282
5283 If the constructor is named `name`, then the recognizer `is_name`.
5284
5285 >>> List = Datatype('List')
5286 >>> List.declare('cons', ('car', IntSort()), ('cdr', List))
5287 >>> List.declare('nil')
5288 >>> List = List.create()
5289 >>> # List is now a Z3 declaration
5290 >>> List.num_constructors()
5291 2
5292 >>> List.recognizer(0)
5293 is(cons)
5294 >>> List.recognizer(1)
5295 is(nil)
5296 >>> simplify(List.is_nil(List.cons(10, List.nil)))
5297 False
5298 >>> simplify(List.is_cons(List.cons(10, List.nil)))
5299 True
5300 >>> l = Const('l', List)
5301 >>> simplify(List.is_cons(l))
5302 is(cons, l)
5303 """
5304 if z3_debug():
5305 _z3_assert(idx < self.num_constructors(), "Invalid recognizer index")
5306 return FuncDeclRef(Z3_get_datatype_sort_recognizer(self.ctx_ref(), self.ast, idx), self.ctx)
5307
Z3_func_decl Z3_API Z3_get_datatype_sort_recognizer(Z3_context c, Z3_sort t, unsigned idx)
Return idx'th recognizer.