148 lines
7.3 KiB
Plaintext
148 lines
7.3 KiB
Plaintext
---
|
||
title: FixedIncomeExpectedValue
|
||
description: API reference for qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue
|
||
---
|
||
|
||
# FixedIncomeExpectedValue
|
||
|
||
<Class id="qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue" isDedicatedPage={true} github="https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/components/uncertainty_problems/fixed_income_expected_value.py" signature="FixedIncomeExpectedValue(uncertainty_model, A, b, cash_flow, c_approx, i_state=None, i_objective=None)" modifiers="class">
|
||
Bases: `qiskit.aqua.components.uncertainty_problems.uncertainty_problem.UncertaintyProblem`
|
||
|
||
The Fixed Income Expected Value.
|
||
|
||
Evaluates a fixed income asset with uncertain interest rates.
|
||
|
||
Constructor.
|
||
|
||
**Parameters**
|
||
|
||
* **uncertainty\_model** (`UncertaintyModel`) – multivariate distribution
|
||
* **A** (`ndarray`) – PCA matrix for delta\_r (changes in interest rates)
|
||
* **b** (`List`\[`int`]) – offset for interest rates (= initial interest rates)
|
||
* **cash\_flow** (`List`\[`float`]) – cash flow time series
|
||
* **c\_approx** (`float`) – approximation scaling factor
|
||
* **i\_state** (`Union`\[`List`\[`int`], `ndarray`, `None`]) – indices of qubits that represent the state
|
||
* **i\_objective** (`Optional`\[`int`]) – index of target qubit to apply the rotation to
|
||
|
||
## Methods
|
||
|
||
### build
|
||
|
||
<Function id="qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.build" signature="FixedIncomeExpectedValue.build(qc, q, q_ancillas=None, params=None)">
|
||
Adds corresponding sub-circuit to given circuit
|
||
|
||
**Parameters**
|
||
|
||
* **qc** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – quantum circuit
|
||
* **q** (*list*) – list of qubits (has to be same length as self.\_num\_qubits)
|
||
* **q\_ancillas** (*list*) – list of ancilla qubits (or None if none needed)
|
||
* **params** (*list*) – parameters for circuit
|
||
</Function>
|
||
|
||
### build\_controlled
|
||
|
||
<Function id="qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.build_controlled" signature="FixedIncomeExpectedValue.build_controlled(qc, q, q_control, q_ancillas=None, use_basis_gates=True)">
|
||
Adds corresponding controlled sub-circuit to given circuit
|
||
|
||
**Parameters**
|
||
|
||
* **qc** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – quantum circuit
|
||
* **q** (*list*) – list of qubits (has to be same length as self.\_num\_qubits)
|
||
* **q\_control** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")) – control qubit
|
||
* **q\_ancillas** (*list*) – list of ancilla qubits (or None if none needed)
|
||
* **use\_basis\_gates** (*bool*) – use basis gates for expansion of controlled circuit
|
||
</Function>
|
||
|
||
### build\_controlled\_inverse
|
||
|
||
<Function id="qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.build_controlled_inverse" signature="FixedIncomeExpectedValue.build_controlled_inverse(qc, q, q_control, q_ancillas=None, use_basis_gates=True)">
|
||
Adds controlled inverse of corresponding sub-circuit to given circuit
|
||
|
||
**Parameters**
|
||
|
||
* **qc** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – quantum circuit
|
||
* **q** (*list*) – list of qubits (has to be same length as self.\_num\_qubits)
|
||
* **q\_control** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")) – control qubit
|
||
* **q\_ancillas** (*list*) – list of ancilla qubits (or None if none needed)
|
||
* **use\_basis\_gates** (*bool*) – use basis gates for expansion of controlled circuit
|
||
</Function>
|
||
|
||
### build\_controlled\_inverse\_power
|
||
|
||
<Function id="qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.build_controlled_inverse_power" signature="FixedIncomeExpectedValue.build_controlled_inverse_power(qc, q, q_control, power, q_ancillas=None, use_basis_gates=True)">
|
||
Adds controlled, inverse, power of corresponding circuit. May be overridden if a more efficient implementation is possible
|
||
</Function>
|
||
|
||
### build\_controlled\_power
|
||
|
||
<Function id="qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.build_controlled_power" signature="FixedIncomeExpectedValue.build_controlled_power(qc, q, q_control, power, q_ancillas=None, use_basis_gates=True)">
|
||
Adds controlled power of corresponding circuit. May be overridden if a more efficient implementation is possible
|
||
</Function>
|
||
|
||
### build\_inverse
|
||
|
||
<Function id="qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.build_inverse" signature="FixedIncomeExpectedValue.build_inverse(qc, q, q_ancillas=None)">
|
||
Adds inverse of corresponding sub-circuit to given circuit
|
||
|
||
**Parameters**
|
||
|
||
* **qc** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – quantum circuit
|
||
* **q** (*list*) – list of qubits (has to be same length as self.\_num\_qubits)
|
||
* **q\_ancillas** (*list*) – list of ancilla qubits (or None if none needed)
|
||
</Function>
|
||
|
||
### build\_inverse\_power
|
||
|
||
<Function id="qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.build_inverse_power" signature="FixedIncomeExpectedValue.build_inverse_power(qc, q, power, q_ancillas=None)">
|
||
Adds inverse power of corresponding circuit. May be overridden if a more efficient implementation is possible
|
||
</Function>
|
||
|
||
### build\_power
|
||
|
||
<Function id="qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.build_power" signature="FixedIncomeExpectedValue.build_power(qc, q, power, q_ancillas=None)">
|
||
Adds power of corresponding circuit. May be overridden if a more efficient implementation is possible
|
||
</Function>
|
||
|
||
### get\_num\_qubits
|
||
|
||
<Function id="qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.get_num_qubits" signature="FixedIncomeExpectedValue.get_num_qubits()">
|
||
returns number of qubits
|
||
</Function>
|
||
|
||
### get\_num\_qubits\_controlled
|
||
|
||
<Function id="qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.get_num_qubits_controlled" signature="FixedIncomeExpectedValue.get_num_qubits_controlled()">
|
||
returns number of qubits controlled
|
||
</Function>
|
||
|
||
### required\_ancillas
|
||
|
||
<Function id="qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.required_ancillas" signature="FixedIncomeExpectedValue.required_ancillas()">
|
||
returns required ancillas
|
||
</Function>
|
||
|
||
### required\_ancillas\_controlled
|
||
|
||
<Function id="qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.required_ancillas_controlled" signature="FixedIncomeExpectedValue.required_ancillas_controlled()">
|
||
returns required ancillas controlled
|
||
</Function>
|
||
|
||
### value\_to\_estimation
|
||
|
||
<Function id="qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.value_to_estimation" signature="FixedIncomeExpectedValue.value_to_estimation(value)">
|
||
value to estimate
|
||
</Function>
|
||
|
||
## Attributes
|
||
|
||
### num\_target\_qubits
|
||
|
||
<Attribute id="qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.num_target_qubits">
|
||
Returns the number of target qubits
|
||
</Attribute>
|
||
</Class>
|
||
|