Skip to content

Commit

Permalink
Clarify config recovery docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
caleb-johnson committed Sep 13, 2024
1 parent 6fdb593 commit 17d658f
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions qiskit_addon_sqd/configuration_recovery.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 17d658f

Please sign in to comment.