eqc-models 0.10.0__py3-none-any.whl → 0.10.3__py3-none-any.whl

{eqc_models-0.10.0.data → eqc_models-0.10.3.data}/platlib/eqc_models/__init__.py

@@ -8,8 +8,9 @@ from .base import QuadraticModel, PolynomialModel
 from .solvers import (Dirac1CloudSolver, Dirac3CloudSolver, Dirac3DirectSolver)
 from .allocation import AllocationModel, AllocationModelX, ResourceRuleEnum
 from .assignment import QAPModel
+from .combinatorics import SetCoverModel, SetPartitionModel
 
 __all__ = ["QuadraticModel", "PolynomialModel", "Dirac1CloudSolver", 
            "Dirac3CloudSolver", "AllocationModel", "AllocationModelX",
            "Dirac3DirectSolver", "ResourceRuleEnum",
-           "QAPModel"]
+           "QAPModel", "SetPartitionModel", "SetCoverModel"]

{eqc_models-0.10.0.data → eqc_models-0.10.3.data}/platlib/eqc_models/algorithms/penaltymultiplier.py

@@ -33,6 +33,14 @@ class PenaltyMultiplierAlgorithm(Algorithm):
     penalties : List
         The values for penalties found at each algorithm iteration. A penalty of 0
         indicates algorithm termination.
+    penalty_threshold : float
+        This value is the cutoff for penalty values that are threated as 0. Default
+        is 1e-6. 
+    progress_threshold : float
+        This value is the cutoff for checking for progress on reducing the penalty
+        value. The current penalty is compared to the average of the previous two
+        and if the absolute difference is less than this value, then the algorithm
+        stops, reporting progress has not been made. The default value is 1e-4.
     dynamic_range : List
         The values for the dynamic range of the unconstrained problem formulation,
         which is useful for identifying difficulty in representation of the problem
@@ -50,7 +58,7 @@ class PenaltyMultiplierAlgorithm(Algorithm):
     This example uses the quadratic assignment problem and the known multiplier to test 
     the implementation of the algorithm.
 
-    >>> from eqc_models.solvers.qciclient import Dirac3CloudSolver
+    >>> from eqc_models.solvers.qciclient import Dirac3IntegerCloudSolver
     >>> from eqc_models.assignment.qap import QAPModel
     >>> A = np.array([[0, 5, 8, 0, 1],
     ...               [0, 0, 0, 10, 15],
@@ -68,10 +76,10 @@ class PenaltyMultiplierAlgorithm(Algorithm):
     ...               [7, 5, 8, 5, 7],
     ...               [1, 9, 2, 9, 2.]])
     >>> model = QAPModel(A, B, C)
-    >>> solver = Dirac3CloudSolver() # must be configured with environment variables
+    >>> solver = Dirac3IntegerCloudSolver() # must be configured with environment variables
     >>> algo = PenaltyMultiplierAlgorithm(model, solver)
     >>> algo.upper_bound = 330.64
-    >>> algo.run(relaxation_schedule=2, mean_photon_number=0.15, normalized_loss_rate=4, num_samples=5) # doctest: +ELLIPSIS
+    >>> algo.run(relaxation_schedule=2, num_samples=5) # doctest: +ELLIPSIS
     2... RUNNING... COMPLETED...
     >>> algo.alphas[-1] # doctest: +SKIP
     106.25
@@ -80,7 +88,8 @@ class PenaltyMultiplierAlgorithm(Algorithm):
  
     """
 
-    def __init__(self, model : ConstraintModel, solver : ModelSolver):
+    def __init__(self, model : ConstraintModel, solver : ModelSolver, penalty_threshold:float=1e-6,
+                 progress_threshold : float = 1e-4):
         self.model = model
         self.solver = solver
         # ub = np.max(model.quad_objective)
@@ -95,6 +104,8 @@ class PenaltyMultiplierAlgorithm(Algorithm):
         self.alphas = None
         self.dynamic_range = None
         self.responses = None
+        self.penalty_threshold = penalty_threshold
+        self.progress_threshold = progress_threshold
 
     @property
     def upper_bound(self) -> float:
@@ -141,7 +152,7 @@ class PenaltyMultiplierAlgorithm(Algorithm):
         else:
             penalty = None
             
-        while penalty is None or penalty > 1e-6:
+        while penalty is None or penalty > self.penalty_threshold:
             log.info("NEW RUN")
             log.info("SETTING MULTIPLIER %f", alpha)
             model.penalty_multiplier = float(alpha)
@@ -162,8 +173,10 @@ class PenaltyMultiplierAlgorithm(Algorithm):
             energies.append(results["energies"][0])
             log.info("NEW SOLUTION OBJECTIVE %f LESS OFFSET %f ENERGY %f PENALTY %f", 
                      obj_val, less_offset, energies[-1], penalty)
-            if obj_val < ub:
+            if penalty < self.penalty_threshold:
+                pass
+            elif obj_val < ub:
                 alpha += (ub - obj_val) / penalty
-            if abs(sum(penalties[-2:])/2-penalty) < 1e-4:
+            if penalty > self.penalty_threshold and abs(sum(penalties[-2:])/2-penalty) < self.progress_threshold:
                 log.warn("SUFFICIENT PROGRESS NOT MADE FOR THREE ITERATIONS, QUITTING")
                 break

eqc_models-0.10.3.data/platlib/eqc_models/assignment/setpartition.py

@@ -0,0 +1,4 @@
+from ..combinatorics import SetPartitionModel
+import warnings
+
+warnings.warn("import of SetPartitionModel through assignment is deprecated", DeprecationWarning)

{eqc_models-0.10.0.data → eqc_models-0.10.3.data}/platlib/eqc_models/base/base.py

@@ -42,12 +42,50 @@ class EqcModel:
     _H = None
     _machine_slacks = 0
     
-    def decode(self, solution : np.ndarray) -> np.ndarray:
-        """ Manipulate the solution to match the variable count """
+    def decode(self, solution : np.ndarray, from_encoding : str=None) -> np.ndarray:
+        """ 
+        Manipulate the solution to match the variable count. Optionally,
+        a log-encoded solution vector can be translated into a vector
+        with integral values.
+
+        Parameters
+        -----------
+
+        solution : np.ndarray
+            1d solution vector 
+
+        from_encoding : str
+            string indicating if the vector is an encoding of particular type. The
+            text 'qubo' is the only option that does anything for now.
+
+        >>> model = EqcModel()
+        >>> ub = np.array([1, 2, 5])
+        >>> model.upper_bound = ub
+        >>> model.machine_slacks = 1
+        >>> solution = np.array([1, 1, 1, 1, 0, 1, 0]) # this solution has a 3, which violates the upper bound, but decode doesn't care
+        >>> model.decode(solution, "qubo")
+        array([1, 3, 5])
+
+        """
         
+        solution = np.array(solution)
         # ignore any slacks that may have been added during encoding
-        solution = solution[:-self.machine_slacks]
-        
+        if self.machine_slacks > 0:
+            solution = solution[:-self.machine_slacks]
+        if from_encoding == "qubo":
+            ub = self.upper_bound
+            en = solution.shape[0]
+            assert en > 0
+            n = ub.shape[0]
+            linear_operator = np.zeros((n,en))
+            j = 0
+            for i in range(self.n):
+                m = int(np.floor(np.log2(ub[i]))+1)
+                bits = 2**np.arange(m)
+                assert j+m <= linear_operator.shape[1]+2, f"Invalid slice for i={i} {j}:{j+m}"
+                linear_operator[i,j:j+m] = bits
+                j += m
+            solution = (linear_operator@solution).astype(np.int64)
         return solution
 
     @property
@@ -64,6 +102,8 @@ class EqcModel:
         value = np.array(value)
         if (value != value.astype(np.int64)).any():
             raise ValueError("Upper bound values must be integer")
+        if (value==0).any():
+            raise ValueError("Zero values are not allowed as an upper_bound.")
         self._upper_bound = value.astype(np.int64)
 
     @property