BaseEstimator#
- class qiskit.primitives.BaseEstimator(*, options=None)[source]#
Bases :
BasePrimitive
,Generic
[T
]Estimator base class.
Base class for Estimator that estimates expectation values of quantum circuits and observables.
Creating an instance of an Estimator, or using one in a
with
context opens a session that holds resources until the instance isclose()
ed or the context is exited.- Paramètres:
options – Default options.
Attributes
- circuits#
Quantum circuits that represents quantum states.
- Renvoie:
The quantum circuits.
- observables#
Observables to be estimated.
- Renvoie:
The observables.
- options#
Return options values for the estimator.
- Renvoie:
options
- parameters#
Parameters of the quantum circuits.
- Renvoie:
Parameters, where
parameters[i][j]
is the j-th parameter of the i-th circuit.
Methods
- run(circuits, observables, parameter_values=None, **run_options)[source]#
Run the job of the estimation of expectation value(s).
circuits
,observables
, andparameter_values
should have the same length. The i-th element of the result is the expectation of observableobs = observables[i]
for the state prepared by
circ = circuits[i]
with bound parameters
values = parameter_values[i].
- Paramètres:
circuits (Sequence[QuantumCircuit] | QuantumCircuit) – one or more circuit objects.
observables (Sequence[BaseOperator | PauliSumOp | str] | BaseOperator | PauliSumOp | str) – one or more observable objects. Several formats are allowed; importantly,
str
should follow the string representation format forPauli
objects.parameter_values (Sequence[Sequence[float]] | Sequence[float] | float | None) – concrete parameters to be bound.
run_options – runtime options used for circuit execution.
- Renvoie:
The job object of EstimatorResult.
- Lève:
TypeError – Invalid argument type given.
ValueError – Invalid argument values given.
- Type renvoyé:
T
- set_options(**fields)#
Set options values for the estimator.
- Paramètres:
**fields – The fields to update the options