Skip to main contentIBM Quantum Documentation
You are viewing the API reference for an old version of Qiskit SDK. Switch to latest version

ExpectationBase

class qiskit.opflow.expectations.ExpectationBase

GitHub(opens in a new tab)

Bases: ConverterBase

Deprecated: A base for Expectation value converters. Expectations are converters which enable the computation of the expectation value of an Observable with respect to some state function. They traverse an Operator tree, replacing OperatorStateFn measurements with equivalent measurements which are more amenable to computation on quantum or classical hardware. For example, if one would like to measure the expectation value of an Operator o expressed as a sum of Paulis with respect to some state function, but only has access to diagonal measurements on Quantum hardware, we can create a measurement ~StateFn(o), use a PauliExpectation to convert it to a diagonal measurement and circuit pre-rotations to a append to the state, and sample this circuit on Quantum hardware with a CircuitSampler. All in all, this would be: my_sampler.convert(my_expect.convert(~StateFn(o)) @ my_state).eval().

Deprecated since version 0.24.0

The class qiskit.opflow.expectations.expectation_base.ExpectationBase is deprecated as of qiskit-terra 0.24.0. It will be removed in the Qiskit 1.0 release. For code migration guidelines, visit https://qisk.it/opflow_migration(opens in a new tab).


Methods

compute_variance

abstract compute_variance(exp_op)

Compute the variance of the expectation estimator.

Parameters

exp_op (OperatorBase) – The full expectation value Operator after sampling.

Returns

The variances or lists thereof (if exp_op contains ListOps) of the expectation value estimation.

Return type

list(opens in a new tab) | complex(opens in a new tab) | ndarray(opens in a new tab)

convert

abstract convert(operator)

Accept an Operator and return a new Operator with the measurements replaced by alternate methods to compute the expectation value.

Parameters

operator (OperatorBase) – The operator to convert.

Returns

The converted operator.

Return type

OperatorBase

Was this page helpful?
Report a bug or request content on GitHub.