pennylane-qrack 0.10.1__tar.gz → 0.10.3__tar.gz

{pennylane-qrack-0.10.1 → pennylane_qrack-0.10.3}/Makefile

@@ -24,7 +24,7 @@ help:
 build-deps:
 ifneq ($(OS),Windows_NT)
 ifeq ($(QRACK_PRESENT),)
-	git clone https://github.com/unitaryfund/qrack.git; cd qrack; git checkout 7b661264a7494f4055504888126d66960e0c26e4; cd ..
+	git clone https://github.com/unitaryfund/qrack.git; cd qrack; git checkout 0dd1e6ce371b69e21bfa33003bc678b3d42713d5; cd ..
 endif
 	mkdir -p qrack/build
 ifeq ($(UNAME_S),Linux)

{pennylane-qrack-0.10.1/pennylane_qrack.egg-info → pennylane_qrack-0.10.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pennylane-qrack
-Version: 0.10.1
+Version: 0.10.3
 Summary: PennyLane plugin for Qrack.
 Home-page: http://github.com/vm6502q
 Maintainer: vm6502q
@@ -26,6 +26,9 @@ Classifier: Topic :: Scientific/Engineering :: Physics
 Provides: pennylane_qrack
 Description-Content-Type: text/x-rst
 License-File: LICENSE
+Requires-Dist: pennylane>=0.32
+Requires-Dist: pyqrack>=1.30.0
+Requires-Dist: numpy>=1.16
 
 PennyLane-Qrack Plugin
 #######################

pennylane_qrack-0.10.3/catalyst/runtime/include/DataView.hpp

@@ -0,0 +1,147 @@
+// Copyright 2023 Xanadu Quantum Technologies Inc.
+
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+
+//     http://www.apache.org/licenses/LICENSE-2.0
+
+// 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.
+
+#pragma once
+
+#include <Exception.hpp>
+
+/**
+ * A multi-dimensional view for MemRef-like and std::vector<T> types.
+ *
+ * @tparam T The underlying data type
+ * @tparam R The Rank (R > 0)
+ *
+ * @note A forward iterator is implemented in this view for traversing over the entire
+ * elements of MemRef types rank-by-rank starting from the last dimension (R-1). For example,
+ * The DataView iterator for MemRef<T, 2> starts from index (0, 0) and traverses elements
+ * in the following order:
+ * (0, 0), ..., (0, sizes[1]-1), (1, 0), ..., (1, sizes[1]-1), ... (sizes[0]-1, sizes[1]-1).
+ */
+template <typename T, size_t R> class DataView {
+  private:
+    T *data_aligned;
+    size_t offset;
+    size_t sizes[R] = {0};
+    size_t strides[R] = {0};
+
+  public:
+    class iterator {
+      private:
+        const DataView<T, R> &view;
+
+        int64_t loc; // physical index
+        size_t indices[R] = {0};
+
+      public:
+        using iterator_category = std::forward_iterator_tag; // LCOV_EXCL_LINE
+        using value_type = T;                                // LCOV_EXCL_LINE
+        using difference_type = std::ptrdiff_t;              // LCOV_EXCL_LINE
+        using pointer = T *;                                 // LCOV_EXCL_LINE
+        using reference = T &;                               // LCOV_EXCL_LINE
+
+        iterator(const DataView<T, R> &_view, int64_t begin_idx) : view(_view), loc(begin_idx) {}
+        pointer operator->() const { return &view.data_aligned[loc]; }
+        reference operator*() const { return view.data_aligned[loc]; }
+        iterator &operator++()
+        {
+            int64_t next_axis = -1;
+            int64_t idx;
+            for (int64_t i = R; i > 0; --i) {
+                idx = i - 1;
+                if (indices[idx]++ < view.sizes[idx] - 1) {
+                    next_axis = idx;
+                    break;
+                }
+                indices[idx] = 0;
+                loc -= (view.sizes[idx] - 1) * view.strides[idx];
+            }
+
+            loc = next_axis == -1 ? -1 : loc + view.strides[next_axis];
+            return *this;
+        }
+        iterator operator++(int)
+        {
+            auto tmp = *this;
+            int64_t next_axis = -1;
+            int64_t idx;
+            for (int64_t i = R; i > 0; --i) {
+                idx = i - 1;
+                if (indices[idx]++ < view.sizes[idx] - 1) {
+                    next_axis = idx;
+                    break;
+                }
+                indices[idx] = 0;
+                loc -= (view.sizes[idx] - 1) * view.strides[idx];
+            }
+
+            loc = next_axis == -1 ? -1 : loc + view.strides[next_axis];
+            return tmp;
+        }
+        bool operator==(const iterator &other) const
+        {
+            return (loc == other.loc && view.data_aligned == other.view.data_aligned);
+        }
+        bool operator!=(const iterator &other) const { return !(*this == other); }
+    };
+
+    explicit DataView(std::vector<T> &buffer) : data_aligned(buffer.data()), offset(0)
+    {
+        static_assert(R == 1, "[Class: DataView] Assertion: R == 1");
+        sizes[0] = buffer.size();
+        strides[0] = 1;
+    }
+
+    explicit DataView(T *_data_aligned, size_t _offset, size_t *_sizes, size_t *_strides)
+        : data_aligned(_data_aligned), offset(_offset)
+    {
+        static_assert(R > 0, "[Class: DataView] Assertion: R > 0");
+        if (_sizes && _strides) {
+            for (size_t i = 0; i < R; i++) {
+                sizes[i] = _sizes[i];
+                strides[i] = _strides[i];
+            }
+        } // else sizes = {0}, strides = {0}
+    }
+
+    [[nodiscard]] auto size() const -> size_t
+    {
+        if (!data_aligned) {
+            return 0;
+        }
+
+        size_t tsize = 1;
+        for (size_t i = 0; i < R; i++) {
+            tsize *= sizes[i];
+        }
+        return tsize;
+    }
+
+    template <typename... I> T &operator()(I... idxs) const
+    {
+        static_assert(sizeof...(idxs) == R,
+                      "[Class: DataView] Error in Catalyst Runtime: Wrong number of indices");
+        size_t indices[] = {static_cast<size_t>(idxs)...};
+
+        size_t loc = offset;
+        for (size_t axis = 0; axis < R; axis++) {
+            RT_ASSERT(indices[axis] < sizes[axis]);
+            loc += indices[axis] * strides[axis];
+        }
+        return data_aligned[loc];
+    }
+
+    iterator begin() { return iterator{*this, static_cast<int64_t>(offset)}; }
+
+    iterator end() { return iterator{*this, -1}; }
+};

pennylane_qrack-0.10.3/catalyst/runtime/include/Exception.hpp

@@ -0,0 +1,87 @@
+// Copyright 2023 Xanadu Quantum Technologies Inc.
+
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+
+//     http://www.apache.org/licenses/LICENSE-2.0
+
+// 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.
+
+#pragma once
+
+#include <exception>
+#include <iostream>
+
+#include <sstream>
+#include <string>
+#include <type_traits>
+#include <utility>
+
+/**
+ * @brief Macro that throws `RuntimeException` with given message.
+ */
+#define RT_FAIL(message) Catalyst::Runtime::_abort((message), __FILE__, __LINE__, __func__)
+
+/**
+ * @brief Macro that throws `RuntimeException` if expression evaluates
+ * to true.
+ */
+#define RT_FAIL_IF(expression, message)                                                            \
+    if ((expression)) {                                                                            \
+        RT_FAIL(message);                                                                          \
+    }
+
+/**
+ * @brief Macro that throws `RuntimeException` with the given expression
+ * and source location if expression evaluates to false.
+ */
+#define RT_ASSERT(expression) RT_FAIL_IF(!(expression), "Assertion: " #expression)
+
+namespace Catalyst::Runtime {
+
+/**
+ * @brief This is the general exception thrown by Catalyst for runtime errors
+ * that is derived from `std::exception`.
+ */
+class RuntimeException : public std::exception {
+  private:
+    const std::string err_msg;
+
+  public:
+    explicit RuntimeException(std::string msg) noexcept
+        : err_msg{std::move(msg)} {}        // LCOV_EXCL_LINE
+    ~RuntimeException() override = default; // LCOV_EXCL_LINE
+
+    RuntimeException(const RuntimeException &) = default;
+    RuntimeException(RuntimeException &&) noexcept = default;
+
+    RuntimeException &operator=(const RuntimeException &) = delete;
+    RuntimeException &operator=(RuntimeException &&) = delete;
+
+    [[nodiscard]] auto what() const noexcept -> const char * override
+    {
+        return err_msg.c_str();
+    } // LCOV_EXCL_LINE
+};
+
+/**
+ * @brief Throws a `RuntimeException` with the given error message.
+ *
+ * @note This is not supposed to be called directly.
+ */
+[[noreturn]] inline void _abort(const char *message, const char *file_name, size_t line,
+                                const char *function_name)
+{
+    std::stringstream sstream;
+    sstream << "[" << file_name << "][Line:" << line << "][Function:" << function_name
+            << "] Error in Catalyst Runtime: " << message;
+
+    throw RuntimeException(sstream.str());
+} // LCOV_EXCL_LINE
+
+} // namespace Catalyst::Runtime

pennylane_qrack-0.10.3/catalyst/runtime/include/QuantumDevice.hpp

@@ -0,0 +1,362 @@
+// Copyright 2022-2023 Xanadu Quantum Technologies Inc.
+
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+
+//     http://www.apache.org/licenses/LICENSE-2.0
+
+// 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.
+
+#pragma once
+
+#include <complex>
+#include <memory>
+#include <optional>
+#include <random>
+#include <vector>
+
+#include "DataView.hpp"
+#include "Types.h"
+
+// A helper template macro to generate the <IDENTIFIER>Factory method by
+// calling <CONSTRUCTOR>(kwargs). Check the Custom Devices guideline for details:
+// https://docs.pennylane.ai/projects/catalyst/en/stable/dev/custom_devices.html
+#define GENERATE_DEVICE_FACTORY(IDENTIFIER, CONSTRUCTOR)                                           \
+    extern "C" Catalyst::Runtime::QuantumDevice *IDENTIFIER##Factory(const char *kwargs)           \
+    {                                                                                              \
+        return new CONSTRUCTOR(std::string(kwargs));                                               \
+    }
+
+namespace Catalyst::Runtime {
+
+/**
+ * @brief struct API for backend quantum devices.
+ *
+ * This device API contains,
+ * - a set of methods to manage qubit allocations and deallocations, device shot
+ *   noise, and quantum tape recording as well as reference values for the result
+ *   data-type; these are used to implement Quantum Runtime (QR) instructions.
+ *
+ * - a set of methods for quantum operations, observables, measurements, and gradient
+ *   of the device; these are used to implement Quantum Instruction Set (QIS) instructions.
+ *
+ */
+struct QuantumDevice {
+    QuantumDevice() = default;          // LCOV_EXCL_LINE
+    virtual ~QuantumDevice() = default; // LCOV_EXCL_LINE
+
+    QuantumDevice &operator=(const QuantumDevice &) = delete;
+    QuantumDevice(const QuantumDevice &) = delete;
+    QuantumDevice(QuantumDevice &&) = delete;
+    QuantumDevice &operator=(QuantumDevice &&) = delete;
+
+    /**
+     * @brief Allocate a qubit.
+     *
+     * @return `QubitIdType`
+     */
+    virtual auto AllocateQubit() -> QubitIdType = 0;
+
+    /**
+     * @brief Allocate a vector of qubits.
+     *
+     * @param num_qubits The number of qubits to allocate.
+     *
+     * @return `std::vector<QubitIdType>`
+     */
+    virtual auto AllocateQubits(size_t num_qubits) -> std::vector<QubitIdType> = 0;
+
+    /**
+     * @brief Release a qubit.
+     *
+     * @param qubit The id of the qubit
+     */
+    virtual void ReleaseQubit(QubitIdType qubit) = 0;
+
+    /**
+     * @brief Release all qubits.
+     */
+    virtual void ReleaseAllQubits() = 0;
+
+    /**
+     * @brief Get the number of allocated qubits.
+     *
+     * @return `size_t`
+     */
+    [[nodiscard]] virtual auto GetNumQubits() const -> size_t = 0;
+
+    /**
+     * @brief Set the number of device shots.
+     *
+     * @param shots The number of noise shots
+     */
+    virtual void SetDeviceShots(size_t shots) = 0;
+
+    /**
+     * @brief Get the number of device shots.
+     *
+     * @return `size_t`
+     */
+    [[nodiscard]] virtual auto GetDeviceShots() const -> size_t = 0;
+
+    /**
+     * @brief Set the PRNG of the device.
+     *
+     * The Catalyst runtime enables seeded program execution on non-hardware devices.
+     * A random number generator instance is managed by the runtime to predictably
+     * generate results for non-deterministic programs, such as those involving `Measure`
+     * calls.
+     * Devices implementing support for this feature do not need to use the provided
+     * PRNG instance as their sole source of random numbers, but it is expected that the
+     * the same instance state will predictable and reproducibly generate the same
+     * program results. It is also expected that the provided PRNG state is evolved
+     * sufficiently so that two device executions sharing the same instance do not produce
+     * identical results.
+     * The provided PRNG instance is not thread-locked, and devices wishing to share it
+     * across threads will need to provide their own thread-safety.
+     *
+     * @param gen The std::mt19937 PRNG object.
+     */
+    virtual void SetDevicePRNG([[maybe_unused]] std::mt19937 *gen){};
+
+    /**
+     * @brief Start recording a quantum tape if provided.
+     *
+     * @note This is backed by the `Catalyst::Runtime::CacheManager<ComplexT>` property in
+     * the device implementation.
+     */
+    virtual void StartTapeRecording() = 0;
+
+    /**
+     * @brief Stop recording a quantum tape if provided.
+     *
+     * @note This is backed by the `Catalyst::Runtime::CacheManager<ComplexT>` property in
+     * the device implementation.
+     */
+    virtual void StopTapeRecording() = 0;
+
+    /**
+     * @brief Result value for "Zero" used in the measurement process.
+     *
+     * @return `Result`
+     */
+    [[nodiscard]] virtual auto Zero() const -> Result = 0;
+
+    /**
+     * @brief Result value for "One"  used in the measurement process.
+     *
+     * @return `Result`
+     */
+    [[nodiscard]] virtual auto One() const -> Result = 0;
+
+    /**
+     * @brief A helper method to print the state vector of a device.
+     */
+    virtual void PrintState() = 0;
+
+    /**
+     * @brief Prepare subsystems using the given ket vector in the computational basis.
+     *
+     * @param state A state vector of size 2**len(wires)
+     * @param wires The wire(s) the operation acts on
+     */
+    virtual void SetState(DataView<std::complex<double>, 1> &, std::vector<QubitIdType> &)
+    {
+        RT_FAIL("Unsupported functionality");
+    }
+
+    /**
+     * @brief Prepares a single computational basis state.
+     *
+     * @param n Prepares the basis state |n>, where n is an array of integers from the set {0, 1}
+     * @param wires The wire(s) the operation acts on
+     */
+    virtual void SetBasisState(DataView<int8_t, 1> &, std::vector<QubitIdType> &)
+    {
+        RT_FAIL("Unsupported functionality");
+    }
+
+    /**
+     * @brief Apply a single gate to the state vector of a device with its name if this is
+     * supported.
+     *
+     * @param name The name of the gate to apply
+     * @param params Optional parameter list for parametric gates
+     * @param wires Wires to apply gate to
+     * @param inverse Indicates whether to use inverse of gate
+     * @param controlled_wires Optional controlled wires applied to the operation
+     * @param controlled_values Optional controlled values applied to the operation
+     */
+    virtual void
+    NamedOperation(const std::string &name, const std::vector<double> &params,
+                   const std::vector<QubitIdType> &wires, [[maybe_unused]] bool inverse = false,
+                   [[maybe_unused]] const std::vector<QubitIdType> &controlled_wires = {},
+                   [[maybe_unused]] const std::vector<bool> &controlled_values = {}) = 0;
+
+    /**
+     * @brief Apply a given matrix directly to the state vector of a device.
+     *
+     * @param matrix The matrix of data in row-major format
+     * @param wires Wires to apply gate to
+     * @param inverse Indicates whether to use inverse of gate
+     * @param controlled_wires Controlled wires applied to the operation
+     * @param controlled_values Controlled values applied to the operation
+     */
+    virtual void
+    MatrixOperation(const std::vector<std::complex<double>> &matrix,
+                    const std::vector<QubitIdType> &wires, [[maybe_unused]] bool inverse = false,
+                    [[maybe_unused]] const std::vector<QubitIdType> &controlled_wires = {},
+                    [[maybe_unused]] const std::vector<bool> &controlled_values = {}) = 0;
+
+    /**
+     * @brief Construct a named (Identity, PauliX, PauliY, PauliZ, and Hadamard)
+     * or Hermitian observable.
+     *
+     * @param id The type of the observable
+     * @param matrix The matrix of data to construct a hermitian observable
+     * @param wires Wires to apply observable to
+     *
+     * @return `ObsIdType` Index of the constructed observable
+     */
+    virtual auto Observable(ObsId id, const std::vector<std::complex<double>> &matrix,
+                            const std::vector<QubitIdType> &wires) -> ObsIdType = 0;
+
+    /**
+     * @brief Construct a tensor product of observables.
+     *
+     * @param obs The vector of observables indices of type ObsIdType
+     *
+     * @return `ObsIdType` Index of the constructed observable
+     */
+    virtual auto TensorObservable(const std::vector<ObsIdType> &obs) -> ObsIdType = 0;
+
+    /**
+     * @brief Construct a Hamiltonian observable.
+     *
+     * @param coeffs The vector of coefficients
+     * @param obs The vector of observables indices of size `coeffs`
+     *
+     * @return `ObsIdType` Index of the constructed observable
+     */
+    virtual auto HamiltonianObservable(const std::vector<double> &coeffs,
+                                       const std::vector<ObsIdType> &obs) -> ObsIdType = 0;
+
+    /**
+     * @brief Compute the expected value of an observable.
+     *
+     * @param obsKey The index of the constructed observable
+     *
+     * @return `double` The expected value
+     */
+    virtual auto Expval(ObsIdType obsKey) -> double = 0;
+
+    /**
+     * @brief Compute the variance of an observable.
+     *
+     * @param obsKey The index of the constructed observable
+     *
+     * @return `double` The variance
+     */
+    virtual auto Var(ObsIdType obsKey) -> double = 0;
+
+    /**
+     * @brief Get the state-vector of a device.
+     *
+     * @param state The pre-allocated `DataView<complex<double>, 1>`
+     */
+    virtual void State(DataView<std::complex<double>, 1> &state) = 0;
+
+    /**
+     * @brief Compute the probabilities of each computational basis state.
+
+     * @param probs The pre-allocated `DataView<double, 1>`
+     */
+    virtual void Probs(DataView<double, 1> &probs) = 0;
+
+    /**
+     * @brief Compute the probabilities for a subset of the full system.
+     *
+     * @param probs The pre-allocated `DataView<double, 1>`
+     * @param wires Wires will restrict probabilities to a subset of the full system
+     */
+    virtual void PartialProbs(DataView<double, 1> &probs,
+                              const std::vector<QubitIdType> &wires) = 0;
+
+    /**
+     * @brief Compute samples with the number of shots on the entire wires,
+     * returing raw samples.
+     *
+     * @param samples The pre-allocated `DataView<double, 2>`representing a matrix of
+     * shape `shots * numQubits`. The built-in iterator in `DataView<double, 2>`
+     * iterates over all elements of `samples` row-wise.
+     * @param shots The number of shots
+     */
+    virtual void Sample(DataView<double, 2> &samples, size_t shots) = 0;
+
+    /**
+     * @brief Compute partial samples with the number of shots on `wires`,
+     * returing raw samples.
+     *
+     * @param samples The pre-allocated `DataView<double, 2>`representing a matrix of
+     * shape `shots * numWires`. The built-in iterator in `DataView<double, 2>`
+     * iterates over all elements of `samples` row-wise.
+     * @param wires Wires to compute samples on
+     * @param shots The number of shots
+     */
+    virtual void PartialSample(DataView<double, 2> &samples, const std::vector<QubitIdType> &wires,
+                               size_t shots) = 0;
+
+    /**
+     * @brief Sample with the number of shots on the entire wires, returning the
+     * number of counts for each sample.
+     *
+     * @param eigvals The pre-allocated `DataView<double, 1>`
+     * @param counts The pre-allocated `DataView<int64_t, 1>`
+     * @param shots The number of shots
+     */
+    virtual void Counts(DataView<double, 1> &eigvals, DataView<int64_t, 1> &counts,
+                        size_t shots) = 0;
+
+    /**
+     * @brief Partial sample with the number of shots on `wires`, returning the
+     * number of counts for each sample.
+     *
+     * @param eigvals The pre-allocated `DataView<double, 1>`
+     * @param counts The pre-allocated `DataView<int64_t, 1>`
+     * @param wires Wires to compute samples on
+     * @param shots The number of shots
+     */
+    virtual void PartialCounts(DataView<double, 1> &eigvals, DataView<int64_t, 1> &counts,
+                               const std::vector<QubitIdType> &wires, size_t shots) = 0;
+
+    /**
+     * @brief A general measurement method that acts on a single wire.
+     *
+     * @param wire The wire to compute Measure on
+     * @param postselect Which basis state to postselect after a mid-circuit measurement (-1 denotes
+     no post-selection)
+
+     * @return `Result` The measurement result
+     */
+    virtual auto Measure(QubitIdType wire, std::optional<int32_t> postselect) -> Result = 0;
+
+    /**
+     * @brief Compute the gradient of a quantum tape, that is cached using
+     * `Catalyst::Runtime::Simulator::CacheManager`, for a specific set of trainable
+     * parameters.
+     *
+     * @param gradients The vector of pre-allocated `DataView<double, 1>*`
+     * to store gradients resutls for the list of cached observables.
+     * @param trainParams The vector of trainable parameters; if none, all parameters
+     * would be assumed trainable
+     *
+     */
+    virtual void Gradient(std::vector<DataView<double, 1>> &gradients,
+                          const std::vector<size_t> &trainParams) = 0;
+};
+} // namespace Catalyst::Runtime