refact: Rename "calculation" to "simulation step" (#527)

Kolarovszki · web-flow · commit a77b1fac7aef · 2025-10-28T12:48:12.000+01:00
The term "calculation" is not very fitting currently. Previously, a
"calculation" is a function associated to an `Instruction` subclass
(e.g., `Beamsplitter`) to be executed during the simulation, when such
instruction is encountered. A better naming would be "simulation step",
and therefore, it has been renamed.
diff --git a/piquasso/_simulators/fock/general/simulation_steps.py b/piquasso/_simulators/fock/general/simulation_steps.py
@@ -42,7 +42,7 @@
     get_fock_space_basis,
 )
 
-from ..calculations import (
+from ..simulation_steps import (
     calculate_state_index_matrix_list,
     calculate_interferometer_helper_indices,
     calculate_index_list_for_appling_interferometer,
diff --git a/piquasso/_simulators/fock/general/simulator.py b/piquasso/_simulators/fock/general/simulator.py
@@ -19,7 +19,7 @@
 from piquasso._simulators.connectors import NumpyConnector
 
 from .state import FockState
-from .calculations import (
+from .simulation_steps import (
     passive_linear,
     squeezing,
     displacement,
@@ -34,7 +34,7 @@
     annihilate,
 )
 
-from ..calculations import attenuator
+from ..simulation_steps import attenuator
 
 
 class FockSimulator(BuiltinSimulator):
diff --git a/piquasso/_simulators/fock/pure/simulation_steps/__init__.py b/piquasso/_simulators/fock/pure/simulation_steps/__init__.py
@@ -39,7 +39,7 @@
 from .passive_linear import _apply_passive_linear
 from .utils import project_to_subspace
 
-from ...calculations import calculate_state_index_matrix_list
+from ...simulation_steps import calculate_state_index_matrix_list
 
 from ..state import PureFockState
 from ..batch_state import BatchPureFockState
diff --git a/piquasso/_simulators/fock/pure/simulation_steps/homodyne.py b/piquasso/_simulators/fock/pure/simulation_steps/homodyne.py
diff --git a/piquasso/_simulators/fock/pure/simulation_steps/measurements.py b/piquasso/_simulators/fock/pure/simulation_steps/measurements.py
@@ -19,7 +19,7 @@
 from piquasso.api.branch import Branch
 
 from piquasso._math.fock import get_fock_space_basis
-from piquasso._simulators.fock.calculations import get_projection_operator_indices
+from piquasso._simulators.fock.simulation_steps import get_projection_operator_indices
 from piquasso._simulators.fock.general.state import FockState
 
 from ..state import PureFockState
diff --git a/piquasso/_simulators/fock/pure/simulation_steps/passive_linear.py b/piquasso/_simulators/fock/pure/simulation_steps/passive_linear.py
@@ -25,7 +25,7 @@
 from piquasso.api.connector import BaseConnector
 
 from ..state import PureFockState
-from ...calculations import (
+from ...simulation_steps import (
     calculate_interferometer_helper_indices,
     calculate_index_list_for_appling_interferometer,
 )
diff --git a/piquasso/_simulators/fock/pure/simulation_steps/utils.py b/piquasso/_simulators/fock/pure/simulation_steps/utils.py
@@ -17,7 +17,7 @@
 
 import numpy as np
 
-from ...calculations import get_projection_operator_indices
+from ...simulation_steps import get_projection_operator_indices
 
 from ..state import PureFockState
 
diff --git a/piquasso/_simulators/fock/pure/simulator.py b/piquasso/_simulators/fock/pure/simulator.py
@@ -15,7 +15,7 @@
 
 from .state import PureFockState
 
-from .calculations import (
+from .simulation_steps import (
     state_vector_instruction,
     passive_linear,
     beamsplitter5050,
@@ -36,7 +36,7 @@
     homodyne_measurement,
 )
 
-from ..calculations import attenuator
+from ..simulation_steps import attenuator
 
 from ...simulator import BuiltinSimulator
 from piquasso.instructions import (
diff --git a/piquasso/_simulators/fock/simulation_steps.py b/piquasso/_simulators/fock/simulation_steps.py
diff --git a/piquasso/_simulators/gaussian/simulation_steps.py b/piquasso/_simulators/gaussian/simulation_steps.py
diff --git a/piquasso/_simulators/gaussian/simulator.py b/piquasso/_simulators/gaussian/simulator.py
@@ -19,7 +19,7 @@
 from piquasso._simulators.connectors import NumpyConnector, JaxConnector
 
 from .state import GaussianState
-from .calculations import (
+from .simulation_steps import (
     passive_linear,
     linear,
     displacement,
diff --git a/piquasso/_simulators/sampling/simulation_steps.py b/piquasso/_simulators/sampling/simulation_steps.py
@@ -27,7 +27,7 @@
 from piquasso.api.branch import Branch
 from piquasso.api.instruction import Instruction
 
-from piquasso._simulators.fock.pure.calculations import (
+from piquasso._simulators.fock.pure.simulation_steps import (
     post_select_photons as pure_fock_post_select_photons,
     imperfect_post_select_photons as pure_fock_imperfect_post_select_photons,
 )
diff --git a/piquasso/_simulators/sampling/simulator.py b/piquasso/_simulators/sampling/simulator.py
@@ -19,7 +19,7 @@
 from piquasso._simulators.connectors import NumpyConnector, JaxConnector
 
 from .state import SamplingState
-from .calculations import (
+from .simulation_steps import (
     state_vector,
     passive_linear,
     particle_number_measurement,
diff --git a/piquasso/api/simulator.py b/piquasso/api/simulator.py
@@ -93,7 +93,7 @@ def create_initial_state(self):
 
     def _validate_instruction_existence(self, instructions: List[Instruction]) -> None:
         for instruction in instructions:
-            self._get_calculation(instruction)
+            self._get_simulation_step(instruction)
 
     def _validate_instruction_modes(self, instructions: List[Instruction]) -> None:
         for instruction in instructions:
@@ -119,10 +119,10 @@ def _validate_instruction_modes(self, instructions: List[Instruction]) -> None:
                         f"{valid_indices_message}"
                     )
 
-    def _get_calculation(self, instruction: Instruction) -> Callable:
-        for instruction_class, calculation in self._instruction_map.items():
+    def _get_simulation_step(self, instruction: Instruction) -> Callable:
+        for instruction_class, simulation_step in self._instruction_map.items():
             if type(instruction) is instruction_class:
-                return calculation
+                return simulation_step
 
         raise InvalidSimulation(
             "\n"
@@ -231,14 +231,14 @@ def _delete_modes_from_active(active_modes, modes):
         )
 
     def _apply_instruction_to_branches(self, branches, instruction, shots):
-        calculation = self._get_calculation(instruction)
+        simulation_step = self._get_simulation_step(instruction)
 
         instruction = self._maybe_postprocess_batch_instruction(instruction)
 
         new_branches = []
 
         for branch in branches:
-            subbranches = calculation(
+            subbranches = simulation_step(
                 branch.state, instruction, shots=int(branch.frequency * shots)
             )
 
diff --git a/piquasso/fermionic/fock/simulation_steps.py b/piquasso/fermionic/fock/simulation_steps.py
diff --git a/piquasso/fermionic/fock/simulator.py b/piquasso/fermionic/fock/simulator.py
@@ -16,7 +16,7 @@
 from piquasso.instructions import gates, preparations
 from .state import PureFockState
 
-from .calculations import (
+from .simulation_steps import (
     passive_linear,
     state_vector,
     squeezing2,
diff --git a/piquasso/fermionic/gaussian/simulation_steps.py b/piquasso/fermionic/gaussian/simulation_steps.py
diff --git a/piquasso/fermionic/gaussian/simulator.py b/piquasso/fermionic/gaussian/simulator.py
@@ -17,7 +17,7 @@
 
 from ..instructions import GaussianHamiltonian, ParentHamiltonian, IsingXX
 
-from .calculations import (
+from .simulation_steps import (
     state_vector,
     vacuum,
     parent_hamiltonian,

Original file line number	Diff line number	Diff line change
`@@ -42,7 +42,7 @@`
`42`	`42`	`get_fock_space_basis,`
`43`	`43`	`)`
`44`	`44`
`45`		`-from ..calculations import (`
	`45`	`+from ..simulation_steps import (`
`46`	`46`	`calculate_state_index_matrix_list,`
`47`	`47`	`calculate_interferometer_helper_indices,`
`48`	`48`	`calculate_index_list_for_appling_interferometer,`
Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@`
`25`	`25`	`from piquasso.api.connector import BaseConnector`
`26`	`26`
`27`	`27`	`from ..state import PureFockState`
`28`		`-from ...calculations import (`
	`28`	`+from ...simulation_steps import (`
`29`	`29`	`calculate_interferometer_helper_indices,`
`30`	`30`	`calculate_index_list_for_appling_interferometer,`
`31`	`31`	`)`