✨ Support more Properties in NA QDMI Device

CHANGELOG.md

@@ -22,6 +22,7 @@ This project adheres to [Semantic Versioning], with the exception that minor rel
 
 ### Changed
 
+- ✨ Extend MQT's implementation of a QDMI Device for neutral atom-based quantum computing with more properties ([#1100]) ([**@ystade**])
 - 🚚 Rename `xxminusyy` to `xx_minus_yy` and `xxplusyy` to `xx_plus_yy` in MLIR dialects ([#1071]) ([**@BertiFlorea**], [**@denialhaag**])
 - 🚸 Add custom assembly format for operations in the MLIR dialects ([#1139]) ([**@burgholzer**])
 - 🚸 Enable `InferTypeOpInterface` in the MLIR dialects to reduce explicit type information ([#1139]) ([**@burgholzer**])
@@ -180,6 +181,7 @@ _📚 Refer to the [GitHub Release Notes](https://github.com/munich-quantum-tool
 [#1117]: https://github.com/munich-quantum-toolkit/core/pull/1117
 [#1116]: https://github.com/munich-quantum-toolkit/core/pull/1116
 [#1106]: https://github.com/munich-quantum-toolkit/core/pull/1106
+[#1100]: https://github.com/munich-quantum-toolkit/core/pull/1100
 [#1099]: https://github.com/munich-quantum-toolkit/core/pull/1099
 [#1098]: https://github.com/munich-quantum-toolkit/core/pull/1098
 [#1089]: https://github.com/munich-quantum-toolkit/core/pull/1089

include/mqt-core/na/device/Device.hpp

@@ -16,9 +16,11 @@
 
 #include "mqt_na_qdmi/device.h"
 
+#include <algorithm>
 #include <cstddef>
 #include <cstdint>
 #include <memory>
+#include <optional>
 #include <string>
 #include <unordered_map>
 #include <utility>
@@ -32,6 +34,26 @@ class Device final {
   /// @brief The number of qubits in the device.
   size_t qubitsNum_ = 0;
 
+  /// @brief A struct representing a unit.
+  struct Unit {
+    /// @brief The unit used to interpret values.
+    std::string unit;
+    /**
+     * @brief The scale factor of the unit.
+     * @details This factor must be multiplied with all values before
+     * interpreting them in the unit specified by @ref Unit::unit.
+     */
+    double scaleFactor = 1.0;
+  };
+  /// @brief The unit used to interpret length values.
+  Unit lengthUnit_;
+
+  /// @brief The unit used to interpret duration values.
+  Unit durationUnit_;
+
+  /// @brief The minimum atom distance that must be maintained.
+  uint64_t minAtomDistance_;
+
   /// @brief The list of sites.
   std::vector<std::unique_ptr<MQT_NA_QDMI_Site_impl_d>> sites_;
 
@@ -226,25 +248,43 @@ struct MQT_NA_QDMI_Device_Job_impl_d {
  * @brief Implementation of the MQT_NA_QDMI_Device_Site structure.
  */
 struct MQT_NA_QDMI_Site_impl_d {
+  friend MQT_NA_QDMI_Operation_impl_d;
+
 private:
   uint64_t id_ = 0;       ///< Unique identifier of the site
   uint64_t moduleId_ = 0; ///< Identifier of the module the site belongs to
-  uint64_t subModuleId_ =
-      0;          ///< Identifier of the sub-module the site belongs to
-  int64_t x_ = 0; ///< X coordinate of the site in the lattice
-  int64_t y_ = 0; ///< Y coordinate of the site in the lattice
+  /// Identifier of the submodule the site belongs to
+  uint64_t subModuleId_ = 0;
+  int64_t x_ = 0;        ///< X coordinate of the site in the lattice
+  int64_t y_ = 0;        ///< Y coordinate of the site in the lattice
+  uint64_t xExtent_ = 0; ///< Width of the site in the lattice (for zone sites)
+  uint64_t yExtent_ = 0; ///< Height of the site in the lattice (for zone sites)
   /// @brief Collects decoherence times for the device.
   struct DecoherenceTimes {
-    double t1_ = 0.0; ///< T1 time in microseconds
-    double t2_ = 0.0; ///< T2 time in microseconds
+    uint64_t t1_ = 0; ///< T1 time
+    uint64_t t2_ = 0; ///< T2 time
   };
   /// @brief The decoherence times of the device.
   DecoherenceTimes decoherenceTimes_{};
+  bool isZone = false; ///< Indicates if the site is a zone site
 
-public:
-  /// @brief Constructor for the MQT_NA_QDMI_Site_impl_d.
-  MQT_NA_QDMI_Site_impl_d(uint64_t id, uint64_t module, uint64_t subModule,
+  /// @brief Constructor for regular sites.
+  MQT_NA_QDMI_Site_impl_d(uint64_t id, uint64_t moduleId, uint64_t subModuleId,
                           int64_t x, int64_t y);
+  /// @brief Constructor for zone sites.
+  MQT_NA_QDMI_Site_impl_d(uint64_t id, int64_t x, int64_t y, uint64_t width,
+                          uint64_t height);
+
+public:
+  /// @brief Factory function for regular sites.
+  [[nodiscard]] static auto makeUniqueSite(uint64_t id, uint64_t moduleId,
+                                           uint64_t subModuleId, int64_t x,
+                                           int64_t y)
+      -> std::unique_ptr<MQT_NA_QDMI_Site_impl_d>;
+  /// @brief Factory function for zone sites.
+  [[nodiscard]] static auto makeUniqueZone(uint64_t id, int64_t x, int64_t y,
+                                           uint64_t width, uint64_t height)
+      -> std::unique_ptr<MQT_NA_QDMI_Site_impl_d>;
   /**
    * @brief Queries a property of the site.
    * @see MQT_NA_QDMI_device_session_query_site_property
@@ -257,45 +297,107 @@ struct MQT_NA_QDMI_Site_impl_d {
  * @brief Implementation of the MQT_NA_QDMI_Device_Operation structure.
  */
 struct MQT_NA_QDMI_Operation_impl_d {
-  /// The type of operation.
-  enum class Type : uint8_t {
-    GlobalSingleQubit, ///< Global single-qubit operation
-    GlobalMultiQubit,  ///< Global multi-qubit operation
-    LocalSingleQubit,  ///< Local single-qubit operation
-    LocalMultiQubit,   ///< Local multi-qubit operation
-    ShuttlingLoad,     ///< Shuttling load operation
-    ShuttlingMove,     ///< Shuttling move operation
-    ShuttlingStore,    ///< Shuttling store operation
-  };
-
 private:
   std::string name_;     ///< Name of the operation
-  Type type_;            ///< Type of the operation
   size_t numParameters_; ///< Number of parameters for the operation
   /**
    * @brief Number of qubits involved in the operation
    * @note This number is only valid if the operation is a multi-qubit
    * operation.
    */
-  size_t numQubits_;
-  double duration_; ///< Duration of the operation in microseconds
-  double fidelity_; ///< Fidelity of the operation
-
-  /**
-   * @brief Checks if the operation type is a shuttling operation.
-   * @param type The operation type to check.
-   * @return true if the operation type is a shuttling operation, false
-   * otherwise.
-   */
-  [[nodiscard]] static auto isShuttling(Type type) -> bool;
+  std::optional<size_t> numQubits_ = std::nullopt;
+  /// Duration of the operation
+  std::optional<uint64_t> duration_ = std::nullopt;
+  std::optional<double> fidelity_ = std::nullopt; ///< Fidelity of the operation
+  /// Interaction radius for multi-qubit operations
+  std::optional<uint64_t> interactionRadius_ = std::nullopt;
+  /// Blocking radius for multi-qubit operations
+  std::optional<uint64_t> blockingRadius_ = std::nullopt;
+  /// Mean shuttling speed
+  std::optional<uint64_t> meanShuttlingSpeed_ = std::nullopt;
+  /// Idling fidelity
+  std::optional<double> idlingFidelity_ = std::nullopt;
+  /// The operation's supported sites
+  std::vector<MQT_NA_QDMI_Site> supportedSites_;
+  /// Indicates if this operation is zoned (global)
+  bool isZoned_ = false;
+
+  /// @brief Constructor for the global single-qubit.
+  MQT_NA_QDMI_Operation_impl_d(std::string name, size_t numParameters,
+                               size_t numQubits, uint64_t duration,
+                               double fidelity, MQT_NA_QDMI_Site zone);
+  /// @brief Constructor for the global multi-qubit operations.
+  MQT_NA_QDMI_Operation_impl_d(std::string name, size_t numParameters,
+                               size_t numQubits, uint64_t duration,
+                               double fidelity, uint64_t interactionRadius,
+                               uint64_t blockingRadius, double idlingFidelity,
+                               MQT_NA_QDMI_Site zone);
+  /// @brief Constructor for the single-qubit operations.
+  MQT_NA_QDMI_Operation_impl_d(std::string name, size_t numParameters,
+                               uint64_t duration, double fidelity,
+                               const std::vector<MQT_NA_QDMI_Site>& sites);
+  /// @brief Constructor for the multi-qubit operations.
+  MQT_NA_QDMI_Operation_impl_d(std::string name, size_t numParameters,
+                               size_t numQubits, uint64_t duration,
+                               double fidelity, uint64_t interactionRadius,
+                               uint64_t blockingRadius,
+                               const std::vector<MQT_NA_QDMI_Site>& sites);
+  /// @brief Constructor for load and store operations.
+  MQT_NA_QDMI_Operation_impl_d(std::string name, size_t numParameters,
+                               uint64_t duration, double fidelity,
+                               MQT_NA_QDMI_Site zone);
+  /// @brief Constructor for the shuttling operations.
+  MQT_NA_QDMI_Operation_impl_d(std::string name, size_t numParameters,
+                               MQT_NA_QDMI_Site zone,
+                               uint64_t meanShuttlingSpeed);
+
+  /// @brief Sort the sites such that the occurrence of a given site can be
+  /// determined in O(log n) time.
+  auto sortSites() -> void;
 
 public:
-  /// @brief Constructor for the MQT_NA_QDMI_Operation_impl_d.
-  MQT_NA_QDMI_Operation_impl_d(std::string name, Type type,
-                               size_t numParameters, size_t numQubits,
-                               double duration, double fidelity)
-      : name_(std::move(name)), type_(type), numParameters_(numParameters),
-        numQubits_(numQubits), duration_(duration), fidelity_(fidelity) {}
+  /// @brief Factory function for the global single-qubit operations.
+  [[nodiscard]] static auto
+  makeUniqueGlobalSingleQubit(const std::string& name, size_t numParameters,
+                              uint64_t duration, double fidelity,
+                              MQT_NA_QDMI_Site zone)
+      -> std::unique_ptr<MQT_NA_QDMI_Operation_impl_d>;
+  /// @brief Factory function for the global multi-qubit operations.
+  [[nodiscard]] static auto makeUniqueGlobalMultiQubit(
+      const std::string& name, size_t numParameters, size_t numQubits,
+      uint64_t duration, double fidelity, uint64_t interactionRadius,
+      uint64_t blockingRadius, double idlingFidelity, MQT_NA_QDMI_Site zone)
+      -> std::unique_ptr<MQT_NA_QDMI_Operation_impl_d>;
+  /// @brief Factory function for the local single-qubit operations.
+  [[nodiscard]] static auto
+  makeUniqueLocalSingleQubit(const std::string& name, size_t numParameters,
+                             uint64_t duration, double fidelity,
+                             const std::vector<MQT_NA_QDMI_Site>& sites)
+      -> std::unique_ptr<MQT_NA_QDMI_Operation_impl_d>;
+  /// @brief Factory function for the local multi-qubit operations.
+  [[nodiscard]] static auto makeUniqueLocalTwoQubit(
+      const std::string& name, size_t numParameters, size_t numQubits,
+      uint64_t duration, double fidelity, uint64_t interactionRadius,
+      uint64_t blockingRadius,
+      const std::vector<std::pair<MQT_NA_QDMI_Site, MQT_NA_QDMI_Site>>& sites)
+      -> std::unique_ptr<MQT_NA_QDMI_Operation_impl_d>;
+  /// @brief Factory function for the shuttling load operations.
+  [[nodiscard]] static auto
+  makeUniqueShuttlingLoad(const std::string& name, size_t numParameters,
+                          uint64_t duration, double fidelity,
+                          MQT_NA_QDMI_Site zone)
+      -> std::unique_ptr<MQT_NA_QDMI_Operation_impl_d>;
+  /// @brief Factory function for the shuttling move operations.
+  [[nodiscard]] static auto
+  makeUniqueShuttlingMove(const std::string& name, size_t numParameters,
+                          MQT_NA_QDMI_Site zone, uint64_t meanShuttlingSpeed)
+      -> std::unique_ptr<MQT_NA_QDMI_Operation_impl_d>;
+  /// @brief Factory function for the shuttling store operations.
+  [[nodiscard]] static auto
+  makeUniqueShuttlingStore(const std::string& name, size_t numParameters,
+                           uint64_t duration, double fidelity,
+                           MQT_NA_QDMI_Site zone)
+      -> std::unique_ptr<MQT_NA_QDMI_Operation_impl_d>;
 
   /**
    * @brief Queries a property of the operation.