Skip to content

hamiltonian_set

Collections of Hamiltonian operators.

HamiltonianSet

Represents a set of quantum Hamiltonians.

Source code in shadowsim/core/hamiltonian_set.py
class HamiltonianSet:
    """Represents a set of quantum Hamiltonians."""

    def __init__(self, hamiltonians: Sequence[Hamiltonian | str | PauliString | PauliSum]) -> None:
        """Initialize a HamiltonianSet of quantum Hamiltonians.

        Parameter hamiltonians: Hamiltonians, or values coercible via
            ``Hamiltonian`` (Pauli strings / expressions / PauliSum).
        """
        if not isinstance(hamiltonians, list):
            raise TypeError(f"hamiltonians must be a list; got {type(hamiltonians)!r}")
        coerced: list[Hamiltonian] = []
        for h in hamiltonians:
            if isinstance(h, Hamiltonian):
                coerced.append(h)
            elif isinstance(h, (str, PauliString, PauliSum)):
                coerced.append(Hamiltonian(h))
            else:
                raise TypeError(f"all hamiltonians must be Hamiltonian, str, PauliString, or PauliSum; got {type(h)!r}")
        self.hamiltonians = coerced
        self.hamiltonian_count = len(coerced)

    def __str__(self) -> str:
        """Return a string representation of the HamiltonianSet."""
        return f"HamiltonianSet(hamiltonian_count={self.hamiltonian_count})"

    def __repr__(self) -> str:
        """Return a string representation of the HamiltonianSet."""
        return f"HamiltonianSet(hamiltonians={self.hamiltonians!r})"

    def __iter__(self) -> Iterator[Hamiltonian]:
        """Return an iterator over the Hamiltonians in the HamiltonianSet."""
        return iter(self.hamiltonians)

    def __len__(self) -> int:
        """Return the number of Hamiltonians in the HamiltonianSet."""
        return self.hamiltonian_count

    def __getitem__(self, index: int) -> Hamiltonian:
        """Return the Hamiltonian at the given index."""
        return self.hamiltonians[index]

    def __contains__(self, item: Hamiltonian) -> bool:
        """Return whether the HamiltonianSet contains the given Hamiltonian."""
        return item in self.hamiltonians

__init__

__init__(
    hamiltonians: Sequence[
        Hamiltonian | str | PauliString | PauliSum
    ],
) -> None

Initialize a HamiltonianSet of quantum Hamiltonians.

Hamiltonians, or values coercible via

Hamiltonian (Pauli strings / expressions / PauliSum).

Source code in shadowsim/core/hamiltonian_set.py
def __init__(self, hamiltonians: Sequence[Hamiltonian | str | PauliString | PauliSum]) -> None:
    """Initialize a HamiltonianSet of quantum Hamiltonians.

    Parameter hamiltonians: Hamiltonians, or values coercible via
        ``Hamiltonian`` (Pauli strings / expressions / PauliSum).
    """
    if not isinstance(hamiltonians, list):
        raise TypeError(f"hamiltonians must be a list; got {type(hamiltonians)!r}")
    coerced: list[Hamiltonian] = []
    for h in hamiltonians:
        if isinstance(h, Hamiltonian):
            coerced.append(h)
        elif isinstance(h, (str, PauliString, PauliSum)):
            coerced.append(Hamiltonian(h))
        else:
            raise TypeError(f"all hamiltonians must be Hamiltonian, str, PauliString, or PauliSum; got {type(h)!r}")
    self.hamiltonians = coerced
    self.hamiltonian_count = len(coerced)

__str__

__str__() -> str

Return a string representation of the HamiltonianSet.

Source code in shadowsim/core/hamiltonian_set.py
def __str__(self) -> str:
    """Return a string representation of the HamiltonianSet."""
    return f"HamiltonianSet(hamiltonian_count={self.hamiltonian_count})"

__repr__

__repr__() -> str

Return a string representation of the HamiltonianSet.

Source code in shadowsim/core/hamiltonian_set.py
def __repr__(self) -> str:
    """Return a string representation of the HamiltonianSet."""
    return f"HamiltonianSet(hamiltonians={self.hamiltonians!r})"

__iter__

__iter__() -> Iterator[Hamiltonian]

Return an iterator over the Hamiltonians in the HamiltonianSet.

Source code in shadowsim/core/hamiltonian_set.py
def __iter__(self) -> Iterator[Hamiltonian]:
    """Return an iterator over the Hamiltonians in the HamiltonianSet."""
    return iter(self.hamiltonians)

__len__

__len__() -> int

Return the number of Hamiltonians in the HamiltonianSet.

Source code in shadowsim/core/hamiltonian_set.py
def __len__(self) -> int:
    """Return the number of Hamiltonians in the HamiltonianSet."""
    return self.hamiltonian_count

__getitem__

__getitem__(index: int) -> Hamiltonian

Return the Hamiltonian at the given index.

Source code in shadowsim/core/hamiltonian_set.py
def __getitem__(self, index: int) -> Hamiltonian:
    """Return the Hamiltonian at the given index."""
    return self.hamiltonians[index]

__contains__

__contains__(item: Hamiltonian) -> bool

Return whether the HamiltonianSet contains the given Hamiltonian.

Source code in shadowsim/core/hamiltonian_set.py
def __contains__(self, item: Hamiltonian) -> bool:
    """Return whether the HamiltonianSet contains the given Hamiltonian."""
    return item in self.hamiltonians