Add explicit assumption to _apply_to_batch docstring

optimagic-dev · Dec 5, 2024 · 33c5a18 · 33c5a18
1 parent 0c5ead3
commit 33c5a18
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/src/optimagic/optimization/history.py b/src/optimagic/optimization/history.py
@@ -391,6 +391,8 @@ def _apply_to_batch(
 ) -> NDArray[np.float64]:
     """Apply a reduction operator on batches of data.
 
+    This function assumes that batch_ids non-empty and sorted.
+
     Args:
         data: 1d array with data.
         batch_ids: A list with batch ids whose length is equal to the size of data.