243 lines
8.1 KiB
Plaintext
243 lines
8.1 KiB
Plaintext
---
|
||
title: HRSCumulativeMultiplier
|
||
description: API reference for qiskit.circuit.library.HRSCumulativeMultiplier
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.circuit.library.HRSCumulativeMultiplier
|
||
---
|
||
|
||
# HRSCumulativeMultiplier
|
||
|
||
<Class id="qiskit.circuit.library.HRSCumulativeMultiplier" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/0.19/qiskit/circuit/library/arithmetic/multipliers/hrs_cumulative_multiplier.py" signature="HRSCumulativeMultiplier(num_state_qubits, num_result_qubits=None, adder=None, name='HRSCumulativeMultiplier')" modifiers="class">
|
||
Bases: `qiskit.circuit.library.arithmetic.multipliers.multiplier.Multiplier`
|
||
|
||
A multiplication circuit to store product of two input registers out-of-place.
|
||
|
||
Circuit uses the approach from \[1]. As an example, a multiplier circuit that performs a non-modular multiplication on two 3-qubit sized registers with the default adder is as follows (where `Adder` denotes the `CDKMRippleCarryAdder`):
|
||
|
||
```python
|
||
a_0: ────■─────────────────────────
|
||
│
|
||
a_1: ────┼─────────■───────────────
|
||
│ │
|
||
a_2: ────┼─────────┼─────────■─────
|
||
┌───┴────┐┌───┴────┐┌───┴────┐
|
||
b_0: ┤0 ├┤0 ├┤0 ├
|
||
│ ││ ││ │
|
||
b_1: ┤1 ├┤1 ├┤1 ├
|
||
│ ││ ││ │
|
||
b_2: ┤2 ├┤2 ├┤2 ├
|
||
│ ││ ││ │
|
||
out_0: ┤3 ├┤ ├┤ ├
|
||
│ ││ ││ │
|
||
out_1: ┤4 ├┤3 ├┤ ├
|
||
│ Adder ││ Adder ││ Adder │
|
||
out_2: ┤5 ├┤4 ├┤3 ├
|
||
│ ││ ││ │
|
||
out_3: ┤6 ├┤5 ├┤4 ├
|
||
│ ││ ││ │
|
||
out_4: ┤ ├┤6 ├┤5 ├
|
||
│ ││ ││ │
|
||
out_5: ┤ ├┤ ├┤6 ├
|
||
│ ││ ││ │
|
||
aux_0: ┤7 ├┤7 ├┤7 ├
|
||
└────────┘└────────┘└────────┘
|
||
```
|
||
|
||
Multiplication in this circuit is implemented in a classical approach by performing a series of shifted additions using one of the input registers while the qubits from the other input register act as control qubits for the adders.
|
||
|
||
**References:**
|
||
|
||
\[1] Häner et al., Optimizing Quantum Circuits for Arithmetic, 2018. [arXiv:1805.12445](https://arxiv.org/pdf/1805.12445.pdf)
|
||
|
||
**Parameters**
|
||
|
||
* **num\_state\_qubits** (`int`) – The number of qubits in either input register for state $|a\rangle$ or $|b\rangle$. The two input registers must have the same number of qubits.
|
||
* **num\_result\_qubits** (`Optional`\[`int`]) – The number of result qubits to limit the output to. If number of result qubits is $n$, multiplication modulo $2^n$ is performed to limit the output to the specified number of qubits. Default value is `2 * num_state_qubits` to represent any possible result from the multiplication of the two inputs.
|
||
* **adder** (`Optional`\[`QuantumCircuit`]) – Half adder circuit to be used for performing multiplication. The CDKMRippleCarryAdder is used as default if no adder is provided.
|
||
* **name** (`str`) – The name of the circuit object.
|
||
|
||
**Raises**
|
||
|
||
**NotImplementedError** – If `num_result_qubits` is not default and a custom adder is provided.
|
||
|
||
## Attributes
|
||
|
||
### ancillas
|
||
|
||
<Attribute id="qiskit.circuit.library.HRSCumulativeMultiplier.ancillas">
|
||
Returns a list of ancilla bits in the order that the registers were added.
|
||
|
||
**Return type**
|
||
|
||
`List`\[`AncillaQubit`]
|
||
</Attribute>
|
||
|
||
### calibrations
|
||
|
||
<Attribute id="qiskit.circuit.library.HRSCumulativeMultiplier.calibrations">
|
||
Return calibration dictionary.
|
||
|
||
**The custom pulse definition of a given gate is of the form**
|
||
|
||
\{‘gate\_name’: \{(qubits, params): schedule}}
|
||
|
||
**Return type**
|
||
|
||
`dict`
|
||
</Attribute>
|
||
|
||
### clbits
|
||
|
||
<Attribute id="qiskit.circuit.library.HRSCumulativeMultiplier.clbits">
|
||
Returns a list of classical bits in the order that the registers were added.
|
||
|
||
**Return type**
|
||
|
||
`List`\[`Clbit`]
|
||
</Attribute>
|
||
|
||
### data
|
||
|
||
<Attribute id="qiskit.circuit.library.HRSCumulativeMultiplier.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
|
||
</Attribute>
|
||
|
||
### extension\_lib
|
||
|
||
<Attribute id="qiskit.circuit.library.HRSCumulativeMultiplier.extension_lib" attributeValue="'include "qelib1.inc";'" />
|
||
|
||
### global\_phase
|
||
|
||
<Attribute id="qiskit.circuit.library.HRSCumulativeMultiplier.global_phase">
|
||
Return the global phase of the circuit in radians.
|
||
|
||
**Return type**
|
||
|
||
`Union`\[`ParameterExpression`, `float`]
|
||
</Attribute>
|
||
|
||
### header
|
||
|
||
<Attribute id="qiskit.circuit.library.HRSCumulativeMultiplier.header" attributeValue="'OPENQASM 2.0;'" />
|
||
|
||
### instances
|
||
|
||
<Attribute id="qiskit.circuit.library.HRSCumulativeMultiplier.instances" attributeValue="9" />
|
||
|
||
### metadata
|
||
|
||
<Attribute id="qiskit.circuit.library.HRSCumulativeMultiplier.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`
|
||
</Attribute>
|
||
|
||
### num\_ancillas
|
||
|
||
<Attribute id="qiskit.circuit.library.HRSCumulativeMultiplier.num_ancillas">
|
||
Return the number of ancilla qubits.
|
||
|
||
**Return type**
|
||
|
||
`int`
|
||
</Attribute>
|
||
|
||
### num\_clbits
|
||
|
||
<Attribute id="qiskit.circuit.library.HRSCumulativeMultiplier.num_clbits">
|
||
Return number of classical bits.
|
||
|
||
**Return type**
|
||
|
||
`int`
|
||
</Attribute>
|
||
|
||
### num\_parameters
|
||
|
||
<Attribute id="qiskit.circuit.library.HRSCumulativeMultiplier.num_parameters">
|
||
Convenience function to get the number of parameter objects in the circuit.
|
||
|
||
**Return type**
|
||
|
||
`int`
|
||
</Attribute>
|
||
|
||
### num\_qubits
|
||
|
||
<Attribute id="qiskit.circuit.library.HRSCumulativeMultiplier.num_qubits">
|
||
Return number of qubits.
|
||
|
||
**Return type**
|
||
|
||
`int`
|
||
</Attribute>
|
||
|
||
### num\_result\_qubits
|
||
|
||
<Attribute id="qiskit.circuit.library.HRSCumulativeMultiplier.num_result_qubits">
|
||
The number of result qubits to limit the output to.
|
||
|
||
**Return type**
|
||
|
||
`int`
|
||
|
||
**Returns**
|
||
|
||
The number of result qubits.
|
||
</Attribute>
|
||
|
||
### num\_state\_qubits
|
||
|
||
<Attribute id="qiskit.circuit.library.HRSCumulativeMultiplier.num_state_qubits">
|
||
The number of state qubits, i.e. the number of bits in each input register.
|
||
|
||
**Return type**
|
||
|
||
`int`
|
||
|
||
**Returns**
|
||
|
||
The number of state qubits.
|
||
</Attribute>
|
||
|
||
### parameters
|
||
|
||
<Attribute id="qiskit.circuit.library.HRSCumulativeMultiplier.parameters">
|
||
Convenience function to get the parameters defined in the parameter table.
|
||
|
||
**Return type**
|
||
|
||
`ParameterView`
|
||
</Attribute>
|
||
|
||
### prefix
|
||
|
||
<Attribute id="qiskit.circuit.library.HRSCumulativeMultiplier.prefix" attributeValue="'circuit'" />
|
||
|
||
### qubits
|
||
|
||
<Attribute id="qiskit.circuit.library.HRSCumulativeMultiplier.qubits">
|
||
Returns a list of quantum bits in the order that the registers were added.
|
||
|
||
**Return type**
|
||
|
||
`List`\[`Qubit`]
|
||
</Attribute>
|
||
</Class>
|
||
|