✨ C-bindings Implementations

.clang-tidy

@@ -30,8 +30,6 @@ Checks: |
 CheckOptions:
   - key: readability-identifier-naming.ClassCase
     value: CamelCase
-  - key: readability-identifier-naming.ClassIgnoredRegexp
-    value: ".*ZX.*|.*SWAP.*|.*CEX.*|.*DD.*|.*EQ.*"
   - key: readability-identifier-naming.ConstantParameterCase
     value: camelBack
   - key: readability-identifier-naming.EnumCase
@@ -41,7 +39,7 @@ CheckOptions:
   - key: readability-identifier-naming.FunctionCase
     value: camelBack
   - key: readability-identifier-naming.FunctionIgnoredRegexp
-    value: ".*ZX.*|.*SWAP.*|.*CEX.*|.*DD.*|.*EQ.*"
+    value: ".*MQSS.*
   - key: readability-identifier-naming.GlobalConstantCase
     value: UPPER_CASE
   - key: readability-identifier-naming.IgnoreMainLikeFunctions

CMakeLists.txt

@@ -22,7 +22,7 @@ project(
   MQSS-Client
   VERSION 0.1
   DESCRIPTION "MQSS Client"
-  LANGUAGES CXX)
+  LANGUAGES CXX C)
 
 # Generate compile_commands.json to make it easier to work with clang based tools
 set(CMAKE_EXPORT_COMPILE_COMMANDS
@@ -33,6 +33,7 @@ option(BUILD_TESTS "Build the tests" OFF)
 option(BUILD_UNIT_TESTS "Build the unit tests" OFF)
 option(BUILD_INTEGRATION_TESTS "Build the unit tests" OFF)
 option(ENABLE_COVERAGE "Enabling coverage" OFF)
+option(BUILD_BINDINGS "Build Python Bindings" OFF)
 
 list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake")
 

bindings/job.cpp

@@ -66,10 +66,10 @@ void registerJobInterface(const py::module& m) {
 
   py::class_<mqss::client::JobResult>(m, "JobResult")
       .def_property_readonly("results", &mqss::client::JobResult::getResults)
-      .def_property_readonly("completion_timestamp",
+      .def_property_readonly("timestamp_completed",
                              &mqss::client::JobResult::getTimestampCompleted)
-      .def_property_readonly("submission_timestamp",
+      .def_property_readonly("timestamp_submitted",
                              &mqss::client::JobResult::getTimestampSubmitted)
-      .def_property_readonly("scheduled_timestamp",
+      .def_property_readonly("timestamp_scheduled",
                              &mqss::client::JobResult::getTimestampScheduled);
 }

bindings/resource.cpp

@@ -34,8 +34,10 @@ void registerResourceInterface(const py::module& m) {
 
   py::class_<mqss::client::Gate>(m, "Gate")
       .def_property_readonly("name", &mqss::client::Gate::getName)
-      .def_property_readonly("qubit_number", &mqss::client::Gate::getQubitNumber)
-      .def_property_readonly("parameter_number", &mqss::client::Gate::getParameterNumber)
+      .def_property_readonly("qubit_number",
+                             &mqss::client::Gate::getQubitNumber)
+      .def_property_readonly("parameter_number",
+                             &mqss::client::Gate::getParameterNumber)
       .def_property_readonly("supported_qubits",
                              &mqss::client::Gate::getSupportedQubits);
 }

include/mqss-c/client.h

@@ -0,0 +1,47 @@
+/*
+ * Copyright (c) 2024 - 2026 MQSS Project
+ * All rights reserved.
+ *
+ * Licensed under the Apache License v2.0 with LLVM Exceptions (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://llvm.org/LICENSE.txt
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations under
+ * the License.
+ *
+ * SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+ */
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+#include "job.h"
+#include "resource.h"
+
+#include <stdbool.h>
+
+typedef struct MQSSOpaqueClient* MQSSClientRef;
+
+MQSSClientRef MQSSClientCreateClient(char* token, char* urlOrQueue, bool isHpc);
+
+MQSSResourceRef* MQSSClientGetAllResources(MQSSClientRef client, int* size);
+
+MQSSResourceRef MQSSClientGetResourceInfo(MQSSClientRef client,
+                                          char* resourceName);
+
+int MQSSClientSubmitJob(MQSSClientRef client, MQSSJobRef job);
+
+void MQSSClientCancelJob(MQSSClientRef client, MQSSJobRef job);
+
+MQSSJobResultRef MQSSClientGetJobResult(MQSSClientRef client, MQSSJobRef job,
+                                        bool wait, unsigned int timeout);
+
+int MQSSClientGetNumberPendingJobs(MQSSClientRef client, char* resourceName);
+#ifdef __cplusplus
+}
+#endif

include/mqss-c/job.h

@@ -0,0 +1,51 @@
+/*
+ * Copyright (c) 2024 - 2026 MQSS Project
+ * All rights reserved.
+ *
+ * Licensed under the Apache License v2.0 with LLVM Exceptions (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://llvm.org/LICENSE.txt
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations under
+ * the License.
+ *
+ * SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+ */
+
+#include <stdint.h>
+#ifdef __cplusplus
+extern "C" {
+#endif
+#include <stdbool.h>
+typedef struct MQSSOpaqueJob* MQSSJobRef;
+
+typedef struct MQSSOpaqueJobResult* MQSSJobResultRef;
+
+MQSSJobRef MQSSClientCreateCircuitJob(char* circuit, char* circuitFormat,
+                                      char* resourceName, unsigned int shots,
+                                      bool noModify, bool queued);
+
+MQSSJobRef MQSSClientCreateHamiltonianJob(char* resourceName,
+                                          char* interactionStr,
+                                          char* coefficientsStr);
+
+int MQSSClientGetJobResultCounts(MQSSJobResultRef jobResult, char*** bitstreams,
+                                 int** counts, int* size);
+
+int MQSSClientGetJobResultCompletedTimestamp(MQSSJobResultRef jobResult,
+                                             uint64_t* completedTimestamp);
+
+int MQSSClientGetJobResultSubmittedTimestamp(MQSSJobResultRef jobResult,
+                                             uint64_t* submittedTimestamp);
+
+int MQSSClientGetJobResultScheduledTimestamp(MQSSJobResultRef jobResult,
+                                             uint64_t* scheduledTimestamp);
+
+#ifdef __cplusplus
+}
+#endif

include/mqss-c/resource.h

@@ -0,0 +1,43 @@
+/*
+ * Copyright (c) 2024 - 2026 MQSS Project
+ * All rights reserved.
+ *
+ * Licensed under the Apache License v2.0 with LLVM Exceptions (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://llvm.org/LICENSE.txt
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations under
+ * the License.
+ *
+ * SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+ */
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+#include <stdbool.h>
+
+typedef struct MQSSOpaqueResource* MQSSResourceRef;
+
+typedef struct MQSSOpaqueGate* MQSSGateRef;
+
+int MQSSClientResourceGetInfo(MQSSResourceRef resource, char** name,
+                              unsigned* qubitCount, bool* online,
+                              int** couplingMap, unsigned int* couplingMapSize,
+                              MQSSGateRef** nativeGateset,
+                              unsigned int* gateCount);
+
+int MQSSClientResourceGetGateInfo(MQSSGateRef gate, char** name,
+                                  unsigned* qubitNumber,
+                                  unsigned* parameterNumber,
+                                  int** supportedQubits,
+                                  unsigned int* supportedQubitCount);
+
+#ifdef __cplusplus
+}
+#endif

include/mqss/client.h

@@ -32,6 +32,14 @@
 
 #define MQP_DEFAULT_URL "https://portal.quantum.lrz.de:4000/v1/"
 
+template <typename T, typename RefT> inline T* unwrap(RefT ref) {
+  return reinterpret_cast<T*>(ref);
+}
+
+template <typename RefT, typename T> inline RefT wrap(T* ptr) {
+  return reinterpret_cast<RefT>(ptr);
+}
+
 namespace mqss::client {
 
 class MQSSBaseClient {

include/mqss/resource.h

@@ -33,6 +33,12 @@ class Gate {
         mParameterNumber(parameterNumber),
         mSupportedQubits(std::move(supportedQubits)) {}
 
+  Gate(const Gate&) = default;
+  Gate& operator=(const Gate&) = default;
+
+  Gate(Gate&&) = default;
+  Gate& operator=(Gate&&) = default;
+
   const std::string& getName() const noexcept { return mName; }
 
   const unsigned int& getQubitNumber() const noexcept { return mQubitNumber; }
@@ -69,9 +75,7 @@ class Resource {
     return mCouplingMap;
   }
 
-  const std::vector<Gate>& getNativeGateset() const noexcept {
-    return mNativeGateset;
-  }
+  std::vector<Gate>& getNativeGateset() { return mNativeGateset; }
 
 private:
   std::string mName;

src/client.cpp

@@ -21,6 +21,7 @@
 
 #include "clients/hpc_client.h"
 #include "clients/rest_client.h"
+#include "mqss-c/client.h"
 
 #include <chrono>
 #include <optional>
@@ -139,3 +140,60 @@ int MQSSClient::getNumberPendingJobs(const std::string& resource) const {
 
   return parsed.value("num_pending_jobs", -1);
 }
+
+MQSSClientRef MQSSClientCreateClient(char* token, char* urlOrQueue,
+                                     bool isHpc) {
+
+  return wrap<MQSSClientRef>(new MQSSClient(token, urlOrQueue, isHpc));
+}
+MQSSResourceRef* MQSSClientGetAllResources(MQSSClientRef client, int* size) {
+  auto resources_ = unwrap<MQSSClient>(client)->getAllResources();
+
+  auto resources =
+      (MQSSResourceRef*)malloc(resources_.size() * sizeof(MQSSResourceRef));
+
+  for (size_t i = 0; i < resources_.size(); ++i) {
+    resources[i] = wrap<MQSSResourceRef>(new Resource(resources_[i]));
+  }
+
+  *size = (int)resources_.size();
+  return resources;
+}
+
+MQSSResourceRef MQSSClientGetResourceInfo(MQSSClientRef client,
+                                          const char* resourceName) {
+  if (!resourceName)
+    return nullptr;
+
+  auto resource = unwrap<MQSSClient>(client)->getResourceInfo(resourceName);
+  if (!resource)
+    return nullptr;
+
+  return wrap<MQSSResourceRef>(new Resource(*resource));
+}
+int MQSSClientSubmitJob(MQSSClientRef client, MQSSJobRef job) {
+  auto uuid =
+      unwrap<MQSSClient>(client)->submitJob(*unwrap<CircuitJobRequest>(job));
+  if (!uuid.has_value()) {
+    return -1;
+  }
+  return std::stoi(*uuid);
+}
+
+void MQSSClientCancelJob(MQSSClientRef client, MQSSJobRef job) {
+  unwrap<MQSSClient>(client)->cancelJob(*unwrap<CircuitJobRequest>(job));
+}
+
+MQSSJobResultRef MQSSClientGetJobResult(MQSSClientRef client, MQSSJobRef job,
+                                        bool wait, unsigned int timeout) {
+
+  std::unique_ptr<JobResult> jobResult =
+      unwrap<MQSSClient>(client)->getJobResult(*unwrap<CircuitJobRequest>(job),
+                                               wait, timeout);
+  return wrap<MQSSJobResultRef>(jobResult.release());
+}
+
+int MQSSClientGetNumberPendingJobs(MQSSClientRef client, char* resourceName) {
+
+  return unwrap<MQSSClient>(client)->getNumberPendingJobs(resourceName);
+}