pennylane-qrack 0.20.3__tar.gz → 0.21.1__tar.gz

{pennylane_qrack-0.20.3 → pennylane_qrack-0.21.1}/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 f0738286f49fb0ffaeb46d6e5d2294dbfc7f6138; cd ..
+	git clone https://github.com/unitaryfund/qrack.git; cd qrack; git checkout 9bbd10bbadf800d7604dc73f0315e84180f3939c; cd ..
 endif
 	mkdir -p qrack/build
 ifeq ($(UNAME_S),Linux)

{pennylane_qrack-0.20.3 → pennylane_qrack-0.21.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pennylane-qrack
-Version: 0.20.3
+Version: 0.21.1
 Summary: PennyLane plugin for Qrack.
 Home-page: http://github.com/vm6502q
 Maintainer: vm6502q

{pennylane_qrack-0.20.3 → pennylane_qrack-0.21.1}/pennylane_qrack/_version.py

@@ -16,4 +16,4 @@
 Version number (major.minor.patch[-label])
 """
 
-__version__ = "0.20.3"
+__version__ = "0.21.1"

{pennylane_qrack-0.20.3 → pennylane_qrack-0.21.1}/pennylane_qrack/qrack_ace_device.py

@@ -134,11 +134,11 @@ class QrackAceDevice(QubitDevice):
     # Noise parameter. (Default is "0"; depolarizing noise intensity can also be controlled by "QRACK_GATE_DEPOLARIZATION" environment variable)
     noise = 0
     # How many full simulation columns, between border columns
-    long_range_columns=4
+    long_range_columns = 4
     # How many full simulation rows, between border rows
-    long_range_rows=4
+    long_range_rows = 4
     # Whether to transpose rows and columns
-    is_transpose=False
+    is_transpose = False
 
     def __init__(self, wires=0, shots=None, **kwargs):
         options = dict(kwargs)
@@ -376,7 +376,9 @@ class QrackAceDevice(QubitDevice):
             raise DeviceError(f"Operation {opname} is not supported on a {self.short_name} device.")
 
     def analytic_probability(self, wires=None):
-        raise DeviceError(f"analytic_probability is not supported on a {self.short_name} device. (Specify a finite number of shots, instead.)")
+        raise DeviceError(
+            f"analytic_probability is not supported on a {self.short_name} device. (Specify a finite number of shots, instead.)"
+        )
 
     def expval(self, observable, **kwargs):
         if self.shots is None:
@@ -433,7 +435,9 @@ class QrackAceDevice(QubitDevice):
 
         # QubitDevice.states_to_binary() doesn't work for >64qb. (Fix by Elara, the custom OpenAI GPT)
         samples = self._state.measure_shots(list(range(self.num_wires - 1, -1, -1)), self.shots)
-        self._samples = np.array([list(format(b, f"0{self.num_wires}b")) for b in samples], dtype=np.int8)
+        self._samples = np.array(
+            [list(format(b, f"0{self.num_wires}b")) for b in samples], dtype=np.int8
+        )
 
         return self._samples
 

{pennylane_qrack-0.20.3 → pennylane_qrack-0.21.1}/pennylane_qrack/qrack_device.cpp

@@ -483,8 +483,6 @@ struct QrackDevice final : public Catalyst::Runtime::QuantumDevice {
         }
         return ids;
     }
-    [[nodiscard]] auto Zero() const -> Result override { return const_cast<Result>(&QRACK_RESULT_FALSE_CONST); }
-    [[nodiscard]] auto One() const -> Result override { return const_cast<Result>(&QRACK_RESULT_TRUE_CONST); }
     auto Observable(ObsId id, const std::vector<std::complex<double>> &matrix,
                     const std::vector<QubitIdType> &wires) -> ObsIdType override
     {
@@ -576,21 +574,6 @@ struct QrackDevice final : public Catalyst::Runtime::QuantumDevice {
     [[nodiscard]] auto GetDeviceShots() const -> size_t override { return shots; }
     void StartTapeRecording() override { tapeRecording = true; }
     void StopTapeRecording() override { tapeRecording = false; }
-    void PrintState() override
-    {
-        const size_t numQubits = qsim->GetQubitCount();
-        const size_t maxQPower = (size_t)((uint64_t)qsim->GetMaxQPower());
-        const size_t maxLcv = maxQPower - 1U;
-        size_t idx = 0U;
-        std::cout << "*** State-Vector of Size " << maxQPower << " ***" << std::endl;
-        std::cout << "[";
-        std::unique_ptr<Qrack::complex> sv(new Qrack::complex[maxQPower]);
-        qsim->GetQuantumState(sv.get());
-        for (; idx < maxLcv; ++idx) {
-            std::cout << sv.get()[idx] << ", ";
-        }
-        std::cout << sv.get()[idx] << "]" << std::endl;
-    }
     void NamedOperation(const std::string &name, const std::vector<double> &params,
                         const std::vector<QubitIdType> &wires, bool inverse,
                         const std::vector<QubitIdType> &controlled_wires,
@@ -735,7 +718,7 @@ struct QrackDevice final : public Catalyst::Runtime::QuantumDevice {
             }
         }
     }
-    void Sample(DataView<double, 2> &samples, size_t shots) override
+    void Sample(DataView<double, 2> &samples) override
     {
         RT_FAIL_IF(samples.size() != shots * qsim->GetQubitCount(), "Invalid size for the pre-allocated samples");
 
@@ -764,7 +747,7 @@ struct QrackDevice final : public Catalyst::Runtime::QuantumDevice {
         const std::map<bitCapInt, int> q_samples = qsim->MultiShotMeasureMask(qPowers, shots);
         _SampleBody(qPowers.size(), q_samples, samples);
     }
-    void PartialSample(DataView<double, 2> &samples, const std::vector<QubitIdType> &wires, size_t shots) override
+    void PartialSample(DataView<double, 2> &samples, const std::vector<QubitIdType> &wires) override
     {
         RT_FAIL_IF(samples.size() != shots * wires.size(), "Invalid size for the pre-allocated samples");
 
@@ -809,8 +792,7 @@ struct QrackDevice final : public Catalyst::Runtime::QuantumDevice {
             }
         }
     }
-    void Counts(DataView<double, 1> &eigvals, DataView<int64_t, 1> &counts,
-                size_t shots) override
+    void Counts(DataView<double, 1> &eigvals, DataView<int64_t, 1> &counts) override
     {
         const size_t numQubits = qsim->GetQubitCount();
         const size_t numElements = 1U << numQubits;
@@ -844,7 +826,7 @@ struct QrackDevice final : public Catalyst::Runtime::QuantumDevice {
     }
 
     void PartialCounts(DataView<double, 1> &eigvals, DataView<int64_t, 1> &counts,
-                       const std::vector<QubitIdType> &wires, size_t shots) override
+                       const std::vector<QubitIdType> &wires) override
     {
         const size_t numQubits = wires.size();
         const size_t numElements = 1U << numQubits;

{pennylane_qrack-0.20.3 → pennylane_qrack-0.21.1}/pennylane_qrack/qrack_device.py

@@ -720,7 +720,9 @@ class QrackDevice(QubitDevice):
 
         # QubitDevice.states_to_binary() doesn't work for >64qb. (Fix by Elara, the custom OpenAI GPT)
         samples = self._state.measure_shots(list(range(self.num_wires - 1, -1, -1)), self.shots)
-        self._samples = np.array([list(format(b, f"0{self.num_wires}b")) for b in samples], dtype=np.int8)
+        self._samples = np.array(
+            [list(format(b, f"0{self.num_wires}b")) for b in samples], dtype=np.int8
+        )
 
         return self._samples
 

{pennylane_qrack-0.20.3 → pennylane_qrack-0.21.1}/pennylane_qrack.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pennylane-qrack
-Version: 0.20.3
+Version: 0.21.1
 Summary: PennyLane plugin for Qrack.
 Home-page: http://github.com/vm6502q
 Maintainer: vm6502q

{pennylane_qrack-0.20.3 → pennylane_qrack-0.21.1}/pennylane_qrack.egg-info/SOURCES.txt

@@ -6,17 +6,10 @@ Makefile
 README.rst
 requirements.txt
 setup.py
-catalyst/runtime/include/DataView.hpp
-catalyst/runtime/include/DynamicLibraryLoader.hpp
-catalyst/runtime/include/Exception.hpp
-catalyst/runtime/include/QuantumDevice.hpp
-catalyst/runtime/include/RuntimeCAPI.h
-catalyst/runtime/include/Types.h
 pennylane_qrack/QrackAceDeviceConfig.toml
 pennylane_qrack/QrackDeviceConfig.toml
 pennylane_qrack/__init__.py
 pennylane_qrack/_version.py
-pennylane_qrack/libqrack_device.so
 pennylane_qrack/qrack_ace_device.py
 pennylane_qrack/qrack_device.cpp
 pennylane_qrack/qrack_device.py

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

@@ -1,148 +0,0 @@
-// 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, const size_t *_sizes,
-                      const size_t *_strides)
-        : data_aligned(_data_aligned), offset(_offset)
-    {
-        static_assert(R > 0, "[Class: DataView] Assertion: R > 0");
-        if (_sizes != nullptr && _strides != nullptr) {
-            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.20.3/catalyst/runtime/include/DynamicLibraryLoader.hpp

@@ -1,79 +0,0 @@
-// Copyright 2024 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 <dlfcn.h>
-#include <string_view>
-
-#include "Exception.hpp"
-
-/**
- * @brief A utility struct to handle opening, closing and retrieving symbols
- *        from dynamic shared objects.
- */
-struct DynamicLibraryLoader {
-    void *handle;
-
-    DynamicLibraryLoader(std::string_view library_name, int mode = RTLD_LAZY | RTLD_NODELETE)
-    {
-        // Load the shared library
-        handle = dlopen(library_name.data(), mode);
-        if (!handle) {
-            const char *err_msg = dlerror();
-            RT_FAIL(err_msg);
-        }
-    }
-
-    ~DynamicLibraryLoader()
-    {
-        if (handle) {
-            // TODO: This is non-sensical.
-            // We are using RTLD_NODELETE, why would calling dlclose have a side-effect?
-            // Worst of all, the side-effect is not in our code.
-            // When we have dlclose, everything works well the first time.
-            // However, when trying to compile a second time, we will find that jaxlib will now
-            // raise a StopIteration exception. This doesn't really make any sense.
-            // My guess is that somehow dlclosing here will unload a the StopIteration symbol (?)
-            // rebind it with another equivalent (but with different id?)
-            // and then the MLIR python bindings are unable to catch it and stop the iteration and
-            // it gets propagated upwards.
-            //
-            // Is not calling dlclose bad?
-            // A little bit, although dlclose implies intent and does not create any requirements
-            // upon the implementation. See here:
-            // https://pubs.opengroup.org/onlinepubs/000095399/functions/dlclose.html
-            // https://github.com/pybind/pybind11/blob/75e48c5f959b4f0a49d8c664e059b6fb4b497102/include/pybind11/detail/internals.h#L108-L113
-            //
-#ifndef __APPLE__
-            dlclose(handle);
-#endif
-        }
-    }
-
-    // Get symbol from library
-    template <typename T> T getSymbol(std::string_view symbol_name)
-    {
-        // Clear any existing errors
-        dlerror();
-
-        // Retrieve symbol
-        T symbol = reinterpret_cast<T>(dlsym(handle, symbol_name.data()));
-        const char *err_msg = dlerror();
-        if (err_msg != nullptr) {
-            RT_FAIL(err_msg);
-        }
-        return symbol;
-    }
-};

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

@@ -1,87 +0,0 @@
-// 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.20.3/catalyst/runtime/include/QuantumDevice.hpp

@@ -1,364 +0,0 @@
-// 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([[maybe_unused]] DataView<std::complex<double>, 1> &state,
-                          [[maybe_unused]] std::vector<QubitIdType> &wires)
-    {
-        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([[maybe_unused]] DataView<int8_t, 1> &n,
-                               [[maybe_unused]] std::vector<QubitIdType> &wires)
-    {
-        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

pennylane_qrack-0.20.3/catalyst/runtime/include/RuntimeCAPI.h

@@ -1,112 +0,0 @@
-// 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
-#ifndef RUNTIMECAPI_H
-#define RUNTIMECAPI_H
-
-#include "Types.h"
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-// Quantum Runtime Instructions
-void __catalyst__rt__fail_cstr(const char *);
-void __catalyst__rt__initialize(uint32_t *seed);
-void __catalyst__rt__device_init(int8_t *, int8_t *, int8_t *);
-void __catalyst__rt__device_release();
-void __catalyst__rt__finalize();
-void __catalyst__rt__toggle_recorder(bool);
-void __catalyst__rt__print_state();
-void __catalyst__rt__print_tensor(OpaqueMemRefT *, bool);
-void __catalyst__rt__print_string(char *);
-void __catalyst__rt__assert_bool(bool, char *);
-int64_t __catalyst__rt__array_get_size_1d(QirArray *);
-int8_t *__catalyst__rt__array_get_element_ptr_1d(QirArray *, int64_t);
-
-QUBIT *__catalyst__rt__qubit_allocate();
-QirArray *__catalyst__rt__qubit_allocate_array(int64_t);
-void __catalyst__rt__qubit_release(QUBIT *);
-void __catalyst__rt__qubit_release_array(QirArray *);
-
-int64_t __catalyst__rt__num_qubits();
-
-bool __catalyst__rt__result_equal(RESULT *, RESULT *);
-RESULT *__catalyst__rt__result_get_one();
-RESULT *__catalyst__rt__result_get_zero();
-
-// Quantum Gate Set Instructions
-void __catalyst__qis__SetState(MemRefT_CplxT_double_1d *, uint64_t, ...);
-void __catalyst__qis__SetBasisState(MemRefT_int8_1d *, uint64_t, ...);
-void __catalyst__qis__Identity(QUBIT *, const Modifiers *);
-void __catalyst__qis__PauliX(QUBIT *, const Modifiers *);
-void __catalyst__qis__PauliY(QUBIT *, const Modifiers *);
-void __catalyst__qis__PauliZ(QUBIT *, const Modifiers *);
-void __catalyst__qis__Hadamard(QUBIT *, const Modifiers *);
-void __catalyst__qis__S(QUBIT *, const Modifiers *);
-void __catalyst__qis__T(QUBIT *, const Modifiers *);
-void __catalyst__qis__PhaseShift(double, QUBIT *, const Modifiers *);
-void __catalyst__qis__RX(double, QUBIT *, const Modifiers *);
-void __catalyst__qis__RY(double, QUBIT *, const Modifiers *);
-void __catalyst__qis__RZ(double, QUBIT *, const Modifiers *);
-void __catalyst__qis__Rot(double, double, double, QUBIT *, const Modifiers *);
-void __catalyst__qis__CNOT(QUBIT *, QUBIT *, const Modifiers *);
-void __catalyst__qis__CY(QUBIT *, QUBIT *, const Modifiers *);
-void __catalyst__qis__CZ(QUBIT *, QUBIT *, const Modifiers *);
-void __catalyst__qis__SWAP(QUBIT *, QUBIT *, const Modifiers *);
-void __catalyst__qis__IsingXX(double, QUBIT *, QUBIT *, const Modifiers *);
-void __catalyst__qis__IsingYY(double, QUBIT *, QUBIT *, const Modifiers *);
-void __catalyst__qis__IsingXY(double, QUBIT *, QUBIT *, const Modifiers *);
-void __catalyst__qis__IsingZZ(double, QUBIT *, QUBIT *, const Modifiers *);
-void __catalyst__qis__ControlledPhaseShift(double, QUBIT *, QUBIT *, const Modifiers *);
-void __catalyst__qis__CRX(double, QUBIT *, QUBIT *, const Modifiers *);
-void __catalyst__qis__CRY(double, QUBIT *, QUBIT *, const Modifiers *);
-void __catalyst__qis__CRZ(double, QUBIT *, QUBIT *, const Modifiers *);
-void __catalyst__qis__CRot(double, double, double, QUBIT *, QUBIT *, const Modifiers *);
-void __catalyst__qis__CSWAP(QUBIT *, QUBIT *, QUBIT *, const Modifiers *);
-void __catalyst__qis__Toffoli(QUBIT *, QUBIT *, QUBIT *, const Modifiers *);
-void __catalyst__qis__MultiRZ(double, const Modifiers *, int64_t, /*qubits*/...);
-void __catalyst__qis__GlobalPhase(double, const Modifiers *);
-void __catalyst__qis__ISWAP(QUBIT *, QUBIT *, const Modifiers *);
-void __catalyst__qis__PSWAP(double, QUBIT *, QUBIT *, const Modifiers *);
-
-// Struct pointer arguments for these instructions represent real arguments,
-// as passing structs by value is too unreliable / compiler dependant.
-void __catalyst__qis__QubitUnitary(MemRefT_CplxT_double_2d *, const Modifiers *, int64_t,
-                                   /*qubits*/...);
-
-ObsIdType __catalyst__qis__NamedObs(int64_t, QUBIT *);
-ObsIdType __catalyst__qis__HermitianObs(MemRefT_CplxT_double_2d *, int64_t, /*qubits*/...);
-ObsIdType __catalyst__qis__TensorObs(int64_t, /*obsKeys*/...);
-ObsIdType __catalyst__qis__HamiltonianObs(MemRefT_double_1d *, int64_t, /*obsKeys*/...);
-
-// Struct pointers arguments here represent return values.
-RESULT *__catalyst__qis__Measure(QUBIT *, int32_t);
-double __catalyst__qis__Expval(ObsIdType);
-double __catalyst__qis__Variance(ObsIdType);
-void __catalyst__qis__Probs(MemRefT_double_1d *, int64_t, /*qubits*/...);
-void __catalyst__qis__Sample(MemRefT_double_2d *, int64_t, int64_t, /*qubits*/...);
-void __catalyst__qis__Counts(PairT_MemRefT_double_int64_1d *, int64_t, int64_t, /*qubits*/...);
-void __catalyst__qis__State(MemRefT_CplxT_double_1d *, int64_t, /*qubits*/...);
-void __catalyst__qis__Gradient(int64_t, /*results*/...);
-void __catalyst__qis__Gradient_params(MemRefT_int64_1d *, int64_t, /*results*/...);
-
-void __catalyst__host__rt__unrecoverable_error();
-
-#ifdef __cplusplus
-} // extern "C"
-#endif
-
-#endif

pennylane_qrack-0.20.3/catalyst/runtime/include/Types.h

@@ -1,165 +0,0 @@
-// 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
-#ifndef TYPES_H
-#define TYPES_H
-
-#include <cmath>
-#include <cstdint>
-#include <limits>
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-// Qubit, Result and Observable types
-struct QUBIT;
-using QubitIdType = intptr_t;
-
-using RESULT = bool;
-using Result = RESULT *;
-using QirArray = void *;
-
-using ObsIdType = intptr_t;
-
-enum ObsId : int8_t {
-    Identity = 0,
-    PauliX,
-    PauliY,
-    PauliZ,
-    Hadamard,
-    Hermitian,
-};
-
-enum ObsType : int8_t {
-    Basic = 0,
-    TensorProd,
-    Hamiltonian,
-};
-
-// complex<float> type
-struct CplxT_float {
-    float real;
-    float imag;
-};
-
-// complex<double> type
-struct CplxT_double {
-    double real;
-    double imag;
-};
-
-enum NumericType : int8_t {
-    idx = 0,
-    i1,
-    i8,
-    i16,
-    i32,
-    i64,
-    f32,
-    f64,
-    c64,
-    c128,
-};
-
-// MemRefT<datatype, dimension=rank> type
-struct OpaqueMemRefT {
-    int64_t rank;
-    void *descriptor;
-    NumericType datatype;
-};
-
-// MemRefT<complex<double>, dimension=1> type
-struct MemRefT_CplxT_double_1d {
-    CplxT_double *data_allocated;
-    CplxT_double *data_aligned;
-    size_t offset;
-    size_t sizes[1];
-    size_t strides[1];
-};
-
-// MemRefT<complex<double>, dimension=2> type
-struct MemRefT_CplxT_double_2d {
-    CplxT_double *data_allocated;
-    CplxT_double *data_aligned;
-    size_t offset;
-    size_t sizes[2];
-    size_t strides[2];
-};
-
-// MemRefT<double, dimension=1> type
-struct MemRefT_double_1d {
-    double *data_allocated;
-    double *data_aligned;
-    size_t offset;
-    size_t sizes[1];
-    size_t strides[1];
-};
-
-// MemRefT<double, dimension=2> type
-struct MemRefT_double_2d {
-    double *data_allocated;
-    double *data_aligned;
-    size_t offset;
-    size_t sizes[2];
-    size_t strides[2];
-};
-
-// MemRefT<int64_t, dimension=1> type
-struct MemRefT_int64_1d {
-    int64_t *data_allocated;
-    int64_t *data_aligned;
-    size_t offset;
-    size_t sizes[1];
-    size_t strides[1];
-};
-
-// MemRefT<int64_t, dimension=1> type
-struct MemRefT_int8_1d {
-    int8_t *data_allocated;
-    int8_t *data_aligned;
-    size_t offset;
-    size_t sizes[1];
-    size_t strides[1];
-};
-
-// PairT<MemRefT<double, dimension=1>, MemRefT<int64, dimension=2>> type
-struct PairT_MemRefT_double_int64_1d {
-    struct MemRefT_double_1d first;
-    struct MemRefT_int64_1d second;
-};
-
-// Quantum operation modifiers
-struct Modifiers {
-    bool adjoint;
-    size_t num_controlled;
-    QUBIT *controlled_wires;
-    bool *controlled_values;
-};
-
-using CplxT_double = struct CplxT_double;
-using MemRefT_CplxT_double_1d = struct MemRefT_CplxT_double_1d;
-using MemRefT_CplxT_double_2d = struct MemRefT_CplxT_double_2d;
-using MemRefT_double_1d = struct MemRefT_double_1d;
-using MemRefT_double_2d = struct MemRefT_double_2d;
-using MemRefT_int64_1d = struct MemRefT_int64_1d;
-using PairT_MemRefT_double_int64_1d = struct PairT_MemRefT_double_int64_1d;
-using Modifiers = struct Modifiers;
-
-#ifdef __cplusplus
-} // extern "C"
-#endif
-
-#endif