218 lines
17 KiB
Plaintext
218 lines
17 KiB
Plaintext
---
|
||
title: MultivariateUniformDistribution
|
||
description: API reference for qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution
|
||
---
|
||
|
||
# qiskit.aqua.components.uncertainty\_models.MultivariateUniformDistribution
|
||
|
||
<Class id="qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution" isDedicatedPage={true} github="https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/multivariate_uniform_distribution.py" signature="MultivariateUniformDistribution(num_qubits, low=None, high=None)" modifiers="class">
|
||
The Multivariate Uniform Distribution.
|
||
|
||
Although this just results in a Hadamard gate on all involved qubits, the lower and upper bounds and the assignment of the qubits to the different dimensions is important if used in a particular application.
|
||
|
||
**Parameters**
|
||
|
||
* **num\_qubits** (`Union`\[`List`\[`int`], `ndarray`]) – List with the number of qubits per dimension
|
||
* **low** (`Union`\[`List`\[`float`], `ndarray`, `None`]) – List with the lower bounds per dimension, set to 0 for each dimension if None
|
||
* **high** (`Union`\[`List`\[`float`], `ndarray`, `None`]) – List with the upper bounds per dimension, set to 1 for each dimension if None
|
||
|
||
### \_\_init\_\_
|
||
|
||
<Function id="qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.__init__" signature="__init__(num_qubits, low=None, high=None)">
|
||
**Parameters**
|
||
|
||
* **num\_qubits** (`Union`\[`List`\[`int`], `ndarray`]) – List with the number of qubits per dimension
|
||
* **low** (`Union`\[`List`\[`float`], `ndarray`, `None`]) – List with the lower bounds per dimension, set to 0 for each dimension if None
|
||
* **high** (`Union`\[`List`\[`float`], `ndarray`, `None`]) – List with the upper bounds per dimension, set to 1 for each dimension if None
|
||
</Function>
|
||
|
||
## Methods
|
||
|
||
| | |
|
||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------- |
|
||
| [`__init__`](#qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.__init__ "qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.__init__")(num\_qubits\[, low, high]) | **type num\_qubits**`Union`\[`List`\[`int`], `ndarray`] |
|
||
| [`build`](#qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.build "qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.build")(qc, q\[, q\_ancillas, params]) | |
|
||
| [`build_controlled`](#qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.build_controlled "qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.build_controlled")(qc, q, q\_control\[, …]) | Adds corresponding controlled sub-circuit to given circuit |
|
||
| [`build_controlled_inverse`](#qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.build_controlled_inverse "qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.build_controlled_inverse")(qc, q, q\_control\[, …]) | Adds controlled inverse of corresponding sub-circuit to given circuit |
|
||
| [`build_controlled_inverse_power`](#qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.build_controlled_inverse_power "qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.build_controlled_inverse_power")(qc, q, …\[, …]) | Adds controlled, inverse, power of corresponding circuit. |
|
||
| [`build_controlled_power`](#qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.build_controlled_power "qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.build_controlled_power")(qc, q, q\_control, power) | Adds controlled power of corresponding circuit. |
|
||
| [`build_inverse`](#qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.build_inverse "qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.build_inverse")(qc, q\[, q\_ancillas]) | Adds inverse of corresponding sub-circuit to given circuit |
|
||
| [`build_inverse_power`](#qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.build_inverse_power "qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.build_inverse_power")(qc, q, power\[, q\_ancillas]) | Adds inverse power of corresponding circuit. |
|
||
| [`build_power`](#qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.build_power "qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.build_power")(qc, q, power\[, q\_ancillas]) | Adds power of corresponding circuit. |
|
||
| [`get_num_qubits`](#qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.get_num_qubits "qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.get_num_qubits")() | returns number of qubits |
|
||
| [`get_num_qubits_controlled`](#qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.get_num_qubits_controlled "qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.get_num_qubits_controlled")() | returns number of qubits controlled |
|
||
| [`pdf_to_probabilities`](#qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.pdf_to_probabilities "qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.pdf_to_probabilities")(pdf, low, high, num\_values) | pdf to probabilities |
|
||
| [`required_ancillas`](#qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.required_ancillas "qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.required_ancillas")() | returns required ancillas |
|
||
| [`required_ancillas_controlled`](#qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.required_ancillas_controlled "qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.required_ancillas_controlled")() | returns required ancillas controlled |
|
||
|
||
## Attributes
|
||
|
||
| | |
|
||
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- |
|
||
| [`dimension`](#qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.dimension "qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.dimension") | returns dimensions |
|
||
| [`high`](#qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.high "qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.high") | returns high |
|
||
| [`low`](#qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.low "qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.low") | returns low |
|
||
| [`num_qubits`](#qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.num_qubits "qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.num_qubits") | returns num qubits |
|
||
| [`num_target_qubits`](#qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.num_target_qubits "qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.num_target_qubits") | Returns the number of target qubits |
|
||
| [`num_values`](#qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.num_values "qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.num_values") | returns number of values |
|
||
| [`probabilities`](#qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.probabilities "qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.probabilities") | returns probabilities |
|
||
| [`probabilities_vector`](#qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.probabilities_vector "qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.probabilities_vector") | returns probabilities vector |
|
||
| [`values`](#qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.values "qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.values") | returns values |
|
||
|
||
### build
|
||
|
||
<Function id="qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.build" signature="build(qc, q, q_ancillas=None, params=None)" />
|
||
|
||
### build\_controlled
|
||
|
||
<Function id="qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.build_controlled" signature="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.aqua.components.uncertainty_models.MultivariateUniformDistribution.build_controlled_inverse" signature="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.aqua.components.uncertainty_models.MultivariateUniformDistribution.build_controlled_inverse_power" signature="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.aqua.components.uncertainty_models.MultivariateUniformDistribution.build_controlled_power" signature="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.aqua.components.uncertainty_models.MultivariateUniformDistribution.build_inverse" signature="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.aqua.components.uncertainty_models.MultivariateUniformDistribution.build_inverse_power" signature="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.aqua.components.uncertainty_models.MultivariateUniformDistribution.build_power" signature="build_power(qc, q, power, q_ancillas=None)">
|
||
Adds power of corresponding circuit. May be overridden if a more efficient implementation is possible
|
||
</Function>
|
||
|
||
### dimension
|
||
|
||
<Attribute id="qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.dimension">
|
||
returns dimensions
|
||
</Attribute>
|
||
|
||
### get\_num\_qubits
|
||
|
||
<Function id="qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.get_num_qubits" signature="get_num_qubits()">
|
||
returns number of qubits
|
||
</Function>
|
||
|
||
### get\_num\_qubits\_controlled
|
||
|
||
<Function id="qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.get_num_qubits_controlled" signature="get_num_qubits_controlled()">
|
||
returns number of qubits controlled
|
||
</Function>
|
||
|
||
### high
|
||
|
||
<Attribute id="qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.high">
|
||
returns high
|
||
</Attribute>
|
||
|
||
### low
|
||
|
||
<Attribute id="qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.low">
|
||
returns low
|
||
</Attribute>
|
||
|
||
### num\_qubits
|
||
|
||
<Attribute id="qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.num_qubits">
|
||
returns num qubits
|
||
</Attribute>
|
||
|
||
### num\_target\_qubits
|
||
|
||
<Attribute id="qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.num_target_qubits">
|
||
Returns the number of target qubits
|
||
</Attribute>
|
||
|
||
### num\_values
|
||
|
||
<Attribute id="qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.num_values">
|
||
returns number of values
|
||
</Attribute>
|
||
|
||
### pdf\_to\_probabilities
|
||
|
||
<Function id="qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.pdf_to_probabilities" signature="pdf_to_probabilities(pdf, low, high, num_values)" modifiers="static">
|
||
pdf to probabilities
|
||
</Function>
|
||
|
||
### probabilities
|
||
|
||
<Attribute id="qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.probabilities">
|
||
returns probabilities
|
||
</Attribute>
|
||
|
||
### probabilities\_vector
|
||
|
||
<Attribute id="qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.probabilities_vector">
|
||
returns probabilities vector
|
||
</Attribute>
|
||
|
||
### required\_ancillas
|
||
|
||
<Function id="qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.required_ancillas" signature="required_ancillas()">
|
||
returns required ancillas
|
||
</Function>
|
||
|
||
### required\_ancillas\_controlled
|
||
|
||
<Function id="qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.required_ancillas_controlled" signature="required_ancillas_controlled()">
|
||
returns required ancillas controlled
|
||
</Function>
|
||
|
||
### values
|
||
|
||
<Attribute id="qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.values">
|
||
returns values
|
||
</Attribute>
|
||
</Class>
|
||
|