Add API-specific documentation for a CoherentUnit

docs/api/coherent_unit.rst

@@ -0,0 +1,133 @@
+:orphan:
+
+.. Copyright (c) 2018
+
+.. _coherent-unit-reference:
+
+
+``CoherentUnit``
+================
+
+Defined in `qregister.hpp <https://github.com/vm6502q/qrack/blob/master/qregister.hpp>`_.
+
+.. doxygenclass:: Qrack::CoherentUnit
+    :project: qrack
+
+Creating a CoherentUnit
+-----------------------
+
+There's two primary implementations of a ``CoherentUnit``:
+
+.. doxygenenum:: Qrack::CoherentUnitEngine
+
+These enums can be passed to an allocator to create a ``CoherentUnit`` of that specified implementation type:
+
+.. doxygenfunction:: Qrack::CreateCoherentUnit
+
+Constructors
+------------
+
+.. doxygenfunction:: CoherentUnit(bitLenInt)
+
+.. doxygenfunction:: CoherentUnit(bitLenInt, bitCapInt)
+
+.. doxygenfunction:: CoherentUnit(const CoherentUnit&)
+
+Utility and Configuration Methods
+---------------------------------
+
+.. doxygenfunction:: SetRandomSeed
+
+.. doxygenfunction:: GetQubitCount
+
+.. doxygenfunction:: GetMaxQPower
+
+State Manipulation Methods
+--------------------------
+
+.. doxygenfunction:: CloneRawState
+
+.. doxygenfunction:: SetPermutation
+
+.. doxygenfunction:: SetQuantumState
+
+.. doxygenfunction:: Cohere
+
+.. doxygenfunction:: Decohere
+
+.. doxygenfunction:: Dispose
+
+.. doxygenfunction:: Prob
+
+.. doxygenfunction:: ProbAll
+
+.. doxygenfunction:: ProbArray
+
+Quantum Gates
+-------------
+
+.. note:: Most gates offer both a single-bit version taking just the index to the qubit, as well as a register-spanning variant for convienence and performance that performs the gate across a sequence of bits.  Only the latter is documented here.
+
+.. doxygenfunction:: AND(bitLenInt, bitLenInt, bitLenInt)
+
+.. doxygenfunction:: CLAND(bitLenInt, bitCapInt, bitLenInt, bitLenInt)
+
+.. doxygenfunction:: OR(bitLenInt, bitLenInt, bitLenInt)
+
+.. doxygenfunction:: CLOR(bitLenInt, bitCapInt, bitLenInt, bitLenInt)
+
+.. doxygenfunction:: XOR(bitLenInt, bitLenInt, bitLenInt)
+
+.. doxygenfunction:: CLXOR(bitLenInt, bitCapInt, bitLenInt, bitLenInt)
+
+.. doxygenfunction:: CCNOT
+
+.. doxygenfunction:: AntiCCNOT
+
+.. doxygenfunction:: CNOT(bitLenInt, bitLenInt, bitLenInt)
+
+.. doxygenfunction:: AntiCNOT
+
+.. doxygenfunction:: H(bitLenInt, bitLenInt)
+
+.. doxygenfunction:: M(bitLenInt, bitLenInt)
+
+.. doxygenfunction:: X(bitLenInt, bitLenInt)
+
+.. doxygenfunction:: Y(bitLenInt, bitLenInt)
+
+.. doxygenfunction:: Z(bitLenInt, bitLenInt)
+
+.. doxygenfunction:: CY(bitLenInt, bitLenInt, bitLenInt)
+
+.. doxygenfunction:: CZ(bitLenInt, bitLenInt, bitLenInt)
+
+.. doxygenfunction:: R1(double, bitLenInt, bitLenInt)
+
+.. doxygenfunction:: R1Dyad(int, int, bitLenInt, bitLenInt)
+
+.. doxygenfunction:: RX(double, bitLenInt, bitLenInt)
+
+.. doxygenfunction:: RXDyad(int, int, bitLenInt, bitLenInt)
+
+.. doxygenfunction:: CRX(double, bitLenInt, bitLenInt, bitLenInt)
+
+.. doxygenfunction:: CRXDyad(int, int, bitLenInt, bitLenInt, bitLenInt)
+
+.. doxygenfunction:: RY(double, bitLenInt, bitLenInt)
+
+.. doxygenfunction:: RYDyad(int, int, bitLenInt, bitLenInt)
+
+.. doxygenfunction:: CRY(double, bitLenInt, bitLenInt, bitLenInt)
+
+.. doxygenfunction:: CRYDyad(int, int, bitLenInt, bitLenInt, bitLenInt)
+
+.. doxygenfunction:: RZ(double, bitLenInt, bitLenInt)
+
+.. doxygenfunction:: RZDyad(int, int, bitLenInt, bitLenInt)
+
+.. doxygenfunction:: CRZ(double, bitLenInt, bitLenInt, bitLenInt)
+
+.. doxygenfunction:: CRZDyad(int, int, bitLenInt, bitLenInt, bitLenInt)
+
+