diff --git a/docs/api.rst b/docs/api.rst index 1e91e2c8..48ed0e2c 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -1,11 +1,6 @@ API documentation ----------------- -.. autoclass:: pytket.extensions.cutensornet.CuTensorNetHandle - - .. automethod:: destroy - - .. toctree:: modules/general_state.rst modules/structured_state.rst diff --git a/docs/changelog.rst b/docs/changelog.rst index a1fc3c73..ac0fd654 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -3,6 +3,14 @@ Changelog ~~~~~~~~~ +Unreleased +---------- + +* New API: ``GeneralBraOpKet`` for exact calculation of arbitrary ```` values. +* 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. + 0.9.0 (October 2024) --------------------- diff --git a/docs/modules/general_state.rst b/docs/modules/general_state.rst index 0c552812..bf557a0b 100644 --- a/docs/modules/general_state.rst +++ b/docs/modules/general_state.rst @@ -4,30 +4,17 @@ 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 .. automethod:: expectation_value .. automethod:: sample .. automethod:: destroy -cuQuantum `contract` API interface -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. autoclass:: pytket.extensions.cutensornet.general_state.TensorNetwork - -.. autoclass:: pytket.extensions.cutensornet.general_state.PauliOperatorTensorNetwork - -.. autoclass:: pytket.extensions.cutensornet.general_state.ExpectationValueTensorNetwork - -.. autofunction:: pytket.extensions.cutensornet.general_state.tk_to_tensor_network - -.. autofunction:: pytket.extensions.cutensornet.general_state.measure_qubits_state - -.. autofunction:: pytket.extensions.cutensornet.general_state.get_operator_expectation_value - -.. autofunction:: pytket.extensions.cutensornet.general_state.get_circuit_overlap - +.. autoclass:: pytket.extensions.cutensornet.general_state.GeneralBraOpKet() + .. automethod:: __init__ + .. automethod:: contract + .. automethod:: destroy Pytket backend ~~~~~~~~~~~~~~ diff --git a/docs/modules/structured_state.rst b/docs/modules/structured_state.rst index 94cb320f..ce1ea6d8 100644 --- a/docs/modules/structured_state.rst +++ b/docs/modules/structured_state.rst @@ -3,6 +3,10 @@ Structured state evolution .. automodule:: pytket.extensions.cutensornet.structured_state +.. autoclass:: pytket.extensions.cutensornet.CuTensorNetHandle + + .. automethod:: destroy + Simulation ~~~~~~~~~~