--- title: HRSCumulativeMultiplier (v1.1) description: API reference for qiskit.circuit.library.HRSCumulativeMultiplier in qiskit v1.1 source: https://eu-de.quantum.cloud.ibm.com/docs/en/api/qiskit/1.1/qiskit.circuit.library.HRSCumulativeMultiplier --- # HRSCumulativeMultiplier *class* `qiskit.circuit.library.HRSCumulativeMultiplier(num_state_qubits, num_result_qubits=None, adder=None, name='HRSCumulativeMultiplier')` [GitHub](https://github.com/Qiskit/qiskit/tree/stable/1.1/qiskit/circuit/library/arithmetic/multipliers/hrs_cumulative_multiplier.py#L21-L138) Bases: `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*](https://docs.python.org/3/library/functions.html#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** ([*int*](https://docs.python.org/3/library/functions.html#int) *| None*) – 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** ([*QuantumCircuit*](/docs/api/qiskit/1.1/qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") *| None*) – Half adder circuit to be used for performing multiplication. The CDKMRippleCarryAdder is used as default if no adder is provided. - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str)) – The name of the circuit object. **Raises** [**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError) – If `num_result_qubits` is not default and a custom adder is provided. ## Attributes ### ancillas A list of `AncillaQubit`s in the order that they were added. You should not mutate this. ### calibrations Return calibration dictionary. The custom pulse definition of a given gate is of the form `{'gate_name': {(qubits, params): schedule}}` ### clbits A list of `Clbit`s in the order that they were added. You should not mutate this. ### data The circuit data (instructions and context). **Returns** a list-like object containing the [`CircuitInstruction`](/docs/api/qiskit/1.1/qiskit.circuit.CircuitInstruction "qiskit.circuit.CircuitInstruction")s for each instruction. **Return type** QuantumCircuitData ### global\_phase The global phase of the current circuit scope in radians. ### instances Default value: `198` ### layout Return any associated layout information about the circuit This attribute contains an optional [`TranspileLayout`](/docs/api/qiskit/1.1/qiskit.transpiler.TranspileLayout "qiskit.transpiler.TranspileLayout") object. This is typically set on the output from [`transpile()`](/docs/api/qiskit/1.1/compiler#qiskit.compiler.transpile "qiskit.compiler.transpile") or [`PassManager.run()`](/docs/api/qiskit/1.1/qiskit.transpiler.PassManager#run "qiskit.transpiler.PassManager.run") to retain information about the permutations caused on the input circuit by transpilation. There are two types of permutations caused by the [`transpile()`](/docs/api/qiskit/1.1/compiler#qiskit.compiler.transpile "qiskit.compiler.transpile") function, an initial layout which permutes the qubits based on the selected physical qubits on the [`Target`](/docs/api/qiskit/1.1/qiskit.transpiler.Target "qiskit.transpiler.Target"), and a final layout which is an output permutation caused by [`SwapGate`](/docs/api/qiskit/1.1/qiskit.circuit.library.SwapGate "qiskit.circuit.library.SwapGate")s inserted during routing. ### metadata Arbitrary user-defined metadata for the circuit. Qiskit will not examine the content of this mapping, but it will pass it through the transpiler and reattach it to the output, so you can track your own metadata. ### num\_ancillas Return the number of ancilla qubits. ### num\_captured\_vars The number of real-time classical variables in the circuit marked as captured from an enclosing scope. This is the length of the `iter_captured_vars()` iterable. If this is non-zero, [`num_input_vars`](#qiskit.circuit.library.HRSCumulativeMultiplier.num_input_vars "qiskit.circuit.library.HRSCumulativeMultiplier.num_input_vars") must be zero. ### num\_clbits Return number of classical bits. ### num\_declared\_vars The number of real-time classical variables in the circuit that are declared by this circuit scope, excluding inputs or captures. This is the length of the `iter_declared_vars()` iterable. ### num\_input\_vars The number of real-time classical variables in the circuit marked as circuit inputs. This is the length of the `iter_input_vars()` iterable. If this is non-zero, [`num_captured_vars`](#qiskit.circuit.library.HRSCumulativeMultiplier.num_captured_vars "qiskit.circuit.library.HRSCumulativeMultiplier.num_captured_vars") must be zero. ### num\_parameters The number of parameter objects in the circuit. ### num\_qubits Return number of qubits. ### num\_result\_qubits The number of result qubits to limit the output to. **Returns** The number of result qubits. ### num\_state\_qubits The number of state qubits, i.e. the number of bits in each input register. **Returns** The number of state qubits. ### num\_vars The number of real-time classical variables in the circuit. This is the length of the `iter_vars()` iterable. ### op\_start\_times Return a list of operation start times. This attribute is enabled once one of scheduling analysis passes runs on the quantum circuit. **Returns** List of integers representing instruction start times. The index corresponds to the index of instruction in `QuantumCircuit.data`. **Raises** [**AttributeError**](https://docs.python.org/3/library/exceptions.html#AttributeError) – When circuit is not scheduled. ### parameters The parameters defined in the circuit. This attribute returns the [`Parameter`](/docs/api/qiskit/1.1/qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects in the circuit sorted alphabetically. Note that parameters instantiated with a [`ParameterVector`](/docs/api/qiskit/1.1/qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector") are still sorted numerically. **Examples** The snippet below shows that insertion order of parameters does not matter. ```python >>> from qiskit.circuit import QuantumCircuit, Parameter >>> a, b, elephant = Parameter("a"), Parameter("b"), Parameter("elephant") >>> circuit = QuantumCircuit(1) >>> circuit.rx(b, 0) >>> circuit.rz(elephant, 0) >>> circuit.ry(a, 0) >>> circuit.parameters # sorted alphabetically! ParameterView([Parameter(a), Parameter(b), Parameter(elephant)]) ``` Bear in mind that alphabetical sorting might be unintuitive when it comes to numbers. The literal “10” comes before “2” in strict alphabetical sorting. ```python >>> from qiskit.circuit import QuantumCircuit, Parameter >>> angles = [Parameter("angle_1"), Parameter("angle_2"), Parameter("angle_10")] >>> circuit = QuantumCircuit(1) >>> circuit.u(*angles, 0) >>> circuit.draw() ┌─────────────────────────────┐ q: ┤ U(angle_1,angle_2,angle_10) ├ └─────────────────────────────┘ >>> circuit.parameters ParameterView([Parameter(angle_1), Parameter(angle_10), Parameter(angle_2)]) ``` To respect numerical sorting, a [`ParameterVector`](/docs/api/qiskit/1.1/qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector") can be used. ```python >>> from qiskit.circuit import QuantumCircuit, Parameter, ParameterVector >>> x = ParameterVector("x", 12) >>> circuit = QuantumCircuit(1) >>> for x_i in x: ... circuit.rx(x_i, 0) >>> circuit.parameters ParameterView([ ParameterVectorElement(x[0]), ParameterVectorElement(x[1]), ParameterVectorElement(x[2]), ParameterVectorElement(x[3]), ..., ParameterVectorElement(x[11]) ]) ``` **Returns** The sorted [`Parameter`](/docs/api/qiskit/1.1/qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects in the circuit. ### prefix Default value: `'circuit'` ### qubits A list of `Qubit`s in the order that they were added. You should not mutate this. ### name Type: `str` A human-readable name for the circuit. ### qregs Type: `list[QuantumRegister]` A list of the `QuantumRegister`s in this circuit. You should not mutate this. ### cregs Type: `list[ClassicalRegister]` A list of the `ClassicalRegister`s in this circuit. You should not mutate this. ### duration Type: `int | float | None` The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.HRSCumulativeMultiplier.unit "qiskit.circuit.library.HRSCumulativeMultiplier.unit"). ### unit The unit that [`duration`](#qiskit.circuit.library.HRSCumulativeMultiplier.duration "qiskit.circuit.library.HRSCumulativeMultiplier.duration") is specified in.