PySMT 0.9.7.dev479__tar.gz → 0.9.7.dev485__tar.gz

{pysmt-0.9.7.dev479/PySMT.egg-info → pysmt-0.9.7.dev485}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PySMT
-Version: 0.9.7.dev479
+Version: 0.9.7.dev485
 Summary: A solver-agnostic library for SMT Formulae manipulation and solving
 Home-page: http://www.pysmt.org
 Author: PySMT Team

{pysmt-0.9.7.dev479 → pysmt-0.9.7.dev485/PySMT.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PySMT
-Version: 0.9.7.dev479
+Version: 0.9.7.dev485
 Summary: A solver-agnostic library for SMT Formulae manipulation and solving
 Home-page: http://www.pysmt.org
 Author: PySMT Team

{pysmt-0.9.7.dev479 → pysmt-0.9.7.dev485}/PySMT.egg-info/SOURCES.txt

@@ -98,6 +98,7 @@ pysmt/test/test_cnf.py
 pysmt/test/test_configuration.py
 pysmt/test/test_constants.py
 pysmt/test/test_cvc_quantifiers.py
+pysmt/test/test_doc_snippets.py
 pysmt/test/test_dwf.py
 pysmt/test/test_eager_model.py
 pysmt/test/test_env.py

{pysmt-0.9.7.dev479 → pysmt-0.9.7.dev485}/docs/getting_started.rst

@@ -222,6 +222,88 @@ Here is the complete example for reference using the logic QF_LIA:
 .. literalinclude:: code_snippets/hello_world_qf_lia.py
 
 
+.. _gs-unsat-core:
+
+Unsat Cores
+-----------
+
+When a set of formulae is unsatisfiable, not all of them are usually
+responsible for the unsatisfiability. An *unsat core* of the asserted
+formulae is a subset of them whose conjunction is still
+unsatisfiable. UNSAT cores are a handy debugging tool because they
+narrow down which assertions of your problem are in conflict. The
+core returned by the solver is not guaranteed to be minimal: removing
+a formula from it may leave it unsatisfiable.
+
+pySMT exposes two ways to obtain an unsat core, both provided by the
+:py:class:`~pysmt.solvers.solver.UnsatCoreSolver` class:
+
+* ``get_unsat_core()`` returns the core as a set of formulae (this is
+  also what the :py:func:`~pysmt.shortcuts.get_unsat_core` shortcut
+  uses);
+* ``get_named_unsat_core()`` returns the core as a dictionary mapping
+  assertion names to formulae.
+
+Named cores are useful when the assertions come from different
+sources (e.g. different rules of a constraint, different parts of the
+input), because the names allow you to map the core back to the
+structure of your original problem.
+
+Core extraction must be enabled when the solver is created, through
+the ``unsat_cores_mode`` option of
+:py:func:`~pysmt.shortcuts.UnsatCoreSolver`:
+
+* ``"all"`` (the default of the shortcut): every assertion is a
+  candidate for the core. Use it when you only need the formulae.
+* ``"named"``: only the assertions added with
+  ``add_assertion(f, named="...")`` are candidates, and
+  ``get_named_unsat_core()`` reports them under the given names. Use it
+  when you need to map the core back to your problem, or when only
+  some of the assertions should be tracked.
+
+.. note::
+
+  Not every solver supports unsat-core extraction. You can list the
+  installed solvers that do by looking at the result of
+  ``Factory.all_unsat_core_solvers()`` (see
+  :py:meth:`pysmt.factory.Factory.all_unsat_core_solvers`); as of this
+  writing the supported solvers are z3, MathSAT/OptiMathSAT and
+  Boolector, while cvc5 and Yices do not.
+  ``UnsatCoreSolver(...)`` raises
+  :py:class:`~pysmt.exceptions.NoSolverAvailableError` if no installed
+  solver supports unsat cores for the requested logic.
+
+Minimal example
+"""""""""""""""
+
+.. literalinclude:: code_snippets/unsat_core.py
+
+Named cores
+"""""""""""
+
+.. literalinclude:: code_snippets/unsat_core_named.py
+
+.. note::
+
+  Named cores are meaningful only when the solver is created with
+  ``unsat_cores_mode="named"``. In the other modes, some solvers
+  (e.g. z3) keep the names that were given to the assertions while
+  others (e.g. MathSAT, Boolector) replace them with generated,
+  meaningless names; only ``unsat_cores_mode="named"`` is therefore
+  portable if you rely on the names.
+
+Cores under assumptions
+"""""""""""""""""""""""
+
+Assumptions are extra constraints that apply only to a particular call
+of ``solve()``, not to the solver's theory. The following snippet
+shows that ``get_unsat_core()`` reports the assumptions that belong to
+the core (in both unsat cores modes), while ``get_named_unsat_core()``
+never does, since assumptions carry no name.
+
+.. literalinclude:: code_snippets/unsat_core_assumptions.py
+
+
 What's Next?
 ------------
 
@@ -232,3 +314,7 @@ there with a simple to use interface.
 
 To understand more about other functionalities of pySMT, you can take
 a look at the `examples/ folder <https://github.com/pysmt/pysmt/blob/master/examples/README.rst>`_ .
+
+If a problem you are trying to solve is unsatisfiable, you can
+use unsat-core extraction to debug it: see the :ref:`gs-unsat-core`
+section above for an introduction.

{pysmt-0.9.7.dev479 → pysmt-0.9.7.dev485}/docs/tutorials.rst

@@ -62,6 +62,17 @@ Demonstrates how to perform SMT-LIB parsing, dumping and extension
 ------------------------------------------------------------------
 .. literalinclude:: ../examples/smtlib.py
 
+Unsat Cores
+-----------
+
+pySMT can extract an *unsat core* of an unsatisfiable set of
+formulae: a subset of the asserted formulae whose conjunction is
+still unsatisfiable. This is a handy debugging tool to find out
+which assertions of your problem are in conflict. See the
+:ref:`gs-unsat-core` section of the getting started guide for a
+full walkthrough, and note that the example below (``examples/einstein.py``)
+already uses UNSAT cores.
+
 Shows the use of UNSAT Core as debugging tools
 ----------------------------------------------
 .. literalinclude:: ../examples/einstein.py

{pysmt-0.9.7.dev479 → pysmt-0.9.7.dev485}/pysmt/__init__.py

@@ -19,7 +19,7 @@
 from typing import Tuple, Union
 
 
-VERSION: Union[Tuple[int, int, int], Tuple[int, int, int, str, int]] = (0, 9, 7, "dev", 479)
+VERSION: Union[Tuple[int, int, int], Tuple[int, int, int, str, int]] = (0, 9, 7, "dev", 485)
 
 # Try to provide human-readable version of latest commit for dev versions
 # E.g. v0.5.1-4-g49a49f2-wip

{pysmt-0.9.7.dev479 → pysmt-0.9.7.dev485}/pysmt/cmd/install.py

@@ -36,7 +36,7 @@ INSTALLERS = [
     Installer(CVC5Installer,    "1.3.3", {}),
     Installer(CVC4Installer,    "1.7-prerelease",
               {"git_version" : "391ab9df6c3fd9a3771864900c1718534c1e4666"}),
-    Installer(Z3Installer,      "4.15.0", {}),
+    Installer(Z3Installer,      "5.1.0", {}),
     Installer(YicesInstaller,   "2.6.4", {"yices_api_version": "1.1.5"}),
     Installer(BtorInstaller,    "3.2.3", {}),
     Installer(PicoSATInstaller, "965",

{pysmt-0.9.7.dev479 → pysmt-0.9.7.dev485}/pysmt/optimization/z3.py

@@ -18,8 +18,6 @@
 
 from __future__ import absolute_import
 
-from warnings import warn
-
 from pysmt.decorators import clear_pending_pop
 from pysmt.solvers.solver import Model
 from pysmt.solvers.z3 import Z3Solver, Z3Model
@@ -127,33 +125,31 @@ class Z3NativeOptimizer(Optimizer, Z3Solver):
 
     @clear_pending_pop
     def boxed_optimize(self, goals: Sequence[Goal]) -> Optional[Dict[Goal, Tuple[Model, FNode]]]:
-        # This implementation is a naive simulation of a box optimization,
-        # but is needed to cope with an upstream Z3 issue:
-        # https://github.com/Z3Prover/z3/issues/7240
-        #
-        # A properer implementation would be as follows.
-        # '''python
-        # self.z3.set(priority='box')
-        # models = {}
-        # for goal_id, goal in enumerate(goals):
-        #     self._assert_z3_goal(goal, goal_id)
-        # for goal in goals:
-        #     if self.z3.check() == z3.sat:
-        #         model = Z3Model(self.environment, self.z3.model())
-        #         models[goal] = (model, model.get_value(goal.term()))
-        #     else:
-        #         return None
-        # return models
-        # '''
-        warn("Boxed optimization is not working in Z3 (see https://github.com/Z3Prover/z3/issues/7240). "
-             "PySMT will simulate the correct behavior, but the performance will be sub-optimal")
-        models = {}
-        for g in goals:
-            r = self.optimize(g)
-            if r is None:
-                return None
-            models[g] = r
-        return models
+        self.push()
+        try:
+            self.z3.set(priority='box')
+            handles = [self._assert_z3_goal(goal, goal_id)
+                       for goal_id, goal in enumerate(goals)]
+            # In box mode, each call to check() yields the optimal model
+            # of the next objective, in the order they were asserted
+            models: Dict[Goal, Tuple[Model, FNode]] = {}
+            for goal, h in zip(goals, handles):
+                if self.z3.check() != z3.sat:
+                    return None
+                try:
+                    model = Z3Model(self.environment, self.z3.model())
+                    if goal.is_maxsmt_goal():
+                        models[goal] = (model, self._compute_max_smt_cost(model, goal))
+                    else:
+                        self.converter.back(self.z3.lower(h))
+                        models[goal] = (model, model.get_value(goal.term()))
+                except PysmtInfinityError:
+                    raise PysmtUnboundedOptimizationError("The optimal value is unbounded")
+                except PysmtInfinitesimalError:
+                    raise PysmtInfinitesimalError("The optimal value is infinitesimal")
+            return models
+        finally:
+            self.pop()
 
     @clear_pending_pop
     def lexicographic_optimize(self, goals: Sequence[Goal]) -> Optional[Tuple[Model, List[FNode]]]:

pysmt-0.9.7.dev485/pysmt/test/test_doc_snippets.py

@@ -0,0 +1,75 @@
+#
+# This file is part of pySMT.
+#
+#   Copyright 2014 Andrea Micheli and Marco Gario
+#
+#   Licensed under the Apache License, Version 2.0 (the "License");
+#   you may not use this file except in compliance with the License.
+#   You may obtain a copy of the License at
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS,
+#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#   See the License for the specific language governing permissions and
+#   limitations under the License.
+#
+import os
+import runpy
+import unittest
+
+from pysmt.test import (TestCase, skipIfSolverNotAvailable,
+                        skipIfNoSolverForLogic,
+                        skipIfNoUnsatCoreSolverForLogic, main)
+from pysmt.logics import QF_LIA
+
+
+SNIPPETS_DIR = os.path.join(os.path.dirname(__file__),
+                            "..", "..", "docs", "code_snippets")
+
+
+# The docs are not shipped with the package, so skip when run from an install.
+@unittest.skipIf(not os.path.isdir(SNIPPETS_DIR), "docs/ not available")
+class TestDocSnippets(TestCase):
+
+    def setUp(self):
+        super().setUp()
+        # Match the default environment a reader gets from pysmt.shortcuts.
+        self.env.enable_infix_notation = True
+
+    def run_snippets(self, *names):
+        for name in names:
+            with self.subTest(snippet=name):
+                runpy.run_path(os.path.join(SNIPPETS_DIR, name + ".py"),
+                               run_name="__main__")
+
+    def test_no_solver(self):
+        self.run_snippets("hello_world_opening", "hello_world_infix")
+
+    @skipIfNoSolverForLogic(QF_LIA)
+    def test_qf_lia(self):
+        self.run_snippets("hello_world_is_sat", "hello_world_get_model",
+                          "hello_world_qf_lia")
+
+    @skipIfSolverNotAvailable("z3")
+    def test_z3(self):
+        self.run_snippets("hello_world")
+
+    @skipIfNoUnsatCoreSolverForLogic(QF_LIA)
+    def test_unsat_cores(self):
+        self.run_snippets("unsat_core", "unsat_core_named",
+                          "unsat_core_assumptions")
+
+    def test_all_snippets_are_tested(self):
+        tested = {"hello_world_opening", "hello_world_infix",
+                  "hello_world_is_sat", "hello_world_get_model",
+                  "hello_world_qf_lia", "hello_world", "unsat_core",
+                  "unsat_core_named", "unsat_core_assumptions"}
+        found = {f[:-3] for f in os.listdir(SNIPPETS_DIR) if f.endswith(".py")}
+        self.assertEqual(found, tested,
+                         "Add new docs/code_snippets files to this test")
+
+
+if __name__ == '__main__':
+    main()