python-sat 1.8.dev24__tar.gz → 1.8.dev25__tar.gz

{python_sat-1.8.dev24/python_sat.egg-info → python_sat-1.8.dev25}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-sat
-Version: 1.8.dev24
+Version: 1.8.dev25
 Summary: A Python library for prototyping with SAT oracles
 Home-page: https://github.com/pysathq/pysat
 Author: Alexey Ignatiev, Joao Marques-Silva, Antonio Morgado

{python_sat-1.8.dev24 → python_sat-1.8.dev25}/pysat/__init__.py

@@ -10,7 +10,7 @@
 
 # current version
 #==============================================================================
-VERSION = (1, 8, 'dev', 24)
+VERSION = (1, 8, 'dev', 25)
 
 
 # PEP440 Format

{python_sat-1.8.dev24 → python_sat-1.8.dev25}/pysat/formula.py

@@ -297,19 +297,28 @@ class IDPool(object):
         necessary the top variable ID can be accessed directly using the
         ``top`` variable.
 
+        The final parameter ``with_neg``, if set to ``True``, indicates that
+        the *negation* of an object assigned a variable ID ``n`` is to be
+        represented using the negative integer ``-n``. For this to work, the
+        object must have the method ``__neg__()`` implemented. This behaviour
+        is disabled by default.
+
         :param start_from: the smallest ID to assign.
         :param occupied: a list of occupied intervals.
+        :param with_neg: whether to support automatic negation handling
 
         :type start_from: int
         :type occupied: list(list(int))
+        :type with_neg: bool
     """
 
-    def __init__(self, start_from=1, occupied=[]):
+    def __init__(self, start_from=1, occupied=[], with_neg=False):
         """
             Constructor.
         """
 
-        self.restart(start_from=start_from, occupied=occupied)
+        self.restart(start_from=start_from, occupied=occupied,
+                     with_neg=with_neg)
 
     def __repr__(self):
         """
@@ -318,7 +327,7 @@ class IDPool(object):
 
         return f'IDPool(start_from={self.top+1}, occupied={self._occupied})'
 
-    def restart(self, start_from=1, occupied=[]):
+    def restart(self, start_from=1, occupied=[], with_neg=False):
         """
             Restart the manager from scratch. The arguments replicate those of
             the constructor of :class:`IDPool`.
@@ -337,6 +346,10 @@ class IDPool(object):
         # (if for whatever reason necessary)
         self.id2obj = {}
 
+        # flag to indicate whether this IDPool object
+        # should support automatic negation handling
+        self.with_neg = with_neg
+
     def id(self, obj=None):
         """
             The method is to be used to assign an integer variable ID for a
@@ -385,6 +398,11 @@ class IDPool(object):
 
             if vid not in self.id2obj:
                 self.id2obj[vid] = obj
+
+                # adding the object's negation, if required and supported
+                if self.with_neg and hasattr(obj, '__neg__'):
+                    self.obj2id[-obj] = -vid
+                    self.id2obj[-vid] = -obj
         else:
             # no object is provided => simply return a new ID
             vid = self._next()
@@ -1022,6 +1040,13 @@ class Formula(object):
             return Neg(self)
         return self.subformula
 
+    def __neg__(self):
+        """
+            Negation operator. Takes the same effect as ``__invert__()``.
+        """
+
+        return self.__invert__()
+
     def __and__(self, other):
         """
             Logical conjunction operator overloaded for class

{python_sat-1.8.dev24 → python_sat-1.8.dev25}/pysat/pb.py

@@ -137,6 +137,8 @@ class EncType(object):
         cases, this invokes the ``bdd`` encoder).
     """
 
+    assert pblib_present, 'Package \'pypblib\' is unavailable. Check your installation.'
+
     best       = 0
     bdd        = 1
     seqcounter = 2
@@ -242,7 +244,7 @@ class PBEnc(object):
 
     @classmethod
     def _encode(cls, lits, weights=None, bound=1, top_id=None, vpool=None,
-            encoding=EncType.best, comparator='<'):
+            encoding=EncType.best, comparator='<', conditionals=None):
         """
             This is the method that wraps the encoder of PyPBLib. Although the
             method can be invoked directly, a user is expected to call one of
@@ -310,7 +312,9 @@ class PBEnc(object):
             top_id = vpool.top
 
         # choosing the maximum id among the current top and the list of literals
-        top_id = max(map(lambda x: abs(x), lits + [top_id if top_id != None else 0]))
+        if conditionals is None:
+            conditionals = []
+        top_id = max(map(lambda x: abs(x), conditionals + lits + [top_id if top_id != None else 0]))
 
         # native representation
         if encoding == 6:
@@ -331,8 +335,13 @@ class PBEnc(object):
         # pseudo-Boolean constraint and variable manager
         constr = pblib.PBConstraint([pblib.WeightedLit(*wl) for wl in wlits],
                 EncType._to_pbcmp[comparator], bound)
+
         varmgr = pblib.AuxVarManager(top_id + 1)
 
+        # add optional conditionals
+        if len(conditionals) > 0:
+            constr.add_conditionals(conditionals)
+
         # encoder configuration
         config = pblib.PBConfig()
         config.set_PB_Encoder(EncType._to_pbenc[encoding])
@@ -358,7 +367,7 @@ class PBEnc(object):
 
     @classmethod
     def leq(cls, lits, weights=None, bound=1, top_id=None, vpool=None,
-            encoding=EncType.best):
+            encoding=EncType.best, conditionals=None):
         """
             This method can be used for creating a CNF encoding of a LEQ
             (weighted AtMostK) constraint, i.e. of
@@ -374,12 +383,18 @@ class PBEnc(object):
             ``EncType.best``, i.e. it is up to the PBLib encoder to choose the
             encoding type.
 
+            The final optional argument is ``conditionals``, where a list of
+            literals can be passed to be used as the antecedent for the PB
+            constraint, which makes it *"reified"*. If the argument is set to
+            ``None``, the constraint won't be reified.
+
             :param lits: a list of literals in the sum.
             :param weights: a list of weights
             :param bound: the value of bound :math:`k`.
             :param top_id: top variable identifier used so far.
             :param vpool: variable pool for counting the number of variables.
             :param encoding: identifier of the encoding to use.
+            :param conditionals: a list of variables that imply this constraint.
 
             :type lits: iterable(int)
             :type weights: iterable(int)
@@ -387,26 +402,29 @@ class PBEnc(object):
             :type top_id: integer or None
             :type vpool: :class:`.IDPool`
             :type encoding: integer
+            :type conditionals: list(int) or None
 
             :rtype: :class:`pysat.formula.CNFPlus`
         """
 
         return cls._encode(lits, weights=weights, bound=bound, top_id=top_id,
-                vpool=vpool, encoding=encoding, comparator='<')
+                           vpool=vpool, encoding=encoding, comparator='<',
+                           conditionals=conditionals)
 
     @classmethod
     def atmost(cls, lits, weights=None, bound=1, top_id=None, vpool=None,
-            encoding=EncType.best):
+            encoding=EncType.best, conditionals=None):
         """
             A synonim for :meth:`PBEnc.leq`.
         """
 
         return cls.leq(lits, weights=weights, bound=bound, top_id=top_id,
-                vpool=vpool, encoding=encoding)
+                       vpool=vpool, encoding=encoding,
+                       conditionals=conditionals)
 
     @classmethod
     def geq(cls, lits, weights=None, bound=1, top_id=None, vpool=None,
-            encoding=EncType.best):
+            encoding=EncType.best, conditionals=None):
         """
             This method can be used for creating a CNF encoding of a GEQ
             (weighted AtLeastK) constraint, i.e. of
@@ -416,21 +434,23 @@ class PBEnc(object):
         """
 
         return cls._encode(lits, weights=weights, bound=bound, top_id=top_id,
-                vpool=vpool, encoding=encoding, comparator='>')
+                           vpool=vpool, encoding=encoding, comparator='>',
+                           conditionals=conditionals)
 
     @classmethod
     def atleast(cls, lits, weights=None, bound=1, top_id=None, vpool=None,
-            encoding=EncType.best):
+            encoding=EncType.best, conditionals=None):
         """
             A synonym for :meth:`PBEnc.geq`.
         """
 
         return cls.geq(lits, weights=weights, bound=bound, top_id=top_id,
-                vpool=vpool, encoding=encoding)
+                       vpool=vpool, encoding=encoding,
+                       conditionals=conditionals)
 
     @classmethod
     def equals(cls, lits, weights=None, bound=1, top_id=None, vpool=None,
-            encoding=EncType.best):
+            encoding=EncType.best, conditionals=None):
         """
             This method can be used for creating a CNF encoding of a weighted
             EqualsK constraint, i.e. of :math:`\\sum_{i=1}^{n}{a_i\\cdot x_i}=
@@ -439,4 +459,5 @@ class PBEnc(object):
         """
 
         return cls._encode(lits, weights=weights, bound=bound, top_id=top_id,
-                vpool=vpool, encoding=encoding, comparator='=')
+                           vpool=vpool, encoding=encoding, comparator='=',
+                           conditionals=conditionals)

{python_sat-1.8.dev24 → python_sat-1.8.dev25/python_sat.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-sat
-Version: 1.8.dev24
+Version: 1.8.dev25
 Summary: A Python library for prototyping with SAT oracles
 Home-page: https://github.com/pysathq/pysat
 Author: Alexey Ignatiev, Joao Marques-Silva, Antonio Morgado

{python_sat-1.8.dev24 → python_sat-1.8.dev25}/python_sat.egg-info/SOURCES.txt

@@ -88,8 +88,10 @@ tests/test_atmostk.py
 tests/test_boolengine.py
 tests/test_clausification.py
 tests/test_cnf.py
+tests/test_encode_pb_conditional.py
 tests/test_equals1.py
 tests/test_formula_unique.py
+tests/test_idpool.py
 tests/test_process.py
 tests/test_propagate.py
 tests/test_unique_model.py

python_sat-1.8.dev25/tests/test_encode_pb_conditional.py

@@ -0,0 +1,54 @@
+from pysat.formula import IDPool
+from pysat.card import CardEnc
+import pytest
+
+@pytest.mark.skip(reason="PBLIB not installed in CI")
+def test_pbenc_conditional():
+    from pysat.pb import PBEnc, EncType
+    L = 3
+    LITS = list(range(1, L + 1))  # Variables x1, x2, x3, x4
+    WEIGHTS = [2, 1, 1]        # Coefficients: 2*x1 + 3*x2 + 5*x3 + 8*x4
+    bound = 10                 # Constraint: ... <= 10
+
+    CONDS = [L+1]
+
+    # We need a vpool even if we don't use it, to handle PySAT internal structure
+    vpool = IDPool()
+
+    # Generate the CNF clauses
+    cnf = PBEnc.atleast(
+        lits=LITS,
+        weights=WEIGHTS,
+        bound=bound,
+        vpool=vpool,
+        conditionals=CONDS
+    )
+
+    assert cnf.clauses == [[-4]] # without PR to pblib this will be [[3, -4], [1, -4], [2, -4], [-4]]
+
+    bound = 2
+
+    # Generate the CNF clauses
+    cnf = PBEnc.atleast(
+        lits=LITS,
+        weights=WEIGHTS,
+        bound=bound,
+        vpool=vpool,
+        conditionals=CONDS
+    )
+
+    assert cnf.clauses == [[5], [-5, 6], [3, 6], [-5, 3, 7], [2, 6], [-5, 2, 7], [3, 2, 7], [-5, 3, 2, 8], [1, 9], [-7, 9], [1, -7, 10], [-10, -4]]
+
+    bound = 0
+
+    # Generate the CNF clauses
+    cnf = PBEnc.atleast(
+        lits=LITS,
+        weights=WEIGHTS,
+        bound=bound,
+        vpool=vpool,
+        conditionals=CONDS
+    )
+
+    assert cnf.clauses == []
+

python_sat-1.8.dev25/tests/test_idpool.py

@@ -0,0 +1,27 @@
+from pysat.formula import IDPool
+
+def test_idpool_neg():
+    pool = IDPool(with_neg=True)
+
+    pool.id('hello')
+    pool.id(+25)
+    pool.id(-42)
+    pool.id('world')
+
+    assert pool.id('hello') == 1
+    assert pool.id(25) == -pool.id(-25) == +2
+    assert pool.id(42) == -pool.id(-42) == -3
+    assert pool.id('world') == 4
+
+def test_idpool_occupied():
+    pool = IDPool(start_from=5, occupied=[[2, 10], [12, 20], [22, 30]], with_neg=True)
+
+    pool.id('hello')
+    pool.id(+25)
+    pool.id(-42)
+    pool.id('world')
+
+    assert pool.id('hello') == 11
+    assert pool.id(25) == -pool.id(-25) == +21
+    assert pool.id(42) == -pool.id(-42) == -31
+    assert pool.id('world') == 32