Z3
Public Member Functions | Data Fields
Datatype Class Reference

Public Member Functions

def __init__ (self, name, ctx=None)
 
def __deepcopy__ (self, memo={})
 
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 4642 of file z3py.py.

Constructor & Destructor Documentation

◆ __init__()

def __init__ (   self,
  name,
  ctx = None 
)

Definition at line 4668 of file z3py.py.

4668  def __init__(self, name, ctx=None):
4669  self.ctx = _get_ctx(ctx)
4670  self.name = name
4671  self.constructors = []
4672 

Member Function Documentation

◆ __deepcopy__()

def __deepcopy__ (   self,
  memo = {} 
)

Definition at line 4673 of file z3py.py.

4673  def __deepcopy__(self, memo={}):
4674  r = Datatype(self.name, self.ctx)
4675  r.constructors = copy.deepcopy(self.constructors)
4676  return r
4677 

◆ __repr__()

def __repr__ (   self)

Definition at line 4705 of file z3py.py.

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

◆ create()

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

Referenced by Datatype.declare().

4708  def create(self):
4709  """Create a Z3 datatype based on the constructors declared using the method `declare()`.
4710 
4711  The function `CreateDatatypes()` must be used to define mutually recursive datatypes.
4712 
4713  >>> List = Datatype('List')
4714  >>> List.declare('cons', ('car', IntSort()), ('cdr', List))
4715  >>> List.declare('nil')
4716  >>> List = List.create()
4717  >>> List.nil
4718  nil
4719  >>> List.cons(10, List.nil)
4720  cons(10, nil)
4721  """
4722  return CreateDatatypes([self])[0]
4723 
def CreateDatatypes(ds)
Definition: z3py.py:4742

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

Referenced by Datatype.create().

4685  def declare(self, name, *args):
4686  """Declare constructor named `name` with the given accessors `args`.
4687  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.
4688 
4689  In the following example `List.declare('cons', ('car', IntSort()), ('cdr', List))`
4690  declares the constructor named `cons` that builds a new List using an integer and a List.
4691  It also declares the accessors `car` and `cdr`. The accessor `car` extracts the integer of a `cons` cell,
4692  and `cdr` the list of a `cons` cell. After all constructors were declared, we use the method create() to create
4693  the actual datatype in Z3.
4694 
4695  >>> List = Datatype('List')
4696  >>> List.declare('cons', ('car', IntSort()), ('cdr', List))
4697  >>> List.declare('nil')
4698  >>> List = List.create()
4699  """
4700  if __debug__:
4701  _z3_assert(isinstance(name, str), "String expected")
4702  _z3_assert(name != "", "Constructor name cannot be empty")
4703  return self.declare_core(name, "is-" + name, *args)
4704 

◆ declare_core()

def declare_core (   self,
  name,
  rec_name,
  args 
)

Definition at line 4678 of file z3py.py.

4678  def declare_core(self, name, rec_name, *args):
4679  if __debug__:
4680  _z3_assert(isinstance(name, str), "String expected")
4681  _z3_assert(isinstance(rec_name, str), "String expected")
4682  _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)")
4683  self.constructors.append((name, rec_name, args))
4684 

Field Documentation

◆ constructors

constructors

Definition at line 4671 of file z3py.py.

◆ ctx

ctx

Definition at line 4669 of file z3py.py.

Referenced by Probe.__call__(), Fixedpoint.__deepcopy__(), Optimize.__deepcopy__(), ApplyResult.__deepcopy__(), Tactic.__deepcopy__(), Probe.__deepcopy__(), Fixedpoint.__del__(), Optimize.__del__(), ApplyResult.__del__(), Tactic.__del__(), Probe.__del__(), Probe.__eq__(), Probe.__ge__(), ApplyResult.__getitem__(), Probe.__gt__(), Probe.__le__(), ApplyResult.__len__(), Probe.__lt__(), Probe.__ne__(), Fixedpoint.add_cover(), Fixedpoint.add_rule(), Optimize.add_soft(), Tactic.apply(), ApplyResult.as_expr(), Fixedpoint.assert_exprs(), Optimize.assert_exprs(), Optimize.assertions(), Optimize.check(), Optimize.from_file(), Optimize.from_string(), Fixedpoint.get_answer(), Fixedpoint.get_assertions(), Fixedpoint.get_cover_delta(), Fixedpoint.get_ground_sat_answer(), Fixedpoint.get_num_levels(), Fixedpoint.get_rule_names_along_trace(), Fixedpoint.get_rules(), Fixedpoint.get_rules_along_trace(), Fixedpoint.help(), Optimize.help(), Tactic.help(), Optimize.maximize(), Optimize.minimize(), Optimize.model(), Optimize.objectives(), Fixedpoint.param_descrs(), Optimize.param_descrs(), Tactic.param_descrs(), Fixedpoint.parse_file(), Fixedpoint.parse_string(), Fixedpoint.pop(), Optimize.pop(), Fixedpoint.push(), Optimize.push(), Fixedpoint.query(), Fixedpoint.query_from_lvl(), Fixedpoint.reason_unknown(), Optimize.reason_unknown(), Fixedpoint.register_relation(), Fixedpoint.set(), Optimize.set(), Fixedpoint.set_predicate_representation(), Fixedpoint.sexpr(), Optimize.sexpr(), ApplyResult.sexpr(), Tactic.solver(), Fixedpoint.statistics(), Optimize.statistics(), Solver.to_smt2(), Fixedpoint.to_string(), Optimize.unsat_core(), and Fixedpoint.update_rule().

◆ name

name

Definition at line 4670 of file z3py.py.