Z3 |

Public Member Functions | Data Fields
UserPropagateBase Class Reference

## Public Member Functions
def | __init__ (self, s, ctx=None)
def | __del__ (self)
def | ctx (self)
def | ctx_ref (self)
def | add_fixed (self, fixed)
def | add_final (self, final)
def | add_eq (self, eq)
def | add_diseq (self, diseq)
def | push (self)
def | pop (self, num_scopes)
def | fresh (self)
def | add (self, e)
def | propagate (self, e, ids, eqs=[])
def | conflict (self, ids)

## Data Fields
| solver
| cb
| id
| fixed
| final
| eq
| diseq

## Detailed Description

Definition at line 11168 of file z3py.py.

## Constructor & Destructor Documentation

## ◆ __init__()

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

Definition at line 11177 of file z3py.py.

11177 def __init__(self, s, ctx=None):
11178 assert s is None or ctx is None
11179 ensure_prop_closures()
11180 self.solver = s
11181 self._ctx = None
11182 self.cb = None
11183 self.id = _prop_closures.insert(self)
11184 self.fixed = None
11185 self.final = None
11186 self.eq = None
11187 self.diseq = None
11188 if ctx:
11189 self._ctx = Context()
11190 Z3_del_context(self._ctx.ctx)
11191 self._ctx.ctx = ctx
11192 self._ctx.eh = Z3_set_error_handler(ctx, z3_error_handler)
11193 Z3_set_ast_print_mode(ctx, Z3_PRINT_SMTLIB2_COMPLIANT)
11194 if s:
11195 Z3_solver_propagate_init(self.ctx_ref(),
11196 s.solver,
11197 ctypes.c_void_p(self.id),
11198 _user_prop_push,
11199 _user_prop_pop,
11200 _user_prop_fresh)
11201
z3py.ensure_prop_closures
def ensure_prop_closures()
Definition: z3py.py:11110
Z3_del_context
void Z3_API Z3_del_context(Z3_context c)
Delete the given logical context.
Z3_set_ast_print_mode
void Z3_API Z3_set_ast_print_mode(Z3_context c, Z3_ast_print_mode mode)
Select mode for the format used for pretty-printing AST nodes.
Z3_set_error_handler
void Z3_API Z3_set_error_handler(Z3_context c, Z3_error_handler h)
Register a Z3 error handler.
Z3_solver_propagate_init
void Z3_API Z3_solver_propagate_init(Z3_context c, Z3_solver s, void *user_context, Z3_push_eh push_eh, Z3_pop_eh pop_eh, Z3_fresh_eh fresh_eh)
register a user-properator with the solver.

## ◆ __del__()

def __del__ | ( |  | self | ) |

Definition at line 11202 of file z3py.py.

11202 def __del__(self):
11203 if self._ctx:
11204 self._ctx.ctx = None
11205

## Member Function Documentation

## ◆ add()

def add | ( |  | self,
|  |  | e
| ) |  |

Definition at line 11248 of file z3py.py.

11248 def add(self, e):
11249 assert self.solver
11250 assert not self._ctx
11251 return Z3_solver_propagate_register(self.ctx_ref(), self.solver.solver, e.ast)
11252
Z3_solver_propagate_register
unsigned Z3_API Z3_solver_propagate_register(Z3_context c, Z3_solver s, Z3_ast e)
register an expression to propagate on with the solver. Only expressions of type Bool and type Bit-Ve...

Referenced by Solver.__iadd__(), Fixedpoint.__iadd__(), and Optimize.__iadd__().

## ◆ add_diseq()

def add_diseq | ( |  | self,
|  |  | diseq
| ) |  |

Definition at line 11233 of file z3py.py.

11233 def add_diseq(self, diseq):
11234 assert not self.diseq
11235 assert not self._ctx
11236 Z3_solver_propagate_diseq(self.ctx_ref(), self.solver.solver, _user_prop_diseq)
11237 self.diseq = diseq
11238
Z3_solver_propagate_diseq
void Z3_API Z3_solver_propagate_diseq(Z3_context c, Z3_solver s, Z3_eq_eh eq_eh)
register a callback on expression dis-equalities.

## ◆ add_eq()

def add_eq | ( |  | self,
|  |  | eq
| ) |  |

Definition at line 11227 of file z3py.py.

11227 def add_eq(self, eq):
11228 assert not self.eq
11229 assert not self._ctx
11230 Z3_solver_propagate_eq(self.ctx_ref(), self.solver.solver, _user_prop_eq)
11231 self.eq = eq
11232
Z3_solver_propagate_eq
void Z3_API Z3_solver_propagate_eq(Z3_context c, Z3_solver s, Z3_eq_eh eq_eh)
register a callback on expression equalities.

## ◆ add_final()

def add_final | ( |  | self,
|  |  | final
| ) |  |

Definition at line 11221 of file z3py.py.

11221 def add_final(self, final):
11222 assert not self.final
11223 assert not self._ctx
11224 Z3_solver_propagate_final(self.ctx_ref(), self.solver.solver, _user_prop_final)
11225 self.final = final
11226
Z3_solver_propagate_final
void Z3_API Z3_solver_propagate_final(Z3_context c, Z3_solver s, Z3_final_eh final_eh)
register a callback on final check. This provides freedom to the propagator to delay actions or imple...

## ◆ add_fixed()

def add_fixed | ( |  | self,
|  |  | fixed
| ) |  |

Definition at line 11215 of file z3py.py.

11215 def add_fixed(self, fixed):
11216 assert not self.fixed
11217 assert not self._ctx
11218 Z3_solver_propagate_fixed(self.ctx_ref(), self.solver.solver, _user_prop_fixed)
11219 self.fixed = fixed
11220
Z3_solver_propagate_fixed
void Z3_API Z3_solver_propagate_fixed(Z3_context c, Z3_solver s, Z3_fixed_eh fixed_eh)
register a callback for when an expression is bound to a fixed value. The supported expression types ...

## ◆ conflict()

def conflict | ( |  | self,
|  |  | ids
| ) |  |

Definition at line 11270 of file z3py.py.

11270 def conflict(self, ids):
11271 self.propagate(BoolVal(False, self.ctx()), ids, eqs=[])
z3py.BoolVal
def BoolVal(val, ctx=None)
Definition: z3py.py:1673

## ◆ ctx()

def ctx | ( |  | self | ) |

Definition at line 11206 of file z3py.py.

11206 def ctx(self):
11207 if self._ctx:
11208 return self._ctx
11209 else:
11210 return self.solver.ctx
11211

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().

## ◆ ctx_ref()

def ctx_ref | ( |  | self | ) |

Definition at line 11212 of file z3py.py.

11212 def ctx_ref(self):
11213 return self.ctx().ref()
11214

Referenced by BitVecRef.__add__(), BitVecRef.__and__(), FuncDeclRef.__call__(), ArithRef.__div__(), BitVecRef.__div__(), SortRef.__eq__(), ExprRef.__eq__(), ArithRef.__ge__(), BitVecRef.__ge__(), SeqRef.__ge__(), QuantifierRef.__getitem__(), ArrayRef.__getitem__(), SeqRef.__getitem__(), ArithRef.__gt__(), BitVecRef.__gt__(), SeqRef.__gt__(), BitVecRef.__invert__(), ArithRef.__le__(), BitVecRef.__le__(), SeqRef.__le__(), BitVecRef.__lshift__(), ArithRef.__lt__(), BitVecRef.__lt__(), SeqRef.__lt__(), ArithRef.__mod__(), BitVecRef.__mod__(), BitVecRef.__mul__(), SortRef.__ne__(), ExprRef.__ne__(), ArithRef.__neg__(), BitVecRef.__neg__(), BitVecRef.__or__(), ArithRef.__pow__(), BitVecRef.__radd__(), BitVecRef.__rand__(), ArithRef.__rdiv__(), BitVecRef.__rdiv__(), BitVecRef.__rlshift__(), ArithRef.__rmod__(), BitVecRef.__rmod__(), BitVecRef.__rmul__(), BitVecRef.__ror__(), ArithRef.__rpow__(), BitVecRef.__rrshift__(), BitVecRef.__rshift__(), BitVecRef.__rsub__(), BitVecRef.__rxor__(), BitVecRef.__sub__(), BitVecRef.__xor__(), DatatypeSortRef.accessor(), UserPropagateBase.add(), UserPropagateBase.add_diseq(), UserPropagateBase.add_eq(), UserPropagateBase.add_final(), UserPropagateBase.add_fixed(), AlgebraicNumRef.approx(), ExprRef.arg(), FuncDeclRef.arity(), SortRef.as_ast(), FuncDeclRef.as_ast(), PatternRef.as_ast(), IntNumRef.as_binary_string(), BitVecNumRef.as_binary_string(), RatNumRef.as_decimal(), AlgebraicNumRef.as_decimal(), IntNumRef.as_string(), RatNumRef.as_string(), BitVecNumRef.as_string(), FiniteDomainRef.as_string(), FiniteDomainNumRef.as_string(), FPRef.as_string(), FPRMRef.as_string(), SeqRef.as_string(), SeqRef.at(), SeqSortRef.basis(), ReSortRef.basis(), QuantifierRef.body(), DatatypeSortRef.constructor(), ExprRef.decl(), ArrayRef.default(), RatNumRef.denominator(), ArraySortRef.domain(), FuncDeclRef.domain(), FPSortRef.ebits(), AstRef.eq(), AstRef.get_id(), SortRef.get_id(), FuncDeclRef.get_id(), ExprRef.get_id(), PatternRef.get_id(), QuantifierRef.get_id(), AstRef.hash(), AlgebraicNumRef.index(), QuantifierRef.is_exists(), QuantifierRef.is_forall(), QuantifierRef.is_lambda(), SeqSortRef.is_string(), SeqRef.is_string(), SeqRef.is_string_value(), FuncDeclRef.kind(), SortRef.name(), FuncDeclRef.name(), QuantifierRef.no_pattern(), ExprRef.num_args(), DatatypeSortRef.num_constructors(), QuantifierRef.num_no_patterns(), QuantifierRef.num_patterns(), QuantifierRef.num_vars(), RatNumRef.numerator(), FuncDeclRef.params(), QuantifierRef.pattern(), AlgebraicNumRef.poly(), FuncDeclRef.range(), ArraySortRef.range(), DatatypeSortRef.recognizer(), FPSortRef.sbits(), AstRef.sexpr(), BitVecSortRef.size(), FiniteDomainSortRef.size(), BoolRef.sort(), ArithRef.sort(), BitVecRef.sort(), ArrayRef.sort(), DatatypeRef.sort(), FiniteDomainRef.sort(), FPRef.sort(), SeqRef.sort(), QuantifierRef.var_name(), QuantifierRef.var_sort(), and QuantifierRef.weight().

## ◆ fresh()

def fresh | ( |  | self | ) |

Definition at line 11245 of file z3py.py.

11245 def fresh(self):
11246 raise Z3Exception("fresh needs to be overwritten")
11247

## ◆ pop()

def pop | ( |  | self,
|  |  | num_scopes
| ) |  |

Definition at line 11242 of file z3py.py.

11242 def pop(self, num_scopes):
11243 raise Z3Exception("pop needs to be overwritten")
11244

## ◆ propagate()

def propagate | ( |  | self,
|  |  | e,
|  |  | ids,
|  |  | eqs = `[]`
| ) |  |

Definition at line 11256 of file z3py.py.

11256 def propagate(self, e, ids, eqs=[]):
11257 num_fixed = len(ids)
11258 _ids = (ctypes.c_uint * num_fixed)()
11259 for i in range(num_fixed):
11260 _ids[i] = ids[i]
11261 num_eqs = len(eqs)
11262 _lhs = (ctypes.c_uint * num_eqs)()
11263 _rhs = (ctypes.c_uint * num_eqs)()
11264 for i in range(num_eqs):
11265 _lhs[i] = eqs[i][0]
11266 _rhs[i] = eqs[i][1]
11267 Z3_solver_propagate_consequence(e.ctx.ref(), ctypes.c_void_p(
11268 self.cb), num_fixed, _ids, num_eqs, _lhs, _rhs, e.ast)
11269
z3::range
expr range(expr const &lo, expr const &hi)
Definition: z3++.h:3725
Z3_solver_propagate_consequence
void Z3_API Z3_solver_propagate_consequence(Z3_context c, Z3_solver_callback, unsigned num_fixed, unsigned const *fixed_ids, unsigned num_eqs, unsigned const *eq_lhs, unsigned const *eq_rhs, Z3_ast conseq)
propagate a consequence based on fixed values. This is a callback a client may invoke during the fixe...

Referenced by UserPropagateBase.conflict().

## ◆ push()

def push | ( |  | self | ) |

Definition at line 11239 of file z3py.py.

11239 def push(self):
11240 raise Z3Exception("push needs to be overwritten")
11241

## Field Documentation

## ◆ cb

cb

Definition at line 11182 of file z3py.py.

Referenced by UserPropagateBase.propagate().

## ◆ diseq

diseq

Definition at line 11187 of file z3py.py.

Referenced by UserPropagateBase.add_diseq().

## ◆ eq

eq

Definition at line 11186 of file z3py.py.

Referenced by AstRef.__eq__(), UserPropagateBase.add_eq(), SortRef.cast(), and BoolSortRef.cast().

## ◆ final

final

Definition at line 11185 of file z3py.py.

Referenced by UserPropagateBase.add_final().

## ◆ fixed

fixed

Definition at line 11184 of file z3py.py.

Referenced by UserPropagateBase.add_fixed().

## ◆ id

id

Definition at line 11183 of file z3py.py.

## ◆ solver

solver

Definition at line 11180 of file z3py.py.

Referenced by Solver.__del__(), UserPropagateBase.add(), UserPropagateBase.add_diseq(), UserPropagateBase.add_eq(), UserPropagateBase.add_final(), UserPropagateBase.add_fixed(), Solver.assert_and_track(), Solver.assert_exprs(), Solver.assertions(), Solver.check(), Solver.consequences(), UserPropagateBase.ctx(), Solver.dimacs(), Solver.from_file(), Solver.from_string(), Solver.help(), Solver.import_model_converter(), Solver.model(), Solver.non_units(), Solver.num_scopes(), Solver.param_descrs(), Solver.pop(), Solver.proof(), Solver.push(), Solver.reason_unknown(), Solver.reset(), Solver.set(), Solver.sexpr(), Solver.statistics(), Solver.trail(), Solver.trail_levels(), Solver.translate(), Solver.units(), and Solver.unsat_core().