Runners.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 "qrmci/BackendRegistry.h"
#include "qrmci/BackendWrapper.h"
#include "qrmci/ConstantsMapping.h"
#include "qrmci/Error.h"
 
#include <MQSSCIInterfaces/MQSSCompiler.h>
#include <atomic>
#include <chrono>
#include <expected>
#include <mqss/submitter/Job.h>
#include <optional>
#include <string>
#include <vector>
 
namespace mqss::submitter {
class Device;
} // namespace mqss::submitter
 
namespace mqss::qrmci {

[[nodiscard]] std::expected<std::string, Error> chooseBackend(
    const mqss::QuantumTask &task, const BackendRegistry &availableBackends,
    BackendSelectionPolicy policy = BackendSelectionPolicy::LowestName);

[[nodiscard]] std::expected<void, Error>
compileQuantumTask(mqss::QuantumTask &task, const BackendWrapper &backendInfo,
                   mqss::mqssci::MQSSCompiler &compiler);

[[nodiscard]] std::expected<void, Error>
compileQuantumTask(mqss::QuantumTask &task, const BackendWrapper &backendInfo);

[[nodiscard]] std::expected<mqss::QuantumResult, Error> buildQuantumResult(
    const mqss::QuantumTask &task,
    const std::vector<std::optional<mqss::submitter::Counts>> &histogram);

[[nodiscard]] std::expected<std::vector<mqss::submitter::Job>, Error>
submitQuantumTask(const mqss::QuantumTask &task,
                  const mqss::submitter::Device &device);

[[nodiscard]] std::expected<std::vector<mqss::submitter::Job>, Error>
submitQuantumTask(const mqss::QuantumTask &task,
                  const mqss::submitter::Device &device,
                  const std::atomic<bool> &terminationFlag);

[[nodiscard]] std::expected<mqss::QuantumResult, Error>
collectQuantumResult(const mqss::QuantumTask &task,
                     std::vector<mqss::submitter::Job> &jobs,
                     std::chrono::seconds waitTimeout);

[[nodiscard]] std::expected<mqss::QuantumResult, Error> collectQuantumResult(
    const mqss::QuantumTask &task, std::vector<mqss::submitter::Job> &jobs,
    std::chrono::seconds waitTimeout, const std::atomic<bool> &terminationFlag);

[[nodiscard]] std::expected<mqss::QuantumResult, Error>
executeQuantumTask(const mqss::QuantumTask &task,
                   const mqss::submitter::Device &device,
                   std::chrono::seconds waitTimeout);

[[nodiscard]] std::expected<mqss::QuantumResult, Error> executeQuantumTask(
    const mqss::QuantumTask &task, const mqss::submitter::Device &device,
    std::chrono::seconds waitTimeout, const std::atomic<bool> &terminationFlag);

[[nodiscard]] mqss::QuantumResult
cancelQuantumTask(const mqss::QuantumTask &task,
                  const std::string &cancelReason);
 
} // namespace mqss::qrmci