🎨 pre-commit fixes

Author: pre-commit-ci[bot]

include/mqt-core/qdmi/sc/Device.hpp

@@ -48,31 +48,34 @@ class Device final {
 
 public:
   /**
- * @brief Move-constructs a Device, transferring ownership of internal resources.
- *
- * Leaves the moved-from instance in a valid but unspecified state.
- */
+   * @brief Move-constructs a Device, transferring ownership of internal
+   * resources.
+   *
+   * Leaves the moved-from instance in a valid but unspecified state.
+   */
   Device(Device&&) = default;
   /**
- * @brief Move-assigns the Device instance from another Device.
- *
- * @param other rvalue reference to the source Device to move from.
- * @return Device& Reference to this Device after move assignment.
- */
-Device& operator=(Device&&) = default;
+   * @brief Move-assigns the Device instance from another Device.
+   *
+   * @param other rvalue reference to the source Device to move from.
+   * @return Device& Reference to this Device after move assignment.
+   */
+  Device& operator=(Device&&) = default;
   /**
- * @brief Deleted copy constructor to prevent copying of the singleton Device.
- *
- * Deleting this constructor enforces the singleton pattern by disallowing copy construction.
- */
+   * @brief Deleted copy constructor to prevent copying of the singleton Device.
+   *
+   * Deleting this constructor enforces the singleton pattern by disallowing
+   * copy construction.
+   */
   Device(const Device&) = delete;
   /**
- * @brief Deleted copy assignment operator to prevent copying of the Device singleton.
- *
- * The Device class is non-copyable; assigning from another Device is disallowed to
- * preserve the singleton semantics and unique device state.
- */
-Device& operator=(const Device&) = delete;
+   * @brief Deleted copy assignment operator to prevent copying of the Device
+   * singleton.
+   *
+   * The Device class is non-copyable; assigning from another Device is
+   * disallowed to preserve the singleton semantics and unique device state.
+   */
+  Device& operator=(const Device&) = delete;
 
   /**
    * @brief Accesses the singleton Device instance.
@@ -187,10 +190,11 @@ struct MQT_SC_QDMI_Device_Job_impl_d {
 
 public:
   /**
-       * @brief Initializes a device job implementation bound to the given session.
-       *
-       * @param session Pointer to the owning MQT_SC_QDMI_Device_Session_impl_d. The session must remain valid for the job's lifetime.
-       */
+   * @brief Initializes a device job implementation bound to the given session.
+   *
+   * @param session Pointer to the owning MQT_SC_QDMI_Device_Session_impl_d. The
+   * session must remain valid for the job's lifetime.
+   */
   explicit MQT_SC_QDMI_Device_Job_impl_d(
       MQT_SC_QDMI_Device_Session_impl_d* session)
       : session_(session) {}
@@ -260,10 +264,10 @@ struct MQT_SC_QDMI_Site_impl_d {
   uint64_t id_ = 0; ///< Unique identifier of the site
 
   /**
- * @brief Initializes a site implementation with the given unique identifier.
- *
- * @param id Unique identifier for the site.
- */
+   * @brief Initializes a site implementation with the given unique identifier.
+   *
+   * @param id Unique identifier for the site.
+   */
   MQT_SC_QDMI_Site_impl_d(uint64_t id) : id_(id) {}
 
 public:
@@ -299,4 +303,4 @@ struct MQT_SC_QDMI_Operation_impl_d {
                      size_t numParams, const double* params,
                      QDMI_Operation_Property prop, size_t size, void* value,
                      size_t* sizeRet) const -> int;
-};
+};

src/na/device/Device.cpp

@@ -91,10 +91,11 @@
 
 namespace qdmi::na {
 /**
- * @brief Constructs the device and initializes its metadata and supported entities.
+ * @brief Constructs the device and initializes its metadata and supported
+ * entities.
  *
- * Initializes the device name, number of qubits, minimum atom distance, length and
- * duration units/scale factors, and populates the site and operation lists.
+ * Initializes the device name, number of qubits, minimum atom distance, length
+ * and duration units/scale factors, and populates the site and operation lists.
  */
 Device::Device() {
   // NOLINTBEGIN(cppcoreguidelines-prefer-member-initializer)
@@ -187,13 +188,7 @@ auto Device::queryProperty(const QDMI_Device_Property prop, const size_t size,
                     operations_, prop, size, value, sizeRet)
   return QDMI_ERROR_NOTSUPPORTED;
 }
-} /**
- * @brief Initialize the device session by transitioning it from ALLOCATED to INITIALIZED.
- *
- * Sets the session's internal state to INITIALIZED when it is currently ALLOCATED.
- *
- * @return int `QDMI_SUCCESS` on successful initialization, `QDMI_ERROR_BADSTATE` if the session was not in the ALLOCATED state.
- */
+} // namespace qdmi::na
 
 auto MQT_NA_QDMI_Device_Session_impl_d::init() -> int {
   if (status_ != Status::ALLOCATED) {
@@ -237,10 +232,16 @@ auto MQT_NA_QDMI_Device_Session_impl_d::freeDeviceJob(
  * @brief Query a device-level property for this session.
  *
  * @param prop The device property to query.
- * @param size Size of the caller-provided buffer pointed to by `value`, in bytes.
- * @param value Pointer to a buffer to receive the property's value; may be null to query required size.
- * @param sizeRet Pointer to receive the number of bytes written or required; may be null if not needed.
- * @return int QDMI status code: `QDMI_SUCCESS` on success, `QDMI_ERROR_BADSTATE` if the session is not initialized, `QDMI_ERROR_NOTSUPPORTED` if the property is not supported, or other QDMI error codes on failure.
+ * @param size Size of the caller-provided buffer pointed to by `value`, in
+ * bytes.
+ * @param value Pointer to a buffer to receive the property's value; may be null
+ * to query required size.
+ * @param sizeRet Pointer to receive the number of bytes written or required;
+ * may be null if not needed.
+ * @return int QDMI status code: `QDMI_SUCCESS` on success,
+ * `QDMI_ERROR_BADSTATE` if the session is not initialized,
+ * `QDMI_ERROR_NOTSUPPORTED` if the property is not supported, or other QDMI
+ * error codes on failure.
  */
 auto MQT_NA_QDMI_Device_Session_impl_d::queryDeviceProperty(
     const QDMI_Device_Property prop, const size_t size, void* value,
@@ -258,11 +259,14 @@ auto MQT_NA_QDMI_Device_Session_impl_d::queryDeviceProperty(
  * @param site Site handle to query; must not be `nullptr`.
  * @param prop Property to query.
  * @param size Size of the buffer pointed to by `value`, in bytes.
- * @param value Output buffer for the property value; may be `nullptr` to obtain required size.
- * @param sizeRet Receives the number of bytes written or required; may be `nullptr` if not needed.
+ * @param value Output buffer for the property value; may be `nullptr` to obtain
+ * required size.
+ * @param sizeRet Receives the number of bytes written or required; may be
+ * `nullptr` if not needed.
  * @return int `QDMI_ERROR_INVALIDARGUMENT` if `site` is `nullptr`.
  * `QDMI_ERROR_BADSTATE` if the session is not initialized.
- * Otherwise, returns the status code produced while retrieving the site's property. 
+ * Otherwise, returns the status code produced while retrieving the site's
+ * property.
  */
 auto MQT_NA_QDMI_Device_Session_impl_d::querySiteProperty(
     MQT_NA_QDMI_Site site, const QDMI_Site_Property prop, const size_t size,
@@ -598,26 +602,31 @@ auto MQT_NA_QDMI_Operation_impl_d::queryProperty(
   }
   if (fidelity_) {
     /**
- * @brief Query an operation property for the specified sites and parameters.
- *
- * Validates the provided site pointers and parameter pointers, checks that the
- * supplied sites are compatible with this operation (including ordering for
- * two-qubit operations), and writes the requested property into the provided
- * buffer if supported.
- *
- * @param numSites Number of sites in `sites`.
- * @param sites Pointer to an array of site handles to query against.
- * @param numParams Number of numeric parameters in `params`.
- * @param params Pointer to an array of parameter values (may be nullptr if none).
- * @param prop The operation property to query.
- * @param size Size of the `value` buffer in bytes.
- * @param value Buffer to receive the property value (may be nullptr to query required size).
- * @param sizeRet If non-null, receives the number of bytes written or required.
- * @return int `QDMI_ERROR_SUCCESS` if the property was written to `value`;
- * `QDMI_ERROR_NOTSUPPORTED` if the property or the supplied site/parameter
- * combination is not supported; `QDMI_ERROR_BADARG` for invalid input arguments.
- */
-ADD_SINGLE_VALUE_PROPERTY(QDMI_OPERATION_PROPERTY_FIDELITY, double,
+     * @brief Query an operation property for the specified sites and
+     * parameters.
+     *
+     * Validates the provided site pointers and parameter pointers, checks that
+     * the supplied sites are compatible with this operation (including ordering
+     * for two-qubit operations), and writes the requested property into the
+     * provided buffer if supported.
+     *
+     * @param numSites Number of sites in `sites`.
+     * @param sites Pointer to an array of site handles to query against.
+     * @param numParams Number of numeric parameters in `params`.
+     * @param params Pointer to an array of parameter values (may be nullptr if
+     * none).
+     * @param prop The operation property to query.
+     * @param size Size of the `value` buffer in bytes.
+     * @param value Buffer to receive the property value (may be nullptr to
+     * query required size).
+     * @param sizeRet If non-null, receives the number of bytes written or
+     * required.
+     * @return int `QDMI_ERROR_SUCCESS` if the property was written to `value`;
+     * `QDMI_ERROR_NOTSUPPORTED` if the property or the supplied site/parameter
+     * combination is not supported; `QDMI_ERROR_BADARG` for invalid input
+     * arguments.
+     */
+    ADD_SINGLE_VALUE_PROPERTY(QDMI_OPERATION_PROPERTY_FIDELITY, double,
                               *fidelity_, prop, size, value, sizeRet)
   }
   if (numQubits_) {
@@ -634,7 +643,8 @@ ADD_SINGLE_VALUE_PROPERTY(QDMI_OPERATION_PROPERTY_FIDELITY, double,
 }
 
 /**
- * @brief Initializes the NA QDMI device subsystem by ensuring the Device singleton exists.
+ * @brief Initializes the NA QDMI device subsystem by ensuring the Device
+ * singleton exists.
  *
  * @return QDMI_SUCCESS on success.
  */
@@ -644,9 +654,11 @@ int MQT_NA_QDMI_device_initialize() {
 }
 
 /**
- * @brief Finalizes the NA QDMI device subsystem and releases any global resources.
+ * @brief Finalizes the NA QDMI device subsystem and releases any global
+ * resources.
  *
- * Performs any final cleanup required by the device subsystem prior to library unload.
+ * Performs any final cleanup required by the device subsystem prior to library
+ * unload.
  *
  * @return int `QDMI_SUCCESS` on success.
  */
@@ -655,8 +667,10 @@ int MQT_NA_QDMI_device_finalize() { return QDMI_SUCCESS; }
 /**
  * @brief Allocates a new device session and returns its handle.
  *
- * @param session Pointer to storage that receives the new MQT_NA_QDMI_Device_Session handle; must not be null.
- * @return int Status code indicating success or failure. On success the out-parameter `session` is set to the allocated session handle.
+ * @param session Pointer to storage that receives the new
+ * MQT_NA_QDMI_Device_Session handle; must not be null.
+ * @return int Status code indicating success or failure. On success the
+ * out-parameter `session` is set to the allocated session handle.
  */
 int MQT_NA_QDMI_device_session_alloc(MQT_NA_QDMI_Device_Session* session) {
   return qdmi::na::Device::get().sessionAlloc(session);
@@ -666,7 +680,8 @@ int MQT_NA_QDMI_device_session_alloc(MQT_NA_QDMI_Device_Session* session) {
  * @brief Initializes a device session.
  *
  * @param session Pointer to an allocated device session handle.
- * @return int QDMI_SUCCESS on success; QDMI_ERROR_INVALIDARGUMENT if `session` is null; otherwise the status code returned by the session initialization.
+ * @return int QDMI_SUCCESS on success; QDMI_ERROR_INVALIDARGUMENT if `session`
+ * is null; otherwise the status code returned by the session initialization.
  */
 int MQT_NA_QDMI_device_session_init(MQT_NA_QDMI_Device_Session session) {
   if (session == nullptr) {
@@ -694,7 +709,8 @@ void MQT_NA_QDMI_device_session_free(MQT_NA_QDMI_Device_Session session) {
  * @param param Identifier of the session parameter to set.
  * @param size Size in bytes of the data pointed to by `value`.
  * @param value Pointer to the parameter data.
- * @return int QDMI status code: `QDMI_ERROR_INVALIDARGUMENT` if `session` is null; otherwise the status returned by the session implementation.
+ * @return int QDMI status code: `QDMI_ERROR_INVALIDARGUMENT` if `session` is
+ * null; otherwise the status returned by the session implementation.
  */
 int MQT_NA_QDMI_device_session_set_parameter(
     MQT_NA_QDMI_Device_Session session, QDMI_Device_Session_Parameter param,
@@ -839,4 +855,4 @@ int MQT_NA_QDMI_device_session_query_operation_property(
   }
   return session->queryOperationProperty(operation, numSites, sites, numParams,
                                          params, prop, size, value, sizeRet);
-}
+}

src/qdmi/Driver.cpp

@@ -81,16 +81,19 @@ DEFINE_STATIC_LIBRARY(MQT_SC)
 
 #ifndef _WIN32
 /**
- * @brief Load a device shared library, bind required QDMI symbols using the given prefix, and initialize the device.
+ * @brief Load a device shared library, bind required QDMI symbols using the
+ * given prefix, and initialize the device.
  *
- * Opens the shared library specified by libName, resolves the set of required QDMI symbols named using
- * the pattern "<prefix>_QDMI_<symbol>", and calls the library's initialize function.
+ * Opens the shared library specified by libName, resolves the set of required
+ * QDMI symbols named using the pattern "<prefix>_QDMI_<symbol>", and calls the
+ * library's initialize function.
  *
  * @param libName Path or filename of the shared library to load.
- * @param prefix Symbol name prefix used to construct exported QDMI symbol names (e.g., prefix_QDMI_device_initialize).
+ * @param prefix Symbol name prefix used to construct exported QDMI symbol names
+ * (e.g., prefix_QDMI_device_initialize).
  *
- * @throws std::runtime_error If the library cannot be opened, if the library is already loaded,
- *         or if any required symbol cannot be resolved.
+ * @throws std::runtime_error If the library cannot be opened, if the library is
+ * already loaded, or if any required symbol cannot be resolved.
  */
 DynamicDeviceLibrary::DynamicDeviceLibrary(const std::string& libName,
                                            const std::string& prefix)
@@ -363,7 +366,8 @@ Driver::Driver() {
 /**
  * @brief Releases all resources owned by the Driver.
  *
- * Destroys and removes all managed session and device objects so the Driver releases its held resources.
+ * Destroys and removes all managed session and device objects so the Driver
+ * releases its held resources.
  */
 Driver::~Driver() {
   sessions_.clear();
@@ -531,4 +535,4 @@ int QDMI_device_query_operation_property(
   }
   return device->queryOperationProperty(operation, numSites, sites, numParams,
                                         params, prop, size, value, sizeRet);
-}
+}