[CQT-437] Separate arguments into parameters (or arguments) and operands (#653)

Author: davidbakker123

opensquirrel/circuit_builder.py

@@ -8,7 +8,7 @@
 
 from opensquirrel.circuit import Circuit
 from opensquirrel.default_instructions import default_instruction_set
-from opensquirrel.ir import IR, AsmDeclaration, Bit, BitLike, Instruction, Measure, Qubit, QubitLike
+from opensquirrel.ir import IR, AsmDeclaration, Bit, BitLike, Instruction, Qubit, QubitLike
 from opensquirrel.register_manager import BitRegister, QubitRegister, RegisterManager
 
 _builder_dynamic_attributes = (*default_instruction_set, "asm")
@@ -75,12 +75,11 @@ def _check_bit_out_of_bounds_access(self, bit: BitLike) -> None:
             raise IndexError(msg)
 
     def _check_out_of_bounds_access(self, instruction: Instruction) -> None:
-        for qubit in instruction.get_qubit_operands():
+        for qubit in instruction.qubit_operands:
             self._check_qubit_out_of_bounds_access(qubit)
 
-        if isinstance(instruction, Measure):
-            for bit in instruction.get_bit_operands():
-                self._check_bit_out_of_bounds_access(bit)
+        for bit in instruction.bit_operands:
+            self._check_bit_out_of_bounds_access(bit)
 
     def _add_statement(self, attr: str, *args: Any) -> Self:
         if attr == "asm":

opensquirrel/ir/control_instruction.py

@@ -1,7 +1,7 @@
 from abc import ABC, abstractmethod
 from typing import Any, SupportsInt
 
-from opensquirrel.ir.expression import Expression, Int, Qubit, QubitLike
+from opensquirrel.ir.expression import Bit, Expression, Int, Qubit, QubitLike
 from opensquirrel.ir.ir import IRVisitor
 from opensquirrel.ir.statement import Instruction
 
@@ -16,8 +16,13 @@ def __init__(self, qubit: QubitLike, name: str) -> None:
     def arguments(self) -> tuple[Expression, ...]:
         pass
 
-    def get_qubit_operands(self) -> list[Qubit]:
-        return [self.qubit]
+    @property
+    def qubit_operands(self) -> tuple[Qubit, ...]:
+        return (self.qubit,)
+
+    @property
+    def bit_operands(self) -> tuple[Bit, ...]:
+        return ()
 
 
 class Barrier(ControlInstruction):

opensquirrel/ir/default_gates/two_qubit_gates.py

@@ -41,13 +41,6 @@ def __init__(self, qubit_0: QubitLike, qubit_1: QubitLike) -> None:
         self.qubit_0 = Qubit(qubit_0)
         self.qubit_1 = Qubit(qubit_1)
 
-    @property
-    def arguments(self) -> tuple[Expression, ...]:
-        return self.qubit_0, self.qubit_1
-
-    def get_qubit_operands(self) -> list[Qubit]:
-        return [self.qubit_0, self.qubit_1]
-
 
 class CNOT(TwoQubitGate):
     def __init__(self, control_qubit: QubitLike, target_qubit: QubitLike) -> None:

opensquirrel/ir/non_unitary.py

@@ -19,8 +19,13 @@ def __init__(self, qubit: QubitLike, name: str) -> None:
     def arguments(self) -> tuple[Expression, ...]:
         pass
 
-    def get_qubit_operands(self) -> list[Qubit]:
-        return [self.qubit]
+    @property
+    def qubit_operands(self) -> tuple[Qubit, ...]:
+        return (self.qubit,)
+
+    @property
+    def bit_operands(self) -> tuple[Bit, ...]:
+        return ()
 
     def accept(self, visitor: IRVisitor) -> Any:
         return visitor.visit_non_unitary(self)
@@ -49,8 +54,9 @@ def accept(self, visitor: IRVisitor) -> Any:
         non_unitary_visit = super().accept(visitor)
         return non_unitary_visit if non_unitary_visit is not None else visitor.visit_measure(self)
 
-    def get_bit_operands(self) -> list[Bit]:
-        return [self.bit]
+    @property
+    def bit_operands(self) -> tuple[Bit, ...]:
+        return (self.bit,)
 
 
 class Init(NonUnitary):

opensquirrel/ir/single_qubit_gate.py

@@ -84,12 +84,9 @@ def __mul__(self, other: SingleQubitGate) -> SingleQubitGate:
         return SingleQubitGate(self.qubit, self.bsr * other.bsr)
 
     @property
-    def arguments(self) -> tuple[Qubit, ...]:
+    def qubit_operands(self) -> tuple[Qubit, ...]:
         return (self.qubit,)
 
-    def get_qubit_operands(self) -> list[Qubit]:
-        return [self.qubit]
-
     def is_identity(self) -> bool:
         if self.bsr is not None:
             return self.bsr.is_identity()

opensquirrel/ir/statement.py

@@ -1,7 +1,7 @@
 from abc import ABC, abstractmethod
 from typing import Any
 
-from opensquirrel.ir.expression import Expression, Qubit, String, SupportsStr
+from opensquirrel.ir.expression import Bit, Expression, Qubit, String, SupportsStr
 from opensquirrel.ir.ir import IRNode, IRVisitor
 
 
@@ -40,8 +40,18 @@ def __init__(self, name: str) -> None:
     def arguments(self) -> tuple[Expression, ...]:
         pass
 
+    @property
+    @abstractmethod
+    def qubit_operands(self) -> tuple[Qubit, ...]:
+        pass
+
+    @property
+    def qubit_indices(self) -> list[int]:
+        return [qubit.index for qubit in self.qubit_operands]
+
+    @property
     @abstractmethod
-    def get_qubit_operands(self) -> list[Qubit]:
+    def bit_operands(self) -> tuple[Bit, ...]:
         pass
 
     def accept(self, visitor: IRVisitor) -> Any:

opensquirrel/ir/two_qubit_gate.py

@@ -4,7 +4,6 @@
 import numpy as np
 
 from opensquirrel.ir import Gate, IRVisitor, Qubit, QubitLike
-from opensquirrel.ir.expression import Expression
 from opensquirrel.ir.semantics import CanonicalGateSemantic, ControlledGateSemantic, MatrixGateSemantic
 from opensquirrel.ir.semantics.gate_semantic import GateSemantic
 from opensquirrel.utils import get_matrix
@@ -27,7 +26,7 @@ def __init__(
             msg = "the qubit from the target gate does not match with 'qubit1'."
             raise ValueError(msg)
 
-        if self._check_repeated_qubit_operands([self.qubit0, self.qubit1]):
+        if self._check_repeated_qubit_operands(self.qubit_operands):
             msg = "qubit0 and qubit1 cannot be the same"
             raise ValueError(msg)
 
@@ -62,12 +61,9 @@ def accept(self, visitor: IRVisitor) -> Any:
         return visit_parent if visit_parent is not None else visitor.visit_two_qubit_gate(self)
 
     @property
-    def arguments(self) -> tuple[Expression, ...]:
+    def qubit_operands(self) -> tuple[Qubit, ...]:
         return (self.qubit0, self.qubit1)
 
-    def get_qubit_operands(self) -> list[Qubit]:
-        return [self.qubit0, self.qubit1]
-
     def is_identity(self) -> bool:
         if self.controlled:
             return self.controlled.is_identity()

opensquirrel/ir/unitary.py

@@ -8,8 +8,8 @@
 from opensquirrel.ir.statement import Instruction
 
 if TYPE_CHECKING:
-    from opensquirrel.ir import IRVisitor
-    from opensquirrel.ir.expression import Qubit
+    from opensquirrel.ir import Bit, IRVisitor, Qubit
+    from opensquirrel.ir.expression import Expression
 
 
 class Unitary(Instruction, ABC):
@@ -25,14 +25,18 @@ def __init__(self, name: str) -> None:
     def _check_repeated_qubit_operands(qubits: Sequence[Qubit]) -> bool:
         return len(qubits) != len(set(qubits))
 
-    @abstractmethod
-    def get_qubit_operands(self) -> list[Qubit]:
-        pass
-
     @abstractmethod
     def is_identity(self) -> bool:
         pass
 
+    @property
+    def arguments(self) -> tuple[Expression, ...]:
+        return ()
+
+    @property
+    def bit_operands(self) -> tuple[Bit, ...]:
+        return ()
+
     def accept(self, visitor: IRVisitor) -> Any:
         return visitor.visit_gate(self)
 
@@ -43,7 +47,7 @@ def __eq__(self, other: object) -> bool:
 
 
 def compare_gates(g1: Gate, g2: Gate) -> bool:
-    union_mapping = [q.index for q in list(set(g1.get_qubit_operands()) | set(g2.get_qubit_operands()))]
+    union_mapping = list(set(g1.qubit_indices) | set(g2.qubit_indices))
 
     from opensquirrel.circuit_matrix_calculator import get_circuit_matrix
     from opensquirrel.reindexer import get_reindexed_circuit

opensquirrel/passes/decomposer/cnot2cz_decomposer.py

@@ -25,7 +25,7 @@ def decompose(self, gate: Gate) -> list[Gate]:
         if gate.name != "CNOT":
             return [gate]
 
-        control_qubit, target_qubit = gate.get_qubit_operands()
+        control_qubit, target_qubit = gate.qubit_operands
         return [
             Ry(target_qubit, -pi / 2),
             CZ(control_qubit, target_qubit),

opensquirrel/passes/decomposer/cz_decomposer.py

@@ -32,7 +32,7 @@ def decompose(self, g: Gate) -> list[Gate]:
             # - decomposing MatrixGate is currently not supported.
             return [g]
 
-        control_qubit, target_qubit = g.get_qubit_operands()
+        control_qubit, target_qubit = g.qubit_operands
         target_gate = g.controlled.target_gate
 
         # Perform XYX decomposition on the target gate.