Z3
Public Member Functions | Data Fields
Datatype Class Reference

Public Member Functions

def __init__
 
def __deepcopy__
 
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 5092 of file z3py.py.

Constructor & Destructor Documentation

def __init__ (   self,
  name,
  ctx = None 
)

Definition at line 5119 of file z3py.py.

5119  def __init__(self, name, ctx=None):
5120  self.ctx = _get_ctx(ctx)
5121  self.name = name
5122  self.constructors = []
5123 
def __init__
Definition: z3py.py:5119

Member Function Documentation

def __deepcopy__ (   self,
  memo = {} 
)

Definition at line 5124 of file z3py.py.

5124  def __deepcopy__(self, memo={}):
5125  r = Datatype(self.name, self.ctx)
5126  r.constructors = copy.deepcopy(self.constructors)
5127  return r
5128 
def __deepcopy__
Definition: z3py.py:5124
def __repr__ (   self)

Definition at line 5160 of file z3py.py.

5160  def __repr__(self):
5161  return "Datatype(%s, %s)" % (self.name, self.constructors)
5162 
def __repr__(self)
Definition: z3py.py:5160
def create (   self)
Create a Z3 datatype based on the constructors declared using the method `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 5163 of file z3py.py.

Referenced by Datatype.declare().

5163  def create(self):
5164  """Create a Z3 datatype based on the constructors declared using the method `declare()`.
5165 
5166  The function `CreateDatatypes()` must be used to define mutually recursive datatypes.
5167 
5168  >>> List = Datatype('List')
5169  >>> List.declare('cons', ('car', IntSort()), ('cdr', List))
5170  >>> List.declare('nil')
5171  >>> List = List.create()
5172  >>> List.nil
5173  nil
5174  >>> List.cons(10, List.nil)
5175  cons(10, nil)
5176  """
5177  return CreateDatatypes([self])[0]
5178 
5179 
def CreateDatatypes(ds)
Definition: z3py.py:5204
def create(self)
Definition: z3py.py:5163
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 following 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 5139 of file z3py.py.

Referenced by Datatype.create().

5139  def declare(self, name, *args):
5140  """Declare constructor named `name` with the given accessors `args`.
5141  Each accessor is a pair `(name, sort)`, where `name` is a string and `sort` a Z3 sort
5142  or a reference to the datatypes being declared.
5143 
5144  In the following example `List.declare('cons', ('car', IntSort()), ('cdr', List))`
5145  declares the constructor named `cons` that builds a new List using an integer and a List.
5146  It also declares the accessors `car` and `cdr`. The accessor `car` extracts the integer
5147  of a `cons` cell, and `cdr` the list of a `cons` cell. After all constructors were declared,
5148  we use the method create() to create the actual datatype in Z3.
5149 
5150  >>> List = Datatype('List')
5151  >>> List.declare('cons', ('car', IntSort()), ('cdr', List))
5152  >>> List.declare('nil')
5153  >>> List = List.create()
5154  """
5155  if z3_debug():
5156  _z3_assert(isinstance(name, str), "String expected")
5157  _z3_assert(name != "", "Constructor name cannot be empty")
5158  return self.declare_core(name, "is-" + name, *args)
5159 
def declare(self, name, args)
Definition: z3py.py:5139
def z3_debug()
Definition: z3py.py:62
def declare_core(self, name, rec_name, args)
Definition: z3py.py:5129
def declare_core (   self,
  name,
  rec_name,
  args 
)

Definition at line 5129 of file z3py.py.

Referenced by Datatype.declare().

5129  def declare_core(self, name, rec_name, *args):
5130  if z3_debug():
5131  _z3_assert(isinstance(name, str), "String expected")
5132  _z3_assert(isinstance(rec_name, str), "String expected")
5133  _z3_assert(
5134  all([_valid_accessor(a) for a in args]),
5135  "Valid list of accessors expected. An accessor is a pair of the form (String, Datatype|Sort)",
5136  )
5137  self.constructors.append((name, rec_name, args))
5138 
def z3_debug()
Definition: z3py.py:62
def declare_core(self, name, rec_name, args)
Definition: z3py.py:5129

Field Documentation

constructors

Definition at line 5122 of file z3py.py.

Referenced by Datatype.__deepcopy__(), and Datatype.__repr__().

ctx
name

Definition at line 5121 of file z3py.py.

Referenced by Datatype.__deepcopy__(), and Datatype.__repr__().