cuda-quantum/python/runtime/common/py_EvolveResult.cpp at 6cfaef5f1c46841377a7609c63c823affd2909f5 · sacpis/cuda-quantum · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
/*******************************************************************************
 * Copyright (c) 2022 - 2025 NVIDIA Corporation & Affiliates.                  *
 * All rights reserved.                                                        *
 *                                                                             *
 * This source code and the accompanying materials are made available under    *
 * the terms of the Apache License 2.0 which accompanies this distribution.    *
 ******************************************************************************/

#include "py_EvolveResult.h"
#include "common/EvolveResult.h"
#include "cudaq/algorithms/evolve_internal.h"
#include <optional>
#include <pybind11/stl.h>

namespace py = pybind11;

namespace cudaq {
/// @brief Bind the `cudaq::evolve_result` and `cudaq::async_evolve_result`
/// data classes to python as `cudaq.EvolveResult` and
/// `cudaq.AsyncEvolveResult`.
void bindEvolveResult(py::module &mod) {
  py::class_<evolve_result>(
      mod, "EvolveResult",
      "Stores the execution data from an invocation of :func:`evolve`.\n")
      // IMPORTANT: state overloads must be provided before vector<state>
      // overloads. Otherwise, Python might try to access the __len__ of state
      // during overload resolution. __len__ is not always well-defined for all
      // state types and may raise an exception.
      .def(py::init<state>())
      .def(py::init<state, std::vector<observe_result>>())
      .def(py::init<state, std::vector<double>>())
      .def(py::init<std::vector<state>>())
      .def(py::init<std::vector<state>,
                    std::vector<std::vector<observe_result>>>())
      .def(py::init<std::vector<state>, std::vector<std::vector<double>>>())
      .def(
          "final_state",
          [](evolve_result &self) { return self.states->back(); },
          "Stores the final state produced by a call to :func:`evolve`. "
          "Represent the state of a quantum system after time evolution under "
          "a set of operators, see the :func:`evolve` documentation for more "
          "detail.\n")
      .def(
          "intermediate_states",
          [](evolve_result &self) { return self.states; },
          "Stores all intermediate states, meaning the state after each step "
          "in a defined schedule, produced by a call to :func:`evolve`, "
          "including the final state. This property is only populated if "
          "saving intermediate results was requested in the call to "
          ":func:`evolve`.\n")
      .def(
          "final_expectation_values",
          [](evolve_result &self) { return self.expectation_values; },
          "Stores the final expectation values, that is the results produced "
          "by "
          "calls to :func:`observe`, triggered by a call to :func:`evolve`. "
          "Each "
          "entry corresponds to one observable provided in the :func:`evolve` "
          "call. This value will be None if no observables were specified in "
          "the "
          "call.\n")
      .def(
          "expectation_values",
          [](evolve_result &self) { return self.expectation_values; },
          "Stores the expectation values, that is the results from the calls "
          "to "
          ":func:`observe`, at each step in the schedule produced by a call to "
          ":func:`evolve`, including the final expectation values. Each entry "
          "corresponds to one observable provided in the :func:`evolve` call. "
          "This property is only populated saving intermediate results was "
          "requested in the call to :func:`evolve`. This value will be None "
          "if no intermediate results were requested, or if no observables "
          "were specified in the call.\n");

  py::class_<async_evolve_result>(
      mod, "AsyncEvolveResult",
      "Stores the execution data from an invocation of :func:`evolve_async`.\n")
      .def(
          "get", [](async_evolve_result &self) { return self.get(); },
          py::call_guard<py::gil_scoped_release>(),
          "Retrieve the evolution result from the asynchronous evolve "
          "execution\n.");
}

} // namespace cudaq