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 4874 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 4936 of file z3py.py.

4936 def accessor(self, i, j):
4937 """In Z3, each constructor has 0 or more accessor. The number of accessors is equal to the arity of the constructor.
4938
4939 >>> List = Datatype('List')
4940 >>> List.declare('cons', ('car', IntSort()), ('cdr', List))
4941 >>> List.declare('nil')
4942 >>> List = List.create()
4943 >>> List.num_constructors()
4944 2
4945 >>> List.constructor(0)
4946 cons
4947 >>> num_accs = List.constructor(0).arity()
4948 >>> num_accs
4949 2
4950 >>> List.accessor(0, 0)
4951 car
4952 >>> List.accessor(0, 1)
4953 cdr
4954 >>> List.constructor(1)
4955 nil
4956 >>> num_accs = List.constructor(1).arity()
4957 >>> num_accs
4958 0
4959 """
4960 if z3_debug():
4961 _z3_assert(i < self.num_constructors(), "Invalid constructor index")
4962 _z3_assert(j < self.constructor(i).arity(), "Invalid accessor index")
4963 return FuncDeclRef(Z3_get_datatype_sort_constructor_accessor(self.ctx_ref(), self.ast, i, j), self.ctx)
4964
def z3_debug()
Definition: z3py.py:56
def IntSort(ctx=None)
Definition: z3py.py:2907
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 4889 of file z3py.py.

4889 def constructor(self, idx):
4890 """Return a constructor of the datatype `self`.
4891
4892 >>> List = Datatype('List')
4893 >>> List.declare('cons', ('car', IntSort()), ('cdr', List))
4894 >>> List.declare('nil')
4895 >>> List = List.create()
4896 >>> # List is now a Z3 declaration
4897 >>> List.num_constructors()
4898 2
4899 >>> List.constructor(0)
4900 cons
4901 >>> List.constructor(1)
4902 nil
4903 """
4904 if z3_debug():
4905 _z3_assert(idx < self.num_constructors(), "Invalid constructor index")
4906 return FuncDeclRef(Z3_get_datatype_sort_constructor(self.ctx_ref(), self.ast, idx), self.ctx)
4907
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 4876 of file z3py.py.

4876 def num_constructors(self):
4877 """Return the number of constructors in the given Z3 datatype.
4878
4879 >>> List = Datatype('List')
4880 >>> List.declare('cons', ('car', IntSort()), ('cdr', List))
4881 >>> List.declare('nil')
4882 >>> List = List.create()
4883 >>> # List is now a Z3 declaration
4884 >>> List.num_constructors()
4885 2
4886 """
4887 return int(Z3_get_datatype_sort_num_constructors(self.ctx_ref(), self.ast))
4888
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 4908 of file z3py.py.

4908 def recognizer(self, idx):
4909 """In Z3, each constructor has an associated recognizer predicate.
4910
4911 If the constructor is named `name`, then the recognizer `is_name`.
4912
4913 >>> List = Datatype('List')
4914 >>> List.declare('cons', ('car', IntSort()), ('cdr', List))
4915 >>> List.declare('nil')
4916 >>> List = List.create()
4917 >>> # List is now a Z3 declaration
4918 >>> List.num_constructors()
4919 2
4920 >>> List.recognizer(0)
4921 is(cons)
4922 >>> List.recognizer(1)
4923 is(nil)
4924 >>> simplify(List.is_nil(List.cons(10, List.nil)))
4925 False
4926 >>> simplify(List.is_cons(List.cons(10, List.nil)))
4927 True
4928 >>> l = Const('l', List)
4929 >>> simplify(List.is_cons(l))
4930 is(cons, l)
4931 """
4932 if z3_debug():
4933 _z3_assert(idx < self.num_constructors(), "Invalid recognizer index")
4934 return FuncDeclRef(Z3_get_datatype_sort_recognizer(self.ctx_ref(), self.ast, idx), self.ctx)
4935
def simplify(a, *arguments, **keywords)
Utils.
Definition: z3py.py:8182
def Const(name, sort)
Definition: z3py.py:1301
Z3_func_decl Z3_API Z3_get_datatype_sort_recognizer(Z3_context c, Z3_sort t, unsigned idx)
Return idx'th recognizer.