Skip to content

Commit e5cc988

Browse files
Update docs of decompositions. (#281)
1 parent 78bfb92 commit e5cc988

File tree

2 files changed

+53
-9
lines changed

2 files changed

+53
-9
lines changed

docs/projectq.setups.decompositions.rst

Lines changed: 49 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,18 +9,23 @@ The decomposition package is a collection of gate decomposition / replacement ru
99
projectq.setups.decompositions.arb1qubit2rzandry
1010
projectq.setups.decompositions.barrier
1111
projectq.setups.decompositions.carb1qubit2cnotrzandry
12+
projectq.setups.decompositions.cnot2cz
1213
projectq.setups.decompositions.cnu2toffoliandcu
1314
projectq.setups.decompositions.crz2cxandrz
1415
projectq.setups.decompositions.entangle
1516
projectq.setups.decompositions.globalphase
1617
projectq.setups.decompositions.ph2r
1718
projectq.setups.decompositions.qft2crandhadamard
19+
projectq.setups.decompositions.qubitop2onequbit
1820
projectq.setups.decompositions.r2rzandph
1921
projectq.setups.decompositions.rx2rz
2022
projectq.setups.decompositions.ry2rz
23+
projectq.setups.decompositions.sqrtswap2cnot
24+
projectq.setups.decompositions.stateprep2cnot
2125
projectq.setups.decompositions.swap2cnot
2226
projectq.setups.decompositions.time_evolution
2327
projectq.setups.decompositions.toffoli2cnotandtgate
28+
projectq.setups.decompositions.uniformlycontrolledr2cnot
2429

2530

2631
Submodules
@@ -32,7 +37,7 @@ projectq.setups.decompositions.arb1qubit2rzandry module
3237
.. automodule:: projectq.setups.decompositions.arb1qubit2rzandry
3338
:members:
3439
:undoc-members:
35-
40+
3641

3742
projectq.setups.decompositions.barrier module
3843
---------------------------------------------
@@ -48,6 +53,13 @@ projectq.setups.decompositions.carb1qubit2cnotrzandry module
4853
:members:
4954
:undoc-members:
5055

56+
projectq.setups.decompositions.cnot2cz module
57+
---------------------------------------------
58+
59+
.. automodule:: projectq.setups.decompositions.cnot2cz
60+
:members:
61+
:undoc-members:
62+
5163
projectq.setups.decompositions.cnu2toffoliandcu module
5264
------------------------------------------------------
5365

@@ -61,35 +73,42 @@ projectq.setups.decompositions.crz2cxandrz module
6173
.. automodule:: projectq.setups.decompositions.crz2cxandrz
6274
:members:
6375
:undoc-members:
64-
76+
6577
projectq.setups.decompositions.entangle module
6678
----------------------------------------------
6779

6880
.. automodule:: projectq.setups.decompositions.entangle
6981
:members:
7082
:undoc-members:
71-
83+
7284
projectq.setups.decompositions.globalphase module
7385
-------------------------------------------------
7486

7587
.. automodule:: projectq.setups.decompositions.globalphase
7688
:members:
7789
:undoc-members:
78-
90+
7991
projectq.setups.decompositions.ph2r module
8092
------------------------------------------
8193

8294
.. automodule:: projectq.setups.decompositions.ph2r
8395
:members:
8496
:undoc-members:
85-
97+
8698
projectq.setups.decompositions.qft2crandhadamard module
8799
-------------------------------------------------------
88100

89101
.. automodule:: projectq.setups.decompositions.qft2crandhadamard
90102
:members:
91103
:undoc-members:
92-
104+
105+
projectq.setups.decompositions.qubitop2onequbit module
106+
-------------------------------------------------------
107+
108+
.. automodule:: projectq.setups.decompositions.qubitop2onequbit
109+
:members:
110+
:undoc-members:
111+
93112
projectq.setups.decompositions.r2rzandph module
94113
-----------------------------------------------
95114

@@ -110,7 +129,21 @@ projectq.setups.decompositions.ry2rz module
110129
.. automodule:: projectq.setups.decompositions.ry2rz
111130
:members:
112131
:undoc-members:
113-
132+
133+
projectq.setups.decompositions.sqrtswap2cnot module
134+
---------------------------------------------------
135+
136+
.. automodule:: projectq.setups.decompositions.sqrtswap2cnot
137+
:members:
138+
:undoc-members:
139+
140+
projectq.setups.decompositions.stateprep2cnot module
141+
----------------------------------------------------
142+
143+
.. automodule:: projectq.setups.decompositions.stateprep2cnot
144+
:members:
145+
:undoc-members:
146+
114147
projectq.setups.decompositions.swap2cnot module
115148
-----------------------------------------------
116149

@@ -124,14 +157,21 @@ projectq.setups.decompositions.time_evolution module
124157
.. automodule:: projectq.setups.decompositions.time_evolution
125158
:members:
126159
:undoc-members:
127-
160+
128161
projectq.setups.decompositions.toffoli2cnotandtgate module
129162
----------------------------------------------------------
130163

131164
.. automodule:: projectq.setups.decompositions.toffoli2cnotandtgate
132165
:members:
133166
:undoc-members:
134-
167+
168+
projectq.setups.decompositions.uniformlycontrolledr2cnot module
169+
---------------------------------------------------------------
170+
171+
.. automodule:: projectq.setups.decompositions.uniformlycontrolledr2cnot
172+
:members:
173+
:undoc-members:
174+
135175

136176
Module contents
137177
---------------

projectq/setups/decompositions/qubitop2onequbit.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,10 @@
1212
# See the License for the specific language governing permissions and
1313
# limitations under the License.
1414

15+
"""
16+
Registers a decomposition rule for a unitary QubitOperator to one qubit gates.
17+
"""
18+
1519
import cmath
1620

1721
from projectq.cengines import DecompositionRule

0 commit comments

Comments
 (0)