BackendWrapper.h

Go to the documentation of this file.

/*
 * Copyright (c) 2026 MQSS Maintainers
 * All rights reserved.
 *
 * SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 */

 
#pragma once
 
#include "mqss/Protocol.hpp"
#include "qrmci/CircuitFormatPolicy.h"
#include "qrmci/ConstantsMapping.h"
#include "qrmci/Error.h"
 
#include <MQSSCIInterfaces/MQSSCompiler.h>
#include <algorithm>
#include <cstddef>
#include <cstdint>
#include <expected>
#include <iterator>
#include <string>
#include <string_view>
#include <utility>
#include <vector>
 
namespace mqss::submitter {
class Device;
} // namespace mqss::submitter
 
namespace mqss::qrmci::test {
class BackendBuilder;
} // namespace mqss::qrmci::test
 
namespace mqss::qrmci {

class BackendWrapper {
 
public:
  BackendWrapper() = default;
  BackendWrapper(const BackendWrapper &) = default;
  BackendWrapper(BackendWrapper &&) = default;
  BackendWrapper &operator=(const BackendWrapper &) = default;
  BackendWrapper &operator=(BackendWrapper &&) = default;

  [[nodiscard]] static std::expected<BackendWrapper, Error>
  fromSubmitter(const mqss::submitter::Device &device,
                std::string_view dispatchQueue = "");

  [[nodiscard]] static std::expected<BackendWrapper, Error>
  fromPublishedStatus(const mqss::Backend &backend);

  [[nodiscard]] mqss::Backend toBackend() const;

  [[nodiscard]] bool isOnline() const noexcept;

  [[nodiscard]] bool canRun(const mqss::QuantumTask &task) const;

  [[nodiscard]] std::expected<CompilerTarget, Error> compilerTarget() const;

  [[nodiscard]] const std::string &getName() const noexcept { return name; }
  [[nodiscard]] std::uint32_t getNumQubits() const noexcept {
    return numQubits;
  }

  [[nodiscard]] mqss::BackendStatus getStatus() const noexcept {
    return status;
  }

  [[nodiscard]] const std::vector<std::string> &
  getInstructions() const noexcept {
    return instructions;
  }

  [[nodiscard]] const std::vector<std::pair<std::uint32_t, std::uint32_t>> &
  getQubitConnectivity() const noexcept {
    return qubitConnectivity;
  }

  [[nodiscard]] const std::vector<mqss::CircuitFormat> &
  getSupportedCircuitFormats() const noexcept {
    return supportedCircuitFormats;
  }

  [[nodiscard]] const std::string &getQueueName() const noexcept {
    return queueName;
  }
 
private:
  explicit BackendWrapper(const mqss::Backend &backend);
 
  friend class mqss::qrmci::test::BackendBuilder;
 
  std::string name;
  std::uint32_t numQubits{};
  mqss::BackendType type{};
  mqss::BackendStatus status{};
  std::uint32_t queueLength{};
  float currentLoad{};
  std::string queueName;
  std::vector<std::string> instructions;
  std::vector<std::pair<std::uint32_t, std::uint32_t>> qubitConnectivity;
  std::vector<mqss::CircuitFormat> supportedCircuitFormats;
};
} // namespace mqss::qrmci