111 lines
2.6 KiB
Plaintext
111 lines
2.6 KiB
Plaintext
---
|
||
title: GroverResult
|
||
description: API reference for qiskit.algorithms.GroverResult
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.algorithms.GroverResult
|
||
---
|
||
|
||
# GroverResult
|
||
|
||
<Class id="qiskit.algorithms.GroverResult" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_amplifiers/grover.py" signature="GroverResult" modifiers="class">
|
||
Bases: `qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifierResult`
|
||
|
||
Grover Result.
|
||
|
||
## Methods
|
||
|
||
### combine
|
||
|
||
<Function id="qiskit.algorithms.GroverResult.combine" signature="GroverResult.combine(result)">
|
||
Any property from the argument that exists in the receiver is updated. :type result: `AlgorithmResult` :param result: Argument result with properties to be set.
|
||
|
||
**Raises**
|
||
|
||
**TypeError** – Argument is None
|
||
|
||
**Return type**
|
||
|
||
`None`
|
||
</Function>
|
||
|
||
## Attributes
|
||
|
||
### assignment
|
||
|
||
<Attribute id="qiskit.algorithms.GroverResult.assignment">
|
||
The post-processed value of the most likely bitstring.
|
||
|
||
**Return type**
|
||
|
||
`Any`
|
||
|
||
**Returns**
|
||
|
||
The output of the `post_processing` function of the respective `AmplificationProblem`, where the input is the `top_measurement`. The type is the same as the return type of the post-processing function.
|
||
</Attribute>
|
||
|
||
### circuit\_results
|
||
|
||
<Attribute id="qiskit.algorithms.GroverResult.circuit_results">
|
||
Return the circuit results. Can be a statevector or counts dictionary.
|
||
|
||
**Return type**
|
||
|
||
`Union`\[`List`\[`ndarray`], `List`\[`Dict`\[`str`, `int`]], `None`]
|
||
</Attribute>
|
||
|
||
### iterations
|
||
|
||
<Attribute id="qiskit.algorithms.GroverResult.iterations">
|
||
All the powers of the Grover operator that have been tried.
|
||
|
||
**Return type**
|
||
|
||
`List`\[`int`]
|
||
|
||
**Returns**
|
||
|
||
The powers of the Grover operator tested.
|
||
</Attribute>
|
||
|
||
### max\_probability
|
||
|
||
<Attribute id="qiskit.algorithms.GroverResult.max_probability">
|
||
Return the maximum sampling probability.
|
||
|
||
**Return type**
|
||
|
||
`float`
|
||
</Attribute>
|
||
|
||
### oracle\_evaluation
|
||
|
||
<Attribute id="qiskit.algorithms.GroverResult.oracle_evaluation">
|
||
Whether the classical oracle evaluation of the top measurement was True or False.
|
||
|
||
**Return type**
|
||
|
||
`bool`
|
||
|
||
**Returns**
|
||
|
||
The classical oracle evaluation of the top measurement.
|
||
</Attribute>
|
||
|
||
### top\_measurement
|
||
|
||
<Attribute id="qiskit.algorithms.GroverResult.top_measurement">
|
||
The most frequently measured output as bitstring.
|
||
|
||
**Return type**
|
||
|
||
`Optional`\[`str`]
|
||
|
||
**Returns**
|
||
|
||
The most frequently measured output state.
|
||
</Attribute>
|
||
</Class>
|
||
|