Added num_residuals abstract method to residual fns

BQSKit · Aug 5, 2024 · c9fd5af · c9fd5af
1 parent 200e799
commit c9fd5af
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/bqskit/ir/opt/cost/residual.py b/bqskit/ir/opt/cost/residual.py
@@ -25,6 +25,10 @@ class ResidualsFunction(CostFunction):
     def get_residuals(self, params: RealVector) -> npt.NDArray[np.float64]:
         """Return the vector of residuals given the input parameters."""
 
+    @abc.abstractmethod
+    def num_residuals(self) -> int:
+        """Return the number of residuals, should be nonnegative."""
+
     def __call__(  # type: ignore
         self,
         params: RealVector,