Public Member Functions
def	__init__ (self, name, ctx=None)

def	declare_core (self, name, rec_name, *args)

def	declare (self, name, *args)

def	__repr__ (self)

def	create (self)

Data Fields
	ctx

	name

	constructors

Detailed Description

Helper class for declaring Z3 datatypes.

>>> List = Datatype('List')
>>> List.declare('cons', ('car', IntSort()), ('cdr', List))
>>> List.declare('nil')
>>> List = List.create()
>>> # List is now a Z3 declaration
>>> List.nil
nil
>>> List.cons(10, List.nil)
cons(10, nil)
>>> List.cons(10, List.nil).sort()
List
>>> cons = List.cons
>>> nil  = List.nil
>>> car  = List.car
>>> cdr  = List.cdr
>>> n = cons(1, cons(0, nil))
>>> n
cons(1, cons(0, nil))
>>> simplify(cdr(n))
cons(0, nil)
>>> simplify(car(n))
1

Definition at line 4290 of file z3py.py.

Constructor & Destructor Documentation

◆ init()

def __init__	(	self,
		name,
		ctx = `None`
	)

Definition at line 4316 of file z3py.py.

     def __init__(self, name, ctx=None):
         self.ctx          = _get_ctx(ctx)
         self.name         = name
         self.constructors = []
 

Member Function Documentation

◆ repr()

def __repr__ ( self )

Definition at line 4348 of file z3py.py.

     def __repr__(self):
         return "Datatype(%s, %s)" % (self.name, self.constructors)
 

◆ create()

def create ( self )

Create a Z3 datatype based on the constructors declared using the mehtod `declare()`.

The function `CreateDatatypes()` must be used to define mutually recursive datatypes.

>>> List = Datatype('List')
>>> List.declare('cons', ('car', IntSort()), ('cdr', List))
>>> List.declare('nil')
>>> List = List.create()
>>> List.nil
nil
>>> List.cons(10, List.nil)
cons(10, nil)

Definition at line 4351 of file z3py.py.

     def create(self):
         """Create a Z3 datatype based on the constructors declared using the mehtod `declare()`.
 
         The function `CreateDatatypes()` must be used to define mutually recursive datatypes.
 
         >>> List = Datatype('List')
         >>> List.declare('cons', ('car', IntSort()), ('cdr', List))
         >>> List.declare('nil')
         >>> List = List.create()
         >>> List.nil
         nil
         >>> List.cons(10, List.nil)
         cons(10, nil)
         """
         return CreateDatatypes([self])[0]
 

◆ declare()

def declare	(		self,
			name,
		*	args
	)

Declare constructor named `name` with the given accessors `args`.
Each accessor is a pair `(name, sort)`, where `name` is a string and `sort` a Z3 sort or a reference to the datatypes being declared.

In the followin example `List.declare('cons', ('car', IntSort()), ('cdr', List))`
declares the constructor named `cons` that builds a new List using an integer and a List.
It also declares the accessors `car` and `cdr`. The accessor `car` extracts the integer of a `cons` cell,
and `cdr` the list of a `cons` cell. After all constructors were declared, we use the method create() to create
the actual datatype in Z3.

>>> List = Datatype('List')
>>> List.declare('cons', ('car', IntSort()), ('cdr', List))
>>> List.declare('nil')
>>> List = List.create()

Definition at line 4328 of file z3py.py.

     def declare(self, name, *args):
         """Declare constructor named `name` with the given accessors `args`.
         Each accessor is a pair `(name, sort)`, where `name` is a string and `sort` a Z3 sort or a reference to the datatypes being declared.
 
         In the followin example `List.declare('cons', ('car', IntSort()), ('cdr', List))`
         declares the constructor named `cons` that builds a new List using an integer and a List.
         It also declares the accessors `car` and `cdr`. The accessor `car` extracts the integer of a `cons` cell,
         and `cdr` the list of a `cons` cell. After all constructors were declared, we use the method create() to create
         the actual datatype in Z3.
 
         >>> List = Datatype('List')
         >>> List.declare('cons', ('car', IntSort()), ('cdr', List))
         >>> List.declare('nil')
         >>> List = List.create()
         """
         if __debug__:
             _z3_assert(isinstance(name, str), "String expected")
             _z3_assert(name != "", "Constructor name cannot be empty")
         return self.declare_core(name, "is_" + name, *args)
 

◆ declare_core()

def declare_core	(		self,
			name,
			rec_name,
		*	args
	)

Definition at line 4321 of file z3py.py.

     def declare_core(self, name, rec_name, *args):
         if __debug__:
             _z3_assert(isinstance(name, str), "String expected")
             _z3_assert(isinstance(rec_name, str), "String expected")
             _z3_assert(all([_valid_accessor(a) for a in args]), "Valid list of accessors expected. An accessor is a pair of the form (String, Datatype|Sort)")
         self.constructors.append((name, rec_name, args))
 