From 17d658f0548b1e7c8b28c54d34f98841219a8b8b Mon Sep 17 00:00:00 2001 From: Caleb Johnson Date: Fri, 13 Sep 2024 13:19:34 -0500 Subject: [PATCH] Clarify config recovery docstring --- qiskit_addon_sqd/configuration_recovery.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/qiskit_addon_sqd/configuration_recovery.py b/qiskit_addon_sqd/configuration_recovery.py index 9672df4..97e5ba3 100644 --- a/qiskit_addon_sqd/configuration_recovery.py +++ b/qiskit_addon_sqd/configuration_recovery.py @@ -68,8 +68,9 @@ def recover_configurations( """ Refine bitstrings based on average orbital occupancy and a target hamming weight. - This function makes the assumption that bit ``i`` represents the same orbital as - bit ``i + # orbitals`` in all input bitstrings, s.t. ``i < # orbitals``. + This function makes the assumption that bit ``i`` represents the spin-down orbital + corresponding to the spin-up orbital in bit ``i + N`` where ``N`` is the number of + spatial orbitals and ``i < N``. Args: bitstring_matrix: A 2D array of ``bool`` representations of bit