docstring

Qiskit · Oct 28, 2024 · 144f1cf · 144f1cf
1 parent 762a495
commit 144f1cf
Showing 1 changed file with 3 additions and 2 deletions.
diff --git a/qiskit_addon_sqd/fermion.py b/qiskit_addon_sqd/fermion.py
@@ -32,8 +32,9 @@
 class SCIState(NamedTuple):
     """The amplitudes and determinants describing a quantum state.
 
-    ``amplitudes`` is an ``MxN`` array such that ``amplitudes[i][j]`` corresponds
-    to the amplitude of the determinant pair (``ci_strs_a[i]``, ``ci_strs_b[j]``).
+    ``amplitudes`` is an ``MxN`` array such that ``M`` = ``len(ci_strs_a)``
+    and ``N`` = ``len(ci_strs_b)``. ``amplitudes[i][j]`` corresponds to the
+    amplitude of the determinant pair (``ci_strs_a[i]``, ``ci_strs_b[j]``).
     """
 
     amplitudes: np.ndarray