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

## Constructor & Destructor Documentation

## ◆ __init__()

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

Definition at line 5007 of file z3py.py.

5007 def __init__(self, name, ctx=None):
5008 self.ctx = _get_ctx(ctx)
5009 self.name = name
5010 self.constructors = []
5011

## Member Function Documentation

## ◆ __deepcopy__()

def __deepcopy__ | ( |  | self,
|  |  | memo = `{}`
| ) |  |

Definition at line 5012 of file z3py.py.

5012 def __deepcopy__(self, memo={}):
5013 r = Datatype(self.name, self.ctx)
5014 r.constructors = copy.deepcopy(self.constructors)
5015 return r
5016

## ◆ __repr__()

def __repr__ | ( |  | self | ) |

Definition at line 5048 of file z3py.py.

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

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

5051 def create(self):
5052 """Create a Z3 datatype based on the constructors declared using the method `declare()`.
5053
5054 The function `CreateDatatypes()` must be used to define mutually recursive datatypes.
5055
5056 >>> List = Datatype('List')
5057 >>> List.declare('cons', ('car', IntSort()), ('cdr', List))
5058 >>> List.declare('nil')
5059 >>> List = List.create()
5060 >>> List.nil
5061 nil
5062 >>> List.cons(10, List.nil)
5063 cons(10, nil)
5064 """
5065 return CreateDatatypes([self])[0]
5066
5067
z3py.IntSort
def IntSort(ctx=None)
Definition: z3py.py:3100
z3py.CreateDatatypes
def CreateDatatypes(*ds)
Definition: z3py.py:5092

Referenced by Datatype.declare().

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

5027 def declare(self, name, *args):
5028 """Declare constructor named `name` with the given accessors `args`.
5029 Each accessor is a pair `(name, sort)`, where `name` is a string and `sort` a Z3 sort
5030 or a reference to the datatypes being declared.
5031
5032 In the following example `List.declare('cons', ('car', IntSort()), ('cdr', List))`
5033 declares the constructor named `cons` that builds a new List using an integer and a List.
5034 It also declares the accessors `car` and `cdr`. The accessor `car` extracts the integer
5035 of a `cons` cell, and `cdr` the list of a `cons` cell. After all constructors were declared,
5036 we use the method create() to create the actual datatype in Z3.
5037
5038 >>> List = Datatype('List')
5039 >>> List.declare('cons', ('car', IntSort()), ('cdr', List))
5040 >>> List.declare('nil')
5041 >>> List = List.create()
5042 """
5043 if z3_debug():
5044 _z3_assert(isinstance(name, str), "String expected")
5045 _z3_assert(name != "", "Constructor name cannot be empty")
5046 return self.declare_core(name, "is-" + name, *args)
5047
z3py.z3_debug
def z3_debug()
Definition: z3py.py:64

## ◆ declare_core()

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

Definition at line 5017 of file z3py.py.

5017 def declare_core(self, name, rec_name, *args):
5018 if z3_debug():
5019 _z3_assert(isinstance(name, str), "String expected")
5020 _z3_assert(isinstance(rec_name, str), "String expected")
5021 _z3_assert(
5022 all([_valid_accessor(a) for a in args]),
5023 "Valid list of accessors expected. An accessor is a pair of the form (String, Datatype|Sort)",
5024 )
5025 self.constructors.append((name, rec_name, args))
5026

Referenced by Datatype.declare().

## Field Documentation

## ◆ constructors

constructors

Definition at line 5010 of file z3py.py.

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

## ◆ ctx

ctx

Definition at line 5008 of file z3py.py.

Referenced by ArithRef.__add__(), BitVecRef.__add__(), FPRef.__add__(), BitVecRef.__and__(), FuncDeclRef.__call__(), Probe.__call__(), AstMap.__contains__(), AstRef.__copy__(), Goal.__copy__(), AstVector.__copy__(), FuncInterp.__copy__(), ModelRef.__copy__(), Solver.__copy__(), AstRef.__deepcopy__(), Datatype.__deepcopy__(), ParamsRef.__deepcopy__(), ParamDescrsRef.__deepcopy__(), Goal.__deepcopy__(), AstVector.__deepcopy__(), AstMap.__deepcopy__(), FuncEntry.__deepcopy__(), FuncInterp.__deepcopy__(), ModelRef.__deepcopy__(), Statistics.__deepcopy__(), Solver.__deepcopy__(), Fixedpoint.__deepcopy__(), Optimize.__deepcopy__(), ApplyResult.__deepcopy__(), Tactic.__deepcopy__(), Probe.__deepcopy__(), Context.__del__(), AstRef.__del__(), ScopedConstructor.__del__(), ScopedConstructorList.__del__(), ParamsRef.__del__(), ParamDescrsRef.__del__(), Goal.__del__(), AstVector.__del__(), AstMap.__del__(), FuncEntry.__del__(), FuncInterp.__del__(), ModelRef.__del__(), Statistics.__del__(), Solver.__del__(), Fixedpoint.__del__(), Optimize.__del__(), ApplyResult.__del__(), Tactic.__del__(), Probe.__del__(), ArithRef.__div__(), BitVecRef.__div__(), FPRef.__div__(), ExprRef.__eq__(), Probe.__eq__(), ArithRef.__ge__(), BitVecRef.__ge__(), Probe.__ge__(), FPRef.__ge__(), SeqRef.__ge__(), QuantifierRef.__getitem__(), ArrayRef.__getitem__(), AstVector.__getitem__(), SeqRef.__getitem__(), ModelRef.__getitem__(), Statistics.__getitem__(), ApplyResult.__getitem__(), AstMap.__getitem__(), ArithRef.__gt__(), BitVecRef.__gt__(), Probe.__gt__(), FPRef.__gt__(), SeqRef.__gt__(), BitVecRef.__invert__(), ArithRef.__le__(), BitVecRef.__le__(), Probe.__le__(), FPRef.__le__(), SeqRef.__le__(), AstVector.__len__(), AstMap.__len__(), ModelRef.__len__(), Statistics.__len__(), ApplyResult.__len__(), BitVecRef.__lshift__(), ArithRef.__lt__(), BitVecRef.__lt__(), Probe.__lt__(), FPRef.__lt__(), SeqRef.__lt__(), ArithRef.__mod__(), BitVecRef.__mod__(), ArithRef.__mul__(), BitVecRef.__mul__(), FPRef.__mul__(), ExprRef.__ne__(), Probe.__ne__(), ArithRef.__neg__(), BitVecRef.__neg__(), BitVecRef.__or__(), ArithRef.__pow__(), ArithRef.__radd__(), BitVecRef.__radd__(), FPRef.__radd__(), BitVecRef.__rand__(), ArithRef.__rdiv__(), BitVecRef.__rdiv__(), FPRef.__rdiv__(), ParamsRef.__repr__(), ParamDescrsRef.__repr__(), AstMap.__repr__(), Statistics.__repr__(), BitVecRef.__rlshift__(), ArithRef.__rmod__(), BitVecRef.__rmod__(), ArithRef.__rmul__(), BitVecRef.__rmul__(), FPRef.__rmul__(), BitVecRef.__ror__(), ArithRef.__rpow__(), BitVecRef.__rrshift__(), BitVecRef.__rshift__(), ArithRef.__rsub__(), BitVecRef.__rsub__(), FPRef.__rsub__(), BitVecRef.__rxor__(), AstVector.__setitem__(), AstMap.__setitem__(), ArithRef.__sub__(), BitVecRef.__sub__(), FPRef.__sub__(), BitVecRef.__xor__(), DatatypeSortRef.accessor(), Fixedpoint.add_cover(), Fixedpoint.add_rule(), Optimize.add_soft(), Tactic.apply(), AlgebraicNumRef.approx(), ExprRef.arg(), FuncEntry.arg_value(), FuncInterp.arity(), Goal.as_expr(), ApplyResult.as_expr(), FPNumRef.as_string(), Solver.assert_and_track(), Optimize.assert_and_track(), Goal.assert_exprs(), Solver.assert_exprs(), Fixedpoint.assert_exprs(), Optimize.assert_exprs(), Solver.assertions(), Optimize.assertions(), SeqRef.at(), SeqSortRef.basis(), ReSortRef.basis(), QuantifierRef.body(), BoolSortRef.cast(), Solver.check(), Optimize.check(), UserPropagateBase.conflict(), Solver.consequences(), DatatypeSortRef.constructor(), Goal.convert_model(), AstRef.ctx_ref(), UserPropagateBase.ctx_ref(), ExprRef.decl(), ModelRef.decls(), ArrayRef.default(), RatNumRef.denominator(), Goal.depth(), Goal.dimacs(), Solver.dimacs(), ArraySortRef.domain(), FuncDeclRef.domain(), FuncInterp.else_value(), FuncInterp.entry(), AstMap.erase(), ModelRef.eval(), FPNumRef.exponent(), FPNumRef.exponent_as_bv(), FPNumRef.exponent_as_long(), Solver.from_file(), Optimize.from_file(), Solver.from_string(), Optimize.from_string(), Goal.get(), Fixedpoint.get_answer(), Fixedpoint.get_assertions(), Fixedpoint.get_cover_delta(), ParamDescrsRef.get_documentation(), Fixedpoint.get_ground_sat_answer(), ModelRef.get_interp(), Statistics.get_key_value(), ParamDescrsRef.get_kind(), ParamDescrsRef.get_name(), Fixedpoint.get_num_levels(), Fixedpoint.get_rule_names_along_trace(), Fixedpoint.get_rules(), Fixedpoint.get_rules_along_trace(), ModelRef.get_sort(), ModelRef.get_universe(), Solver.help(), Fixedpoint.help(), Optimize.help(), Tactic.help(), Solver.import_model_converter(), Goal.inconsistent(), FPNumRef.isInf(), FPNumRef.isNaN(), FPNumRef.isNegative(), FPNumRef.isNormal(), FPNumRef.isPositive(), FPNumRef.isSubnormal(), FPNumRef.isZero(), AstMap.keys(), Statistics.keys(), SortRef.kind(), Optimize.maximize(), Optimize.minimize(), Solver.model(), Optimize.model(), SortRef.name(), FuncDeclRef.name(), QuantifierRef.no_pattern(), Solver.non_units(), FuncEntry.num_args(), FuncInterp.num_entries(), Solver.num_scopes(), ModelRef.num_sorts(), RatNumRef.numerator(), Optimize.objectives(), Solver.param_descrs(), Fixedpoint.param_descrs(), Optimize.param_descrs(), Tactic.param_descrs(), FuncDeclRef.params(), Fixedpoint.parse_file(), Fixedpoint.parse_string(), QuantifierRef.pattern(), AlgebraicNumRef.poly(), Optimize.pop(), Solver.pop(), Goal.prec(), Solver.proof(), Solver.push(), Optimize.push(), AstVector.push(), Fixedpoint.query(), Fixedpoint.query_from_lvl(), FuncDeclRef.range(), ArraySortRef.range(), Solver.reason_unknown(), Fixedpoint.reason_unknown(), Optimize.reason_unknown(), DatatypeSortRef.recognizer(), Context.ref(), Fixedpoint.register_relation(), AstMap.reset(), Solver.reset(), AstVector.resize(), Solver.set(), Fixedpoint.set(), Optimize.set(), ParamsRef.set(), Optimize.set_on_model(), Fixedpoint.set_predicate_representation(), Goal.sexpr(), AstVector.sexpr(), ModelRef.sexpr(), Solver.sexpr(), Fixedpoint.sexpr(), Optimize.sexpr(), ApplyResult.sexpr(), FPNumRef.sign(), FPNumRef.sign_as_bv(), FPNumRef.significand(), FPNumRef.significand_as_bv(), FPNumRef.significand_as_long(), ParamDescrsRef.size(), Goal.size(), Tactic.solver(), ExprRef.sort(), BoolRef.sort(), QuantifierRef.sort(), ArithRef.sort(), BitVecRef.sort(), ArrayRef.sort(), DatatypeRef.sort(), FiniteDomainRef.sort(), FPRef.sort(), SeqRef.sort(), Solver.statistics(), Fixedpoint.statistics(), Optimize.statistics(), Solver.to_smt2(), Fixedpoint.to_string(), Solver.trail(), Solver.trail_levels(), AstVector.translate(), FuncInterp.translate(), AstRef.translate(), Goal.translate(), ModelRef.translate(), Solver.translate(), Solver.units(), Solver.unsat_core(), Optimize.unsat_core(), Fixedpoint.update_rule(), ParamsRef.validate(), FuncEntry.value(), QuantifierRef.var_name(), and QuantifierRef.var_sort().

## ◆ name

name

Definition at line 5009 of file z3py.py.

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