Fix API

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

Hide file tree

Showing 6 changed files with 9 additions and 9 deletions.
diff --git a/docs/api/oclengine.rst b/docs/api/oclengine.rst
@@ -23,7 +23,7 @@ OCLEngine is a singleton class that manages all OpenCL devices and supported obj
 Configuration Methods
 ---------------------------------
 
-.. doxygenfunction:: Qrack::OCLEngine::GetDeviceContextPtr(const int&)
+.. doxygenfunction:: Qrack::OCLEngine::GetDeviceContextPtr(const int64_t&)
 .. doxygenfunction:: Qrack::OCLEngine::GetDeviceContextPtrVector()
 .. doxygenfunction:: Qrack::OCLEngine::SetDeviceContextPtrVector(std::vector<DeviceContextPtr>, DeviceContextPtr)
 .. doxygenfunction:: Qrack::OCLEngine::GetDeviceCount()

diff --git a/docs/api/qalu.rst b/docs/api/qalu.rst
@@ -16,8 +16,8 @@ This is an interface layer, separate from and in addition to `Qrack::QInterface`
 Arithmetic
 --------------------------
 
-.. doxygenfunction:: Qrack::QAlu::INCSC(bitCapInt, bitLenInt, bitLenInt, bitLenInt, bitLenInt)
-.. doxygenfunction:: Qrack::QAlu::INCSC(bitCapInt, bitLenInt, bitLenInt, bitLenInt)
+.. doxygenfunction:: Qrack::QAlu::INCSC(const bitCapInt&, bitLenInt, bitLenInt, bitLenInt, bitLenInt)
+.. doxygenfunction:: Qrack::QAlu::INCSC(const bitCapInt&, bitLenInt, bitLenInt, bitLenInt)
 .. doxygenfunction:: Qrack::QAlu::MUL
 .. doxygenfunction:: Qrack::QAlu::DIV
 .. doxygenfunction:: Qrack::QAlu::CMUL

diff --git a/docs/api/qcircuit.rst b/docs/api/qcircuit.rst
@@ -11,8 +11,8 @@ This is a class that represents and optimizes a simple quantum "circuit," (witho
 
 Via `QCircuitGate`, the fundamental "atomic" gate of a `QCircuit` is "uniformly controlled." (See `Quantum circuits with uniformly controlled one-qubit gates <https://arxiv.org/abs/quant-ph/0410066>`_.) In other words, a different "target qubit payload" (as a 2x2 operator on a single qubit, controlled) is associated with every logical permutation of control qubits, which can greatly optimize performance through coalescence in an efficient form for state vector simulation.
 
-.. doxygenfunction:: Qrack::QCircuit::QCircuit(bool)
-.. doxygenfunction:: Qrack::QCircuit::QCircuit(bitLenInt, const std::list<QCircuitGatePtr>&, bool)
+.. doxygenfunction:: Qrack::QCircuit::QCircuit(bool, bool)
+.. doxygenfunction:: Qrack::QCircuit::QCircuit(bitLenInt, const std::list<QCircuitGatePtr>&, bool, bool)
 .. doxygenfunction:: Qrack::QCircuit::Clone()
 .. doxygenfunction:: Qrack::QCircuit::Inverse()
 .. doxygenfunction:: Qrack::QCircuit::Append(QCircuitPtr)
@@ -37,5 +37,5 @@ QCircuitGate
 .. doxygenfunction:: Qrack::QCircuitGate::QCircuitGate()
 .. doxygenfunction:: Qrack::QCircuitGate::QCircuitGate(bitLenInt, bitLenInt)
 .. doxygenfunction:: Qrack::QCircuitGate::QCircuitGate(bitLenInt, const complex[])
-.. doxygenfunction:: Qrack::QCircuitGate::QCircuitGate(bitLenInt, const complex[], const std::set<bitLenInt>&, bitCapInt)
+.. doxygenfunction:: Qrack::QCircuitGate::QCircuitGate(bitLenInt, const complex[], const std::set<bitLenInt>&, const bitCapInt&)
 .. doxygenfunction:: Qrack::QCircuitGate::QCircuitGate(bitLenInt, const std::map<bitCapInt, std::shared_ptr<complex>>&, const std::set<bitLenInt>&)
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, const bitCapInt&, qrack_rand_gen_ptr, const complex&, bool, bool, bool, int, bool, bool, real1_f, std::vector<int>, bitLenInt)
+.. doxygenfunction:: Qrack::QEngineCPU::QEngineCPU(bitLenInt, const bitCapInt&, qrack_rand_gen_ptr, const complex&, bool, bool, bool, int64_t, 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, const bitCapInt&, qrack_rand_gen_ptr, const complex&, bool, bool, bool, int, bool, bool, real1_f, std::vector<int>, bitLenInt)
+.. doxygenfunction:: Qrack::QEngineOCL::QEngineOCL(bitLenInt, const bitCapInt&, qrack_rand_gen_ptr, const complex&, bool, bool, bool, int64_t, 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, const bitCapInt&, qrack_rand_gen_ptr, const complex&, bool, bool, bool, int, bool, bool, real1_f, std::vector<int>, bitLenInt)
+.. doxygenfunction:: Qrack::QHybrid::QHybrid(bitLenInt, const bitCapInt&, qrack_rand_gen_ptr, const complex&, bool, bool, bool, int64_t, bool, bool, real1_f, std::vector<int>, bitLenInt)
 
 .. doxygenfunction:: Qrack::QHybrid::SwitchModes
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, const bitCapInt&, qrack_rand_gen_ptr, const complex&, bool, bool, bool, int, bool, bool, real1_f, std::vector<int>, bitLenInt)
		.. doxygenfunction:: Qrack::QEngineCPU::QEngineCPU(bitLenInt, const bitCapInt&, qrack_rand_gen_ptr, const complex&, bool, bool, bool, int64_t, 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, const bitCapInt&, qrack_rand_gen_ptr, const complex&, bool, bool, bool, int, bool, bool, real1_f, std::vector<int>, bitLenInt)
		.. doxygenfunction:: Qrack::QEngineOCL::QEngineOCL(bitLenInt, const bitCapInt&, qrack_rand_gen_ptr, const complex&, bool, bool, bool, int64_t, bool, bool, real1_f, std::vector<int>, bitLenInt)