Ancillary and garbage support

TooMuchDakka commented 2 months ago

Description

Adds support for ancillary as well as garbage definitions to the .real file parser. Additionally, the default 1-1 output_permutation is update if matching entries in the .input definitions exist for any .output definition (see mqt-core documentation)

Fixes #88

Checklist:

[x] The pull request only contains commits that are related to it.
[x] I have added appropriate tests and documentation.
[x] I have made sure that all CI jobs on GitHub pass.
[x] The pull request introduces no new warnings and follows the project's style guidelines.

codecov[bot] commented 2 months ago

Codecov Report

Attention: Patch coverage is 90.90909% with 33 lines in your changes missing coverage. Please review.

Project coverage is 87.1%. Comparing base (89f18fb) to head (c458531).

Files	Patch %	Lines
src/ir/parsers/RealParser.cpp	90.9%	33 Missing :warning:

Additional details and impacted files

[![Impacted file tree graph](https://app.codecov.io/gh/cda-tum/mqt-core/pull/635/graphs/tree.svg?width=650&height=150&src=pr&token=MqstsRKdqp&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=cda-tum)](https://app.codecov.io/gh/cda-tum/mqt-core/pull/635?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=cda-tum) ```diff @@ Coverage Diff @@ ## main #635 +/- ## ======================================= + Coverage 87.0% 87.1% +0.1% ======================================= Files 125 125 Lines 13781 14100 +319 Branches 2164 2214 +50 ======================================= + Hits 11996 12294 +298 - Misses 1785 1806 +21 ``` | [Flag](https://app.codecov.io/gh/cda-tum/mqt-core/pull/635/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=cda-tum) | Coverage Δ | | |---|---|---| | [cpp](https://app.codecov.io/gh/cda-tum/mqt-core/pull/635/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=cda-tum) | `86.8% <90.9%> (+0.1%)` | :arrow_up: | | [python](https://app.codecov.io/gh/cda-tum/mqt-core/pull/635/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=cda-tum) | `99.7% <ø> (ø)` | | | [Files](https://app.codecov.io/gh/cda-tum/mqt-core/pull/635?dropdown=coverage&src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=cda-tum) | Coverage Δ | | |---|---|---| | [src/ir/parsers/RealParser.cpp](https://app.codecov.io/gh/cda-tum/mqt-core/pull/635?src=pr&el=tree&filepath=src%2Fir%2Fparsers%2FRealParser.cpp&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=cda-tum#diff-c3JjL2lyL3BhcnNlcnMvUmVhbFBhcnNlci5jcHA=) | `87.6% <90.9%> (+16.5%)` | :arrow_up: | ... and [5 files with indirect coverage changes](https://app.codecov.io/gh/cda-tum/mqt-core/pull/635/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=cda-tum)

burgholzer commented 2 months ago

Please make sure to add appropriate tests covering your changes and to resolve all clang-tidy warnings. You can see the clang-tidy warnings in the "Files Changed" tab here on GitHub or here: https://github.com/cda-tum/mqt-core/actions/runs/9686994807?pr=635#summary-26730667014

Tests should probably go into their own new file here: https://github.com/cda-tum/mqt-core/tree/main/test/unittests similar to https://github.com/cda-tum/mqt-core/blob/main/test/unittests/test_qasm3_parser.cpp

cda-tum / mqt-core