✨ OpenQASM 3.0 support #309

martin-fink · 2023-05-17T12:20:46Z

This PR replaces the existing OpenQASM 2.0 parser with a new OpenQASM 3.0 parser.

The new parser now builds a syntax tree, where type checking, constant evaluation, and translation to the Quantum circuit.

The parser can handle the following new features:

New Syntax

New syntax for declaring bits, qubit, measure operations. The old syntax (creg, qreg) is still supported.

qubit[8] q;
bit[8] c;

c[0] = measure q[0];
measure q[1] -> c[1];

if (c[0] == 1) {
  x q[0];
}

Gate modifiers

Gate modifiers (inv, ctrl, and negctrl) are now supported. This replaces the c prefix.
See the OpenQASM 3.0 specification for more information: https://openqasm.com/language/gates.html#quantum-gate-modifiers

ctrl @ x q[0], q[1]; // Equivalent to cx q
ctrl(2) @ x q[0], q[1], q[2]; // Equivalent to ccx q;

Classical constant values

The parser now supports classical computation with constant values. This can be used to e.g. define the number of quantum registers.

const uint N = 4;
qubit[N * 2];
x qubit[N * 2 - 1];

Additionally, all features of the previous parser are still supported.

The big features from OpenQASM 3.0 still missing are:

classical computational features such as loops, functions, etc. (see Support for OpenQASM 3.0 looping and branching #33)
types such as bools, floats, angles, complex types, etc. (see Support for OpenQASM 3.0 additional datatypes #30, Support for casting of OpenQASM 3.0 types #32)
pow modifier (Support for the powering modifier of OpenQASM 3.0 #27)

burgholzer

Just some very early comments on the early draft.
It would be great to separate the generation of the parser from the actual library. Ideally the underlying grammar hardly changes and the Lexer and syntax tree construction remains rather constant.
As such, the parser generation should probably be hidden behind a CMake option (just as we hide the tests behind some CMake option).

The generation itself only needs to work on one particular system (probably Ubuntu, because it's easiest and the fastest).
It would be nice to have a separate CI check that can be used for checking whether everything still works. Maybe there even is some GitHub action for properly setting up ANTLr. Wouldn't be surprised. That CI check should probably also only run on changes to the respective files.

Of course, the generated parser should work under all systems. Maybe this setup becomes obsolete if we were to adopt QIR and the corresponding OQ3 parser. We'll have to see.

src/QuantumComputation.cpp

src/parsers/qasm3_parser/cmake/FindANTLR.cmake

martin-fink · 2023-08-02T18:46:31Z

There remains some refactoring and cleanup to do; currently, stdgates.inc is parsed from a string every time it is included.
Additionally, computing the inverse and controls is done on the parser level and will be moved to the QuantumComputation level.

burgholzer · 2023-08-07T13:11:00Z

Really just a comment since I briefly looked at the PR: I think we don't really need the explicit UTF-8 support via an external library. std::string should be just fine for our purposes.

Another comment: try to factor out as much functionality as possible from the parser and try to put it into the Core library. Most importantly the modifiers. These can all happen in their own PR. Then this PR can be rebased and use the newly created functions 🙂

This now also allows including `qelib1.inc`, which will print a warning.

burgholzer

Hey 👋🏼

I know you are still working on this, but I just had some time to kill at the airport and thought I'd give you some feedback. You should be able to use GitHub's batch commit feature (go to files changed and then add suggestions to commit batch) to resolve most of the suggestions/comments. Hope all of that makes sense.

README.md

docs/index.md

include/QuantumComputation.hpp

include/operations/ClassicControlledOperation.hpp

include/parsers/qasm3_parser/Parser.hpp

src/operations/NonUnitaryOperation.cpp

src/operations/StandardOperation.cpp

src/operations/SymbolicOperation.cpp

src/parsers/qasm3_parser/Scanner.cpp

test/unittests/test_qfr_functionality.cpp

Co-authored-by: Lukas Burgholzer <[email protected]>

burgholzer · 2023-12-11T17:34:21Z

From my side I'm happy -- I will address the CodeQL warnings though. Regarding your questions which issues will be closed

Support for OpenQASM 3.0 classical bits and registers #29 yes

Support for OpenQASM 3.0 constant values #31 yes

Support for OpenQASM 3.0 additional datatypes #30 partly there (type checker, constant eval is there for float, bool; not for angles, time)

Support for casting of OpenQASM 3.0 types #32 no

Support for OpenQASM 3.0 looping and branching #33 no

Support for the powering modifier of OpenQASM 3.0 #27 no

Great, many thanks. Updated the list of linked issues accordingly.
I also took the liberty of adjusting the title from WIP to a proper title and update with the latest changes from main.
As a last step before merging: Could you please update the PR description so that it is a little more complete and elaborative on what is actually available now (and maybe also that the OQ2 parser is completely replaced by the new parser).
Afterwards, you can request a (final) review and I should be able to merge 🎉

martin-fink · 2023-12-11T20:44:28Z

I've updated the description. Thanks!

src/parsers/QASM3Parser.cpp

include/parsers/qasm3_parser/StdGates.hpp

burgholzer

I now also briefly looked over the parser code itself and it is looking good ✨

I just left one last comment where I would like to get your opinion on a couple of things. Those things need not necessarily happen as part of this PR if they turn out to be to complicated.

burgholzer · 2023-12-12T11:02:35Z

And I seem to have screwed up one of the tests with one of the changes above. Could you maybe fix that? 😅

If the parser detects an `OpenQASM 2.0` version declaration, `c` prefixes are treated as control modifiers. This allows parsing the following gate: ```qasm cccc x q[0], q[1], q[2], q[3], q[4]; // equivalent to ctrl(4) @ x q[0], q[1], q[2], q[3], q[4]; ```

…tPermutation

…de`.

The corresponding member was hardly maintained and even less frequently used. Might as well not bother keeping it.

…ason for not assuming these are supported natively in either of the two standards.

codecov · 2023-12-13T18:18:26Z

Codecov Report

Merging #309 (eb7a097) into main (d181d45) will increase coverage by 0.3%.
The diff coverage is 89.5%.

Additional details and impacted files

@@           Coverage Diff           @@
##            main    #309     +/-   ##
=======================================
+ Coverage   90.4%   90.8%   +0.3%     
=======================================
  Files        114     127     +13     
  Lines      12033   13850   +1817     
  Branches    2058    2176    +118     
=======================================
+ Hits       10889   12583   +1694     
- Misses      1144    1267    +123

Flag	Coverage Δ
cpp	`90.5% <89.5%> (+0.4%)`	⬆️
python	`99.7% <ø> (ø)`

Files	Coverage Δ
include/Definitions.hpp	`86.6% <ø> (ø)`
include/QuantumComputation.hpp	`91.0% <100.0%> (+0.1%)`	⬆️
include/operations/ClassicControlledOperation.hpp	`96.8% <100.0%> (+8.9%)`	⬆️
include/operations/CompoundOperation.hpp	`93.2% <100.0%> (ø)`
include/operations/NonUnitaryOperation.hpp	`91.6% <ø> (ø)`
include/operations/Operation.hpp	`95.9% <ø> (ø)`
include/operations/StandardOperation.hpp	`100.0% <ø> (ø)`
include/operations/SymbolicOperation.hpp	`100.0% <ø> (ø)`
include/parsers/qasm3_parser/Gate.hpp	`100.0% <100.0%> (ø)`
include/parsers/qasm3_parser/NestedEnvironment.hpp	`100.0% <100.0%> (ø)`
... and 25 more

... and 2 files with indirect coverage changes

burgholzer

Many many thanks again for this nice contribution! Great to see OpenQASM 3 support within the MQT finally happening 🎉
Looking forward to some future additions to enhance the support even further.

burgholzer reviewed May 17, 2023

View reviewed changes

src/QuantumComputation.cpp Outdated Show resolved Hide resolved

src/parsers/qasm3_parser/cmake/FindANTLR.cmake Outdated Show resolved Hide resolved

burgholzer added this to the OpenQASM 3.0 Support milestone Jun 15, 2023

burgholzer added feature New feature or request Core Anything related to the Core library and IR labels Jun 15, 2023

martin-fink force-pushed the main branch 2 times, most recently from c8df7d1 to ded8393 Compare August 2, 2023 18:42

martin-fink mentioned this pull request Sep 2, 2023

Add addControl, clearControls, removeControl functions on Operation #411

Merged

4 tasks

martin-fink force-pushed the main branch from 6b60ef5 to 2b5cb2f Compare September 2, 2023 13:09

Add OpenQASM 3.0 parser

ef86fb2

martin-fink force-pushed the main branch from e02cc64 to ef86fb2 Compare October 24, 2023 17:50

pre-commit-ci bot and others added 14 commits October 24, 2023 17:52

🎨 pre-commit fixes

0ecaffb

cleanup code

bcec8e2

Rename constructor params to fix shadowing warnings

58fdfde

Update code

d7c6335

Add unit tests

66b04ac

🎨 pre-commit fixes

0e3c435

Merge remote-tracking branch 'upstream/main'

c5cf9de

Add support for if statements

25b57fd

Implicitly include stdgates.inc

bc4bf8d

This now also allows including `qelib1.inc`, which will print a warning.

Add dumpOpenQASM3

e3baeb7

Add support for teleport/opaque gates

62c1092

Warn user if old-style designator is encountered.

f346500

Merge remote-tracking branch 'upstream/main'

d4ffa56

🎨 pre-commit fixes

b93e8f5

burgholzer requested changes Nov 18, 2023

View reviewed changes

martin-fink and others added 3 commits November 25, 2023 15:26

Apply suggestions from code review

b7ebfcb

Co-authored-by: Lukas Burgholzer <[email protected]>

🎨 pre-commit fixes

52be091

Return false in CompoundOperation::isControlled

4c37b9b

burgholzer changed the title ~~[WIP] OpenQASM 3.0 support~~ ✨ OpenQASM 3.0 support Dec 11, 2023

Merge branch 'main' into main

18d6074

burgholzer marked this pull request as ready for review December 11, 2023 17:30

burgholzer added the minor Minor version update label Dec 11, 2023

martin-fink requested a review from burgholzer December 11, 2023 20:44

burgholzer reviewed Dec 12, 2023

View reviewed changes

src/parsers/QASM3Parser.cpp Outdated Show resolved Hide resolved

burgholzer reviewed Dec 12, 2023

View reviewed changes

src/parsers/QASM3Parser.cpp Outdated Show resolved Hide resolved

burgholzer reviewed Dec 12, 2023

View reviewed changes

include/parsers/qasm3_parser/StdGates.hpp Show resolved Hide resolved

burgholzer and others added 3 commits December 12, 2023 11:51

Update src/parsers/QASM3Parser.cpp

a57666a

Update src/parsers/QASM3Parser.cpp

4cf0eb7

🎨 pre-commit fixes

f6d4eea

burgholzer approved these changes Dec 12, 2023

View reviewed changes

martin-fink and others added 12 commits December 13, 2023 11:01

Update failing test

9cd5d35

Use natively supported gates instead of parsing stdgates.inc

fb5c507

Ignore redeclaration of standard gates

7c486ca

In OpenQASM 2.0 compat mode, ignore gate redefinitions with c prefixes

3300ede

Remove Comment token, add separate tokens for InitialLayout and Outpu…

a7897d5

…tPermutation

🚨 fix a couple of clang-tidy warnings

22ca99c

Merge branch 'main' into oq3

4d0973f

♻️ also allow mcx_* and mcphase definitions in `openQASM2CompatMo…

c0217f6

…de`.

🔥 remove maxControls

386cb14

The corresponding member was hardly maintained and even less frequently used. Might as well not bother keeping it.

♻️ move QASM2_COMPAT_GATES to STANDARD_GATES. There is no real re…

29734f3

…ason for not assuming these are supported natively in either of the two standards.

✏️ adjust std gates documentation

eb7a097

burgholzer approved these changes Dec 13, 2023

View reviewed changes

burgholzer merged commit e193ddb into cda-tum:main Dec 13, 2023
34 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

✨ OpenQASM 3.0 support #309

✨ OpenQASM 3.0 support #309

martin-fink commented May 17, 2023 •

edited

Loading

burgholzer left a comment

martin-fink commented Aug 2, 2023

burgholzer commented Aug 7, 2023

burgholzer left a comment

burgholzer commented Dec 11, 2023

martin-fink commented Dec 11, 2023

burgholzer left a comment

burgholzer commented Dec 12, 2023

codecov bot commented Dec 13, 2023

burgholzer left a comment

✨ OpenQASM 3.0 support #309

✨ OpenQASM 3.0 support #309

Conversation

martin-fink commented May 17, 2023 • edited Loading

New Syntax

Gate modifiers

Classical constant values

burgholzer left a comment

Choose a reason for hiding this comment

martin-fink commented Aug 2, 2023

burgholzer commented Aug 7, 2023

burgholzer left a comment

Choose a reason for hiding this comment

burgholzer commented Dec 11, 2023

martin-fink commented Dec 11, 2023

burgholzer left a comment

Choose a reason for hiding this comment

burgholzer commented Dec 12, 2023

codecov bot commented Dec 13, 2023

Codecov Report

burgholzer left a comment

Choose a reason for hiding this comment

martin-fink commented May 17, 2023 •

edited

Loading