182 lines
7.5 KiB
Plaintext
182 lines
7.5 KiB
Plaintext
---
|
||
title: BernoulliDistribution
|
||
description: API reference for qiskit.aqua.components.uncertainty_models.BernoulliDistribution
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.aqua.components.uncertainty_models.BernoulliDistribution
|
||
---
|
||
|
||
# BernoulliDistribution
|
||
|
||
<Class id="qiskit.aqua.components.uncertainty_models.BernoulliDistribution" isDedicatedPage={true} github="https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/uncertainty_models/bernoulli_distribution.py" signature="BernoulliDistribution(p, low=0, high=1)" modifiers="class">
|
||
Bases: `qiskit.aqua.components.uncertainty_models.univariate_distribution.UnivariateDistribution`
|
||
|
||
The Univariate Bernoulli Distribution.
|
||
|
||
Distribution with only two values (low, high) and the corresponding probabilities represented by a single qubit.
|
||
|
||
**Parameters**
|
||
|
||
* **p** (`float`) – Probability
|
||
* **low** (`float`) – Low value
|
||
* **high** (`float`) – High value
|
||
|
||
## Methods
|
||
|
||
### build
|
||
|
||
<Function id="qiskit.aqua.components.uncertainty_models.BernoulliDistribution.build" signature="BernoulliDistribution.build(qc, q, q_ancillas=None, params=None)" />
|
||
|
||
### build\_controlled
|
||
|
||
<Function id="qiskit.aqua.components.uncertainty_models.BernoulliDistribution.build_controlled" signature="BernoulliDistribution.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.BernoulliDistribution.build_controlled_inverse" signature="BernoulliDistribution.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.BernoulliDistribution.build_controlled_inverse_power" signature="BernoulliDistribution.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.BernoulliDistribution.build_controlled_power" signature="BernoulliDistribution.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.BernoulliDistribution.build_inverse" signature="BernoulliDistribution.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.BernoulliDistribution.build_inverse_power" signature="BernoulliDistribution.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.BernoulliDistribution.build_power" signature="BernoulliDistribution.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.BernoulliDistribution.get_num_qubits" signature="BernoulliDistribution.get_num_qubits()">
|
||
returns number of qubits
|
||
</Function>
|
||
|
||
### get\_num\_qubits\_controlled
|
||
|
||
<Function id="qiskit.aqua.components.uncertainty_models.BernoulliDistribution.get_num_qubits_controlled" signature="BernoulliDistribution.get_num_qubits_controlled()">
|
||
returns number of qubits controlled
|
||
</Function>
|
||
|
||
### pdf\_to\_probabilities
|
||
|
||
<Function id="qiskit.aqua.components.uncertainty_models.BernoulliDistribution.pdf_to_probabilities" signature="BernoulliDistribution.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.BernoulliDistribution.required_ancillas" signature="BernoulliDistribution.required_ancillas()">
|
||
returns required ancillas
|
||
</Function>
|
||
|
||
### required\_ancillas\_controlled
|
||
|
||
<Function id="qiskit.aqua.components.uncertainty_models.BernoulliDistribution.required_ancillas_controlled" signature="BernoulliDistribution.required_ancillas_controlled()">
|
||
returns required ancillas controlled
|
||
</Function>
|
||
|
||
## Attributes
|
||
|
||
### high
|
||
|
||
<Attribute id="qiskit.aqua.components.uncertainty_models.BernoulliDistribution.high">
|
||
returns high
|
||
</Attribute>
|
||
|
||
### low
|
||
|
||
<Attribute id="qiskit.aqua.components.uncertainty_models.BernoulliDistribution.low">
|
||
returns low
|
||
</Attribute>
|
||
|
||
### num\_target\_qubits
|
||
|
||
<Attribute id="qiskit.aqua.components.uncertainty_models.BernoulliDistribution.num_target_qubits">
|
||
Returns the number of target qubits
|
||
</Attribute>
|
||
|
||
### num\_values
|
||
|
||
<Attribute id="qiskit.aqua.components.uncertainty_models.BernoulliDistribution.num_values">
|
||
returns number of values
|
||
</Attribute>
|
||
|
||
### p
|
||
|
||
<Attribute id="qiskit.aqua.components.uncertainty_models.BernoulliDistribution.p" />
|
||
|
||
### probabilities
|
||
|
||
<Attribute id="qiskit.aqua.components.uncertainty_models.BernoulliDistribution.probabilities">
|
||
returns probabilities
|
||
</Attribute>
|
||
|
||
### values
|
||
|
||
<Attribute id="qiskit.aqua.components.uncertainty_models.BernoulliDistribution.values">
|
||
returns values
|
||
</Attribute>
|
||
</Class>
|
||
|