v9.10.0

vm6502q · Oct 5, 2024 · 397cf1b · 397cf1b
1 parent f3c4382
commit 397cf1b
Show file tree

Hide file tree

Showing 10 changed files with 22 additions and 39 deletions.
diff --git a/docs/api/qbdt.rst b/docs/api/qbdt.rst
@@ -9,5 +9,5 @@ Defined in `QBdt.hpp <https://github.com/vm6502q/qrack/blob/main/include/qbinary
 
 The API is provided by Qrack::QInterface. Qrack::QBdt is an attempt at an alternative representation of quantum pure states, in terms of quantum binary decision trees, inspired by `other open source work <https://iic.jku.at/eda/research/quantum_dd/>`_.
 
-.. doxygenfunction:: Qrack::QBdt::QBdt(bitLenInt, bitCapInt, qrack_rand_gen_ptr, complex, bool, bool, bool, int64_t, bool, bool, real1_f, std::vector<int64_t>, bitLenInt, real1_f)
-.. doxygenfunction:: Qrack::QBdt::QBdt(std::vector<QInterfaceEngine>, bitLenInt, bitCapInt, qrack_rand_gen_ptr, complex, bool, bool, bool, int64_t, bool, bool, real1_f, std::vector<int64_t>, bitLenInt, real1_f)
+.. doxygenfunction:: Qrack::QBdt::QBdt(bitLenInt, const bitCapInt&, qrack_rand_gen_ptr, const complex&, bool, bool, bool, int64_t, bool, bool, real1_f, std::vector<int64_t>, bitLenInt, real1_f)
+.. doxygenfunction:: Qrack::QBdt::QBdt(std::vector<QInterfaceEngine>, bitLenInt, const bitCapInt&, qrack_rand_gen_ptr, const complex&, bool, bool, bool, int64_t, bool, bool, real1_f, std::vector<int64_t>, bitLenInt, real1_f)
diff --git a/docs/api/qengine.rst b/docs/api/qengine.rst
@@ -21,7 +21,7 @@ This is an (abstract) intermediate specialization that inherits from Qrack::QInt
 
 .. doxygenfunction:: Qrack::QEngine::GetAmplitudePage
 
-.. doxygenfunction:: Qrack::QEngine::SetAmplitudePage(complex const *, bitCapIntOcl, bitCapIntOcl)
+.. doxygenfunction:: Qrack::QEngine::SetAmplitudePage(const complex*, bitCapIntOcl, bitCapIntOcl)
 
 .. doxygenfunction:: Qrack::QEngine::SetAmplitudePage(QEnginePtr, bitCapIntOcl, bitCapIntOcl, bitCapIntOcl) 
 

diff --git a/docs/api/qenginecpu.rst b/docs/api/qenginecpu.rst
@@ -9,4 +9,4 @@ Defined in `qengine_cpu.hpp <https://github.com/vm6502q/qrack/blob/master/includ
 
 The API is provided by Qrack::QInterface, via Qrack::Engine. This is a general purpose implementation of Qrack::QInterface, without OpenCL.
 
-.. doxygenfunction:: Qrack::QEngineCPU::QEngineCPU(bitLenInt, bitCapInt, qrack_rand_gen_ptr, complex, bool, bool, bool, int, bool, bool, real1, std::vector<int>, bitLenInt)
+.. doxygenfunction:: Qrack::QEngineCPU::QEngineCPU(bitLenInt, const bitCapInt&, qrack_rand_gen_ptr, const complex&, bool, bool, bool, int, bool, bool, real1_f, std::vector<int>, bitLenInt)
diff --git a/docs/api/qengineocl.rst b/docs/api/qengineocl.rst
@@ -9,4 +9,4 @@ Defined in `qengine_opencl.hpp <https://github.com/vm6502q/qrack/blob/master/inc
 
 The API is provided by Qrack::QInterface, via Qrack::Engine. However, QEngineOCL has a custom constructor:
 
-.. doxygenfunction:: Qrack::QEngineOCL::QEngineOCL(bitLenInt, bitCapInt, qrack_rand_gen_ptr, complex, bool, bool, bool, int, bool, bool, real1, std::vector<int>, bitLenInt)
+.. doxygenfunction:: Qrack::QEngineOCL::QEngineOCL(bitLenInt, const bitCapInt&, qrack_rand_gen_ptr, const complex&, bool, bool, bool, int, bool, bool, real1_f, std::vector<int>, bitLenInt)
diff --git a/docs/api/qhybrid.rst b/docs/api/qhybrid.rst
@@ -11,6 +11,6 @@ Qrack::QHybrid is a Qrack::Engine that switches between QEngineCPU and QEngineOC
 
 The parameter "qubitThreshold" is the number of qubits at which QHybrid will automatically switch to GPU operation. A value of "0" will automatically pick this threshold based on best estimates of efficiency.
 
-.. doxygenfunction:: Qrack::QHybrid::QHybrid(bitLenInt, bitCapInt, qrack_rand_gen_ptr, complex, bool, bool, bool, int, bool, bool, real1, std::vector<int>, bitLenInt)
+.. doxygenfunction:: Qrack::QHybrid::QHybrid(bitLenInt, const bitCapInt&, qrack_rand_gen_ptr, const complex&, bool, bool, bool, int, bool, bool, real1_f, std::vector<int>, bitLenInt)
 
 .. doxygenfunction:: Qrack::QHybrid::SwitchModes
diff --git a/docs/api/qinterface_noisy.rst b/docs/api/qinterface_noisy.rst
@@ -0,0 +1,12 @@
+:orphan:
+
+.. Copyright (c) 2017-2023
+
+QInterfaceNoisy
+========================
+
+Defined in `qinterface_noisy.hpp <https://github.com/vm6502q/qrack/blob/main/include/qinterface_noisy.hpp>`_.
+
+The API is provided by Qrack::QInterface. Qrack::QInterfaceNoisy adds depolarizing noise to every gate executed on the simulator instance. Noise level can be controlled with `SetNoiseParameter(real1_f)` or the environment variable `QRACK_GATE_DEPOLARIZATION`.
+
+.. doxygenfunction:: Qrack::QInterfaceNoisy::SetNoiseParameter(real1_f)
diff --git a/docs/api/qmaskfusion.rst b/docs/api/qmaskfusion.rst
diff --git a/docs/api/qstabilizerhybrid.rst b/docs/api/qstabilizerhybrid.rst
@@ -9,5 +9,5 @@ Defined in `qstabilizerhybrid.hpp <https://github.com/vm6502q/qrack/blob/main/in
 
 The API is provided by Qrack::QInterface. This is an extended "stabilizer" or "Clifford" simulation. If a Qrack::QInterface method call cannot be carried out by this simulator via "stabilizer" simulation methods, it will automatically convert to traditional state vector representation, (while keep its Qrack::QStabilizerHybrid class type).
 
-.. doxygenfunction:: Qrack::QStabilizerHybrid::QStabilizerHybrid(bitLenInt, bitCapInt, qrack_rand_gen_ptr, complex, bool, bool, bool, int64_t, bool, bool, real1_f, std::vector<int64_t>, bitLenInt, real1_f)
-.. doxygenfunction:: Qrack::QStabilizerHybrid::QStabilizerHybrid(std::vector<QInterfaceEngine>, bitLenInt, bitCapInt, qrack_rand_gen_ptr, complex, bool, bool, bool, int64_t, bool, bool, real1_f, std::vector<int64_t>, bitLenInt, real1_f)
+.. doxygenfunction:: Qrack::QStabilizerHybrid::QStabilizerHybrid(bitLenInt, const bitCapInt&, qrack_rand_gen_ptr, const complex&, bool, bool, bool, int64_t, bool, bool, real1_f, std::vector<int64_t>, bitLenInt, real1_f)
+.. doxygenfunction:: Qrack::QStabilizerHybrid::QStabilizerHybrid(std::vector<QInterfaceEngine>, bitLenInt, const bitCapInt&, qrack_rand_gen_ptr, const complex&, bool, bool, bool, int64_t, bool, bool, real1_f, std::vector<int64_t>, bitLenInt, real1_f)
diff --git a/docs/index.rst b/docs/index.rst
@@ -30,7 +30,6 @@ Daniel Strano would like to specifically note that Benn Bollay is almost entirel
     opencl
     examples
     implementation
-    noisy
     performance
     hardware
 
@@ -52,6 +51,7 @@ Daniel Strano would like to specifically note that Benn Bollay is almost entirel
     api/qunitmulti
     api/qbdt
     api/qtensornetwork
+    api/qinterface_noisy
     api/qcircuit
     api/6502
 
@@ -80,5 +80,6 @@ Daniel Strano would like to specifically note that Benn Bollay is almost entirel
     QUnitMulti </en/latest/_static/doxygen/classQrack_1_1QUnitMulti.html#http://>
     QBdt </en/latest/_static/doxygen/classQrack_1_1QBdt.html#http://>
     QTensorNetwork </en/latest/_static/doxygen/classQrack_1_1QTensorNetwork.html#http://>
+    QInterfaceNoisy </en/latest/_static/doxygen/classQrack_1_1QInterfaceNoisy.html#http://>
     QCircuit </en/latest/_static/doxygen/classQrack_1_1QCircuit.html#http://>
 
diff --git a/docs/noisy.rst b/docs/noisy.rst
Original file line number	Diff line number	Diff line change
Expand Up		@@ -9,4 +9,4 @@ Defined in `qengine_cpu.hpp <https://github.com/vm6502q/qrack/blob/master/includ

		The API is provided by Qrack::QInterface, via Qrack::Engine. This is a general purpose implementation of Qrack::QInterface, without OpenCL.

		.. doxygenfunction:: Qrack::QEngineCPU::QEngineCPU(bitLenInt, bitCapInt, qrack_rand_gen_ptr, complex, bool, bool, bool, int, bool, bool, real1, std::vector<int>, bitLenInt)
		.. doxygenfunction:: Qrack::QEngineCPU::QEngineCPU(bitLenInt, const bitCapInt&, qrack_rand_gen_ptr, const complex&, bool, bool, bool, int, bool, bool, real1_f, std::vector<int>, bitLenInt)
Original file line number	Diff line number	Diff line change
Expand Up		@@ -9,4 +9,4 @@ Defined in `qengine_opencl.hpp <https://github.com/vm6502q/qrack/blob/master/inc

		The API is provided by Qrack::QInterface, via Qrack::Engine. However, QEngineOCL has a custom constructor:

		.. doxygenfunction:: Qrack::QEngineOCL::QEngineOCL(bitLenInt, bitCapInt, qrack_rand_gen_ptr, complex, bool, bool, bool, int, bool, bool, real1, std::vector<int>, bitLenInt)
		.. doxygenfunction:: Qrack::QEngineOCL::QEngineOCL(bitLenInt, const bitCapInt&, qrack_rand_gen_ptr, const complex&, bool, bool, bool, int, bool, bool, real1_f, std::vector<int>, bitLenInt)