Skip to content

Commit

Permalink
Added clarification to get_bits docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
PabloAndresCQ committed Sep 26, 2024
1 parent cc3afe8 commit 94ce2dc
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion pytket/extensions/cutensornet/structured_state/general.py
Original file line number Diff line number Diff line change
Expand Up @@ -448,7 +448,10 @@ def get_amplitude(self, state: int) -> complex:
raise NotImplementedError(f"Method not implemented in {type(self).__name__}.")

def get_bits(self) -> dict[Bit, bool]:
"""Returns the dictionary of bits and their values."""
"""Returns the dictionary of bits and their values.
A bit with value ``False`` corresponds to ``0``, and ``True`` is ``1``.
"""
return self._bits_dict.copy()

@abstractmethod
Expand Down

0 comments on commit 94ce2dc

Please sign in to comment.