Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add missing Circuit methods to API docs #1352

Merged
merged 1 commit into from
Apr 17, 2024
Merged

Add missing Circuit methods to API docs #1352

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions pytket/docs/circuit_class.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -327,6 +327,12 @@ condition on a specified set of bit values.)

.. automethod:: ZZMax

.. automethod:: AAMS

.. automethod:: GPI

.. automethod:: GPI2
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Doesn't have to be in this PR, but maybe these should be in alphabetical order to make them easier to find?

Copy link
Contributor Author

@CalMacCQ CalMacCQ Apr 17, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The order I opted for was to have similar gates grouped together rather than alphabetical

e.g.

   .. automethod:: CRy

   .. automethod:: CRz

   .. automethod:: CU1

   .. automethod:: CU3

Alphabetical ordering would mean that Circuit.AAMS would be at the top and the more commonly used Circuit.Z would be at the bottom.

Maybe alphabetical is better, not sure.


Methods for appending circuit boxes
-----------------------------------

Expand All @@ -347,6 +353,10 @@ condition on a specified set of bit values.)

.. automethod:: add_circbox

.. automethod:: add_circbox_regwise

.. automethod:: add_circbox_with_regmap

.. automethod:: add_unitary1qbox

.. automethod:: add_unitary2qbox
Expand All @@ -361,6 +371,8 @@ condition on a specified set of bit values.)

.. automethod:: add_pauliexpcommutingsetbox

.. automethod:: add_termsequencebox

.. automethod:: add_phasepolybox

.. automethod:: add_toffolibox
Expand Down
Loading