From ea12cbb24bfd727722151cf140845a3c31760828 Mon Sep 17 00:00:00 2001 From: PabloAndresCQ Date: Wed, 23 Oct 2024 14:25:25 +0000 Subject: [PATCH] Fixed problems in docs --- docs/changelog.rst | 5 +++-- docs/modules/general_state.rst | 2 ++ docs/modules/structured_state.rst | 3 +++ 3 files changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/changelog.rst b/docs/changelog.rst index ac0fd654..d2c71682 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -6,10 +6,11 @@ Changelog Unreleased ---------- -* New API: ``GeneralBraOpKet`` for exact calculation of arbitrary ```` values. +* New API: ``GeneralBraOpKet`` for exact calculation of arbitrary ```` values. Can be used to calculate inner products, expectation values and arbitrary matrix elements. +* New feature: both ``GeneralState`` and ``GeneralBraOpKet`` admit circuits with parameterised gates. * New feature: ``GeneralState`` has a new method ``get_amplitude`` to obtain the amplitude of computational basis states. * New feature: ``GeneralState`` and ``CuTensorNetShotsBackend`` now support RNG seeds for sampling. -* Deprecated ``TensorNetwork`` object. It is still available for the sake backwards compatibility, but it has been removed from doc pages. +* Deprecated ``TensorNetwork`` object. It is still available for the sake of backwards compatibility, but it has been removed from doc pages. 0.9.0 (October 2024) --------------------- diff --git a/docs/modules/general_state.rst b/docs/modules/general_state.rst index bf557a0b..3d996e20 100644 --- a/docs/modules/general_state.rst +++ b/docs/modules/general_state.rst @@ -4,6 +4,7 @@ General state (exact) simulation .. automodule:: pytket.extensions.cutensornet.general_state .. autoclass:: pytket.extensions.cutensornet.general_state.GeneralState() + .. automethod:: __init__ .. automethod:: get_statevector .. automethod:: get_amplitude @@ -12,6 +13,7 @@ General state (exact) simulation .. automethod:: destroy .. autoclass:: pytket.extensions.cutensornet.general_state.GeneralBraOpKet() + .. automethod:: __init__ .. automethod:: contract .. automethod:: destroy diff --git a/docs/modules/structured_state.rst b/docs/modules/structured_state.rst index ce1ea6d8..aeafb5df 100644 --- a/docs/modules/structured_state.rst +++ b/docs/modules/structured_state.rst @@ -3,6 +3,9 @@ Structured state evolution .. automodule:: pytket.extensions.cutensornet.structured_state +Library handle +~~~~~~~~~~~~~~ + .. autoclass:: pytket.extensions.cutensornet.CuTensorNetHandle .. automethod:: destroy