178 lines
7.6 KiB
Plaintext
178 lines
7.6 KiB
Plaintext
---
|
||
title: UniformDistribution
|
||
description: API reference for qiskit.aqua.components.uncertainty_models.UniformDistribution
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.aqua.components.uncertainty_models.UniformDistribution
|
||
---
|
||
|
||
# UniformDistribution
|
||
|
||
<Class id="qiskit.aqua.components.uncertainty_models.UniformDistribution" isDedicatedPage={true} github="https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/uniform_distribution.py" signature="UniformDistribution(num_target_qubits, low=0, high=1)" modifiers="class">
|
||
Bases: `qiskit.aqua.components.uncertainty_models.univariate_distribution.UnivariateDistribution`
|
||
|
||
The Univariate Uniform Distribution.
|
||
|
||
Uniform distribution is defined by the number of qubits that should be used to represent the distribution, as well as the lower bound and upper bound of the considered interval.
|
||
|
||
**Parameters**
|
||
|
||
* **num\_target\_qubits** (`int`) – Number of qubits it acts on, has a minimum value of 1.
|
||
* **low** (`float`) – Lower bound, i.e., the value corresponding to |0…0> (assuming an equidistant grid)
|
||
* **high** (`float`) – Upper bound, i.e., the value corresponding to |1…1> (assuming an equidistant grid)
|
||
|
||
## Methods
|
||
|
||
### build
|
||
|
||
<Function id="qiskit.aqua.components.uncertainty_models.UniformDistribution.build" signature="UniformDistribution.build(qc, q, q_ancillas=None, params=None)" />
|
||
|
||
### build\_controlled
|
||
|
||
<Function id="qiskit.aqua.components.uncertainty_models.UniformDistribution.build_controlled" signature="UniformDistribution.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.UniformDistribution.build_controlled_inverse" signature="UniformDistribution.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.UniformDistribution.build_controlled_inverse_power" signature="UniformDistribution.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.UniformDistribution.build_controlled_power" signature="UniformDistribution.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.UniformDistribution.build_inverse" signature="UniformDistribution.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.UniformDistribution.build_inverse_power" signature="UniformDistribution.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.UniformDistribution.build_power" signature="UniformDistribution.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.aqua.components.uncertainty_models.UniformDistribution.get_num_qubits" signature="UniformDistribution.get_num_qubits()">
|
||
returns number of qubits
|
||
</Function>
|
||
|
||
### get\_num\_qubits\_controlled
|
||
|
||
<Function id="qiskit.aqua.components.uncertainty_models.UniformDistribution.get_num_qubits_controlled" signature="UniformDistribution.get_num_qubits_controlled()">
|
||
returns number of qubits controlled
|
||
</Function>
|
||
|
||
### pdf\_to\_probabilities
|
||
|
||
<Function id="qiskit.aqua.components.uncertainty_models.UniformDistribution.pdf_to_probabilities" signature="UniformDistribution.pdf_to_probabilities(pdf, low, high, num_values)" modifiers="static">
|
||
Takes a probability density function (pdf), and returns a truncated and discretized array of probabilities corresponding to it
|
||
|
||
**Parameters**
|
||
|
||
* **pdf** (*function*) – probability density function
|
||
* **low** (*float*) – lower bound of equidistant grid
|
||
* **high** (*float*) – upper bound of equidistant grid
|
||
* **num\_values** (*int*) – number of grid points
|
||
|
||
**Returns**
|
||
|
||
array of probabilities
|
||
|
||
**Return type**
|
||
|
||
list
|
||
</Function>
|
||
|
||
### required\_ancillas
|
||
|
||
<Function id="qiskit.aqua.components.uncertainty_models.UniformDistribution.required_ancillas" signature="UniformDistribution.required_ancillas()">
|
||
returns required ancillas
|
||
</Function>
|
||
|
||
### required\_ancillas\_controlled
|
||
|
||
<Function id="qiskit.aqua.components.uncertainty_models.UniformDistribution.required_ancillas_controlled" signature="UniformDistribution.required_ancillas_controlled()">
|
||
returns required ancillas controlled
|
||
</Function>
|
||
|
||
## Attributes
|
||
|
||
### high
|
||
|
||
<Attribute id="qiskit.aqua.components.uncertainty_models.UniformDistribution.high">
|
||
returns high
|
||
</Attribute>
|
||
|
||
### low
|
||
|
||
<Attribute id="qiskit.aqua.components.uncertainty_models.UniformDistribution.low">
|
||
returns low
|
||
</Attribute>
|
||
|
||
### num\_target\_qubits
|
||
|
||
<Attribute id="qiskit.aqua.components.uncertainty_models.UniformDistribution.num_target_qubits">
|
||
Returns the number of target qubits
|
||
</Attribute>
|
||
|
||
### num\_values
|
||
|
||
<Attribute id="qiskit.aqua.components.uncertainty_models.UniformDistribution.num_values">
|
||
returns number of values
|
||
</Attribute>
|
||
|
||
### probabilities
|
||
|
||
<Attribute id="qiskit.aqua.components.uncertainty_models.UniformDistribution.probabilities">
|
||
returns probabilities
|
||
</Attribute>
|
||
|
||
### values
|
||
|
||
<Attribute id="qiskit.aqua.components.uncertainty_models.UniformDistribution.values">
|
||
returns values
|
||
</Attribute>
|
||
</Class>
|
||
|