From e5cc9885ce0bede6187191ed0cfe5be76bf868af Mon Sep 17 00:00:00 2001 From: Damian Steiger Date: Mon, 29 Oct 2018 19:53:03 +0100 Subject: [PATCH] Update docs of decompositions. (#281) --- docs/projectq.setups.decompositions.rst | 58 ++++++++++++++++--- .../setups/decompositions/qubitop2onequbit.py | 4 ++ 2 files changed, 53 insertions(+), 9 deletions(-) diff --git a/docs/projectq.setups.decompositions.rst b/docs/projectq.setups.decompositions.rst index a17e3d1bd..883395db6 100755 --- a/docs/projectq.setups.decompositions.rst +++ b/docs/projectq.setups.decompositions.rst @@ -9,18 +9,23 @@ The decomposition package is a collection of gate decomposition / replacement ru projectq.setups.decompositions.arb1qubit2rzandry projectq.setups.decompositions.barrier projectq.setups.decompositions.carb1qubit2cnotrzandry + projectq.setups.decompositions.cnot2cz projectq.setups.decompositions.cnu2toffoliandcu projectq.setups.decompositions.crz2cxandrz projectq.setups.decompositions.entangle projectq.setups.decompositions.globalphase projectq.setups.decompositions.ph2r projectq.setups.decompositions.qft2crandhadamard + projectq.setups.decompositions.qubitop2onequbit projectq.setups.decompositions.r2rzandph projectq.setups.decompositions.rx2rz projectq.setups.decompositions.ry2rz + projectq.setups.decompositions.sqrtswap2cnot + projectq.setups.decompositions.stateprep2cnot projectq.setups.decompositions.swap2cnot projectq.setups.decompositions.time_evolution projectq.setups.decompositions.toffoli2cnotandtgate + projectq.setups.decompositions.uniformlycontrolledr2cnot Submodules @@ -32,7 +37,7 @@ projectq.setups.decompositions.arb1qubit2rzandry module .. automodule:: projectq.setups.decompositions.arb1qubit2rzandry :members: :undoc-members: - + projectq.setups.decompositions.barrier module --------------------------------------------- @@ -48,6 +53,13 @@ projectq.setups.decompositions.carb1qubit2cnotrzandry module :members: :undoc-members: +projectq.setups.decompositions.cnot2cz module +--------------------------------------------- + +.. automodule:: projectq.setups.decompositions.cnot2cz + :members: + :undoc-members: + projectq.setups.decompositions.cnu2toffoliandcu module ------------------------------------------------------ @@ -61,35 +73,42 @@ projectq.setups.decompositions.crz2cxandrz module .. automodule:: projectq.setups.decompositions.crz2cxandrz :members: :undoc-members: - + projectq.setups.decompositions.entangle module ---------------------------------------------- .. automodule:: projectq.setups.decompositions.entangle :members: :undoc-members: - + projectq.setups.decompositions.globalphase module ------------------------------------------------- .. automodule:: projectq.setups.decompositions.globalphase :members: :undoc-members: - + projectq.setups.decompositions.ph2r module ------------------------------------------ .. automodule:: projectq.setups.decompositions.ph2r :members: :undoc-members: - + projectq.setups.decompositions.qft2crandhadamard module ------------------------------------------------------- .. automodule:: projectq.setups.decompositions.qft2crandhadamard :members: :undoc-members: - + +projectq.setups.decompositions.qubitop2onequbit module +------------------------------------------------------- + +.. automodule:: projectq.setups.decompositions.qubitop2onequbit + :members: + :undoc-members: + projectq.setups.decompositions.r2rzandph module ----------------------------------------------- @@ -110,7 +129,21 @@ projectq.setups.decompositions.ry2rz module .. automodule:: projectq.setups.decompositions.ry2rz :members: :undoc-members: - + +projectq.setups.decompositions.sqrtswap2cnot module +--------------------------------------------------- + +.. automodule:: projectq.setups.decompositions.sqrtswap2cnot + :members: + :undoc-members: + +projectq.setups.decompositions.stateprep2cnot module +---------------------------------------------------- + +.. automodule:: projectq.setups.decompositions.stateprep2cnot + :members: + :undoc-members: + projectq.setups.decompositions.swap2cnot module ----------------------------------------------- @@ -124,14 +157,21 @@ projectq.setups.decompositions.time_evolution module .. automodule:: projectq.setups.decompositions.time_evolution :members: :undoc-members: - + projectq.setups.decompositions.toffoli2cnotandtgate module ---------------------------------------------------------- .. automodule:: projectq.setups.decompositions.toffoli2cnotandtgate :members: :undoc-members: - + +projectq.setups.decompositions.uniformlycontrolledr2cnot module +--------------------------------------------------------------- + +.. automodule:: projectq.setups.decompositions.uniformlycontrolledr2cnot + :members: + :undoc-members: + Module contents --------------- diff --git a/projectq/setups/decompositions/qubitop2onequbit.py b/projectq/setups/decompositions/qubitop2onequbit.py index b66f64b25..61f7954e7 100644 --- a/projectq/setups/decompositions/qubitop2onequbit.py +++ b/projectq/setups/decompositions/qubitop2onequbit.py @@ -12,6 +12,10 @@ # See the License for the specific language governing permissions and # limitations under the License. +""" +Registers a decomposition rule for a unitary QubitOperator to one qubit gates. +""" + import cmath from projectq.cengines import DecompositionRule