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

Remove name attribute from API components #1284

Merged
merged 42 commits into from
May 2, 2024
Merged
Changes from 1 commit
Commits
Show all changes
42 commits
Select commit Hold shift + click to select a range
257b3cc
Remove `name` attribute from API components
Eric-Arellano May 2, 2024
fd65ac5
Regenerate qiskit-ibm-provider 0.10.0
Eric-Arellano May 2, 2024
3c0883e
Regenerate qiskit-ibm-provider 0.7.3
Eric-Arellano May 2, 2024
6ba5cf8
Regenerate qiskit-ibm-provider 0.8.0
Eric-Arellano May 2, 2024
f88a2b5
Regenerate qiskit-ibm-provider 0.9.0
Eric-Arellano May 2, 2024
d28aa50
Regenerate qiskit-ibm-provider 0.11.0
Eric-Arellano May 2, 2024
e5b1f35
Regenerate qiskit-ibm-runtime 0.14.0
Eric-Arellano May 2, 2024
181fb8b
Regenerate qiskit-ibm-runtime 0.15.0
Eric-Arellano May 2, 2024
e3b035a
Regenerate qiskit-ibm-runtime 0.16.1
Eric-Arellano May 2, 2024
5e92ff6
Regenerate qiskit-ibm-runtime 0.17.0
Eric-Arellano May 2, 2024
54de1cc
Regenerate qiskit-ibm-runtime 0.18.0
Eric-Arellano May 2, 2024
01bc55b
Regenerate qiskit-ibm-runtime 0.19.1
Eric-Arellano May 2, 2024
5fced21
Regenerate qiskit-ibm-runtime 0.20.0
Eric-Arellano May 2, 2024
4046f45
Regenerate qiskit-ibm-runtime 0.21.1
Eric-Arellano May 2, 2024
c8ce7dd
Regenerate qiskit-ibm-runtime 0.22.0
Eric-Arellano May 2, 2024
4a9ba6c
Regenerate qiskit-ibm-runtime 0.23.0
Eric-Arellano May 2, 2024
840e121
Regenerate qiskit-ibm-runtime 0.24.0-dev
Eric-Arellano May 2, 2024
0b13815
Regenerate qiskit 0.19.6
Eric-Arellano May 2, 2024
0e0042f
Regenerate qiskit 0.24.1
Eric-Arellano May 2, 2024
389517d
Regenerate qiskit 0.25.4
Eric-Arellano May 2, 2024
43bf3ff
Regenerate qiskit 0.26.2
Eric-Arellano May 2, 2024
0fbdb7c
Regenerate qiskit 0.27.0
Eric-Arellano May 2, 2024
e470ea7
Regenerate qiskit 0.28.0
Eric-Arellano May 2, 2024
59dd008
Regenerate qiskit 0.29.1
Eric-Arellano May 2, 2024
5353d13
Regenerate qiskit 0.30.1
Eric-Arellano May 2, 2024
f64a778
Regenerate qiskit 0.31.0
Eric-Arellano May 2, 2024
962a68b
Regenerate qiskit 0.32.1
Eric-Arellano May 2, 2024
795c096
Regenerate qiskit 0.33.1
Eric-Arellano May 2, 2024
7dd57df
Regenerate qiskit 0.35.0
Eric-Arellano May 2, 2024
b798d94
Regenerate qiskit 0.36.0
Eric-Arellano May 2, 2024
7e7f515
Regenerate qiskit 0.37.2
Eric-Arellano May 2, 2024
41011f2
Regenerate qiskit 0.38.0
Eric-Arellano May 2, 2024
463b3e1
Regenerate qiskit 0.39.5
Eric-Arellano May 2, 2024
9044aa3
Regenerate qiskit 0.40.0
Eric-Arellano May 2, 2024
8c1cf4c
Regenerate qiskit 0.41.0
Eric-Arellano May 2, 2024
00af4ac
Regenerate qiskit 0.42.0
Eric-Arellano May 2, 2024
291286d
Regenerate qiskit 0.43.0
Eric-Arellano May 2, 2024
19f743c
Regenerate qiskit 0.44.0
Eric-Arellano May 2, 2024
ea5d9a0
Regenerate qiskit 0.45.3
Eric-Arellano May 2, 2024
d1326af
Regenerate qiskit 0.46.1
Eric-Arellano May 2, 2024
ae535c3
Regenerate qiskit 1.0.2
Eric-Arellano May 2, 2024
ad44ce6
Regenerate qiskit 1.1.0-dev
Eric-Arellano May 2, 2024
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
  •  
  •  
  •  
Prev Previous commit
Next Next commit
Regenerate qiskit 0.38.0
Eric-Arellano committed May 2, 2024

Verified

This commit was signed with the committer’s verified signature.
Eric-Arellano Eric Arellano
commit 41011f28dedd84218cd93e46ef7a4299ddc6a6a1
2 changes: 1 addition & 1 deletion docs/api/qiskit/0.38/execute.mdx
Original file line number Diff line number Diff line change
@@ -18,7 +18,7 @@ python_api_name: qiskit.execute_function

### execute

<Function id="qiskit.execute_function.execute" name="execute" github="https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/execute_function.py" signature="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)">
<Function id="qiskit.execute_function.execute" github="https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/execute_function.py" signature="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 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.

The execution is asynchronous, and a handle to a job instance is returned.
2 changes: 1 addition & 1 deletion docs/api/qiskit/0.38/qiskit.algorithms.AlgorithmError.mdx
Original file line number Diff line number Diff line change
@@ -8,7 +8,7 @@ python_api_name: qiskit.algorithms.AlgorithmError

# qiskit.algorithms.AlgorithmError

<Class id="qiskit.algorithms.AlgorithmError" name="AlgorithmError" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/exceptions.py" signature="AlgorithmError(*message)">
<Class id="qiskit.algorithms.AlgorithmError" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/exceptions.py" signature="AlgorithmError(*message)">
For Algorithm specific errors.

Set the error message.
12 changes: 6 additions & 6 deletions docs/api/qiskit/0.38/qiskit.algorithms.AmplificationProblem.mdx
Original file line number Diff line number Diff line change
@@ -28,7 +28,7 @@ python_api_name: qiskit.algorithms.AmplificationProblem

### grover\_operator

<Attribute id="qiskit.algorithms.AmplificationProblem.grover_operator" name="grover_operator">
<Attribute id="qiskit.algorithms.AmplificationProblem.grover_operator">
Get the $\mathcal{Q}$ operator, or Grover operator.

If the Grover operator is not set, we try to build it from the $\mathcal{A}$ operator and objective\_qubits. This only works if objective\_qubits is a list of integers.
@@ -44,7 +44,7 @@ python_api_name: qiskit.algorithms.AmplificationProblem

### is\_good\_state

<Attribute id="qiskit.algorithms.AmplificationProblem.is_good_state" name="is_good_state">
<Attribute id="qiskit.algorithms.AmplificationProblem.is_good_state">
Check whether a provided bitstring is a good state or not.

**Return type**
@@ -58,7 +58,7 @@ python_api_name: qiskit.algorithms.AmplificationProblem

### objective\_qubits

<Attribute id="qiskit.algorithms.AmplificationProblem.objective_qubits" name="objective_qubits">
<Attribute id="qiskit.algorithms.AmplificationProblem.objective_qubits">
The indices of the objective qubits.

**Return type**
@@ -72,7 +72,7 @@ python_api_name: qiskit.algorithms.AmplificationProblem

### oracle

<Attribute id="qiskit.algorithms.AmplificationProblem.oracle" name="oracle">
<Attribute id="qiskit.algorithms.AmplificationProblem.oracle">
Return the oracle.

**Return type**
@@ -86,7 +86,7 @@ python_api_name: qiskit.algorithms.AmplificationProblem

### post\_processing

<Attribute id="qiskit.algorithms.AmplificationProblem.post_processing" name="post_processing">
<Attribute id="qiskit.algorithms.AmplificationProblem.post_processing">
Apply post processing to the input value.

**Return type**
@@ -100,7 +100,7 @@ python_api_name: qiskit.algorithms.AmplificationProblem

### state\_preparation

<Attribute id="qiskit.algorithms.AmplificationProblem.state_preparation" name="state_preparation">
<Attribute id="qiskit.algorithms.AmplificationProblem.state_preparation">
Get the state preparation operator $\mathcal{A}$.

**Return type**
Original file line number Diff line number Diff line change
@@ -17,7 +17,7 @@ python_api_name: qiskit.algorithms.AmplitudeAmplifier

### amplify

<Function id="qiskit.algorithms.AmplitudeAmplifier.amplify" name="amplify" signature="abstract AmplitudeAmplifier.amplify(amplification_problem)">
<Function id="qiskit.algorithms.AmplitudeAmplifier.amplify" signature="abstract AmplitudeAmplifier.amplify(amplification_problem)">
Run the amplification algorithm.

**Parameters**
12 changes: 6 additions & 6 deletions docs/api/qiskit/0.38/qiskit.algorithms.AmplitudeEstimation.mdx
Original file line number Diff line number Diff line change
@@ -48,7 +48,7 @@ $$

### compute\_confidence\_interval

<Function id="qiskit.algorithms.AmplitudeEstimation.compute_confidence_interval" name="compute_confidence_interval" signature="static AmplitudeEstimation.compute_confidence_interval(result, alpha=0.05, kind='likelihood_ratio')">
<Function id="qiskit.algorithms.AmplitudeEstimation.compute_confidence_interval" signature="static AmplitudeEstimation.compute_confidence_interval(result, alpha=0.05, kind='likelihood_ratio')">
Compute the (1 - alpha) confidence interval.

**Parameters**
@@ -73,7 +73,7 @@ $$

### compute\_mle

<Function id="qiskit.algorithms.AmplitudeEstimation.compute_mle" name="compute_mle" signature="static AmplitudeEstimation.compute_mle(result, apply_post_processing=False)">
<Function id="qiskit.algorithms.AmplitudeEstimation.compute_mle" signature="static AmplitudeEstimation.compute_mle(result, apply_post_processing=False)">
Compute the Maximum Likelihood Estimator (MLE).

**Parameters**
@@ -92,7 +92,7 @@ $$

### construct\_circuit

<Function id="qiskit.algorithms.AmplitudeEstimation.construct_circuit" name="construct_circuit" signature="AmplitudeEstimation.construct_circuit(estimation_problem, measurement=False)">
<Function id="qiskit.algorithms.AmplitudeEstimation.construct_circuit" signature="AmplitudeEstimation.construct_circuit(estimation_problem, measurement=False)">
Construct the Amplitude Estimation quantum circuit.

**Parameters**
@@ -111,7 +111,7 @@ $$

### estimate

<Function id="qiskit.algorithms.AmplitudeEstimation.estimate" name="estimate" signature="AmplitudeEstimation.estimate(estimation_problem)">
<Function id="qiskit.algorithms.AmplitudeEstimation.estimate" signature="AmplitudeEstimation.estimate(estimation_problem)">
Run the amplitude estimation algorithm on provided estimation problem.

**Parameters**
@@ -133,7 +133,7 @@ $$

### evaluate\_measurements

<Function id="qiskit.algorithms.AmplitudeEstimation.evaluate_measurements" name="evaluate_measurements" signature="AmplitudeEstimation.evaluate_measurements(circuit_results, threshold=1e-06)">
<Function id="qiskit.algorithms.AmplitudeEstimation.evaluate_measurements" signature="AmplitudeEstimation.evaluate_measurements(circuit_results, threshold=1e-06)">
Evaluate the results from the circuit simulation.

Given the probabilities from statevector simulation of the QAE circuit, compute the probabilities that the measurements y/gridpoints a are the best estimate.
@@ -158,7 +158,7 @@ $$

### quantum\_instance

<Attribute id="qiskit.algorithms.AmplitudeEstimation.quantum_instance" name="quantum_instance">
<Attribute id="qiskit.algorithms.AmplitudeEstimation.quantum_instance">
Get the quantum instance.

**Return type**
Original file line number Diff line number Diff line change
@@ -17,7 +17,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult

### combine

<Function id="qiskit.algorithms.AmplitudeEstimationResult.combine" name="combine" signature="AmplitudeEstimationResult.combine(result)">
<Function id="qiskit.algorithms.AmplitudeEstimationResult.combine" signature="AmplitudeEstimationResult.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**
@@ -33,7 +33,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult

### circuit\_results

<Attribute id="qiskit.algorithms.AmplitudeEstimationResult.circuit_results" name="circuit_results">
<Attribute id="qiskit.algorithms.AmplitudeEstimationResult.circuit_results">
Return the circuit results. Can be a statevector or counts dictionary.

**Return type**
@@ -43,7 +43,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult

### confidence\_interval

<Attribute id="qiskit.algorithms.AmplitudeEstimationResult.confidence_interval" name="confidence_interval">
<Attribute id="qiskit.algorithms.AmplitudeEstimationResult.confidence_interval">
Return the confidence interval for the amplitude (95% interval by default).

**Return type**
@@ -53,7 +53,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult

### confidence\_interval\_processed

<Attribute id="qiskit.algorithms.AmplitudeEstimationResult.confidence_interval_processed" name="confidence_interval_processed">
<Attribute id="qiskit.algorithms.AmplitudeEstimationResult.confidence_interval_processed">
Return the post-processed confidence interval (95% interval by default).

**Return type**
@@ -63,7 +63,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult

### estimation

<Attribute id="qiskit.algorithms.AmplitudeEstimationResult.estimation" name="estimation">
<Attribute id="qiskit.algorithms.AmplitudeEstimationResult.estimation">
Return the estimation for the amplitude in $[0, 1]$.

**Return type**
@@ -73,7 +73,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult

### estimation\_processed

<Attribute id="qiskit.algorithms.AmplitudeEstimationResult.estimation_processed" name="estimation_processed">
<Attribute id="qiskit.algorithms.AmplitudeEstimationResult.estimation_processed">
Return the estimation for the amplitude after the post-processing has been applied.

**Return type**
@@ -83,7 +83,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult

### max\_probability

<Attribute id="qiskit.algorithms.AmplitudeEstimationResult.max_probability" name="max_probability">
<Attribute id="qiskit.algorithms.AmplitudeEstimationResult.max_probability">
Return the maximum sampling probability.

**Return type**
@@ -93,7 +93,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult

### measurements

<Attribute id="qiskit.algorithms.AmplitudeEstimationResult.measurements" name="measurements">
<Attribute id="qiskit.algorithms.AmplitudeEstimationResult.measurements">
Return the measurements as integers with their measurement probability.

**Return type**
@@ -103,7 +103,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult

### mle

<Attribute id="qiskit.algorithms.AmplitudeEstimationResult.mle" name="mle">
<Attribute id="qiskit.algorithms.AmplitudeEstimationResult.mle">
Return the MLE for the amplitude, in $\[0, 1]\$.

**Return type**
@@ -113,7 +113,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult

### mle\_processed

<Attribute id="qiskit.algorithms.AmplitudeEstimationResult.mle_processed" name="mle_processed">
<Attribute id="qiskit.algorithms.AmplitudeEstimationResult.mle_processed">
Return the post-processed MLE for the amplitude.

**Return type**
@@ -123,7 +123,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult

### num\_evaluation\_qubits

<Attribute id="qiskit.algorithms.AmplitudeEstimationResult.num_evaluation_qubits" name="num_evaluation_qubits">
<Attribute id="qiskit.algorithms.AmplitudeEstimationResult.num_evaluation_qubits">
Returns the number of evaluation qubits.

**Return type**
@@ -133,7 +133,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult

### num\_oracle\_queries

<Attribute id="qiskit.algorithms.AmplitudeEstimationResult.num_oracle_queries" name="num_oracle_queries">
<Attribute id="qiskit.algorithms.AmplitudeEstimationResult.num_oracle_queries">
Return the number of Grover oracle queries.

**Return type**
@@ -143,7 +143,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult

### post\_processing

<Attribute id="qiskit.algorithms.AmplitudeEstimationResult.post_processing" name="post_processing">
<Attribute id="qiskit.algorithms.AmplitudeEstimationResult.post_processing">
Return a handle to the post processing function.

**Return type**
@@ -153,7 +153,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult

### samples

<Attribute id="qiskit.algorithms.AmplitudeEstimationResult.samples" name="samples">
<Attribute id="qiskit.algorithms.AmplitudeEstimationResult.samples">
Return the measurement samples with their measurement probability.

**Return type**
@@ -163,7 +163,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult

### samples\_processed

<Attribute id="qiskit.algorithms.AmplitudeEstimationResult.samples_processed" name="samples_processed">
<Attribute id="qiskit.algorithms.AmplitudeEstimationResult.samples_processed">
Return the post-processed measurement samples with their measurement probability.

**Return type**
@@ -173,7 +173,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult

### shots

<Attribute id="qiskit.algorithms.AmplitudeEstimationResult.shots" name="shots">
<Attribute id="qiskit.algorithms.AmplitudeEstimationResult.shots">
Return the number of shots used. Is 1 for statevector-based simulations.

**Return type**
Original file line number Diff line number Diff line change
@@ -17,7 +17,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimator

### estimate

<Function id="qiskit.algorithms.AmplitudeEstimator.estimate" name="estimate" signature="abstract AmplitudeEstimator.estimate(estimation_problem)">
<Function id="qiskit.algorithms.AmplitudeEstimator.estimate" signature="abstract AmplitudeEstimator.estimate(estimation_problem)">
Run the amplitude estimation algorithm.

**Parameters**
Original file line number Diff line number Diff line change
@@ -17,7 +17,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult

### combine

<Function id="qiskit.algorithms.AmplitudeEstimatorResult.combine" name="combine" signature="AmplitudeEstimatorResult.combine(result)">
<Function id="qiskit.algorithms.AmplitudeEstimatorResult.combine" signature="AmplitudeEstimatorResult.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**
@@ -33,7 +33,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult

### circuit\_results

<Attribute id="qiskit.algorithms.AmplitudeEstimatorResult.circuit_results" name="circuit_results">
<Attribute id="qiskit.algorithms.AmplitudeEstimatorResult.circuit_results">
Return the circuit results. Can be a statevector or counts dictionary.

**Return type**
@@ -43,7 +43,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult

### confidence\_interval

<Attribute id="qiskit.algorithms.AmplitudeEstimatorResult.confidence_interval" name="confidence_interval">
<Attribute id="qiskit.algorithms.AmplitudeEstimatorResult.confidence_interval">
Return the confidence interval for the amplitude (95% interval by default).

**Return type**
@@ -53,7 +53,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult

### confidence\_interval\_processed

<Attribute id="qiskit.algorithms.AmplitudeEstimatorResult.confidence_interval_processed" name="confidence_interval_processed">
<Attribute id="qiskit.algorithms.AmplitudeEstimatorResult.confidence_interval_processed">
Return the post-processed confidence interval (95% interval by default).

**Return type**
@@ -63,7 +63,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult

### estimation

<Attribute id="qiskit.algorithms.AmplitudeEstimatorResult.estimation" name="estimation">
<Attribute id="qiskit.algorithms.AmplitudeEstimatorResult.estimation">
Return the estimation for the amplitude in $[0, 1]$.

**Return type**
@@ -73,7 +73,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult

### estimation\_processed

<Attribute id="qiskit.algorithms.AmplitudeEstimatorResult.estimation_processed" name="estimation_processed">
<Attribute id="qiskit.algorithms.AmplitudeEstimatorResult.estimation_processed">
Return the estimation for the amplitude after the post-processing has been applied.

**Return type**
@@ -83,7 +83,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult

### num\_oracle\_queries

<Attribute id="qiskit.algorithms.AmplitudeEstimatorResult.num_oracle_queries" name="num_oracle_queries">
<Attribute id="qiskit.algorithms.AmplitudeEstimatorResult.num_oracle_queries">
Return the number of Grover oracle queries.

**Return type**
@@ -93,7 +93,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult

### post\_processing

<Attribute id="qiskit.algorithms.AmplitudeEstimatorResult.post_processing" name="post_processing">
<Attribute id="qiskit.algorithms.AmplitudeEstimatorResult.post_processing">
Return a handle to the post processing function.

**Return type**
@@ -103,7 +103,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult

### shots

<Attribute id="qiskit.algorithms.AmplitudeEstimatorResult.shots" name="shots">
<Attribute id="qiskit.algorithms.AmplitudeEstimatorResult.shots">
Return the number of shots used. Is 1 for statevector-based simulations.

**Return type**
4 changes: 2 additions & 2 deletions docs/api/qiskit/0.38/qiskit.algorithms.Eigensolver.mdx
Original file line number Diff line number Diff line change
@@ -19,7 +19,7 @@ python_api_name: qiskit.algorithms.Eigensolver

### compute\_eigenvalues

<Function id="qiskit.algorithms.Eigensolver.compute_eigenvalues" name="compute_eigenvalues" signature="abstract Eigensolver.compute_eigenvalues(operator, aux_operators=None)">
<Function id="qiskit.algorithms.Eigensolver.compute_eigenvalues" signature="abstract Eigensolver.compute_eigenvalues(operator, aux_operators=None)">
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.

**Parameters**
@@ -38,7 +38,7 @@ python_api_name: qiskit.algorithms.Eigensolver

### supports\_aux\_operators

<Function id="qiskit.algorithms.Eigensolver.supports_aux_operators" name="supports_aux_operators" signature="classmethod Eigensolver.supports_aux_operators()">
<Function id="qiskit.algorithms.Eigensolver.supports_aux_operators" signature="classmethod Eigensolver.supports_aux_operators()">
Whether computing the expectation value of auxiliary operators is supported.

**Return type**
Loading