xacc-py.cpp 25.7 KB
Newer Older
1
2
3
4
5
6
/*******************************************************************************
 * Copyright (c) 2018 UT-Battelle, LLC.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * and Eclipse Distribution License v1.0 which accompanies this
 * distribution. The Eclipse Public License is available at
7
8
 * http://www.eclipse.org/legal/epl-v10.html and the Eclipse Distribution
 *License is available at https://eclipse.org/org/documents/edl-v10.php
9
10
11
12
 *
 * Contributors:
 *   Alexander J. McCaskey - initial API and implementation
 *******************************************************************************/
13
#include "XACC.hpp"
14
#include "IRGenerator.hpp"
15
16
#include "IRProvider.hpp"
#include "InstructionIterator.hpp"
17
#include "AcceleratorBuffer.hpp"
18
#include "AcceleratorDecorator.hpp"
19
#include "InstructionParameter.hpp"
20

21
#include <pybind11/complex.h>
22
#include <pybind11/numpy.h>
23
24
25
26
27
28
29
30
31
#include <pybind11/stl.h>
#include <pybind11/stl_bind.h>
#include <pybind11/eigen.h>
#include <pybind11/iostream.h>
#include <pybind11/operators.h>

namespace py = pybind11;
using namespace xacc;

32
// `boost::variant` as an example -- can be any `std::variant`-like container
33
34
namespace pybind11 {
namespace detail {
35
36
37
38
39
40
41
42
43
44
45
46
template <typename... Ts>
struct type_caster<Variant<Ts...>> : variant_caster<Variant<Ts...>> {};

// Specifies the function used to visit the variant -- `apply_visitor` instead
// of `visit`
template <> struct visit_helper<Variant> {
  template <typename... Args>
  static auto call(Args &&... args) -> decltype(boost::apply_visitor(args...)) {
    return boost::apply_visitor(args...);
  }
};

47
48
49
50
51
52
53
54
55
56
57
58
59
60
template <typename... Ts>
struct type_caster<boost::variant<Ts...>>
    : variant_caster<boost::variant<Ts...>> {};

// Specifies the function used to visit the variant -- `apply_visitor` instead
// of `visit`
template <> struct visit_helper<boost::variant> {
  template <typename... Args>
  static auto call(Args &&... args) -> decltype(boost::apply_visitor(args...)) {
    return boost::apply_visitor(args...);
  }
};
} // namespace detail
} // namespace pybind11
61

62
63
class PyAccelerator : public xacc::Accelerator {
public:
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
  /* Inherit the constructors */
  using Accelerator::Accelerator;

  const std::string name() const override {
    PYBIND11_OVERLOAD_PURE(const std::string, xacc::Accelerator, name);
  }

  const std::string description() const override { return ""; }

  void initialize() override { return; }

  AcceleratorType getType() override {
    return Accelerator::AcceleratorType::qpu_gate;
  }

  std::vector<std::shared_ptr<IRTransformation>>
  getIRTransformations() override {
    return {};
  }

  bool isValidBufferSize(const int n) override { return true; }

  /* Trampoline (need one for each virtual function) */
  void execute(std::shared_ptr<xacc::AcceleratorBuffer> buf,
               std::shared_ptr<xacc::Function> f) override {
    PYBIND11_OVERLOAD_PURE(void, xacc::Accelerator, execute, buf, f);
  }

  std::vector<std::shared_ptr<AcceleratorBuffer>>
  execute(std::shared_ptr<AcceleratorBuffer> buffer,
          const std::vector<std::shared_ptr<Function>> functions) override {
    return {};
  }

  std::shared_ptr<AcceleratorBuffer>
  createBuffer(const std::string &varId) override {
    return std::make_shared<AcceleratorBuffer>(varId, 100);
  }

  std::shared_ptr<AcceleratorBuffer> createBuffer(const std::string &varId,
                                                  const int size) override {
    return std::make_shared<AcceleratorBuffer>(varId, size);
  }
107
108
};

109
PYBIND11_MODULE(_pyxacc, m) {
110
111
112
113
  m.doc() =
      "Python bindings for XACC. XACC provides a plugin infrastructure for "
      "programming, compiling, and executing quantum kernels in a language and "
      "hardware agnostic manner.";
114

115
116
117
118
119
120
121
122
  py::class_<xacc::InstructionParameter>(
      m, "InstructionParameter",
      "The InstructionParameter provides a variant structure "
      "to provide parameters to XACC Instructions at runtime. "
      "This type can be an int, double, float, string, or complex value.")
      .def(py::init<int>(), "Construct as an int.")
      .def(py::init<double>(), "Construct as a double.")
      .def(py::init<std::string>(), "Construct as a string.")
123
      .def(py::init<std::complex<double>>(), "Construct as a complex double.");
124
125
126
127

  py::class_<xacc::Instruction, std::shared_ptr<xacc::Instruction>>(
      m, "Instruction", "")
      .def("nParameters", &xacc::Instruction::nParameters, "")
128
129
130
131
132
133
134
135
      .def("toString",
           (const std::string (xacc::Instruction::*)()) &
               xacc::Instruction::toString,
           "")
      .def("toString",
           (const std::string (xacc::Instruction::*)(const std::string &)) &
               xacc::Instruction::toString,
           "")
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
      .def("isEnabled", &xacc::Instruction::isEnabled, "")
      .def("isComposite", &xacc::Instruction::isComposite, "")
      .def("bits", &xacc::Instruction::bits, "")
      .def("getParameter", &xacc::Instruction::getParameter, "")
      .def("getParameters", &xacc::Instruction::getParameters, "")
      .def("setParameter", &xacc::Instruction::setParameter, "")
      .def("mapBits", &xacc::Instruction::mapBits, "")
      .def("name", &xacc::Instruction::name, "")
      .def("description", &xacc::Instruction::description, "");

  py::class_<xacc::Function, std::shared_ptr<xacc::Function>>(m, "Function", "")
      .def("nInstructions", &xacc::Function::nInstructions, "")
      .def("getInstruction", &xacc::Function::getInstruction, "")
      .def("getInstructions", &xacc::Function::getInstructions, "")
      .def("removeInstruction", &xacc::Function::removeInstruction, "")
      .def("replaceInstruction", &xacc::Function::replaceInstruction, "")
      .def("insertInstruction", &xacc::Function::insertInstruction, "")
      .def("addInstruction", &xacc::Function::addInstruction, "")
      .def("addParameter", &xacc::Function::addParameter, "")
155
      .def("nParameters", &xacc::Function::nParameters, "")
156
157
158
159
      .def("eval", &xacc::Function::operator(), "")
      .def("name", &xacc::Function::name, "")
      .def("description", &xacc::Function::description, "")
      .def("nParameters", &xacc::Function::nParameters, "")
160
161
162
163
164
165
166
      .def("toString",
           (const std::string (xacc::Function::*)()) & xacc::Function::toString,
           "")
      .def("toString",
           (const std::string (xacc::Function::*)(const std::string &)) &
               xacc::Function::toString,
           "")
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
      .def("enabledView", &xacc::Function::enabledView, "")
      .def("enable", &xacc::Function::enable, "")
      .def("getParameter", &xacc::Function::getParameter, "")
      .def("getParameters", &xacc::Function::getParameters, "")
      .def("setParameter", &xacc::Function::setParameter, "")
      .def("depth", &xacc::Function::depth, "")
      .def("persistGraph", &xacc::Function::persistGraph, "")
      .def("mapBits", &xacc::Function::mapBits, "");

  // Expose the IR interface
  py::class_<xacc::IR, std::shared_ptr<xacc::IR>>(
      m, "IR",
      "The XACC Intermediate Representation, "
      "serves as a container for XACC Functions.")
      .def("getKernels", &xacc::IR::getKernels, "Return the kernels in this IR")
      .def("addKernel", &xacc::IR::addKernel, "");
183

184
185
186
187
  py::class_<xacc::InstructionIterator>(m, "InstructionIterator", "")
      .def(py::init<std::shared_ptr<xacc::Function>>())
      .def("hasNext", &xacc::InstructionIterator::hasNext, "")
      .def("next", &xacc::InstructionIterator::next, "");
188

189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
  py::class_<xacc::IRPreprocessor, std::shared_ptr<xacc::IRPreprocessor>>(
      m, "IRPreprocesor", "")
      .def("process", &xacc::IRPreprocessor::process, "");

  py::class_<xacc::IRTransformation, std::shared_ptr<xacc::IRTransformation>>(
      m, "IRTransformation", "")
      .def("transform", &xacc::IRTransformation::transform, "");

  py::class_<xacc::AcceleratorBufferPostprocessor,
             std::shared_ptr<xacc::AcceleratorBufferPostprocessor>>(
      m, "AcceleratorBufferPostprocessor", "")
      .def("process", &xacc::AcceleratorBufferPostprocessor::process, "");

  py::class_<xacc::IRGenerator, std::shared_ptr<xacc::IRGenerator>>(
      m, "IRGenerator", "")
      .def("generate",
           (std::shared_ptr<xacc::Function>(xacc::IRGenerator::*)(
               std::vector<xacc::InstructionParameter>)) &
               xacc::IRGenerator::generate,
           py::return_value_policy::reference, "")
      .def("generate",
           (std::shared_ptr<xacc::Function>(xacc::IRGenerator::*)(
               std::map<std::string, xacc::InstructionParameter>)) &
               xacc::IRGenerator::generate,
213
214
           py::return_value_policy::reference, "")
      .def("analyzeResults", &xacc::IRGenerator::analyzeResults, "");
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256

  // Expose the Kernel
  py::class_<xacc::Kernel<>, std::shared_ptr<xacc::Kernel<>>>(
      m, "Kernel",
      "The XACC Kernel is the "
      "executable functor that executes XACC IR on the desired Accelerator.")
      .def("getIRFunction", &xacc::Kernel<>::getIRFunction,
           py::return_value_policy::reference,
           "Return the IR Function instance this Kernel wraps.")
      .def("execute",
           (void (xacc::Kernel<>::*)(std::shared_ptr<xacc::AcceleratorBuffer>,
                                     std::vector<xacc::InstructionParameter>)) &
               xacc::Kernel<>::operator(),
           "Execute this Kernel with the given set of "
           "InstructionParamters. This set can be empty "
           "if there are no parameters.");

  py::class_<xacc::KernelList<>>(
      m, "KernelList",
      "The XACC KernelList is a vector of "
      "Kernels that provides a operator() implementation to execute multiple "
      "kernels at once.")
      .def(
          "execute",
          (std::vector<std::shared_ptr<xacc::AcceleratorBuffer>>(
              xacc::KernelList<>::*)(std::shared_ptr<xacc::AcceleratorBuffer>,
                                     std::vector<xacc::InstructionParameter>)) &
              xacc::KernelList<>::operator(),
          "Execute a list of Kernels at once.")
      .def("__getitem__",
           [](const xacc::KernelList<> &kl, int i) -> xacc::Kernel<> {
             if (i >= kl.size())
               throw py::index_error();
             return kl[i];
           })
      .def("__setitem__",
           [](xacc::KernelList<> &kl, size_t i, xacc::Kernel<> v) {
             if (i >= kl.size())
               throw py::index_error();
             kl[i] = v;
           })
      .def("__len__", &xacc::KernelList<>::size)
257
258
259
260
261
262
      .def(
          "__iter__",
          [](const xacc::KernelList<> &kl) {
            return py::make_iterator(kl.begin(), kl.end());
          },
          py::keep_alive<0, 1>())
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
      .def("__getitem__",
           [](xacc::KernelList<> &s, py::slice slice) -> xacc::KernelList<> * {
             size_t start, stop, step, slicelength;
             if (!slice.compute(s.size(), &start, &stop, &step, &slicelength))
               throw py::error_already_set();
             xacc::KernelList<> *seq =
                 new xacc::KernelList<>(s.getAccelerator());
             for (size_t i = 0; i < slicelength; ++i) {
               (*seq).push_back(s[start]);
               start += step;
             }
             return seq;
           });

  // Expose the Accelerator
  py::class_<xacc::Accelerator, std::shared_ptr<xacc::Accelerator>,
             PyAccelerator>
      acc(m, "Accelerator",
          "Accelerator wraps the XACC C++ Accelerator class "
          "and provides a mechanism for creating buffers of qubits. Execution "
          "is handled by the XACC Kernels.");
  acc.def(py::init<>())
      .def("name", &xacc::Accelerator::name,
           "Return the name of this Accelerator.")
      .def("createBuffer",
           (std::shared_ptr<xacc::AcceleratorBuffer>(xacc::Accelerator::*)(
               const std::string &, const int)) &
               xacc::Accelerator::createBuffer,
           py::return_value_policy::reference,
           "Return a newly created register of qubits of the given size.")
      .def(
          "createBuffer",
          (std::shared_ptr<xacc::AcceleratorBuffer>(xacc::Accelerator::*)(
              const std::string &)) &
              xacc::Accelerator::createBuffer,
          py::return_value_policy::reference,
          "Return a newly allocated register of all qubits on the Accelerator.")
      .def("execute",
           (void (xacc::Accelerator::*)(std::shared_ptr<AcceleratorBuffer>,
Mccaskey, Alex's avatar
Mccaskey, Alex committed
302
303
304
305
306
307
308
309
                                        const std::shared_ptr<Function>)) &
               xacc::Accelerator::execute,
           "Execute the Function with the given AcceleratorBuffer.")
      .def("execute",
           (std::vector<std::shared_ptr<AcceleratorBuffer>>(
               xacc::Accelerator::*)(
               std::shared_ptr<AcceleratorBuffer>,
               const std::vector<std::shared_ptr<Function>>)) &
310
               xacc::Accelerator::execute,
311
312
           "Execute the Function with the given AcceleratorBuffer.")
      .def("initialize", &xacc::Accelerator::initialize, "");
313
314
315
316
317
318

  py::enum_<Accelerator::AcceleratorType>(acc, "AcceleratorType")
      .value("qpu_aqc", Accelerator::AcceleratorType::qpu_aqc)
      .value("qpu_gate", Accelerator::AcceleratorType::qpu_gate)
      .export_values();

319
320
321
  py::class_<xacc::AcceleratorDecorator, xacc::Accelerator,
             std::shared_ptr<xacc::AcceleratorDecorator>>
      accd(m, "AcceleratorDecorator", "");
322
  accd.def("setDecorated", &xacc::AcceleratorDecorator::setDecorated, "");
323

324
325
326
327
328
329
330
331
332
333
  // Expose the AcceleratorBuffer
  py::class_<xacc::AcceleratorBuffer, std::shared_ptr<xacc::AcceleratorBuffer>>(
      m, "AcceleratorBuffer",
      "The AcceleratorBuffer models a register of qubits.")
      .def(py::init<const std::string &, const int>())
      .def("getExpectationValueZ",
           &xacc::AcceleratorBuffer::getExpectationValueZ,
           "Return the expectation value with respect to the Z operator.")
      .def("resetBuffer", &xacc::AcceleratorBuffer::resetBuffer,
           "Reset this buffer for use in another computation.")
Mccaskey, Alex's avatar
Mccaskey, Alex committed
334
      .def("size", &xacc::AcceleratorBuffer::size, "")
335
336
337
338
339
340
341
342
343
344
345
346
      .def("appendMeasurement",
           (void (xacc::AcceleratorBuffer::*)(const std::string &)) &
               xacc::AcceleratorBuffer::appendMeasurement,
           "Append the measurement string")
      .def("getMeasurementStrings",
           &xacc::AcceleratorBuffer::getMeasurementStrings,
           "Return observed measurement bit strings")
      .def("computeMeasurementProbability",
           &xacc::AcceleratorBuffer::computeMeasurementProbability,
           "Compute the probability of a given bit string")
      .def("getMeasurementCounts",
           &xacc::AcceleratorBuffer::getMeasurementCounts,
347
348
349
350
351
352
           "Return the mapping of measure bit strings to their counts.")
      .def("getChildren",
           (std::vector<std::shared_ptr<AcceleratorBuffer>>(
               xacc::AcceleratorBuffer::*)(const std::string)) &
               xacc::AcceleratorBuffer::getChildren,
           "")
353
      .def("nChildren", &xacc::AcceleratorBuffer::nChildren, "")
354
355
356
357
358
      .def("getChildren",
           (std::vector<std::shared_ptr<AcceleratorBuffer>>(
               xacc::AcceleratorBuffer::*)()) &
               xacc::AcceleratorBuffer::getChildren,
           "")
359
360
361
362
363
364
      .def("getChildrenNames", &xacc::AcceleratorBuffer::getChildrenNames, "")
      .def("listExtraInfoKeys", &xacc::AcceleratorBuffer::listExtraInfoKeys, "")
      .def("getInformation",
           (std::map<std::string, ExtraInfo>(xacc::AcceleratorBuffer::*)()) &
               xacc::AcceleratorBuffer::getInformation,
           "")
365
366
367
368
      .def("addExtraInfo",
           (void (xacc::AcceleratorBuffer::*)(const std::string, ExtraInfo)) &
               xacc::AcceleratorBuffer::addExtraInfo,
           "")
369
370
371
372
      .def("getInformation",
           (ExtraInfo(xacc::AcceleratorBuffer::*)(const std::string)) &
               xacc::AcceleratorBuffer::getInformation,
           "")
373
      .def("hasExtraInfoKey", &xacc::AcceleratorBuffer::hasExtraInfoKey, "")
374
375
376
      .def("name", &xacc::AcceleratorBuffer::name, "")
      .def("getAllUnique", &xacc::AcceleratorBuffer::getAllUnique,
           "Return all unique information with the provided string name")
377
378
      .def("__repr__", &xacc::AcceleratorBuffer::toString, "")
      .def("__str__", &xacc::AcceleratorBuffer::toString, "")
379
380
381
382
383
      .def("getChildren",
           (std::vector<std::shared_ptr<AcceleratorBuffer>>(
               xacc::AcceleratorBuffer::*)(const std::string, ExtraInfo)) &
               xacc::AcceleratorBuffer::getChildren,
           "");
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468

  // Expose the Compiler
  py::class_<xacc::Compiler, std::shared_ptr<xacc::Compiler>>(
      m, "Compiler",
      "The XACC Compiler takes as input quantum kernel source code, "
      "and compiles it to the XACC intermediate representation.")
      .def("name", &xacc::Compiler::name, "Return the name of this Compiler.")
      .def("compile",
           (std::shared_ptr<xacc::IR>(xacc::Compiler::*)(
               const std::string &, std::shared_ptr<xacc::Accelerator>)) &
               xacc::Compiler::compile,
           "Compile the "
           "given source code against the given Accelerator.")
      .def("compile",
           (std::shared_ptr<xacc::IR>(xacc::Compiler::*)(const std::string &)) &
               xacc::Compiler::compile,
           "Compile the "
           "given source code.")
      .def("translate", &xacc::Compiler::translate,
           "Translate the given IR Function instance to source code in this "
           "Compiler's language.");

  // Expose the Program object
  py::class_<xacc::Program>(
      m, "Program",
      "The Program is the primary entrypoint for compilation and execution in "
      "XACC. Clients provide quantum kernel source "
      "code and the Accelerator instance, and the Program handles compiling "
      "the code and provides Kernel instances to execute.")
      .def(py::init<std::shared_ptr<xacc::Accelerator>, const std::string &>(),
           "The constructor")
      .def(py::init<std::shared_ptr<xacc::Accelerator>,
                    std::shared_ptr<xacc::IR>>(),
           "The constructor")
      .def("build",
           (void (xacc::Program::*)(const std::string &)) &
               xacc::Program::build,
           "Compile this program with the given Compiler name.")
      .def("build", (void (xacc::Program::*)()) & xacc::Program::build,
           "Compile this program.")
      .def("getKernel",
           (xacc::Kernel<>(xacc::Program::*)(const std::string &)) &
               xacc::Program::getKernel<>,
           py::return_value_policy::reference,
           "Return a Kernel representing the source code.")
      .def("getKernels", &xacc::Program::getRuntimeKernels,
           "Return all Kernels.")
      .def("nKernels", &xacc::Program::nKernels,
           "Return the number of kernels compiled by this program");

  // Expose XACC API functions
  m.def("Initialize", (void (*)(std::vector<std::string>)) & xacc::Initialize,
        "Initialize the framework. Can provide a list of strings to model "
        "command line arguments. For instance, "
        "to print the XACC help message, pass ['--help'] to this function, or "
        "to set the compiler to use, ['--compiler','scaffold'].");
  m.def("Initialize", (void (*)()) & xacc::Initialize,
        "Initialize the framework. Use this if there are no command line "
        "arguments to pass.");
  // m.def("help", )
  m.def("getAccelerator",
        (std::shared_ptr<xacc::Accelerator>(*)(const std::string &)) &
            xacc::getAccelerator,
        py::return_value_policy::reference,
        "Return the accelerator with given name.");
  m.def("getCompiler",
        (std::shared_ptr<xacc::Compiler>(*)(const std::string &)) &
            xacc::getCompiler,
        py::return_value_policy::reference,
        "Return the Compiler of given name.");
  m.def("getIRPreprocessor",
        (std::shared_ptr<xacc::IRPreprocessor>(*)(const std::string &)) &
            xacc::getService<IRPreprocessor>,
        py::return_value_policy::reference,
        "Return the IRPreprocessor of given name.");
  m.def("getIRTransformation",
        (std::shared_ptr<xacc::IRTransformation>(*)(const std::string &)) &
            xacc::getService<IRTransformation>,
        py::return_value_policy::reference,
        "Return the IRTransformation of given name.");
  m.def("getIRGenerator",
        (std::shared_ptr<xacc::IRGenerator>(*)(const std::string &)) &
            xacc::getService<IRGenerator>,
        py::return_value_policy::reference,
        "Return the IRGenerator of given name.");
469
470
471
472
473
474
475
476
477
478
479
480
481
482
  m.def("getConnectivity",
        [](const std::string acc) -> std::vector<std::vector<int>> {
          auto a = xacc::getAccelerator(acc);
          auto connectivity = a->getAcceleratorConnectivity();
          std::vector<std::vector<int>> edges;
          for (int i = 0; i < connectivity->order(); ++i) {
            for (int j = i; j < connectivity->order(); ++j) {
              if (connectivity->edgeExists(i, j)) {
                edges.push_back({i, j});
              }
            }
          }
          return edges;
        });
483
484
  m.def("translate", &xacc::translate,
        "Translate the provided IR Function to the given language.");
485
  m.def("setOption", [](const std::string s, InstructionParameter p) {
486
    xacc::setOption(s, p.toString());
487
  });
488
489
490
491
  m.def(
      "info", [](const std::string s) { xacc::info(s); }, "");
  m.def(
      "error", [](const std::string s) { xacc::error(s); }, "");
492
  m.def("setOption", &xacc::setOption, "Set an XACC framework option.");
493
494
495
496
497
498
499
  m.def(
      "setOptions",
      [](std::map<std::string, std::string> options) {
        for (auto &kv : options)
          xacc::setOption(kv.first, kv.second);
      },
      "Set a number of options at once.");
500
501
502
503
504
505
  m.def("getAcceleratorDecorator",
        [](const std::string name, std::shared_ptr<Accelerator> acc) {
          auto accd = xacc::getService<AcceleratorDecorator>(name);
          accd->setDecorated(acc);
          return accd;
        });
506
507
508
509
510
511
512
  m.def(
      "setOptions",
      [](std::map<std::string, InstructionParameter> options) {
        for (auto &kv : options)
          xacc::setOption(kv.first, kv.second.toString());
      },
      "Set a number of options at once.");
513
  m.def("unsetOption", &xacc::unsetOption, "");
514
515
516
517
518
519
520
521
522
523
524
525
  m.def("getOption",
        (const std::string (*)(const std::string &)) & xacc::getOption,
        "Get an XACC framework option.");
  m.def("hasAccelerator", &xacc::hasAccelerator,
        "Does XACC have the given Accelerator installed?");
  m.def("hasCompiler", &xacc::hasCompiler,
        "Does XACC have the given Accelerator installed?");
  m.def("optionExists", &xacc::optionExists, "Set an XACC framework option.");
  m.def("setIsPyApi", &xacc::setIsPyApi,
        "Indicate that this is using XACC via the Python API.");
  m.def("optimizeFunction", &xacc::optimizeFunction,
        "Run an optimizer on the given function.");
Mccaskey, Alex's avatar
Mccaskey, Alex committed
526
527
528
  m.def("analyzeBuffer",
        (void (*)(std::shared_ptr<AcceleratorBuffer>)) & xacc::analyzeBuffer,
        "Analyze the AcceleratorBuffer to produce problem-specific results.");
529
530
  m.def("getCache", &xacc::getCache, "");
  m.def("appendCache", (void (*)(const std::string, const std::string, InstructionParameter&)) &xacc::appendCache, "");
531
  m.def("Finalize", &xacc::Finalize, "Finalize the framework");
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
  m.def(
      "loadBuffer",
      [](const std::string json) {
        std::istringstream s(json);
        auto buffer = std::make_shared<AcceleratorBuffer>();
        buffer->load(s);
        return buffer;
      },
      "");
  m.def(
      "compileKernel",
      [](std::shared_ptr<Accelerator> acc, const std::string &src,
         const std::string &compilerName = "") -> std::shared_ptr<Function> {
        if (!compilerName.empty())
          xacc::setOption("compiler", compilerName);
        xacc::Program p(acc, src);
        p.build();
        return p.getRuntimeKernels()[0].getIRFunction();
      },
      py::arg("acc"), py::arg("src"), py::arg("compilerName") = std::string(""),
      py::return_value_policy::move, "");

  m.def(
      "functionToInstruction",
      [](std::shared_ptr<Function> f) {
        return std::dynamic_pointer_cast<Instruction>(f);
      },
      py::return_value_policy::copy);
560
561
562

  py::module gatesub =
      m.def_submodule("gate", "Gate model quantum computing data structures.");
563
564
565
566
567
568
569
570
571
572
573
574
  gatesub.def(
      "create",
      [](const std::string &name, std::vector<int> qbits,
         std::vector<InstructionParameter> params =
             std::vector<InstructionParameter>{})
          -> std::shared_ptr<Instruction> {
        return xacc::getService<IRProvider>("gate")->createInstruction(
            name, qbits, params);
      },
      "Convenience function for creating a new GateInstruction.",
      py::arg("name"), py::arg("qbits"),
      py::arg("params") = std::vector<InstructionParameter>{});
575
576
577
578
579
580
581
582
583
584
585
  gatesub.def(
      "createFunction",
      [](const std::string &name, std::vector<int> qbits,
         std::vector<InstructionParameter> params =
             std::vector<InstructionParameter>{}) -> std::shared_ptr<Function> {
        return xacc::getService<IRProvider>("gate")->createFunction(name, qbits,
                                                                    params);
      },
      "Convenience function for creating a new GateFunction.", py::arg("name"),
      py::arg("qbits"),
      py::arg("params") = std::vector<InstructionParameter>{});
586
587
588
589
590
591
  gatesub.def(
      "createIR",
      []() -> std::shared_ptr<IR> {
        return xacc::getService<IRProvider>("gate")->createIR();
      },
      "Convenience function for creating a new GateIR.");
592
593
594
595
596
597
598
599
600
601
602
603

  gatesub.def(
      "getState",
      [](std::shared_ptr<Accelerator> acc, std::shared_ptr<Function> f) {
        auto results = acc->getAcceleratorState(f);
        Eigen::VectorXcd ret =
            Eigen::Map<Eigen::VectorXcd>(results.data(), results.size());
        return ret;
      },
      "Compute and return the state after execution of the given program on "
      "the given accelerator.");
}