Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Regeneration Qiskit v0.38 and v0.37 API docs #678

Merged
merged 2 commits into from
Jan 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
6 changes: 3 additions & 3 deletions docs/api/qiskit/0.37/_toc.json
Original file line number Diff line number Diff line change
Expand Up @@ -3010,7 +3010,7 @@
},
{
"title": "Constant",
"url": "/api/qiskit/0.37/qiskit.pulse.library.constant"
"url": "/api/qiskit/0.37/qiskit.pulse.library.Constant"
},
{
"title": "control_channels",
Expand Down Expand Up @@ -3042,7 +3042,7 @@
},
{
"title": "Drag",
"url": "/api/qiskit/0.37/qiskit.pulse.library.drag"
"url": "/api/qiskit/0.37/qiskit.pulse.library.Drag"
},
{
"title": "drive_channel",
Expand All @@ -3062,7 +3062,7 @@
},
{
"title": "Gaussian",
"url": "/api/qiskit/0.37/qiskit.pulse.library.gaussian"
"url": "/api/qiskit/0.37/qiskit.pulse.library.Gaussian"
},
{
"title": "gaussian_deriv",
Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit/0.37/execute.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ python_api_name: qiskit.execute_function

<span id="qiskit.execute_function.execute" />

`execute(experiments, backend, basis_gates=None, coupling_map=None, backend_properties=None, initial_layout=None, seed_transpiler=None, optimization_level=None, pass_manager=None, qobj_id=None, qobj_header=None, shots=None, memory=None, max_credits=None, seed_simulator=None, default_qubit_los=None, default_meas_los=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=None, meas_return=None, memory_slots=None, memory_slot_size=None, rep_time=None, rep_delay=None, parameter_binds=None, schedule_circuit=False, inst_map=None, meas_map=None, scheduling_method=None, init_qubits=None, **run_config)`
`execute(experiments, backend, basis_gates=None, coupling_map=None, backend_properties=None, initial_layout=None, seed_transpiler=None, optimization_level=None, pass_manager=None, qobj_id=None, qobj_header=None, shots=None, memory=None, max_credits=None, seed_simulator=None, default_qubit_los=None, default_meas_los=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=None, meas_return=None, memory_slots=None, memory_slot_size=None, rep_time=None, rep_delay=None, parameter_binds=None, schedule_circuit=False, inst_map=None, meas_map=None, scheduling_method=None, init_qubits=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/execute_function.py "view source code")

Execute a list of [`qiskit.circuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") or [`qiskit.pulse.Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") on a backend.

Expand Down
8 changes: 4 additions & 4 deletions docs/api/qiskit/0.37/pulse.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ These are all instances of the same base class:

<span id="qiskit.pulse.instructions.Instruction" />

`Instruction(operands, name=None)`
`Instruction(operands, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/instructions/instruction.py "view source code")

The smallest schedulable unit: a single instruction. It has a fixed duration and specified channels.

Expand Down Expand Up @@ -175,7 +175,7 @@ All channels are children of the same abstract base class:

<span id="qiskit.pulse.channels.Channel" />

`Channel(index)`
`Channel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/channels.py "view source code")

Base class of channels. Channels provide a Qiskit-side label for typical quantum control hardware signal channels. The final label -> physical channel mapping is the responsibility of the hardware backend. For instance, `DriveChannel(0)` holds instructions which the backend should map to the signal line driving gate operations on the qubit labeled (indexed) 0.

Expand Down Expand Up @@ -226,7 +226,7 @@ These are all subtypes of the abstract base class [`AlignmentKind`](#qiskit.puls

<span id="qiskit.pulse.transforms.AlignmentKind" />

`AlignmentKind(context_params)`
`AlignmentKind(context_params)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/transforms/alignments.py "view source code")

An abstract class for schedule alignment.

Expand Down Expand Up @@ -668,7 +668,7 @@ There are 1e-06 seconds in 4500 samples.

<span id="qiskit.pulse.PulseError" />

`PulseError(*message)`
`PulseError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/exceptions.py "view source code")

Errors raised by the pulse module.

Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit/0.37/qiskit.algorithms.AlgorithmError.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AlgorithmError

<span id="qiskit.algorithms.AlgorithmError" />

`AlgorithmError(*message)`
`AlgorithmError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/exceptions.py "view source code")

For Algorithm specific errors.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplificationProblem

<span id="qiskit.algorithms.AmplificationProblem" />

`AmplificationProblem(oracle, state_preparation=None, grover_operator=None, post_processing=None, objective_qubits=None, is_good_state=None)`
`AmplificationProblem(oracle, state_preparation=None, grover_operator=None, post_processing=None, objective_qubits=None, is_good_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_amplifiers/amplification_problem.py "view source code")

Bases: `object`

Expand Down
4 changes: 2 additions & 2 deletions docs/api/qiskit/0.37/qiskit.algorithms.AmplitudeAmplifier.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeAmplifier

<span id="qiskit.algorithms.AmplitudeAmplifier" />

`AmplitudeAmplifier`
`AmplitudeAmplifier`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_amplifiers/amplitude_amplifier.py "view source code")

Bases: `abc.ABC`

Expand All @@ -22,7 +22,7 @@ The interface for amplification algorithms.

<span id="qiskit.algorithms.AmplitudeAmplifier.amplify" />

`abstract AmplitudeAmplifier.amplify(amplification_problem)`
`abstract AmplitudeAmplifier.amplify(amplification_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_amplifiers/amplitude_amplifier.py "view source code")

Run the amplification algorithm.

Expand Down
12 changes: 6 additions & 6 deletions docs/api/qiskit/0.37/qiskit.algorithms.AmplitudeEstimation.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimation

<span id="qiskit.algorithms.AmplitudeEstimation" />

`AmplitudeEstimation(num_eval_qubits, phase_estimation_circuit=None, iqft=None, quantum_instance=None)`
`AmplitudeEstimation(num_eval_qubits, phase_estimation_circuit=None, iqft=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/ae.py "view source code")

Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator")

Expand Down Expand Up @@ -53,7 +53,7 @@ Iterative Quantum Amplitude Estimation. [arXiv:1912.05559](https://arxiv.org/abs

<span id="qiskit.algorithms.AmplitudeEstimation.compute_confidence_interval" />

`static AmplitudeEstimation.compute_confidence_interval(result, alpha=0.05, kind='likelihood_ratio')`
`static AmplitudeEstimation.compute_confidence_interval(result, alpha=0.05, kind='likelihood_ratio')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/ae.py "view source code")

Compute the (1 - alpha) confidence interval.

Expand All @@ -80,7 +80,7 @@ The (1 - alpha) confidence interval of the specified kind.

<span id="qiskit.algorithms.AmplitudeEstimation.compute_mle" />

`static AmplitudeEstimation.compute_mle(result, apply_post_processing=False)`
`static AmplitudeEstimation.compute_mle(result, apply_post_processing=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/ae.py "view source code")

Compute the Maximum Likelihood Estimator (MLE).

Expand All @@ -101,7 +101,7 @@ The MLE for the provided result object.

<span id="qiskit.algorithms.AmplitudeEstimation.construct_circuit" />

`AmplitudeEstimation.construct_circuit(estimation_problem, measurement=False)`
`AmplitudeEstimation.construct_circuit(estimation_problem, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/ae.py "view source code")

Construct the Amplitude Estimation quantum circuit.

Expand All @@ -122,7 +122,7 @@ The QuantumCircuit object for the constructed circuit.

<span id="qiskit.algorithms.AmplitudeEstimation.estimate" />

`AmplitudeEstimation.estimate(estimation_problem)`
`AmplitudeEstimation.estimate(estimation_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/ae.py "view source code")

Run the amplitude estimation algorithm on provided estimation problem.

Expand All @@ -146,7 +146,7 @@ An amplitude estimation results object.

<span id="qiskit.algorithms.AmplitudeEstimation.evaluate_measurements" />

`AmplitudeEstimation.evaluate_measurements(circuit_results, threshold=1e-06)`
`AmplitudeEstimation.evaluate_measurements(circuit_results, threshold=1e-06)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/ae.py "view source code")

Evaluate the results from the circuit simulation.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult

<span id="qiskit.algorithms.AmplitudeEstimationResult" />

`AmplitudeEstimationResult`
`AmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/ae.py "view source code")

Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult")

Expand Down
4 changes: 2 additions & 2 deletions docs/api/qiskit/0.37/qiskit.algorithms.AmplitudeEstimator.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimator

<span id="qiskit.algorithms.AmplitudeEstimator" />

`AmplitudeEstimator`
`AmplitudeEstimator`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code")

Bases: `abc.ABC`

Expand All @@ -22,7 +22,7 @@ The Amplitude Estimation interface.

<span id="qiskit.algorithms.AmplitudeEstimator.estimate" />

`abstract AmplitudeEstimator.estimate(estimation_problem)`
`abstract AmplitudeEstimator.estimate(estimation_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code")

Run the amplitude estimation algorithm.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult

<span id="qiskit.algorithms.AmplitudeEstimatorResult" />

`AmplitudeEstimatorResult`
`AmplitudeEstimatorResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code")

Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult`

Expand Down
6 changes: 3 additions & 3 deletions docs/api/qiskit/0.37/qiskit.algorithms.Eigensolver.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.Eigensolver

<span id="qiskit.algorithms.Eigensolver" />

`Eigensolver`
`Eigensolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code")

Bases: `abc.ABC`

Expand All @@ -24,7 +24,7 @@ Algorithms that can compute eigenvalues for an operator may implement this inter

<span id="qiskit.algorithms.Eigensolver.compute_eigenvalues" />

`abstract Eigensolver.compute_eigenvalues(operator, aux_operators=None)`
`abstract Eigensolver.compute_eigenvalues(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code")

Computes eigenvalues. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here.

Expand All @@ -45,7 +45,7 @@ EigensolverResult

<span id="qiskit.algorithms.Eigensolver.supports_aux_operators" />

`classmethod Eigensolver.supports_aux_operators()`
`classmethod Eigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code")

Whether computing the expectation value of auxiliary operators is supported.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.EigensolverResult

<span id="qiskit.algorithms.EigensolverResult" />

`EigensolverResult`
`EigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code")

Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult`

Expand Down
4 changes: 2 additions & 2 deletions docs/api/qiskit/0.37/qiskit.algorithms.EstimationProblem.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.EstimationProblem

<span id="qiskit.algorithms.EstimationProblem" />

`EstimationProblem(state_preparation, objective_qubits, grover_operator=None, post_processing=None, is_good_state=None)`
`EstimationProblem(state_preparation, objective_qubits, grover_operator=None, post_processing=None, is_good_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/estimation_problem.py "view source code")

Bases: `object`

Expand All @@ -32,7 +32,7 @@ This class contains all problem-specific information required to run an amplitud

<span id="qiskit.algorithms.EstimationProblem.rescale" />

`EstimationProblem.rescale(scaling_factor)`
`EstimationProblem.rescale(scaling_factor)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/estimation_problem.py "view source code")

Rescale the good state amplitude in the estimation problem.

Expand Down
4 changes: 2 additions & 2 deletions docs/api/qiskit/0.37/qiskit.algorithms.EvolutionProblem.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.EvolutionProblem

<span id="qiskit.algorithms.EvolutionProblem" />

`EvolutionProblem(hamiltonian, time, initial_state, aux_operators=None, truncation_threshold=1e-12, t_param=None, hamiltonian_value_dict=None)`
`EvolutionProblem(hamiltonian, time, initial_state, aux_operators=None, truncation_threshold=1e-12, t_param=None, hamiltonian_value_dict=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/evolvers/evolution_problem.py "view source code")

Bases: `object`

Expand Down Expand Up @@ -38,7 +38,7 @@ This class is the input to time evolution algorithms and must contain informatio

<span id="qiskit.algorithms.EvolutionProblem.validate_params" />

`EvolutionProblem.validate_params()`
`EvolutionProblem.validate_params()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/evolvers/evolution_problem.py "view source code")

Checks if all parameters present in the Hamiltonian are also present in the dictionary that maps them to values.

Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit/0.37/qiskit.algorithms.EvolutionResult.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.EvolutionResult

<span id="qiskit.algorithms.EvolutionResult" />

`EvolutionResult(evolved_state, aux_ops_evaluated=None)`
`EvolutionResult(evolved_state, aux_ops_evaluated=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/evolvers/evolution_result.py "view source code")

Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimation

<span id="qiskit.algorithms.FasterAmplitudeEstimation" />

`FasterAmplitudeEstimation(delta, maxiter, rescale=True, quantum_instance=None)`
`FasterAmplitudeEstimation(delta, maxiter, rescale=True, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/fae.py "view source code")

Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator")

Expand Down Expand Up @@ -51,7 +51,7 @@ Due to the iterative version of the QPE, this algorithm does not require any add

<span id="qiskit.algorithms.FasterAmplitudeEstimation.construct_circuit" />

`FasterAmplitudeEstimation.construct_circuit(estimation_problem, k, measurement=False)`
`FasterAmplitudeEstimation.construct_circuit(estimation_problem, k, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/fae.py "view source code")

Construct the circuit $Q^k X |0\rangle>$.

Expand All @@ -75,7 +75,7 @@ The circuit $Q^k X |0\rangle$.

<span id="qiskit.algorithms.FasterAmplitudeEstimation.estimate" />

`FasterAmplitudeEstimation.estimate(estimation_problem)`
`FasterAmplitudeEstimation.estimate(estimation_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/fae.py "view source code")

Run the amplitude estimation algorithm.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult

<span id="qiskit.algorithms.FasterAmplitudeEstimationResult" />

`FasterAmplitudeEstimationResult`
`FasterAmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_estimators/fae.py "view source code")

Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult")

Expand Down
8 changes: 4 additions & 4 deletions docs/api/qiskit/0.37/qiskit.algorithms.Grover.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.Grover

<span id="qiskit.algorithms.Grover" />

`Grover(iterations=None, growth_rate=None, sample_from_iterations=False, quantum_instance=None)`
`Grover(iterations=None, growth_rate=None, sample_from_iterations=False, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code")

Bases: [`qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifier`](qiskit.algorithms.AmplitudeAmplifier "qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifier")

Expand Down Expand Up @@ -93,7 +93,7 @@ Quantum Amplitude Amplification and Estimation. [arXiv:quant-ph/0005055](http://

<span id="qiskit.algorithms.Grover.amplify" />

`Grover.amplify(amplification_problem)`
`Grover.amplify(amplification_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code")

Run the Grover algorithm.

Expand All @@ -118,7 +118,7 @@ The result as a `GroverResult`, where e.g. the most likely state can be queried

<span id="qiskit.algorithms.Grover.construct_circuit" />

`Grover.construct_circuit(problem, power=None, measurement=False)`
`Grover.construct_circuit(problem, power=None, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code")

Construct the circuit for Grover’s algorithm with `power` Grover operators.

Expand All @@ -144,7 +144,7 @@ the QuantumCircuit object for the constructed circuit

<span id="qiskit.algorithms.Grover.optimal_num_iterations" />

`static Grover.optimal_num_iterations(num_solutions, num_qubits)`
`static Grover.optimal_num_iterations(num_solutions, num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code")

Return the optimal number of iterations, if the number of solutions is known.

Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit/0.37/qiskit.algorithms.GroverResult.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.GroverResult

<span id="qiskit.algorithms.GroverResult" />

`GroverResult`
`GroverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code")

Bases: `qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifierResult`

Expand Down
Loading
Loading