Add QPager and QHybrid

WrathfulSpatula · WrathfulSpatula · commit 0d98c48e02c8 · 2020-09-06T10:32:12.000-04:00
diff --git a/docs/api/oclengine.rst b/docs/api/oclengine.rst
@@ -1,6 +1,6 @@
 :orphan:
 
-.. Copyright (c) 2018
+.. Copyright (c) 2017-2020
 
 OCLEngine
 ========================
diff --git a/docs/api/qenginecpu.rst b/docs/api/qenginecpu.rst
@@ -1,6 +1,6 @@
 :orphan:
 
-.. Copyright (c) 2018
+.. Copyright (c) 2017-2020
 
 QEngineCPU
 ========================
diff --git a/docs/api/qengineocl.rst b/docs/api/qengineocl.rst
@@ -1,6 +1,6 @@
 :orphan:
 
-.. Copyright (c) 2018
+.. Copyright (c) 2017-2020
 
 QEngineOCL
 ========================
diff --git a/docs/api/qhybrid.rst b/docs/api/qhybrid.rst
@@ -0,0 +1,16 @@
+:orphan:
+
+.. Copyright (c) 2017-2020
+
+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 combined 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.
+
+.. doxygenfunction:: Qrack::QHybrid::QHybrid(bitLenInt qBitCount, bitCapInt initState = 0, qrack_rand_gen_ptr rgp = nullptr, complex phaseFac = CMPLX_DEFAULT_ARG, bool doNorm = true, bool randomGlobalPhase = true, bool useHostMem = false, int deviceId = -1, bool useHardwareRNG = true, bool useSparseStateVec = false, real1 norm_thresh = REAL1_DEFAULT_ARG, std::vector<int> ignored = {}, bitLenInt qubitThreshold = 0)
+
+.. doxygenfunction:: Qrack::QHybrid::SwitchModes
diff --git a/docs/api/qinterface.rst b/docs/api/qinterface.rst
@@ -1,6 +1,6 @@
 :orphan:
 
-.. Copyright (c) 2018
+.. Copyright (c) 2017-2020
 
 QInterface
 ========================
diff --git a/docs/api/qpager.rst b/docs/api/qpager.rst
@@ -0,0 +1,14 @@
+:orphan:
+
+.. Copyright (c) 2017-2020
+
+QPager
+========================
+
+Defined in `qpager.hpp <https://github.com/vm6502q/qrack/blob/master/include/qpager.hpp>`_.
+
+Qrack::QPager "pages" RAM between several QEngineCPU or QEngineOCL instances, by splitting the simulation into equal segments. QEngineOCL device IDs can by individually specified per page with the "devList" parameter. This allows for a different model of multi-device parallelism.
+
+The parameter "qubitThreshold" is the number of qubits in each "page." A value of "0" will automatically size pages based on best estimates of efficiency.
+
+.. doxygenfunction:: Qrack::QPager::QPager(QInterfaceEngine eng, bitLenInt qBitCount, bitCapInt initState = 0, qrack_rand_gen_ptr rgp = nullptr, complex phaseFac = CMPLX_DEFAULT_ARG, bool ignored = false, bool ignored2 = false, bool useHostMem = false, int deviceId = -1, bool useHardwareRNG = true, bool useSparseStateVec = false, real1 ignored3 = REAL1_DEFAULT_ARG, std::vector<int> devList = {}, bitLenInt qubitThreshold = 0);
diff --git a/docs/api/qunit.rst b/docs/api/qunit.rst
@@ -1,6 +1,6 @@
 :orphan:
 
-.. Copyright (c) 2018
+.. Copyright (c) 2017-2020
 
 QUnit
 ========================
diff --git a/docs/index.rst b/docs/index.rst
@@ -58,6 +58,8 @@ Daniel Strano would like to specifically note that Benn Bollay is almost entirel
     api/oclengine
     api/qenginecpu
     api/qengineocl
+    api/qhybrid
+    api/qpager
     api/qunit
     api/6502
 
