CVaRMeasurement¶

class
CVaRMeasurement
(primitive=None, alpha=1.0, coeff=1.0)[source]¶ Bases:
qiskit.opflow.state_fns.operator_state_fn.OperatorStateFn
 A specialized measurement class to compute CVaR expectation values.
See https://arxiv.org/pdf/1907.04769.pdf for further details.
Used in
CVaRExpectation
, see there for more details. Parameters
primitive (
Optional
[OperatorBase
])  TheOperatorBase
which defines the diagonal operator measurement.coeff (
Union
[complex
,ParameterExpression
])  A coefficient by which to multiply the state functionalpha (
float
)  A realvalued parameter between 0 and 1 which specifies the fraction of observed samples to include when computing the objective value. alpha = 1 corresponds to a standard observable expectation value. alpha = 0 corresponds to only using the single sample with the lowest energy. alpha = 0.5 corresponds to ranking each observation by lowest energy and using the best
 Raises
ValueError  TODO remove that this raises an error
ValueError  If alpha is not in [0, 1].
OpflowError  If the primitive is not diagonal.
Methods Defined Here
Return Operator addition of self and other, overloaded by
+
.The adjoint of a CVaRMeasurement is not defined.
Given the energies of each sampled measurement outcome (H_i) as well as the sampling probability of each measurement outcome (p_i, we can compute the CVaR.
Given the energies of each sampled measurement outcome (H_i) as well as the sampling probability of each measurement outcome (p_i, we can compute the CVaR as H_j + 1/α*(sum_i<j p_i*(H_i  H_j)).
Given the energies of each sampled measurement outcome (H_i) as well as the sampling probability of each measurement outcome (p_i, we can compute the variance of the CVaR estimator as H_j^2 + 1/α * (sum_i<j p_i*(H_i^2  H_j^2)).
In order to compute the CVaR of an observable expectation, we require the energies of each sampled measurement outcome as well as the sampling probability of each measurement outcome.
Returns the scalar multiplication of the Operator, overloaded by
*
, including support for Terra'sParameters
, which can be bound to values later (viabind_parameters
).Sample the state function as a normalized probability distribution.
Return tensor product between self and other, overloaded by
^
.Not defined.
Not defined.
Not defined.
Not defined.
Apply the convert_fn to the internal primitive if the primitive is an Operator (as in the case of
OperatorStateFn
).Attributes

INDENTATION
= ' '¶

alpha
¶  A realvalued parameter between 0 and 1 which specifies the
fraction of observed samples to include when computing the objective value. alpha = 1 corresponds to a standard observable expectation value. alpha = 0 corresponds to only using the single sample with the lowest energy. alpha = 0.5 corresponds to ranking each observation by lowest energy and using the best half.
 Return type
float
 Returns
The parameter alpha which was given at initialization

coeff
¶ A coefficient by which the state function is multiplied.
 Return type
Union
[complex
,ParameterExpression
]

instance_id
¶ Return the unique instance id.
 Return type
int

is_measurement
¶ Whether the StateFn object is a measurement Operator.
 Return type
bool

num_qubits
¶  Return type
int

parameters
¶

primitive
: qiskit.opflow.operator_base.OperatorBase¶ The primitive which defines the behavior of the underlying State function.

settings
¶ Return settings.
 Return type
Dict