Skip to content

Commit

Permalink
Update docs for ApproxTimeEvolution to reference TrotterProduct (#…
Browse files Browse the repository at this point in the history
…4679)

**Context:**
Once the new `TrotterProduct` functionality is added to Pennylane, the
`ApproxTimeEvolution` class will be redundant. In future releases it
will be deprecated and removed. For now we point to the new
functionality in the doc string.
  • Loading branch information
Jaybsoni authored Oct 20, 2023
1 parent dc905b1 commit aa626e3
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions pennylane/templates/subroutines/approx_time_evolution.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,12 @@ class ApproxTimeEvolution(Operation):
r"""Applies the Trotterized time-evolution operator for an arbitrary Hamiltonian, expressed in terms
of Pauli gates.
.. note::
This operation is a special case of :class:`~pennylane.TrotterProduct` and will be deprecated in
future releases, please use :class:`~pennylane.TrotterProduct` as the preferred operation for this
functionality.
The general time-evolution operator for a time-independent Hamiltonian is given by
.. math:: U(t) \ = \ e^{-i H t},
Expand Down

0 comments on commit aa626e3

Please sign in to comment.