68 lines
3.9 KiB
Plaintext
68 lines
3.9 KiB
Plaintext
---
|
||
title: portfolio
|
||
description: API reference for qiskit.finance.applications.ising.portfolio
|
||
in_page_toc_min_heading_level: 2
|
||
python_api_type: module
|
||
python_api_name: qiskit.finance.applications.ising.portfolio
|
||
---
|
||
|
||
<span id="qiskit-finance-applications-ising-portfolio" />
|
||
|
||
# qiskit.finance.applications.ising.portfolio
|
||
|
||
Convert portfolio optimization instances into Pauli list
|
||
|
||
**Functions**
|
||
|
||
| | |
|
||
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
||
| [`get_operator`](#qiskit.finance.applications.ising.portfolio.get_operator "qiskit.finance.applications.ising.portfolio.get_operator")(mu, sigma, q, budget, penalty) | get qubit op |
|
||
| [`portfolio_expected_value`](#qiskit.finance.applications.ising.portfolio.portfolio_expected_value "qiskit.finance.applications.ising.portfolio.portfolio_expected_value")(x, mu) | returns portfolio expected value |
|
||
| [`portfolio_value`](#qiskit.finance.applications.ising.portfolio.portfolio_value "qiskit.finance.applications.ising.portfolio.portfolio_value")(x, mu, sigma, q, budget, penalty) | returns portfolio value |
|
||
| [`portfolio_variance`](#qiskit.finance.applications.ising.portfolio.portfolio_variance "qiskit.finance.applications.ising.portfolio.portfolio_variance")(x, sigma) | returns portfolio variance |
|
||
| [`random_model`](#qiskit.finance.applications.ising.portfolio.random_model "qiskit.finance.applications.ising.portfolio.random_model")(n\[, seed]) | Generate random model (mu, sigma) for portfolio optimization problem. |
|
||
|
||
### get\_operator
|
||
|
||
<Function id="qiskit.finance.applications.ising.portfolio.get_operator" github="https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/applications/ising/portfolio.py" signature="get_operator(mu, sigma, q, budget, penalty)">
|
||
get qubit op
|
||
</Function>
|
||
|
||
### portfolio\_expected\_value
|
||
|
||
<Function id="qiskit.finance.applications.ising.portfolio.portfolio_expected_value" github="https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/applications/ising/portfolio.py" signature="portfolio_expected_value(x, mu)">
|
||
returns portfolio expected value
|
||
</Function>
|
||
|
||
### portfolio\_value
|
||
|
||
<Function id="qiskit.finance.applications.ising.portfolio.portfolio_value" github="https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/applications/ising/portfolio.py" signature="portfolio_value(x, mu, sigma, q, budget, penalty)">
|
||
returns portfolio value
|
||
</Function>
|
||
|
||
### portfolio\_variance
|
||
|
||
<Function id="qiskit.finance.applications.ising.portfolio.portfolio_variance" github="https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/applications/ising/portfolio.py" signature="portfolio_variance(x, sigma)">
|
||
returns portfolio variance
|
||
</Function>
|
||
|
||
### random\_model
|
||
|
||
<Function id="qiskit.finance.applications.ising.portfolio.random_model" github="https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/finance/applications/ising/portfolio.py" signature="random_model(n, seed=None)">
|
||
Generate random model (mu, sigma) for portfolio optimization problem.
|
||
|
||
**Parameters**
|
||
|
||
* **n** (*int*) – number of assets.
|
||
* **seed** (*int or None*) – random seed - if None, will not initialize.
|
||
|
||
**Returns**
|
||
|
||
expected return vector numpy.ndarray: covariance matrix
|
||
|
||
**Return type**
|
||
|
||
numpy.narray
|
||
</Function>
|
||
|