QEngine docs

vm6502q · Dec 4, 2021 · 39f4749 · 39f4749
1 parent 102da2c
commit 39f4749
Show file tree

Hide file tree

Showing 2 changed files with 33 additions and 0 deletions.
diff --git a/docs/api/qengine.rst b/docs/api/qengine.rst
@@ -0,0 +1,32 @@
+:orphan:
+
+.. Copyright (c) 2017-2021
+
+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.
+
+.. doxygenfunction:: Qrack::QEngine::QEngine(bitLenInt, qrack_rand_gen_ptr, bool, bool, bool, bool, real1_f)
+
+.. doxygenfunction:: Qrack::QEngine::QEngine()
+
+.. doxygenfunction:: Qrack::QEngine::ZeroAmplitudes
+
+.. doxygenfunction:: Qrack::QEngine::CopyStateVec
+
+.. doxygenfunction:: Qrack::QEngine::IsZeroAmplitude
+
+.. doxygenfunction:: Qrack::QEngine::GetAmplitudePage
+
+.. doxygenfunction:: Qrack::QEngine::SetAmplitudePage(const complex*, const bitCapIntOcl, const bitCapIntOcl)
+
+.. doxygenfunction:: Qrack::QEngine::SetAmplitudePage(QEnginePtr, const bitCapIntOcl, const bitCapIntOcl, const bitCapIntOcl)
+
+.. doxygenfunction:: Qrack::QEngine::ShuffleBuffers
+
+.. doxygenfunction:: Qrack::QEngine::QueueSetDoNormalize
+
+.. doxygenfunction:: Qrack::QEngine::QueueSetRunningNorm
diff --git a/docs/index.rst b/docs/index.rst
@@ -36,6 +36,7 @@ Daniel Strano would like to specifically note that Benn Bollay is almost entirel
 
     api/qinterface
     api/oclengine
+    api/qengine
     api/qenginecpu
     api/qengineocl
     api/qhybrid