Fidelity interface using primitives

qiskit/algorithms/__init__.py

@@ -201,8 +201,18 @@
    IterativePhaseEstimation
 
 
+State Fidelities
+----------------
+
+Algorithms that compute the fidelity of pairs of quantum states.
+
+.. autosummary::
+   :toctree: ../stubs/
+
+   state_fidelities
+
 Exceptions
-==========
+----------
 
 .. autosummary::
    :toctree: ../stubs/
@@ -219,8 +229,19 @@
    :toctree: ../stubs/
 
    eval_observables
-"""
 
+Utility classes
+---------------
+
+Utility classes used by algorithms (mainly for type-hinting purposes).
+
+.. autosummary::
+   :toctree: ../stubs/
+
+   AlgorithmJob
+
+"""
+from .algorithm_job import AlgorithmJob
 from .algorithm_result import AlgorithmResult
 from .evolvers import EvolutionResult, EvolutionProblem
 from .evolvers.real_evolver import RealEvolver
@@ -267,6 +288,7 @@
 from .evolvers.pvqd import PVQD, PVQDResult
 
 __all__ = [
+    "AlgorithmJob",
     "AlgorithmResult",
     "VariationalAlgorithm",
     "VariationalResult",

qiskit/algorithms/algorithm_job.py

@@ -0,0 +1,24 @@
+# This code is part of Qiskit.
+#
+# (C) Copyright IBM 2022.
+#
+# This code is licensed under the Apache License, Version 2.0. You may
+# obtain a copy of this license in the LICENSE.txt file in the root directory
+# of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
+#
+# Any modifications or derivative works of this code must retain this
+# copyright notice, and modified files need to carry a notice indicating
+# that they have been altered from the originals.
+
+"""
+AlgorithmJob class
+"""
+from qiskit.primitives.primitive_job import PrimitiveJob
+
+
+class AlgorithmJob(PrimitiveJob):
+    """
+    This empty class is introduced for typing purposes.
+    """
+
+    pass

qiskit/algorithms/state_fidelities/__init__.py

@@ -0,0 +1,41 @@
+# This code is part of Qiskit.
+#
+# (C) Copyright IBM 2022.
+#
+# This code is licensed under the Apache License, Version 2.0. You may
+# obtain a copy of this license in the LICENSE.txt file in the root directory
+# of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
+#
+# Any modifications or derivative works of this code must retain this
+# copyright notice, and modified files need to carry a notice indicating
+# that they have been altered from the originals.
+"""
+=====================================================================
+State Fidelity Interfaces (:mod:`qiskit.algorithms.state_fidelities`)
+=====================================================================
+
+.. currentmodule:: qiskit.algorithms.state_fidelities
+
+State Fidelities
+================
+
+.. autosummary::
+   :toctree: ../stubs/
+
+   BaseStateFidelity
+   ComputeUncompute
+
+Results
+=======
+
+ .. autosummary::
+    :toctree: ../stubs/
+
+    StateFidelityResult
+"""
+
+from .base_state_fidelity import BaseStateFidelity
+from .compute_uncompute import ComputeUncompute
+from .state_fidelity_result import StateFidelityResult
+
+__all__ = ["BaseStateFidelity", "ComputeUncompute", "StateFidelityResult"]