Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

add overload signature #294

Merged
merged 1 commit into from
Dec 26, 2023
Merged

add overload signature #294

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
68 changes: 67 additions & 1 deletion packages/core/quri_parts/core/state/state_helper.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
UnboundParametricQuantumCircuitProtocol,
)

from . import ComputationalBasisState
from . import ComputationalBasisState, GeneralCircuitQuantumState
from .state import CircuitQuantumState, QuantumState
from .state_parametric import ParametricCircuitQuantumState
from .state_vector import QuantumStateVector, StateVectorType
Expand Down Expand Up @@ -119,8 +119,74 @@ def apply_circuit(
raise ValueError(f"Unsupported state type: {state}")


@overload
def quantum_state(n_qubits: int) -> ComputationalBasisState:
...


@overload
def quantum_state(n_qubits: int, *, bits: int) -> ComputationalBasisState:
...


@overload
def quantum_state(
n_qubits: int, *, bits: int, circuit: NonParametricQuantumCircuit
) -> GeneralCircuitQuantumState:
...


@overload
def quantum_state(
n_qubits: int, *, circuit: NonParametricQuantumCircuit
) -> GeneralCircuitQuantumState:
...


@overload
def quantum_state(
n_qubits: int, *, bits: int, circuit: UnboundParametricQuantumCircuitProtocol
) -> ParametricCircuitQuantumState:
...


@overload
def quantum_state(
n_qubits: int, *, circuit: UnboundParametricQuantumCircuitProtocol
) -> ParametricCircuitQuantumState:
...


@overload
def quantum_state(
n_qubits: int, *, vector: Union[StateVectorType, "npt.ArrayLike"]
) -> QuantumStateVector:
...


@overload
def quantum_state(
n_qubits: int,
*,
vector: Union[StateVectorType, "npt.ArrayLike"],
circuit: NonParametricQuantumCircuit,
) -> QuantumStateVector:
...


@overload
def quantum_state(
n_qubits: int,
*,
vector: Union[StateVectorType, "npt.ArrayLike"],
circuit: UnboundParametricQuantumCircuitProtocol,
) -> ParametricQuantumStateVector:
...


def quantum_state(
n_qubits: int,
*,
vector: Optional[Union[StateVectorType, "npt.ArrayLike"]] = None,
bits: int = 0,
circuit: Optional[
Expand Down
2 changes: 1 addition & 1 deletion packages/core/tests/core/state/test_state_helper.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ def test_quantum_state(
assert _quantum_state_vector_mock.call_count == 1

with pytest.raises(ValueError):
quantum_state(n_qubits, vector=[1.0, 0, 0, 0], bits=0b01)
quantum_state(n_qubits, vector=[1.0, 0, 0, 0], bits=0b01) # type: ignore


@patch("quri_parts.core.state.state_helper.quantum_state")
Expand Down