77 lines
2.2 KiB
Plaintext
77 lines
2.2 KiB
Plaintext
---
|
||
title: LinearSolverResult
|
||
description: API reference for qiskit.algorithms.linear_solvers.LinearSolverResult
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.algorithms.linear_solvers.LinearSolverResult
|
||
---
|
||
|
||
# LinearSolverResult
|
||
|
||
<Class id="qiskit.algorithms.linear_solvers.LinearSolverResult" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/algorithms/linear_solvers/linear_solver.py" signature="LinearSolverResult" modifiers="class">
|
||
Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult`
|
||
|
||
A base class for linear systems results.
|
||
|
||
The linear systems algorithms return an object of the type `LinearSystemsResult` with the information about the solution obtained.
|
||
|
||
## Methods
|
||
|
||
### combine
|
||
|
||
<Function id="qiskit.algorithms.linear_solvers.LinearSolverResult.combine" signature="LinearSolverResult.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
|
||
|
||
### circuit\_results
|
||
|
||
<Attribute id="qiskit.algorithms.linear_solvers.LinearSolverResult.circuit_results">
|
||
return the results from the circuits
|
||
|
||
**Return type**
|
||
|
||
`Union`\[`List`\[`float`], `List`\[[`Result`](qiskit.result.Result "qiskit.result.result.Result")]]
|
||
</Attribute>
|
||
|
||
### euclidean\_norm
|
||
|
||
<Attribute id="qiskit.algorithms.linear_solvers.LinearSolverResult.euclidean_norm">
|
||
return the euclidean norm if the algorithm knows how to calculate it
|
||
|
||
**Return type**
|
||
|
||
`float`
|
||
</Attribute>
|
||
|
||
### observable
|
||
|
||
<Attribute id="qiskit.algorithms.linear_solvers.LinearSolverResult.observable">
|
||
return the (list of) calculated observable(s)
|
||
|
||
**Return type**
|
||
|
||
`Union`\[`float`, `List`\[`float`]]
|
||
</Attribute>
|
||
|
||
### state
|
||
|
||
<Attribute id="qiskit.algorithms.linear_solvers.LinearSolverResult.state">
|
||
return either the circuit that prepares the solution or the solution as a vector
|
||
|
||
**Return type**
|
||
|
||
`Union`\[[`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit"), `ndarray`]
|
||
</Attribute>
|
||
</Class>
|
||
|