QuantumState

Bases: NumpyModel

Represents a quantum state.

Source code in src/qiskit_mps_initializer/datatypes/quantum_state.py

class QuantumState(pdnm.NumpyModel):
    """Represents a quantum state."""

    original_data: pdnt.Np1DArrayComplex128
    """The original data of the quantum state."""

    @classmethod
    def from_dense_data(
        cls, data: npt.ArrayLike, normalize: bool = False
    ) -> "QuantumState":
        """Initializes the QuantumState from the given dense data."""

        normalization_factor = np.linalg.norm(data)

        if not normalize and not np.isclose(normalization_factor, 1.0):
            raise ValueError(
                "The provided data is not normalized. Set `normalize=True` to normalize the wavefunction."
            )

        return cls(original_data=np.array(data, dtype=np.complex128))

    @pd.computed_field
    @property
    def _original_normalization_factor(self) -> float:
        return np.linalg.norm(self.original_data).astype(float)

    @pd.computed_field
    @property
    def wavefunction(self) -> pdnt.Np1DArrayComplex128:
        """The normalized wavefunction of the quantum state."""
        return self.original_data / self._original_normalization_factor

    @pd.computed_field
    @property
    def size(self) -> int:
        """The dimension of the quantum state."""
        return self.wavefunction.size

    @pd.computed_field
    @property
    def num_qubits(self) -> int:
        """The number of qubits required to represent the quantum state."""
        return np.log2(self.size).astype(int)

    def generate_mps_initializer_circuit(
        self, number_of_layers: int
    ) -> qiskit.circuit.QuantumCircuit:
        """Generates the MPS initializer circuit for the quantum state.

        Returns:
            QuantumCircuit: The MPS initializer circuit for the quantum state as a qiskit circuit.
        """
        circuit, _ = multi_layered_circuit_for_non_approximated(
            self.wavefunction, max_number_of_layers=number_of_layers
        )
        return circuit

original_data instance-attribute

original_data: Np1DArrayComplex128

The original data of the quantum state.

wavefunction property

wavefunction: Np1DArrayComplex128

The normalized wavefunction of the quantum state.

size property

size: int

The dimension of the quantum state.

num_qubits property

num_qubits: int

The number of qubits required to represent the quantum state.

from_dense_data classmethod

from_dense_data(
    data: ArrayLike, normalize: bool = False
) -> QuantumState

Initializes the QuantumState from the given dense data.

Source code in src/qiskit_mps_initializer/datatypes/quantum_state.py

@classmethod
def from_dense_data(
    cls, data: npt.ArrayLike, normalize: bool = False
) -> "QuantumState":
    """Initializes the QuantumState from the given dense data."""

    normalization_factor = np.linalg.norm(data)

    if not normalize and not np.isclose(normalization_factor, 1.0):
        raise ValueError(
            "The provided data is not normalized. Set `normalize=True` to normalize the wavefunction."
        )

    return cls(original_data=np.array(data, dtype=np.complex128))

generate_mps_initializer_circuit

generate_mps_initializer_circuit(
    number_of_layers: int,
) -> QuantumCircuit

Generates the MPS initializer circuit for the quantum state.

Returns:

• QuantumCircuit ( QuantumCircuit ) –

  The MPS initializer circuit for the quantum state as a qiskit circuit.

Source code in src/qiskit_mps_initializer/datatypes/quantum_state.py

def generate_mps_initializer_circuit(
    self, number_of_layers: int
) -> qiskit.circuit.QuantumCircuit:
    """Generates the MPS initializer circuit for the quantum state.

    Returns:
        QuantumCircuit: The MPS initializer circuit for the quantum state as a qiskit circuit.
    """
    circuit, _ = multi_layered_circuit_for_non_approximated(
        self.wavefunction, max_number_of_layers=number_of_layers
    )
    return circuit