Skip to content

Commit 2c5da7c

Browse files
committed
added windows qpe doc
1 parent 2d77cb8 commit 2c5da7c

File tree

3 files changed

+13
-0
lines changed

3 files changed

+13
-0
lines changed

doc/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,3 +84,4 @@
8484
utils.rst
8585

8686

87+

doc/pe.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ The **Phase Estimation (PE)** package includes modules for implementing *Quantum
55

66
* :doc:`pe.classical_qpe`: This module implements the Python class CQPE that implements the *QPE* algorithm that returns the eigenvalues of a given input unitary operator and an initial eigenstate (or a linear combination of them). The algorithm uses the Quantum Fourier Transformation Routine.
77
* :doc:`pe.iterative_quantum_pe`: This module implements the Python class IQPE that implements the *Kitaev Iterative Phase Estimation* algorithm that returns the eigenvalues of a given input unitary operator and an initial eigenstate (or a linear combination of them).
8+
* :doc:`pe.windows_pe`: This module implements the Python class CQPE that implements a version of the *QPE* algorithm where the initialization of the auxiliary qubits are different from typical Haddamards gates. Different initializations can be used.
89

910

1011
.. toctree::
@@ -20,4 +21,10 @@ The **Phase Estimation (PE)** package includes modules for implementing *Quantum
2021

2122
pe.iterative_quantum_pe.rst
2223

24+
.. toctree::
25+
:maxdepth: 1
26+
:hidden:
27+
28+
29+
pe.windows_pe.rst
2330

doc/pe.windows_pe.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
windows_pe
2+
==========
3+
4+
.. automodule:: QQuantLib.PE.windows_pe
5+
:members:

0 commit comments

Comments
 (0)