339 lines
13 KiB
Plaintext
339 lines
13 KiB
Plaintext
---
|
||
title: CVaRMeasurement
|
||
description: API reference for qiskit.opflow.state_fns.CVaRMeasurement
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.opflow.state_fns.CVaRMeasurement
|
||
---
|
||
|
||
# CVaRMeasurement
|
||
|
||
<Class id="qiskit.opflow.state_fns.CVaRMeasurement" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/opflow/state_fns/cvar_measurement.py" signature="CVaRMeasurement(primitive=None, alpha=1.0, coeff=1.0)" modifiers="class">
|
||
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](https://arxiv.org/pdf/1907.04769.pdf) for further details.
|
||
|
||
Used in `CVaRExpectation`, see there for more details.
|
||
|
||
**Parameters**
|
||
|
||
* **primitive** (`Optional`\[`OperatorBase`]) – The `OperatorBase` which defines the diagonal operator measurement.
|
||
* **coeff** (`Union`\[`complex`, `ParameterExpression`]) – A coefficient by which to multiply the state function
|
||
* **alpha** (`float`) – A real-valued 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**](qiskit.opflow.OpflowError "qiskit.opflow.OpflowError") – If the primitive is not diagonal.
|
||
|
||
## Methods Defined Here
|
||
|
||
### add
|
||
|
||
<Function id="qiskit.opflow.state_fns.CVaRMeasurement.add" signature="CVaRMeasurement.add(other)">
|
||
Return Operator addition of self and other, overloaded by `+`.
|
||
|
||
**Parameters**
|
||
|
||
**other** (`OperatorBase`) – An `OperatorBase` with the same number of qubits as self, and in the same ‘Operator’, ‘State function’, or ‘Measurement’ category as self (i.e. the same type of underlying function).
|
||
|
||
**Return type**
|
||
|
||
`SummedOp`
|
||
|
||
**Returns**
|
||
|
||
An `OperatorBase` equivalent to the sum of self and other.
|
||
</Function>
|
||
|
||
### adjoint
|
||
|
||
<Function id="qiskit.opflow.state_fns.CVaRMeasurement.adjoint" signature="CVaRMeasurement.adjoint()">
|
||
The adjoint of a CVaRMeasurement is not defined.
|
||
|
||
**Returns**
|
||
|
||
Does not return anything, raises an error.
|
||
|
||
**Raises**
|
||
|
||
[**OpflowError**](qiskit.opflow.OpflowError "qiskit.opflow.OpflowError") – The adjoint of a CVaRMeasurement is not defined.
|
||
</Function>
|
||
|
||
### compute\_cvar
|
||
|
||
<Function id="qiskit.opflow.state_fns.CVaRMeasurement.compute_cvar" signature="CVaRMeasurement.compute_cvar(energies, probabilities)">
|
||
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. Note that the sampling probabilities serve as an alternative to knowing the counts of each observation and that the input energies are assumed to be sorted in increasing order.
|
||
|
||
Consider the outcome with index j, such that only some of the samples with measurement outcome j will be used in computing CVaR. The CVaR calculation can then be separated into two parts. First we sum each of the energies for outcomes i \< j, weighted by the probability of observing that outcome (i.e the normalized counts). Second, we add the energy for outcome j, weighted by the difference (α - sum\_i\<j p\_i)
|
||
|
||
**Parameters**
|
||
|
||
* **energies** (`list`) – A list containing the energies (H\_i) of each sample measurement outcome, sorted in increasing order.
|
||
* **probabilities** (`list`) – The sampling probabilities (p\_i) for each corresponding measurement outcome.
|
||
|
||
**Return type**
|
||
|
||
`complex`
|
||
|
||
**Returns**
|
||
|
||
**The CVaR of the diagonal observable specified by self.primitive and**
|
||
|
||
the sampled quantum state described by the inputs (energies, probabilities). For index j (described above), the CVaR is computed as H\_j + 1/α \* (sum\_i\<j p\_i\*(H\_i - H\_j))
|
||
|
||
**Raises**
|
||
|
||
**ValueError** – front isn’t a DictStateFn or VectorStateFn
|
||
</Function>
|
||
|
||
### eval
|
||
|
||
<Function id="qiskit.opflow.state_fns.CVaRMeasurement.eval" signature="CVaRMeasurement.eval(front=None)">
|
||
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)). Note that index j corresponds to the measurement outcome such that only some of the samples with measurement outcome j will be used in computing CVaR. Note also that the sampling probabilities serve as an alternative to knowing the counts of each observation.
|
||
|
||
This computation is broken up into two subroutines. One which evaluates each measurement outcome and determines the sampling probabilities of each. And one which carries out the above calculation. The computation is split up this way to enable a straightforward calculation of the variance of this estimator.
|
||
|
||
**Parameters**
|
||
|
||
**front** (`Union`\[`str`, `dict`, `ndarray`, `OperatorBase`, `Statevector`, `None`]) – A StateFn or primitive which specifies the results of evaluating a quantum state.
|
||
|
||
**Return type**
|
||
|
||
`complex`
|
||
|
||
**Returns**
|
||
|
||
**The CVaR of the diagonal observable specified by self.primitive and**
|
||
|
||
the sampled quantum state described by the inputs (energies, probabilities). For index j (described above), the CVaR is computed as H\_j + 1/α\*(sum\_i\<j p\_i\*(H\_i - H\_j))
|
||
</Function>
|
||
|
||
### eval\_variance
|
||
|
||
<Function id="qiskit.opflow.state_fns.CVaRMeasurement.eval_variance" signature="CVaRMeasurement.eval_variance(front=None)">
|
||
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)). This follows from the definition that Var\[X] = E\[X^2] - E\[X]^2. In this case, X = E\[\<bi|H|bi>], where H is the diagonal observable and bi corresponds to measurement outcome i. Given this, E\[X^2] = E\[\<bi|H|bi>^2]
|
||
|
||
**Parameters**
|
||
|
||
**front** (`Union`\[`str`, `dict`, `ndarray`, `OperatorBase`, `None`]) – A StateFn or primitive which specifies the results of evaluating a quantum state.
|
||
|
||
**Return type**
|
||
|
||
`complex`
|
||
|
||
**Returns**
|
||
|
||
**The Var\[CVaR] of the diagonal observable specified by self.primitive**
|
||
|
||
and the sampled quantum state described by the inputs (energies, probabilities). For index j (described above), the CVaR is computed as H\_j^2 + 1/α\*(sum\_i\<j p\_i\*(H\_i^2 - H\_j^2))
|
||
</Function>
|
||
|
||
### get\_outcome\_energies\_probabilities
|
||
|
||
<Function id="qiskit.opflow.state_fns.CVaRMeasurement.get_outcome_energies_probabilities" signature="CVaRMeasurement.get_outcome_energies_probabilities(front=None)">
|
||
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. Note that the counts for each measurement outcome will also suffice (and this is often how the CVaR is presented).
|
||
|
||
**Parameters**
|
||
|
||
**front** (`Union`\[`str`, `dict`, `ndarray`, `OperatorBase`, `Statevector`, `None`]) – A StateFn or a primitive which defines a StateFn. This input holds the results of a sampled/simulated circuit.
|
||
|
||
**Return type**
|
||
|
||
`Tuple`\[`list`, `list`]
|
||
|
||
**Returns**
|
||
|
||
**Two lists of equal length. energies contains the energy of each**
|
||
|
||
unique measurement outcome computed against the diagonal observable stored in self.primitive. probabilities contains the corresponding sampling probability for each measurement outcome in energies.
|
||
|
||
**Raises**
|
||
|
||
**ValueError** – front isn’t a DictStateFn or VectorStateFn
|
||
</Function>
|
||
|
||
### mul
|
||
|
||
<Function id="qiskit.opflow.state_fns.CVaRMeasurement.mul" signature="CVaRMeasurement.mul(scalar)">
|
||
Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`).
|
||
|
||
**Parameters**
|
||
|
||
**scalar** (`Union`\[`complex`, `ParameterExpression`]) – The real or complex scalar by which to multiply the Operator, or the `ParameterExpression` to serve as a placeholder for a scalar factor.
|
||
|
||
**Return type**
|
||
|
||
`CVaRMeasurement`
|
||
|
||
**Returns**
|
||
|
||
An `OperatorBase` equivalent to product of self and scalar.
|
||
</Function>
|
||
|
||
### sample
|
||
|
||
<Function id="qiskit.opflow.state_fns.CVaRMeasurement.sample" signature="CVaRMeasurement.sample(shots=1024, massive=False, reverse_endianness=False)">
|
||
Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability.
|
||
|
||
**Parameters**
|
||
|
||
* **shots** (`int`) – The number of samples to take to approximate the State function.
|
||
* **massive** (`bool`) – Whether to allow large conversions, e.g. creating a matrix representing over 16 qubits.
|
||
* **reverse\_endianness** (`bool`) – Whether to reverse the endianness of the bitstrings in the return dict to match Terra’s big-endianness.
|
||
|
||
**Returns**
|
||
|
||
A dict containing pairs sampled strings from the State function and sampling frequency divided by shots.
|
||
</Function>
|
||
|
||
### tensor
|
||
|
||
<Function id="qiskit.opflow.state_fns.CVaRMeasurement.tensor" signature="CVaRMeasurement.tensor(other)">
|
||
Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like
|
||
|
||
> |0⟩– |+⟩–
|
||
|
||
Because Terra prints circuits and results with qubit 0 at the end of the string or circuit.
|
||
|
||
**Parameters**
|
||
|
||
**other** (`OperatorBase`) – The `OperatorBase` to tensor product with self.
|
||
|
||
**Return type**
|
||
|
||
`Union`\[`OperatorStateFn`, `TensoredOp`]
|
||
|
||
**Returns**
|
||
|
||
An `OperatorBase` equivalent to the tensor product of self and other.
|
||
</Function>
|
||
|
||
### to\_circuit\_op
|
||
|
||
<Function id="qiskit.opflow.state_fns.CVaRMeasurement.to_circuit_op" signature="CVaRMeasurement.to_circuit_op()">
|
||
Not defined.
|
||
</Function>
|
||
|
||
### to\_density\_matrix
|
||
|
||
<Function id="qiskit.opflow.state_fns.CVaRMeasurement.to_density_matrix" signature="CVaRMeasurement.to_density_matrix(massive=False)">
|
||
Not defined.
|
||
</Function>
|
||
|
||
### to\_matrix
|
||
|
||
<Function id="qiskit.opflow.state_fns.CVaRMeasurement.to_matrix" signature="CVaRMeasurement.to_matrix(massive=False)">
|
||
Not defined.
|
||
</Function>
|
||
|
||
### to\_matrix\_op
|
||
|
||
<Function id="qiskit.opflow.state_fns.CVaRMeasurement.to_matrix_op" signature="CVaRMeasurement.to_matrix_op(massive=False)">
|
||
Not defined.
|
||
</Function>
|
||
|
||
### traverse
|
||
|
||
<Function id="qiskit.opflow.state_fns.CVaRMeasurement.traverse" signature="CVaRMeasurement.traverse(convert_fn, coeff=None)">
|
||
Apply the convert\_fn to the internal primitive if the primitive is an Operator (as in the case of `OperatorStateFn`). Otherwise do nothing. Used by converters.
|
||
|
||
**Parameters**
|
||
|
||
* **convert\_fn** (`Callable`) – The function to apply to the internal OperatorBase.
|
||
* **coeff** (`Union`\[`complex`, `ParameterExpression`, `None`]) – A coefficient to multiply by after applying convert\_fn. If it is None, self.coeff is used instead.
|
||
|
||
**Return type**
|
||
|
||
`OperatorBase`
|
||
|
||
**Returns**
|
||
|
||
The converted StateFn.
|
||
</Function>
|
||
|
||
## Attributes
|
||
|
||
### INDENTATION
|
||
|
||
<Attribute id="qiskit.opflow.state_fns.CVaRMeasurement.INDENTATION" attributeValue="' '" />
|
||
|
||
### alpha
|
||
|
||
<Attribute id="qiskit.opflow.state_fns.CVaRMeasurement.alpha">
|
||
**A real-valued 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
|
||
</Attribute>
|
||
|
||
### coeff
|
||
|
||
<Attribute id="qiskit.opflow.state_fns.CVaRMeasurement.coeff">
|
||
A coefficient by which the state function is multiplied.
|
||
|
||
**Return type**
|
||
|
||
`Union`\[`complex`, `ParameterExpression`]
|
||
</Attribute>
|
||
|
||
### instance\_id
|
||
|
||
<Attribute id="qiskit.opflow.state_fns.CVaRMeasurement.instance_id">
|
||
Return the unique instance id.
|
||
|
||
**Return type**
|
||
|
||
`int`
|
||
</Attribute>
|
||
|
||
### is\_measurement
|
||
|
||
<Attribute id="qiskit.opflow.state_fns.CVaRMeasurement.is_measurement">
|
||
Whether the StateFn object is a measurement Operator.
|
||
|
||
**Return type**
|
||
|
||
`bool`
|
||
</Attribute>
|
||
|
||
### num\_qubits
|
||
|
||
<Attribute id="qiskit.opflow.state_fns.CVaRMeasurement.num_qubits">
|
||
**Return type**
|
||
|
||
`int`
|
||
</Attribute>
|
||
|
||
### parameters
|
||
|
||
<Attribute id="qiskit.opflow.state_fns.CVaRMeasurement.parameters" />
|
||
|
||
### primitive
|
||
|
||
<Attribute id="qiskit.opflow.state_fns.CVaRMeasurement.primitive" attributeTypeHint="qiskit.opflow.operator_base.OperatorBase">
|
||
The primitive which defines the behavior of the underlying State function.
|
||
</Attribute>
|
||
|
||
### settings
|
||
|
||
<Attribute id="qiskit.opflow.state_fns.CVaRMeasurement.settings">
|
||
Return settings.
|
||
|
||
**Return type**
|
||
|
||
`Dict`
|
||
</Attribute>
|
||
</Class>
|
||
|