LogNormalDistribution
LogNormalDistribution(num_qubits, mu=None, sigma=None, bounds=None, upto_diag=False, name='P(X)')
Bases: qiskit.circuit.quantumcircuit.QuantumCircuit
A circuit to encode a discretized log-normal distribution in qubit amplitudes.
A random variable is log-normal distributed if
for a normal distribution . The probability density function of the log-normal distribution is defined as
The parameter sigma
in this class equals the variance, and not the standard deviation. This is for consistency with multivariate distributions, where the uppercase sigma, , is associated with the covariance.
This circuit considers the discretized version of on 2 ** num_qubits
equidistant points, , truncated to bounds
. The action of this circuit can be written as
where is num_qubits.
The circuit loads the square root of the probabilities into the qubit amplitudes such that the sampling probability, which is the square of the amplitude, equals the probability of the distribution.
This circuit is for example used in amplitude estimation applications, such as finance [1, 2], where customer demand or the return of a portfolio could be modelled using a log-normal distribution.
Examples
This class can be used for both univariate and multivariate distributions. >>> mu = [1, 0.9, 0.2] >>> sigma = [[1, -0.2, 0.2], [-0.2, 1, 0.4], [0.2, 0.4, 1]] >>> circuit = LogNormalDistribution([2, 2, 2], mu, sigma) >>> circuit.num_qubits 6
References
[1]: Gacon, J., Zoufal, C., & Woerner, S. (2020).
Quantum-Enhanced Simulation-Based Optimization. arXiv:2005.10780(opens in a new tab)
[2]: Woerner, S., & Egger, D. J. (2018).
Quantum Risk Analysis. arXiv:1806.06893(opens in a new tab)
Parameters
- num_qubits (
Union
[int
,List
[int
]]) – The number of qubits used to discretize the random variable. For a 1d random variable,num_qubits
is an integer, for multiple dimensions a list of integers indicating the number of qubits to use in each dimension. - mu (
Union
[float
,List
[float
],None
]) – The parameter of the distribution. Can be either a float for a 1d random variable or a list of floats for a higher dimensional random variable. - sigma (
Union
[float
,List
[float
],None
]) – The parameter or , which is the variance or covariance matrix. - bounds (
Union
[Tuple
[float
,float
],List
[Tuple
[float
,float
]],None
]) – The truncation bounds of the distribution as tuples. For multiple dimensions,bounds
is a list of tuples[(low0, high0), (low1, high1), ...]
. IfNone
, the bounds are set to(0, 1)
for each dimension. - upto_diag (
bool
) – If True, load the square root of the probabilities up to multiplication with a diagonal for a more efficient circuit. - name (
str
) – The name of the circuit.
Attributes
ancillas
Returns a list of ancilla bits in the order that the registers were added.
Return type
List
[AncillaQubit
]
bounds
Return the bounds of the probability distribution.
Return type
Union
[Tuple
[float
, float
], List
[Tuple
[float
, float
]]]
calibrations
Return calibration dictionary.
The custom pulse definition of a given gate is of the form
{‘gate_name’: {(qubits, params): schedule}}
Return type
dict
clbits
Returns a list of classical bits in the order that the registers were added.
Return type
List
[Clbit
]
data
Return the circuit data (instructions and context).
Returns
a list-like object containing the tuples for the circuit’s data.
Each tuple is in the format (instruction, qargs, cargs)
, where instruction is an Instruction (or subclass) object, qargs is a list of Qubit objects, and cargs is a list of Clbit objects.
Return type
QuantumCircuitData
extension_lib
Default value: 'include "qelib1.inc";'
global_phase
Return the global phase of the circuit in radians.
Return type
Union
[ParameterExpression
, float
]
header
Default value: 'OPENQASM 2.0;'
instances
Default value: 9
metadata
The user provided metadata associated with the circuit
The metadata for the circuit is a user provided dict
of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit.
Return type
dict
num_ancillas
Return the number of ancilla qubits.
Return type
int
num_clbits
Return number of classical bits.
Return type
int
num_parameters
Convenience function to get the number of parameter objects in the circuit.
Return type
int
num_qubits
Return number of qubits.
Return type
int
parameters
Convenience function to get the parameters defined in the parameter table.
Return type
ParameterView
prefix
Default value: 'circuit'
probabilities
Return the sampling probabilities for the values.
Return type
ndarray
qubits
Returns a list of quantum bits in the order that the registers were added.
Return type
List
[Qubit
]
values
Return the discretized points of the random variable.
Return type
ndarray