Skip to content

Commit

Permalink
Add GitHub links to Qiskit v0.43 API docs (#655)
Browse files Browse the repository at this point in the history
Part of #454. Note that
Qiskit 0.43 refers to Qiskit Terra 0.24.
  • Loading branch information
arnaucasau authored Jan 19, 2024
1 parent 665f201 commit b06afd8
Show file tree
Hide file tree
Showing 990 changed files with 2,626 additions and 2,652 deletions.
2 changes: 1 addition & 1 deletion docs/api/qiskit/0.43/execute.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,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, 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, 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.24/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.43/pulse.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,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.24/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 @@ -182,7 +182,7 @@ All channels are children of the same abstract base class:

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

`Channel(*args, **kwargs)`
`Channel(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/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 @@ -237,7 +237,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.24/qiskit/pulse/transforms/alignments.py "view source code")

An abstract class for schedule alignment.

Expand Down Expand Up @@ -686,7 +686,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.24/qiskit/pulse/exceptions.py "view source code")

Errors raised by the pulse module.

Expand Down
6 changes: 3 additions & 3 deletions docs/api/qiskit/0.43/qasm.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,19 +29,19 @@ python_api_name: qiskit.qasm

<span id="qiskit.qasm.OpenQASMLexer" />

`OpenQASMLexer(*args, **kwds)`
`OpenQASMLexer(*args, **kwds)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qasm/pygments/lexer.py "view source code")

A pygments lexer for OpenQasm.

<span id="qiskit.qasm.QasmHTMLStyle" />

`QasmHTMLStyle`
`QasmHTMLStyle`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qasm/pygments/lexer.py "view source code")

A style for OpenQasm in a HTML env (e.g. Jupyter widget).

<span id="qiskit.qasm.QasmTerminalStyle" />

`QasmTerminalStyle`
`QasmTerminalStyle`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qasm/pygments/lexer.py "view source code")

A style for OpenQasm in a Terminal env (e.g. Jupyter print).

10 changes: 5 additions & 5 deletions docs/api/qiskit/0.43/qasm2.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ This module contains two public functions, both of which create a [`QuantumCircu

<span id="qiskit.qasm2.load" />

`load(filename, *, include_path=('.',), include_input_directory='append', custom_instructions=(), custom_classical=(), strict=False)`
`load(filename, *, include_path=('.',), include_input_directory='append', custom_instructions=(), custom_classical=(), strict=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qasm2/__init__.py "view source code")

Parse an OpenQASM 2 program from a file into a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). The given path should be ASCII or UTF-8 encoded, and contain the OpenQASM 2 program.

Expand All @@ -53,7 +53,7 @@ A circuit object representing the same OpenQASM 2 program.

<span id="qiskit.qasm2.loads" />

`loads(string, *, include_path=('.',), custom_instructions=(), custom_classical=(), strict=False)`
`loads(string, *, include_path=('.',), custom_instructions=(), custom_classical=(), strict=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qasm2/__init__.py "view source code")

Parse an OpenQASM 2 program from a string into a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit").

Expand Down Expand Up @@ -83,7 +83,7 @@ You can extend the quantum components of the OpenQASM 2 language by passing an i

<span id="qiskit.qasm2.CustomInstruction" />

`CustomInstruction(name, num_params, num_qubits, constructor, builtin=False)`
`CustomInstruction(name, num_params, num_qubits, constructor, builtin=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qasm2/parse.py "view source code")

Information about a custom instruction that should be defined during the parse.

Expand Down Expand Up @@ -117,7 +117,7 @@ This module defines a generic error type that derives from `QiskitError` that ca

<span id="qiskit.qasm2.QASM2Error" />

`QASM2Error(*message)`
`QASM2Error(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qasm2/exceptions.py "view source code")

A general error raised by the OpenQASM 2 interoperation layer.

Expand All @@ -127,7 +127,7 @@ In cases where the lexer or parser fails due to an invalid OpenQASM 2 file, the

<span id="qiskit.qasm2.QASM2ParseError" />

`QASM2ParseError(*message)`
`QASM2ParseError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qasm2/exceptions.py "view source code")

An error raised because of a failure to parse an OpenQASM 2 file.

Expand Down
16 changes: 8 additions & 8 deletions docs/api/qiskit/0.43/qasm3.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ The high-level functions are simply [`dump()`](#qiskit.qasm3.dump "qiskit.qasm3.

<span id="qiskit.qasm3.dump" />

`dump(circuit, stream, **kwargs)`
`dump(circuit, stream, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qasm3/__init__.py "view source code")

Serialize a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") object as a OpenQASM3 stream to file-like object.

Expand All @@ -38,7 +38,7 @@ Serialize a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.Qua

<span id="qiskit.qasm3.dumps" />

`dumps(circuit, **kwargs)`
`dumps(circuit, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qasm3/__init__.py "view source code")

Serialize a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") object in an OpenQASM3 string.

Expand All @@ -59,7 +59,7 @@ Both of these exporter functions are single-use wrappers around the main [`Expor

<span id="qiskit.qasm3.Exporter" />

`Exporter(includes=('stdgates.inc', ), basis_gates=('U', ), disable_constants=False, alias_classical_registers=False, indent='  ', experimental=ExperimentalFeatures.None)`
`Exporter(includes=('stdgates.inc', ), basis_gates=('U', ), disable_constants=False, alias_classical_registers=False, indent='  ', experimental=ExperimentalFeatures.None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qasm3/exporter.py "view source code")

QASM3 exporter main class.

Expand Down Expand Up @@ -92,7 +92,7 @@ All of these interfaces will raise [`QASM3ExporterError`](#qiskit.qasm3.QASM3Exp

<span id="qiskit.qasm3.QASM3ExporterError" />

`QASM3ExporterError(*message)`
`QASM3ExporterError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qasm3/exceptions.py "view source code")

An error raised during running the OpenQASM 3 exporter.

Expand All @@ -104,7 +104,7 @@ The OpenQASM 3 language is still evolving as hardware capabilities improve, so t

<span id="qiskit.qasm3.ExperimentalFeatures" />

`ExperimentalFeatures(value)`
`ExperimentalFeatures(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qasm3/experimental.py "view source code")

Flags for experimental features that the OpenQASM 3 exporter supports.

Expand Down Expand Up @@ -163,7 +163,7 @@ Currently only two high-level functions are offered, as Qiskit support for impor

<span id="qiskit.qasm3.load" />

`load(filename)`
`load(filename)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qasm3/__init__.py "view source code")

Load an OpenQASM 3 program from the file `filename`.

Expand All @@ -185,7 +185,7 @@ a circuit representation of the OpenQASM 3 program.

<span id="qiskit.qasm3.loads" />

`loads(program)`
`loads(program)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qasm3/__init__.py "view source code")

Load an OpenQASM 3 program from the given string.

Expand All @@ -209,7 +209,7 @@ Both of these two functions raise [`QASM3ImporterError`](#qiskit.qasm3.QASM3Impo

<span id="qiskit.qasm3.QASM3ImporterError" />

`QASM3ImporterError(*message)`
`QASM3ImporterError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/qasm3/exceptions.py "view source code")

An error raised during the OpenQASM 3 importer.

Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit/0.43/qiskit.algorithms.AlgorithmError.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,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.24/qiskit/algorithms/exceptions.py "view source code")

For Algorithm specific errors.

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

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

`AlgorithmJob(function, *args, **kwargs)`
`AlgorithmJob(function, *args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/algorithm_job.py "view source code")

Bases: `PrimitiveJob`

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.24/qiskit/algorithms/amplitude_amplifiers/amplification_problem.py "view source code")

Bases: `object`

Expand Down
4 changes: 2 additions & 2 deletions docs/api/qiskit/0.43/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.24/qiskit/algorithms/amplitude_amplifiers/amplitude_amplifier.py "view source code")

Bases: `ABC`

Expand All @@ -24,7 +24,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.24/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.43/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, sampler=None)`
`AmplitudeEstimation(num_eval_qubits, phase_estimation_circuit=None, iqft=None, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/amplitude_estimators/ae.py "view source code")

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

Expand Down Expand Up @@ -64,7 +64,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.24/qiskit/algorithms/amplitude_estimators/ae.py "view source code")

Compute the (1 - alpha) confidence interval.

Expand Down Expand Up @@ -93,7 +93,7 @@ tuple\[float, float]

<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.24/qiskit/algorithms/amplitude_estimators/ae.py "view source code")

Compute the Maximum Likelihood Estimator (MLE).

Expand All @@ -116,7 +116,7 @@ float

<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.24/qiskit/algorithms/amplitude_estimators/ae.py "view source code")

Construct the Amplitude Estimation quantum circuit.

Expand All @@ -139,7 +139,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.24/qiskit/algorithms/amplitude_estimators/ae.py "view source code")

Run the amplitude estimation algorithm on provided estimation problem.

Expand Down Expand Up @@ -167,7 +167,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.24/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.24/qiskit/algorithms/amplitude_estimators/ae.py "view source code")

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

Expand Down
4 changes: 2 additions & 2 deletions docs/api/qiskit/0.43/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.24/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code")

Bases: `ABC`

Expand All @@ -24,7 +24,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.24/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.24/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code")

Bases: `AlgorithmResult`

Expand Down
6 changes: 3 additions & 3 deletions docs/api/qiskit/0.43/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.24/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code")

Bases: `ABC`

Expand All @@ -32,7 +32,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.24/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 @@ -55,7 +55,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.24/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.24/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code")

Bases: `AlgorithmResult`

Expand Down
4 changes: 2 additions & 2 deletions docs/api/qiskit/0.43/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.24/qiskit/algorithms/amplitude_estimators/estimation_problem.py "view source code")

Bases: `object`

Expand All @@ -34,7 +34,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.24/qiskit/algorithms/amplitude_estimators/estimation_problem.py "view source code")

Rescale the good state amplitude in the estimation problem.

Expand Down
Loading

0 comments on commit b06afd8

Please sign in to comment.