272 lines
8.5 KiB
Plaintext
272 lines
8.5 KiB
Plaintext
---
|
||
title: QuantumError
|
||
description: API reference for qiskit.providers.aer.noise.QuantumError
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.providers.aer.noise.QuantumError
|
||
---
|
||
|
||
# QuantumError
|
||
|
||
<Class id="qiskit.providers.aer.noise.QuantumError" isDedicatedPage={true} github="https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/quantum_error.py" signature="QuantumError(noise_ops, number_of_qubits=None, standard_gates=True, atol=1e-08)" modifiers="class">
|
||
Bases: `object`
|
||
|
||
Quantum error class for Qiskit Aer noise model
|
||
|
||
**WARNING: The init interface for this class is not finalized and may**
|
||
|
||
change in future releases. For maximum backwards compatibility use the QuantumError generating functions in the noise.errors module.
|
||
|
||
Create a quantum error for a noise model.
|
||
|
||
Noise ops may either be specified as list of Kraus operators for a general CPTP map, or as a list of `(circuit, p)` pairs where `circuit` is a qobj circuit for the noise, and `p` is the probability of the error circuit. If the input is Kraus operators they will be converted to the circuit format, with checks applied for determining if any Kraus operators are unitary matrices.
|
||
|
||
**Example**
|
||
|
||
An example noise\_ops for a bit-flip error with error probability `p = 0.1` is:
|
||
|
||
```python
|
||
noise_ops = [([{"name": "id", "qubits": 0}], 0.9),
|
||
([{"name": "x", "qubits": 0}], 0.1)]
|
||
```
|
||
|
||
The same error represented as a Kraus channel can be input as:
|
||
|
||
```python
|
||
noise_ops = [np.sqrt(0.9) * np.array([[1, 0], [0, 1]]),
|
||
np.sqrt(0.1) * np.array([[0, 1], [1, 0]])]
|
||
```
|
||
|
||
**Parameters**
|
||
|
||
* **noise\_ops** (*list*) – A list of noise ops. See additional information.
|
||
* **number\_of\_qubits** (*int*) – specify the number of qubits for the error. If None this will be determined automatically (default None).
|
||
* **standard\_gates** (*bool*) – Check if input matrices are standard gates.
|
||
* **atol** (*double*) – Threshold for testing if probabilities are equal to 0 or 1 (Default: 1e-8).
|
||
|
||
**Raises**
|
||
|
||
**NoiseError** – If input noise\_ops are not a CPTP map.
|
||
|
||
## Methods
|
||
|
||
### compose
|
||
|
||
<Function id="qiskit.providers.aer.noise.QuantumError.compose" signature="QuantumError.compose(other, front=False)">
|
||
Return the composition error channel other \* self.
|
||
|
||
Note that for front=True this is equivalent to the [`QuantumError.dot()`](qiskit.providers.aer.noise.QuantumError#dot "qiskit.providers.aer.noise.QuantumError.dot") method.
|
||
|
||
**Parameters**
|
||
|
||
* **other** ([*QuantumError*](qiskit.providers.aer.noise.QuantumError "qiskit.providers.aer.noise.QuantumError")) – a quantum error channel.
|
||
* **front** (*bool*) – If True return the reverse order composation self \* other instead \[default: False].
|
||
|
||
**Returns**
|
||
|
||
The composition error channel.
|
||
|
||
**Return type**
|
||
|
||
[QuantumError](qiskit.providers.aer.noise.QuantumError "qiskit.providers.aer.noise.QuantumError")
|
||
|
||
**Raises**
|
||
|
||
* **NoiseError** – if other cannot be converted into a QuantumError,
|
||
* **or has incompatible dimensions.** –
|
||
</Function>
|
||
|
||
### copy
|
||
|
||
<Function id="qiskit.providers.aer.noise.QuantumError.copy" signature="QuantumError.copy()">
|
||
Make a copy of current QuantumError.
|
||
</Function>
|
||
|
||
### dot
|
||
|
||
<Function id="qiskit.providers.aer.noise.QuantumError.dot" signature="QuantumError.dot(other)">
|
||
Return the composition error channel self \* other.
|
||
|
||
**Parameters**
|
||
|
||
**other** ([*QuantumError*](qiskit.providers.aer.noise.QuantumError "qiskit.providers.aer.noise.QuantumError")) – a quantum error channel.
|
||
|
||
**Returns**
|
||
|
||
The composition error channel.
|
||
|
||
**Return type**
|
||
|
||
[QuantumError](qiskit.providers.aer.noise.QuantumError "qiskit.providers.aer.noise.QuantumError")
|
||
|
||
**Raises**
|
||
|
||
* **NoiseError** – if other cannot be converted into a QuantumError,
|
||
* **or has incompatible dimensions.** –
|
||
</Function>
|
||
|
||
### error\_term
|
||
|
||
<Function id="qiskit.providers.aer.noise.QuantumError.error_term" signature="QuantumError.error_term(position)">
|
||
Return a single term from the error.
|
||
|
||
**Parameters**
|
||
|
||
**position** (*int*) – the position of the error term.
|
||
|
||
**Returns**
|
||
|
||
A pair (circuit, p) for error term at position \< size where p is the probability of the error term, and circuit is the list of qobj instructions for the error term.
|
||
|
||
**Return type**
|
||
|
||
tuple
|
||
|
||
**Raises**
|
||
|
||
* **NoiseError** – If the position is greater than the size of
|
||
* **the quantum error.** –
|
||
</Function>
|
||
|
||
### expand
|
||
|
||
<Function id="qiskit.providers.aer.noise.QuantumError.expand" signature="QuantumError.expand(other)">
|
||
Return the tensor product quantum error channel self ⊗ other.
|
||
|
||
**Parameters**
|
||
|
||
**other** ([*QuantumError*](qiskit.providers.aer.noise.QuantumError "qiskit.providers.aer.noise.QuantumError")) – a quantum error channel.
|
||
|
||
**Returns**
|
||
|
||
the tensor product error channel other ⊗ self.
|
||
|
||
**Return type**
|
||
|
||
[QuantumError](qiskit.providers.aer.noise.QuantumError "qiskit.providers.aer.noise.QuantumError")
|
||
|
||
**Raises**
|
||
|
||
**NoiseError** – if other cannot be converted to a QuantumError.
|
||
</Function>
|
||
|
||
### ideal
|
||
|
||
<Function id="qiskit.providers.aer.noise.QuantumError.ideal" signature="QuantumError.ideal()">
|
||
Return True if current error object is an identity
|
||
</Function>
|
||
|
||
### power
|
||
|
||
<Function id="qiskit.providers.aer.noise.QuantumError.power" signature="QuantumError.power(n)">
|
||
Return the compose of a error channel with itself n times.
|
||
|
||
**Parameters**
|
||
|
||
**n** (*int*) – the number of times to compose with self (n>0).
|
||
|
||
**Returns**
|
||
|
||
the n-times composition error channel.
|
||
|
||
**Return type**
|
||
|
||
[QuantumError](qiskit.providers.aer.noise.QuantumError "qiskit.providers.aer.noise.QuantumError")
|
||
|
||
**Raises**
|
||
|
||
**NoiseError** – if the power is not a positive integer.
|
||
</Function>
|
||
|
||
### set\_atol
|
||
|
||
<Function id="qiskit.providers.aer.noise.QuantumError.set_atol" signature="QuantumError.set_atol(value)" modifiers="classmethod">
|
||
Set the class default absolute tolerance parameter for float comparisons.
|
||
</Function>
|
||
|
||
### set\_rtol
|
||
|
||
<Function id="qiskit.providers.aer.noise.QuantumError.set_rtol" signature="QuantumError.set_rtol(value)" modifiers="classmethod">
|
||
Set the class default relative tolerance parameter for float comparisons.
|
||
</Function>
|
||
|
||
### tensor
|
||
|
||
<Function id="qiskit.providers.aer.noise.QuantumError.tensor" signature="QuantumError.tensor(other)">
|
||
Return the tensor product quantum error channel self ⊗ other.
|
||
|
||
**Parameters**
|
||
|
||
**other** ([*QuantumError*](qiskit.providers.aer.noise.QuantumError "qiskit.providers.aer.noise.QuantumError")) – a quantum error channel.
|
||
|
||
**Returns**
|
||
|
||
the tensor product error channel self ⊗ other.
|
||
|
||
**Return type**
|
||
|
||
[QuantumError](qiskit.providers.aer.noise.QuantumError "qiskit.providers.aer.noise.QuantumError")
|
||
|
||
**Raises**
|
||
|
||
**NoiseError** – if other cannot be converted to a QuantumError.
|
||
</Function>
|
||
|
||
### to\_dict
|
||
|
||
<Function id="qiskit.providers.aer.noise.QuantumError.to_dict" signature="QuantumError.to_dict()">
|
||
Return the current error as a dictionary.
|
||
</Function>
|
||
|
||
### to\_instruction
|
||
|
||
<Function id="qiskit.providers.aer.noise.QuantumError.to_instruction" signature="QuantumError.to_instruction()">
|
||
Convert the QuantumError to a circuit Instruction.
|
||
</Function>
|
||
|
||
### to\_quantumchannel
|
||
|
||
<Function id="qiskit.providers.aer.noise.QuantumError.to_quantumchannel" signature="QuantumError.to_quantumchannel()">
|
||
Convert the QuantumError to a SuperOp quantum channel.
|
||
</Function>
|
||
|
||
## Attributes
|
||
|
||
### atol
|
||
|
||
<Attribute id="qiskit.providers.aer.noise.QuantumError.atol">
|
||
The default absolute tolerance parameter for float comparisons.
|
||
</Attribute>
|
||
|
||
### circuits
|
||
|
||
<Attribute id="qiskit.providers.aer.noise.QuantumError.circuits">
|
||
Return the list of error circuits.
|
||
</Attribute>
|
||
|
||
### number\_of\_qubits
|
||
|
||
<Attribute id="qiskit.providers.aer.noise.QuantumError.number_of_qubits">
|
||
Return the number of qubits for the error.
|
||
</Attribute>
|
||
|
||
### probabilities
|
||
|
||
<Attribute id="qiskit.providers.aer.noise.QuantumError.probabilities">
|
||
Return the list of error probabilities.
|
||
</Attribute>
|
||
|
||
### rtol
|
||
|
||
<Attribute id="qiskit.providers.aer.noise.QuantumError.rtol">
|
||
The relative tolerance parameter for float comparisons.
|
||
</Attribute>
|
||
|
||
### size
|
||
|
||
<Attribute id="qiskit.providers.aer.noise.QuantumError.size">
|
||
Return the number of error circuit.
|
||
</Attribute>
|
||
</Class>
|
||
|