Regenerate qiskit-addon-aqc-tensor to document __call__ (#2317)

Qiskit · Nov 14, 2024 · 6c82872 · 6c82872
1 parent c973ae9
commit 6c82872
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/docs/api/qiskit-addon-aqc-tensor/objective.mdx b/docs/api/qiskit-addon-aqc-tensor/objective.mdx
@@ -43,6 +43,20 @@ $$
   *   **target** ([`TensorNetworkState`](simulation#qiskit_addon_aqc_tensor.simulation.TensorNetworkState "qiskit_addon_aqc_tensor.simulation.abstract.TensorNetworkState")) – Target state in tensor-network representation.
   *   **settings** ([`TensorNetworkSimulationSettings`](simulation#qiskit_addon_aqc_tensor.simulation.TensorNetworkSimulationSettings "qiskit_addon_aqc_tensor.simulation.abstract.TensorNetworkSimulationSettings")) – Tensor network simulation settings.
 
+  #### \_\_call\_\_
+
+  <Function id="qiskit_addon_aqc_tensor.objective.OneMinusFidelity.__call__" github="https://github.com/Qiskit/qiskit-addon-aqc-tensor/tree/stable/0.1/qiskit_addon_aqc_tensor/objective.py#L74-L80" signature="__call__(x)[source]">
+    Evaluate `(objective_value, gradient)` of function at point `x`.
+
+    **Return type**
+
+    [`tuple`](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[`float`](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)"), [`ndarray`](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray "(in NumPy v2.1)")]
+
+    **Parameters**
+
+    **x** ([*ndarray*](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray "(in NumPy v2.1)"))
+  </Function>
+
   #### target
 
   <Attribute id="qiskit_addon_aqc_tensor.objective.OneMinusFidelity.target" attributeTypeHint="TensorNetworkState">

diff --git a/public/api/qiskit-addon-aqc-tensor/objects.inv b/public/api/qiskit-addon-aqc-tensor/objects.inv