107 lines
4.1 KiB
Plaintext
107 lines
4.1 KiB
Plaintext
---
|
||
title: simulation (v0.9)
|
||
description: API reference for qiskit_addon_cutting.utils.simulation in qiskit-addon-cutting v0.9
|
||
in_page_toc_min_heading_level: 2
|
||
python_api_type: module
|
||
python_api_name: qiskit_addon_cutting.utils.simulation
|
||
---
|
||
|
||
<span id="module-qiskit_addon_cutting.utils.simulation" />
|
||
|
||
<span id="simulation-utilities-qiskit-addon-cutting-utils-simulation" />
|
||
|
||
# Simulation utilities
|
||
|
||
`qiskit_addon_cutting.utils.simulation`
|
||
|
||
Simulation of precise measurement outcome probabilities.
|
||
|
||
### simulate\_statevector\_outcomes
|
||
|
||
<Function id="qiskit_addon_cutting.utils.simulation.simulate_statevector_outcomes" github="https://github.com/Qiskit/qiskit-addon-cutting/tree/stable/0.9/qiskit_addon_cutting/utils/simulation.py" signature="simulate_statevector_outcomes(qc, /)">
|
||
Return each classical outcome along with its precise probability.
|
||
|
||
Circuit can contain mid-circuit, projective measurements.
|
||
|
||
All gates are supported, along with measurements and reset operations.
|
||
|
||
**Return type**
|
||
|
||
[`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")\[[`int`](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)"), [`float`](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")]
|
||
|
||
**Parameters**
|
||
|
||
**qc** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)"))
|
||
</Function>
|
||
|
||
### ExactSampler
|
||
|
||
<Class id="qiskit_addon_cutting.utils.simulation.ExactSampler" github="https://github.com/Qiskit/qiskit-addon-cutting/tree/stable/0.9/qiskit_addon_cutting/utils/simulation.py" signature="ExactSampler(*, options=None)" modifiers="class">
|
||
Bases: [`BaseSamplerV1`](/api/qiskit/qiskit.primitives.BaseSamplerV1 "(in Qiskit v1.3)")
|
||
|
||
Sampler which returns exact probabilities for each possible outcome.
|
||
|
||
This sampler supports:
|
||
|
||
* all unitary gates
|
||
* projective measurements, anywhere in the circuit
|
||
* reset operations, anywhere in the circuit
|
||
* some (or all) classical bits can remain unused
|
||
* classical bits can be written more than once
|
||
|
||
The samplers provided by [`qiskit.primitives`](/api/qiskit/primitives#module-qiskit.primitives "(in Qiskit v1.3)") and [`qiskit_aer.primitives`](https://qiskit.github.io/qiskit-aer/apidocs/aer_primitives.html#module-qiskit_aer.primitives "(in Qiskit Aer v0.15.0)") do not currently support all of the above functionality. Related upstream issues:
|
||
|
||
* [https://github.com/Qiskit/qiskit/issues/9657](https://github.com/Qiskit/qiskit/issues/9657)
|
||
* [https://github.com/Qiskit/qiskit-aer/issues/1810](https://github.com/Qiskit/qiskit-aer/issues/1810)
|
||
* [https://github.com/Qiskit/qiskit-aer/issues/1811](https://github.com/Qiskit/qiskit-aer/issues/1811)
|
||
|
||
**Parameters**
|
||
|
||
**options** (dict | None) – Default options.
|
||
|
||
#### options
|
||
|
||
<Attribute id="qiskit_addon_cutting.utils.simulation.ExactSampler.options" attributeTypeHint="Options">
|
||
Return options values for the estimator.
|
||
|
||
**Returns**
|
||
|
||
options
|
||
</Attribute>
|
||
|
||
#### run
|
||
|
||
<Function id="qiskit_addon_cutting.utils.simulation.ExactSampler.run" signature="run(circuits, parameter_values=None, **run_options)">
|
||
Run the job of the sampling of bitstrings.
|
||
|
||
**Parameters**
|
||
|
||
* **circuits** (QuantumCircuit | Sequence\[QuantumCircuit]) – One of more circuit objects.
|
||
* **parameter\_values** (Sequence\[float] | Sequence\[Sequence\[float]] | None) – Parameters to be bound to the circuit.
|
||
* **run\_options** – Backend runtime options used for circuit execution.
|
||
|
||
**Return type**
|
||
|
||
T
|
||
|
||
**Returns**
|
||
|
||
The job object of the result of the sampler. The i-th result corresponds to `circuits[i]` evaluated with parameters bound as `parameter_values[i]`.
|
||
|
||
**Raises**
|
||
|
||
[**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – Invalid arguments are given.
|
||
</Function>
|
||
|
||
#### set\_options
|
||
|
||
<Function id="qiskit_addon_cutting.utils.simulation.ExactSampler.set_options" signature="set_options(**fields)">
|
||
Set options values for the estimator.
|
||
|
||
**Parameters**
|
||
|
||
**\*\*fields** – The fields to update the options
|
||
</Function>
|
||
</Class>
|
||
|