43 lines
1.7 KiB
Plaintext
43 lines
1.7 KiB
Plaintext
---
|
|
title: StateFidelityResult
|
|
description: API reference for qiskit.algorithms.state_fidelities.StateFidelityResult
|
|
in_page_toc_min_heading_level: 1
|
|
python_api_type: class
|
|
python_api_name: qiskit.algorithms.state_fidelities.StateFidelityResult
|
|
---
|
|
|
|
# StateFidelityResult
|
|
|
|
<Class id="qiskit.algorithms.state_fidelities.StateFidelityResult" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/algorithms/state_fidelities/state_fidelity_result.py" signature="qiskit.algorithms.state_fidelities.StateFidelityResult(fidelities, raw_fidelities, metadata, options)" modifiers="class">
|
|
Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)")
|
|
|
|
This class stores the result of StateFidelity computations.
|
|
|
|
## Attributes
|
|
|
|
### fidelities
|
|
|
|
<Attribute id="qiskit.algorithms.state_fidelities.StateFidelityResult.fidelities" attributeTypeHint="Sequence[float]">
|
|
List of truncated fidelity values for each pair of input circuits, ensured to be in \[0,1].
|
|
</Attribute>
|
|
|
|
### raw\_fidelities
|
|
|
|
<Attribute id="qiskit.algorithms.state_fidelities.StateFidelityResult.raw_fidelities" attributeTypeHint="Sequence[float]">
|
|
List of raw fidelity values for each pair of input circuits, which might not be in \[0,1] depending on the error mitigation method used.
|
|
</Attribute>
|
|
|
|
### metadata
|
|
|
|
<Attribute id="qiskit.algorithms.state_fidelities.StateFidelityResult.metadata" attributeTypeHint="Sequence[Mapping[str, Any]]">
|
|
Additional information about the fidelity calculation.
|
|
</Attribute>
|
|
|
|
### options
|
|
|
|
<Attribute id="qiskit.algorithms.state_fidelities.StateFidelityResult.options" attributeTypeHint="Options">
|
|
Primitive runtime options for the execution of the fidelity job.
|
|
</Attribute>
|
|
</Class>
|
|
|