SetAmplitudePage and QEngine

vm6502q · Dec 4, 2021 · 6ce0333 · 6ce0333
1 parent 39f4749
commit 6ce0333
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 5 deletions.
diff --git a/docs/api/qengine.rst b/docs/api/qengine.rst
@@ -7,7 +7,7 @@ QEngine
 
 Defined in `qengine.hpp <https://github.com/vm6502q/qrack/blob/master/include/qengine.hpp>`_.
 
-This is an intermediate specialization that inherits from Qrack::QInterface. This type is specifically a "state vector" simulation, with corresponding special methods.
+This is an (abstract) intermediate specialization that inherits from Qrack::QInterface. This type is specifically a "state vector" simulation, with corresponding special methods.
 
 .. doxygenfunction:: Qrack::QEngine::QEngine(bitLenInt, qrack_rand_gen_ptr, bool, bool, bool, bool, real1_f)
 
@@ -21,7 +21,7 @@ This is an intermediate specialization that inherits from Qrack::QInterface. Thi
 
 .. doxygenfunction:: Qrack::QEngine::GetAmplitudePage
 
-.. doxygenfunction:: Qrack::QEngine::SetAmplitudePage(const complex*, const bitCapIntOcl, const bitCapIntOcl)
+.. doxygenfunction:: Qrack::QEngine::SetAmplitudePage(const complex *, const bitCapIntOcl, const bitCapIntOcl)
 
 .. doxygenfunction:: Qrack::QEngine::SetAmplitudePage(QEnginePtr, const bitCapIntOcl, const bitCapIntOcl, const bitCapIntOcl)
 

diff --git a/docs/api/qenginecpu.rst b/docs/api/qenginecpu.rst
@@ -7,6 +7,6 @@ QEngineCPU
 
 Defined in `qengine_cpu.hpp <https://github.com/vm6502q/qrack/blob/master/include/qengine_cpu.hpp>`_.
 
-The API is provided by Qrack::QInterface. This is a general purpose implementation of Qrack::QInterface, without OpenCL.
+The API is provided by Qrack::QInterface, via Qrack::Engine. This is a general purpose implementation of Qrack::QInterface, without OpenCL.
 
 .. doxygenfunction:: Qrack::QEngineOCL::QEngineCPU(bitLenInt, bitCapInt, qrack_rand_gen_ptr, complex, bool, bool, bool, int, bool, bool, real1, std::vector<int>, bitLenInt)
diff --git a/docs/api/qengineocl.rst b/docs/api/qengineocl.rst
@@ -7,6 +7,6 @@ QEngineOCL
 
 Defined in `qengine_opencl.hpp <https://github.com/vm6502q/qrack/blob/master/include/qengine_opencl.hpp>`_.
 
-The API is provided by Qrack::QInterface. However, QEngineOCL has a custom constructor:
+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)
diff --git a/docs/api/qhybrid.rst b/docs/api/qhybrid.rst
@@ -7,7 +7,7 @@ QHybrid
 
 Defined in `qhybrid.hpp <https://github.com/vm6502q/qrack/blob/master/include/qhybrid.hpp>`_.
 
-Qrack::QHybrid switches between QEngineCPU and QEngineOCL as optimal. It may be used as sub-engine type with Qrack::QUnit. It supports the standard Qrack::QInterface API.
+Qrack::QHybrid is a Qrack::Engine that switches between QEngineCPU and QEngineOCL as optimal. It may be used as sub-engine type with Qrack::QUnit. It supports the standard Qrack::QInterface API.
 
 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.