Skip to main contentIBM Quantum Documentation


class qiskit.circuit.library.HRSCumulativeMultiplier(num_state_qubits, num_result_qubits=None, adder=None, name='HRSCumulativeMultiplier')

GitHub(opens in a new tab)

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):

  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.


[1] Häner et al., Optimizing Quantum Circuits for Arithmetic, 2018. arXiv:1805.12445(opens in a new tab)


  • num_state_qubits (int(opens in a new tab)) – The number of qubits in either input register for state a|a\rangle or b|b\rangle. The two input registers must have the same number of qubits.
  • num_result_qubits (int(opens in a new tab) | None) – The number of result qubits to limit the output to. If number of result qubits is nn, multiplication modulo 2n2^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 | None) – Half adder circuit to be used for performing multiplication. The CDKMRippleCarryAdder is used as default if no adder is provided.
  • name (str(opens in a new tab)) – The name of the circuit object.


NotImplementedError(opens in a new tab) – If num_result_qubits is not default and a custom adder is provided.



A list of AncillaQubits in the order that they were added. You should not mutate this.


Return calibration dictionary.

The custom pulse definition of a given gate is of the form {'gate_name': {(qubits, params): schedule}}


A list of Clbits in the order that they were added. You should not mutate this.


The circuit data (instructions and context).


a list-like object containing the CircuitInstructions for each instruction.

Return type



The global phase of the current circuit scope in radians.


Default value: 198


Return any associated layout information about the circuit

This attribute contains an optional TranspileLayout object. This is typically set on the output from transpile() or to retain information about the permutations caused on the input circuit by transpilation.

There are two types of permutations caused by the transpile() function, an initial layout which permutes the qubits based on the selected physical qubits on the Target, and a final layout which is an output permutation caused by SwapGates inserted during routing.


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.


Return the number of ancilla qubits.


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 must be zero.


Return number of classical bits.


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.


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 must be zero.


The number of parameter objects in the circuit.


Return number of qubits.


The number of result qubits to limit the output to.


The number of result qubits.


The number of state qubits, i.e. the number of bits in each input register.


The number of state qubits.


The number of real-time classical variables in the circuit.

This is the length of the iter_vars() iterable.


Return a list of operation start times.

This attribute is enabled once one of scheduling analysis passes runs on the quantum circuit.


List of integers representing instruction start times. The index corresponds to the index of instruction in


AttributeError(opens in a new tab) – When circuit is not scheduled.


The parameters defined in the circuit.

This attribute returns the Parameter objects in the circuit sorted alphabetically. Note that parameters instantiated with a ParameterVector are still sorted numerically.


The snippet below shows that insertion order of parameters does not matter.

>>> 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.

>>> 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()
>>> circuit.parameters
ParameterView([Parameter(angle_1), Parameter(angle_10), Parameter(angle_2)])

To respect numerical sorting, a ParameterVector can be used.

>>> 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
    ParameterVectorElement(x[0]), ParameterVectorElement(x[1]),
    ParameterVectorElement(x[2]), ParameterVectorElement(x[3]),
    ..., ParameterVectorElement(x[11])


The sorted Parameter objects in the circuit.


Default value: 'circuit'


A list of Qubits in the order that they were added. You should not mutate this.


Type: str

A human-readable name for the circuit.


Type: list[QuantumRegister]

A list of the QuantumRegisters in this circuit. You should not mutate this.


Type: list[ClassicalRegister]

A list of the ClassicalRegisters in this circuit. You should not mutate this.


Type: int | float | None

The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by unit.


The unit that duration is specified in.

Was this page helpful?
Report a bug or request content on GitHub.