Skip to content

Commit

Permalink
Add description of equivalence checking to docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
glassnotes committed Aug 24, 2024
1 parent 69792ff commit 1e2ede4
Showing 1 changed file with 4 additions and 5 deletions.
9 changes: 4 additions & 5 deletions ionizer/transforms.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,10 @@
performs end-to-end transpilation and optimization of circuits. It calls a
number of helper transforms which can also be used individually.
While all transforms should preserve the behaviour of the circuit, they contain
a mechanism for under-the-hood equivalence checking (up to a global phase)
through the ``verify_equivalence`` flag. When set, an error will be raised if
the transpiled circuit is not equivalent to the original. This flag is ``False``
by default as equivalence is checked at the unitary matrix level. For more details, see
All transforms contain a mechanism for under-the-hood equivalence checking (up
to a global phase) through the ``verify_equivalence`` flag. When set, an error
will be raised if the transpiled circuit is not equivalent to the original. For
details and example usage see :ref:`basic_usage-equivalence_validation` and
:func:`ionizer.utils.flag_non_equivalence`.
"""
Expand Down

0 comments on commit 1e2ede4

Please sign in to comment.