🚸 better results reporting

[burgholzer]

Description

This long-overdue PR adds better results reporting to QCEC. Previously, any call to a verify* function would just return a Results object that truly only contained results (equivalence, runtime, CEX). On the other hand, the EquivalenceCheckingManager stores way more information that could be interesting to users, such as metrics about the circuits, the configuration that was used for the equivalence check, and the results of the individual checkers. This PR makes all that information part of the Results class and, thus, exposes it to users. This is purely additional to the existing results.

Fixes #147

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

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 96.3%. Comparing base (f5e3526) to head (e721136).

Additional details and impacted files

[](https://app.codecov.io/gh/cda-tum/mqt-qcec/pull/387?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 #387 +/- ## ===================================== Coverage 96.3% 96.3% ===================================== Files 35 35 Lines 1760 1761 +1 Branches 220 219 -1 ===================================== + Hits 1696 1697 +1 Misses 64 64 ``` | [Flag](https://app.codecov.io/gh/cda-tum/mqt-qcec/pull/387/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-qcec/pull/387/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=cda-tum) | `96.1% <100.0%> (+<0.1%)` | :arrow_up: | | [python](https://app.codecov.io/gh/cda-tum/mqt-qcec/pull/387/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=cda-tum) | `97.2% <ø> (ø)` | | | [Files](https://app.codecov.io/gh/cda-tum/mqt-qcec/pull/387?dropdown=coverage&src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=cda-tum) | Coverage Δ | | |---|---|---| | [include/EquivalenceCheckingManager.hpp](https://app.codecov.io/gh/cda-tum/mqt-qcec/pull/387?src=pr&el=tree&filepath=include%2FEquivalenceCheckingManager.hpp&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=cda-tum#diff-aW5jbHVkZS9FcXVpdmFsZW5jZUNoZWNraW5nTWFuYWdlci5ocHA=) | `100.0% <100.0%> (ø)` | | | [src/EquivalenceCheckingManager.cpp](https://app.codecov.io/gh/cda-tum/mqt-qcec/pull/387?src=pr&el=tree&filepath=src%2FEquivalenceCheckingManager.cpp&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=cda-tum#diff-c3JjL0VxdWl2YWxlbmNlQ2hlY2tpbmdNYW5hZ2VyLmNwcA==) | `92.7% <100.0%> (+0.1%)` | :arrow_up: | ... and [2 files with indirect coverage changes](https://app.codecov.io/gh/cda-tum/mqt-qcec/pull/387/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=cda-tum)