Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 13 additions & 8 deletions mpqp/core/instruction/gates/native_gates.py
Original file line number Diff line number Diff line change
Expand Up @@ -433,11 +433,11 @@ def cirq_gate(cls):

qlm_aqasm_keyword = "I"
qiskit_string = "id"
matrix = np.eye(2, dtype=np.complex128)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we don't do this because some of the gates' matrix can only be instantiated at __init__ time, so we try to stay homogeneous

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see your point regarding consistency. I took a closer look at the current inheritance structure to see how we could best align these changes with the rest of the library.

From what I can see, the gates whose matrices depend on parameters (like Rx, Rz, or P) inherit from RotationGate. These don’t actually use self.matrix, but instead override to_canonical_matrix() to calculate the matrix from self.parameters.

Within NoParameterGate, the pattern seems to vary. For example, T, CNOT, and CZ also override the method directly and don't set a self.matrix attribute. It seemed that only the 8 constant gates I modified were using self.matrix in init. Since their matrices are true constants, I thought moving them might simplify the initialization.

However, I might have missed a specific convention you want to maintain here. If you feel that keeping self.matrix inside init is better for readability or consistency with future plans, I’m more than happy to revert that part!


def __init__(self, target: int, label: Optional[str] = None):
super().__init__(target)
self.label = label
self.matrix = np.eye(2, dtype=np.complex128)

def to_other_language(
self,
Expand Down Expand Up @@ -499,10 +499,10 @@ def cirq_gate(cls):

qlm_aqasm_keyword = "X"
qiskit_string = "x"
matrix = np.array([[0, 1], [1, 0]], dtype=np.complex128)

def __init__(self, target: int):
super().__init__(target)
self.matrix = np.array([[0, 1], [1, 0]])


class Y(OneQubitNoParamGate, InvolutionGate):
Expand Down Expand Up @@ -540,10 +540,10 @@ def cirq_gate(cls):

qlm_aqasm_keyword = "Y"
qiskit_string = "y"
matrix = np.array([[0, -1j], [1j, 0]], dtype=np.complex128)

def __init__(self, target: int):
super().__init__(target)
self.matrix = np.array([[0, -1j], [1j, 0]])


class Z(OneQubitNoParamGate, InvolutionGate):
Expand Down Expand Up @@ -581,10 +581,10 @@ def cirq_gate(cls):

qlm_aqasm_keyword = "Z"
qiskit_string = "z"
matrix = np.array([[1, 0], [0, -1]], dtype=np.complex128)

def __init__(self, target: int):
super().__init__(target)
self.matrix = np.array([[1, 0], [0, -1]])


class H(OneQubitNoParamGate, InvolutionGate):
Expand Down Expand Up @@ -620,10 +620,10 @@ def cirq_gate(cls):

qlm_aqasm_keyword = "H"
qiskit_string = "h"
matrix = np.array([[1, 1], [1, -1]], dtype=np.complex128) / np.sqrt(2)

def __init__(self, target: int):
super().__init__(target)
self.matrix = np.array([[1, 1], [1, -1]]) / np.sqrt(2)


class P(RotationGate, SingleQubitGate):
Expand Down Expand Up @@ -778,10 +778,10 @@ def cirq_gate(cls):

qlm_aqasm_keyword = "S"
qiskit_string = "s"
matrix = np.array([[1, 0], [0, 1j]], dtype=np.complex128)

def __init__(self, target: int):
super().__init__(target)
self.matrix = np.array([[1, 0], [0, 1j]])

def inverse(self) -> Gate:
return S_dagger(self.targets[0])
Expand Down Expand Up @@ -823,9 +823,10 @@ def cirq_gate(cls):
qlm_aqasm_keyword = "DAG(S)"
qiskit_string = "sdg"

matrix = np.array([[1, 0], [0, -1j]], dtype=np.complex128)

def __init__(self, target: int):
super().__init__(target, "S†")
self.matrix = np.array([[1, 0], [0, -1j]])

def __repr__(self):
return f"{type(self).__name__}({self.targets[0]})"
Expand Down Expand Up @@ -921,9 +922,13 @@ def cirq_gate(cls):
qlm_aqasm_keyword = "SWAP"
qiskit_string = "swap"

matrix = np.array(
[[1, 0, 0, 0], [0, 0, 1, 0], [0, 1, 0, 0], [0, 0, 0, 1]],
dtype=np.complex128,
)

def __init__(self, a: int, b: int):
super().__init__([a, b], "SWAP")
self.matrix = np.array([[1, 0, 0, 0], [0, 0, 1, 0], [0, 1, 0, 0], [0, 0, 0, 1]])

def __repr__(self) -> str:
return f"{type(self).__name__}({self.targets[0]}, {self.targets[1]})"
Expand Down
5 changes: 3 additions & 2 deletions mpqp/core/instruction/instruction.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
from abc import abstractmethod
from copy import deepcopy
from numbers import Complex
from pickle import dumps
from typing import TYPE_CHECKING, Any, Optional

if TYPE_CHECKING:
Expand Down Expand Up @@ -95,7 +94,9 @@ def to_other_language(
pass

def __eq__(self, value: object) -> bool:
return dumps(self) == dumps(value)
if not isinstance(value, type(self)):
return False
return self.to_dict() == value.to_dict()

def __str__(self) -> str:
from mpqp.core.circuit import QCircuit
Expand Down
273 changes: 270 additions & 3 deletions tests/execution/test_job.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,271 @@
"""Unit tests for the Job class and related enums (JobType, JobStatus).

These tests cover local, non-remote functionality only — no SDK connections
are required.

# 3M-TODO
# In order to do this, we either need a stable account to run these tests from
# or we need to mock the remote connections, would these tests be even useful
# then ?
# Remote job status polling tests need a stable account or mocked connections.
"""

import numpy as np
import pytest

from mpqp import QCircuit
from mpqp.core.instruction.measurement.basis_measure import BasisMeasure
from mpqp.core.instruction.measurement.expectation_value import (
ExpectationMeasure,
Observable,
)
from mpqp.execution.devices import (
ATOSDevice,
AWSDevice,
GOOGLEDevice,
IBMDevice,
)
from mpqp.execution.job import Job, JobStatus, JobType
from mpqp.execution.runner import generate_job
from mpqp.gates import CNOT, H, X

# ---------------------------------------------------------------------------
# JobStatus enum
# ---------------------------------------------------------------------------


class TestJobStatus:
def test_all_statuses_exist(self):
expected = {"INIT", "QUEUED", "RUNNING", "CANCELLED", "ERROR", "DONE"}
actual = {s.name for s in JobStatus}
assert expected == actual

def test_terminal_statuses(self):
"""DONE, ERROR, CANCELLED should be considered terminal."""
terminal = {JobStatus.DONE, JobStatus.ERROR, JobStatus.CANCELLED}
non_terminal = {JobStatus.INIT, JobStatus.QUEUED, JobStatus.RUNNING}
assert terminal.isdisjoint(non_terminal)


# ---------------------------------------------------------------------------
# JobType enum
# ---------------------------------------------------------------------------


class TestJobType:
def test_all_types_exist(self):
expected = {"STATE_VECTOR", "SAMPLE", "OBSERVABLE"}
actual = {t.name for t in JobType}
assert expected == actual

def test_state_vector_accepts_basis_measure(self):
assert BasisMeasure in JobType.STATE_VECTOR.value

def test_state_vector_accepts_none(self):
assert type(None) in JobType.STATE_VECTOR.value

def test_sample_accepts_basis_measure(self):
assert BasisMeasure in JobType.SAMPLE.value

def test_observable_accepts_expectation_measure(self):
assert ExpectationMeasure in JobType.OBSERVABLE.value


# ---------------------------------------------------------------------------
# Job construction
# ---------------------------------------------------------------------------


class TestJobConstruction:
def test_basic_construction(self):
circuit = QCircuit(2)
job = Job(JobType.STATE_VECTOR, circuit, IBMDevice.AER_SIMULATOR)
assert job.job_type == JobType.STATE_VECTOR
assert job.circuit is circuit
assert job.device == IBMDevice.AER_SIMULATOR
assert job.measure is None
assert job.id is None

def test_initial_status_is_init(self):
circuit = QCircuit(2)
job = Job(JobType.STATE_VECTOR, circuit, IBMDevice.AER_SIMULATOR)
assert job._status == JobStatus.INIT

def test_construction_with_measure(self):
circuit = QCircuit([H(0), CNOT(0, 1)])
measure = BasisMeasure([0, 1], shots=100)
job = Job(JobType.SAMPLE, circuit, IBMDevice.AER_SIMULATOR, measure)
assert job.measure is not None
# measure should be deep-copied
assert job.measure is not measure

def test_construction_with_different_devices(self):
circuit = QCircuit(2)
devices = [
IBMDevice.AER_SIMULATOR,
ATOSDevice.MYQLM_PYLINALG,
AWSDevice.BRAKET_LOCAL_SIMULATOR,
GOOGLEDevice.CIRQ_LOCAL_SIMULATOR,
]
for device in devices:
job = Job(JobType.STATE_VECTOR, circuit, device)
assert job.device == device


# ---------------------------------------------------------------------------
# Job status property
# ---------------------------------------------------------------------------


class TestJobStatusProperty:
def test_status_setter(self):
circuit = QCircuit(2)
job = Job(JobType.STATE_VECTOR, circuit, IBMDevice.AER_SIMULATOR)
job.status = JobStatus.RUNNING
assert job._status == JobStatus.RUNNING

def test_local_status_returns_directly(self):
"""For local (non-remote) devices, the status property should return
the stored status without attempting a remote call."""
circuit = QCircuit(2)
job = Job(JobType.STATE_VECTOR, circuit, IBMDevice.AER_SIMULATOR)
job.status = JobStatus.DONE
# Should not raise — no remote lookup attempted for local device
assert job.status == JobStatus.DONE

def test_terminal_status_no_remote_check(self):
"""Once a job reaches a terminal state, the status property should
return immediately for any device."""
circuit = QCircuit(2)
job = Job(JobType.STATE_VECTOR, circuit, IBMDevice.AER_SIMULATOR)
for terminal in [JobStatus.DONE, JobStatus.ERROR, JobStatus.CANCELLED]:
job.status = terminal
assert job.status == terminal


# ---------------------------------------------------------------------------
# Job equality
# ---------------------------------------------------------------------------


class TestJobEquality:
def test_equal_jobs(self):
circuit = QCircuit([H(0), CNOT(0, 1)])
job1 = Job(JobType.STATE_VECTOR, circuit, IBMDevice.AER_SIMULATOR)
job2 = Job(JobType.STATE_VECTOR, circuit, IBMDevice.AER_SIMULATOR)
assert job1 == job2

def test_different_type(self):
circuit = QCircuit([H(0)])
measure = BasisMeasure([0], shots=100)
job1 = Job(JobType.STATE_VECTOR, circuit, IBMDevice.AER_SIMULATOR)
job2 = Job(JobType.SAMPLE, circuit, IBMDevice.AER_SIMULATOR, measure)
assert job1 != job2

def test_different_device(self):
circuit = QCircuit([H(0)])
job1 = Job(JobType.STATE_VECTOR, circuit, IBMDevice.AER_SIMULATOR)
job2 = Job(JobType.STATE_VECTOR, circuit, IBMDevice.AER_SIMULATOR_STATEVECTOR)
assert job1 != job2

def test_different_circuit(self):
circ1 = QCircuit([H(0)])
circ2 = QCircuit([X(0)])
job1 = Job(JobType.STATE_VECTOR, circ1, IBMDevice.AER_SIMULATOR)
job2 = Job(JobType.STATE_VECTOR, circ2, IBMDevice.AER_SIMULATOR)
assert job1 != job2

def test_not_equal_to_non_job(self):
circuit = QCircuit(2)
job = Job(JobType.STATE_VECTOR, circuit, IBMDevice.AER_SIMULATOR)
assert job != "not a job"
assert job != 42
assert job != None


# ---------------------------------------------------------------------------
# Job repr / to_dict
# ---------------------------------------------------------------------------


class TestJobRepr:
def test_repr_no_measure(self):
circuit = QCircuit(2)
job = Job(JobType.STATE_VECTOR, circuit, IBMDevice.AER_SIMULATOR)
r = repr(job)
assert "Job(" in r
assert "STATE_VECTOR" in r
assert "AER_SIMULATOR" in r

def test_repr_with_measure(self):
circuit = QCircuit([H(0)])
measure = BasisMeasure([0], shots=100)
job = Job(JobType.SAMPLE, circuit, IBMDevice.AER_SIMULATOR, measure)
r = repr(job)
assert "BasisMeasure" in r

def test_to_dict_keys(self):
circuit = QCircuit(2)
job = Job(JobType.STATE_VECTOR, circuit, IBMDevice.AER_SIMULATOR)
d = job.to_dict()
assert "job_type" in d
assert "circuit" in d
assert "device" in d
assert "measure" in d
assert "id" in d
assert "status" in d

def test_to_dict_values(self):
circuit = QCircuit(2)
job = Job(JobType.STATE_VECTOR, circuit, IBMDevice.AER_SIMULATOR)
d = job.to_dict()
assert d["job_type"] == JobType.STATE_VECTOR
assert d["device"] == IBMDevice.AER_SIMULATOR
assert d["measure"] is None
assert d["id"] is None


# ---------------------------------------------------------------------------
# generate_job (from runner.py)
# ---------------------------------------------------------------------------


class TestGenerateJob:
def test_no_measurement_gives_state_vector(self):
circuit = QCircuit([H(0), CNOT(0, 1)])
job = generate_job(circuit, IBMDevice.AER_SIMULATOR)
assert job.job_type == JobType.STATE_VECTOR
assert job.measure is None

def test_basis_measure_zero_shots_gives_state_vector(self):
circuit = QCircuit([H(0), BasisMeasure([0], shots=0)])
job = generate_job(circuit, IBMDevice.AER_SIMULATOR)
assert job.job_type == JobType.STATE_VECTOR
assert job.measure is not None

def test_basis_measure_positive_shots_gives_sample(self):
circuit = QCircuit([H(0), BasisMeasure([0], shots=1000)])
job = generate_job(circuit, IBMDevice.AER_SIMULATOR)
assert job.job_type == JobType.SAMPLE
assert job.measure is not None

def test_expectation_measure_gives_observable(self):
obs = Observable(np.array([[1, 0], [0, -1]]))
circuit = QCircuit([H(0), ExpectationMeasure(obs, [0], shots=0)])
job = generate_job(circuit, IBMDevice.AER_SIMULATOR)
assert job.job_type == JobType.OBSERVABLE

def test_multiple_measurements_raises(self):
circuit = QCircuit([H(0), CNOT(0, 1)])
circuit.add(BasisMeasure([0], shots=100))
circuit.add(BasisMeasure([1], shots=100))
with pytest.raises(NotImplementedError, match="multiple measurements"):
generate_job(circuit, IBMDevice.AER_SIMULATOR)

def test_symbolic_substitution(self):
from sympy import symbols

theta = symbols("θ")
from mpqp.gates import Rx

circuit = QCircuit([Rx(theta, 0)])
job = generate_job(circuit, IBMDevice.AER_SIMULATOR, {theta: 1.5})
# After substitution the circuit should have no free variables
assert len(job.circuit.variables()) == 0