Single-register arithmetic gates #13371

Cryoris · 2024-10-25T07:47:46Z

Summary

Part of #13046: Gates for the single-register arithmetic operations.

Details and comments

I'm opening this PR for people to have a look and for more HLS test cases, but this can probably use some more cleanup. Also all the piecewise gates need an auxiliary qubit, which is currently part of the Gate num_qubits but probably shouldn't be and instead be handled by a synthesis plugin.

Since there's already enough for 1.3 I'd suggest we don't include this.

no support for parameter expressions for now

some tests miss, some HLS tests fail (maybe Sasha's PR fixes this)

qiskit-bot · 2025-02-11T17:43:37Z

One or more of the following people are relevant to this code:

@Cryoris
@Qiskit/terra-core
@ajavadia

ShellyGarion

Is there a plan to add deprecation warnings in the related non-gates classes?
Should it be done as part of this PR?

qiskit/circuit/library/__init__.py

qiskit/circuit/library/arithmetic/integer_comparator.py

qiskit/circuit/library/arithmetic/linear_amplitude_function.py

qiskit/circuit/library/arithmetic/linear_pauli_rotations.py

qiskit/circuit/library/arithmetic/piecewise_chebyshev.py

qiskit/circuit/library/arithmetic/polynomial_pauli_rotations.py

qiskit/circuit/library/arithmetic/quadratic_form.py

qiskit/synthesis/arithmetic/__init__.py

qiskit/synthesis/arithmetic/comparators/compare_2s.py

qiskit/synthesis/arithmetic/comparators/compare_greedy.py

coveralls · 2025-02-13T02:45:09Z

Pull Request Test Coverage Report for Build 13541552394

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

For more information on this, see Tracking coverage changes with pull request builds.
To avoid this issue with future PRs, see these Recommended CI Configurations.
For a quick fix, rebase this PR at GitHub. Your next report should be accurate.

Details

488 of 539 (90.54%) changed or added relevant lines in 17 files are covered.
2260 unchanged lines in 122 files lost coverage.
Overall coverage decreased (-0.4%) to 87.873%

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
qiskit/circuit/library/arithmetic/polynomial_pauli_rotations.py	37	38	97.37%
qiskit/circuit/library/arithmetic/weighted_adder.py	10	11	90.91%
qiskit/circuit/library/arithmetic/piecewise_chebyshev.py	41	43	95.35%
qiskit/synthesis/arithmetic/comparators/compare_2s.py	42	45	93.33%
qiskit/synthesis/arithmetic/weighted_sum.py	70	75	93.33%
qiskit/circuit/library/arithmetic/linear_amplitude_function.py	43	49	87.76%
qiskit/transpiler/passes/synthesis/hls_plugins.py	20	26	76.92%
qiskit/circuit/library/arithmetic/exact_reciprocal.py	18	26	69.23%
qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py	50	58	86.21%
qiskit/circuit/library/arithmetic/quadratic_form.py	59	70	84.29%

Files with Coverage Reduction	New Missed Lines	%
crates/accelerate/src/basis/basis_translator/basis_search.rs	1	99.31%
crates/qasm2/src/expr.rs	1	94.23%
qiskit/circuit/add_control.py	1	97.78%
qiskit/circuit/controlflow/switch_case.py	1	95.35%
qiskit/circuit/library/arithmetic/exact_reciprocal.py	1	60.98%
qiskit/circuit/library/standard_gates/r.py	1	97.62%
qiskit/circuit/library/standard_gates/rxx.py	1	97.78%
qiskit/circuit/library/standard_gates/rzx.py	1	97.78%
qiskit/circuit/library/standard_gates/u2.py	1	96.88%
qiskit/circuit/random/utils.py	1	94.87%

Totals
Change from base Build 13268699272:	-0.4%
Covered Lines:	77530
Relevant Lines:	88230

💛 - Coveralls

Cryoris · 2025-02-13T14:13:21Z

Is there a plan to add deprecation warnings in the related non-gates classes?

We cannot deprecate them yet as the alternative has not been available for 1 release. I'd suggest we handle it like the PhaseOracle and add deprecation warnings for 2.1 with removal for 3.0.

ShellyGarion

minor misprints

qiskit/synthesis/arithmetic/comparators/compare_2s.py

qiskit/synthesis/arithmetic/comparators/compare_greedy.py

ShellyGarion · 2025-02-13T14:15:27Z

You should also add release notes. Could you explain there why gates are better than quantum circuits?

ShellyGarion

looks good. I have some comments on the docs.
Also - are there test for exact reciprocal gate? linear pauli rotation gate?
piecewise polynomial pauli rotation gate? polynomial pauli rotation gate

ShellyGarion · 2025-02-24T10:45:50Z

releasenotes/notes/unary-arithmetic-7db455017e1faa45.yaml

+      * :class:`.IntegerComparatorGate` (replacing :class:`.IntegerComparator`)
+      * :class:`.LinearPauliRotationsGate` (replacing :class:`.LinearPauliRotations`)
+      * :class:`.PiecewiseLinearPauliRotationsGate` (replacing :class:`.PiecewiseLinearPauliRotations`)
+      * :class:`.PiecewiseChebychevGate` (replacing :class:`.PiecewiseChebychev`)


there is a misprint here. should be "PiecewiseChebyshev" and not "PiecewiseChebychev"

ShellyGarion · 2025-02-24T10:46:07Z

qiskit/circuit/library/arithmetic/piecewise_chebyshev.py

+        self.breakpoints = breakpoints if breakpoints is not None else [0]
+
+        num_compare = 0 if breakpoints is None else int(len(breakpoints) > 1)
+        super().__init__("PiecewiseChebychev", num_state_qubits + num_compare + 1, [], label)


there is a misprint here. should be "PiecewiseChebyshev" and not "PiecewiseChebychev"

ShellyGarion · 2025-02-24T10:51:14Z

qiskit/circuit/library/__init__.py

@@ -259,6 +259,7 @@
   :template: autosummary/class_no_inherited_members.rst

   LinearAmplitudeFunction
+   LinearAmplitudeFunctionGate


the class "FunctionalPauliRotations" should not be a gate? it's just a base class?

Yes, the methods it provided are not really necessary anymore now that the objects are not BlueprintCircuits anymore, so it doesn't need a new equivalent 🙂

ShellyGarion · 2025-02-24T10:58:17Z

qiskit/circuit/library/arithmetic/exact_reciprocal.py

+                positive.  For the negative case it is assumed that the remaining string represents
+                :math:`1 - x`. This is because :math:`e^{-2 \pi i x} = e^{2 \pi i (1 - x)}` for
+                :math:`x \in [0,1)`.
+            name: The name of the object.


here it should be label and not name

ShellyGarion · 2025-02-24T11:01:21Z

releasenotes/notes/unary-arithmetic-7db455017e1faa45.yaml

@@ -0,0 +1,17 @@
+---
+features_circuits:


you should also mention here the synthesis functions (Unary Arithmetic Synthesis) and the HLS plugins (Integer comparators, Sums).

ShellyGarion · 2025-02-24T11:02:50Z

qiskit/synthesis/__init__.py

+
+.. autofunction:: synth_integer_comparator_2s
+.. autofunction:: synth_integer_comparator_greedy
+


the function synth_weighted_sum_carry does not appear in the docs?

It should be there, see L157 🙂

Another comment: it seems that the names of these functions do not comply with the naming convention in the synthesis library, which usually include the authors' initials and the year. what do you think?
(this convention is usually useful if there are several synthesis methods of the same object).

ShellyGarion · 2025-02-24T11:07:06Z

qiskit/transpiler/passes/synthesis/hls_plugins.py

+      - Description
+      - Auxiliary qubits
+    * - ``"default"``
+      - :class:`~.WeightedSumSynthesisDefault`


the link does not work

Good catch, this is missing in the toctree, I'll add it 👍🏻

ShellyGarion · 2025-02-24T11:14:01Z

test/python/circuit/library/test_functional_pauli_rotations.py

 from qiskit.circuit import QuantumCircuit
 from qiskit.circuit.library import (
    LinearPauliRotations,
    PolynomialPauliRotations,
    PiecewiseLinearPauliRotations,
+    PiecewiseLinearPauliRotationsGate,


should there be a test for LinearPauliRotationsGate ? PolynomialPauliRotations ?

Yeah that'd be good, we can extend the tests for the PiecewiseLinearPauliRotationGate to also check others.

Cryoris added 6 commits October 24, 2024 13:28

integer comparator & exact reciprocal

80b30f1

quadratic form

bf8c69b

no support for parameter expressions for now

no aux integer comparator & linear paulis

c787d7a

almost do LinAmpFunction

3d99f29

some tests miss, some HLS tests fail (maybe Sasha's PR fixes this)

start of the end

d3dd1da

PwChebychev

8187998

Cryoris added this to the 2.0.0 milestone Oct 25, 2024

ShellyGarion mentioned this pull request Nov 11, 2024

Circuit library modernization #13046

Closed

1ucian0 assigned Cryoris Feb 4, 2025

Cryoris added 2 commits February 11, 2025 16:05

Merge branch 'main' into clib/unaryarithmetic

e67ef50

fix tests

0ca6b4f

Cryoris marked this pull request as ready for review February 11, 2025 17:43

Cryoris requested a review from a team as a code owner February 11, 2025 17:43

Cryoris added 3 commits February 11, 2025 18:44

Merge branch 'main' into clib/unaryarithmetic

a90b61d

test & lint

00867cb

fix missing alt text

da46518

ShellyGarion reviewed Feb 12, 2025

View reviewed changes

Cryoris added 2 commits February 13, 2025 15:08

review comments

a4d4dfe

A label for the gate

37ec8a7

ShellyGarion reviewed Feb 13, 2025

View reviewed changes

qiskit/synthesis/arithmetic/comparators/compare_2s.py Show resolved Hide resolved

qiskit/synthesis/arithmetic/comparators/compare_greedy.py Outdated Show resolved Hide resolved

ShellyGarion self-assigned this Feb 13, 2025

1ucian0 mentioned this pull request Feb 20, 2025

Move PendingDeprecations to Deprecations in the circuit library #13604

Open

Cryoris added 2 commits February 20, 2025 16:32

fix typos, add reno

b13ed72

review comments and WeightedAdder

d195ea5

ShellyGarion reviewed Feb 24, 2025

View reviewed changes

review comments

9ac8355

finalize tests

460c6d5

ShellyGarion approved these changes Feb 26, 2025

View reviewed changes

ShellyGarion added this pull request to the merge queue Feb 26, 2025

Merged via the queue into Qiskit:main with commit 0e824cc Feb 26, 2025
19 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Single-register arithmetic gates #13371

Single-register arithmetic gates #13371

Cryoris commented Oct 25, 2024

qiskit-bot commented Feb 11, 2025

ShellyGarion left a comment

coveralls commented Feb 13, 2025 •

edited

Loading

Cryoris commented Feb 13, 2025

ShellyGarion left a comment

ShellyGarion commented Feb 13, 2025

ShellyGarion left a comment

ShellyGarion Feb 24, 2025

ShellyGarion Feb 24, 2025

ShellyGarion Feb 24, 2025

Cryoris Feb 24, 2025

ShellyGarion Feb 24, 2025

ShellyGarion Feb 24, 2025

ShellyGarion Feb 24, 2025

Cryoris Feb 24, 2025

ShellyGarion Feb 24, 2025 •

edited

Loading

ShellyGarion Feb 24, 2025

Cryoris Feb 24, 2025

ShellyGarion Feb 24, 2025

Cryoris Feb 24, 2025


		.. autofunction:: synth_integer_comparator_2s
		.. autofunction:: synth_integer_comparator_greedy

		@@ -0,0 +1,17 @@
		---
		features_circuits:

Single-register arithmetic gates #13371

Single-register arithmetic gates #13371

Conversation

Cryoris commented Oct 25, 2024

Summary

Details and comments

qiskit-bot commented Feb 11, 2025

ShellyGarion left a comment

Choose a reason for hiding this comment

coveralls commented Feb 13, 2025 • edited Loading

Pull Request Test Coverage Report for Build 13541552394

Warning: This coverage report may be inaccurate.

Details

💛 - Coveralls

Cryoris commented Feb 13, 2025

ShellyGarion left a comment

Choose a reason for hiding this comment

ShellyGarion commented Feb 13, 2025

ShellyGarion left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ShellyGarion Feb 24, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

coveralls commented Feb 13, 2025 •

edited

Loading

ShellyGarion Feb 24, 2025 •

edited

Loading