🐛 Fix of duplicate qubit label generation during synthesis #327
+3,895
−110
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…optional creation of inline stack so that release builds can skip this potentially unneeded step in the synthesis process
…bly causes by std::unique_ptr default holder type created via python bindings
…be set when adding qubits for variables when 'feature' is not activated in synthesis settings.
…label in circuit view
…rovide information how information can be queried in GUI
…inal qubit label GUI elements are disabled if the value of the label is empty.
…e information widget
…bits when set cannot be a nullptr or empty since the inline stack should contain at least one entry (i.e. the main module of a SyReC program).
…ne qubit information
…of identifier of module and any of its parameters or local variables
…e hard-coded redundant definitions of qubit label prefix with a single unified "source of truth"
…terOrVariable() of syrec::Module.
…nto syrec::InternalQubitLabelBuilder
…ine information when said feature is activated in synthesis settings
…its generated during synthesis of module synthesis shared same inline stack instance instead of the latter creating a new copy on every call. Added tests for qubit inline information for N-dimensional variables.
…dability of test code
… synthesis algorithms if qubit inline information should not be recorded
…on in annotatable quantum computation
…that the qubit is clickable in the CircuitView and selectable in the qubit label combobox of the qubit inline information widget
Codecov Report❌ Patch coverage is 📢 Thoughts on this report? Let us know! |
…in synthesis base implementation
…t inlining stack as well as missing tests for the latter
burgholzer
approved these changes
Aug 7, 2025
src/CMakeLists.txt
Outdated
Comment on lines
31
to
40
| if(NOT TARGET ${MQT_SYREC_TARGET_NAME}-antlr-parser OR NOT TARGET | ||
| ${MQT_SYREC_PARSER_TARGET_NAME}-synthesis) | ||
| add_library(${MQT_SYREC_TARGET_NAME}-utils INTERFACE) | ||
| target_include_directories( | ||
| ${MQT_SYREC_TARGET_NAME}-utils | ||
| INTERFACE ${MQT_SYREC_INCLUDE_BUILD_DIR}/algorithms/synthesis/internal_qubit_label_builder.hpp) | ||
| target_link_libraries(${MQT_SYREC_TARGET_NAME}-utils INTERFACE MQT::ProjectWarnings | ||
| MQT::ProjectOptions) | ||
| add_library(MQT::SyReC-Utils ALIAS ${MQT_SYREC_TARGET_NAME}-utils) | ||
| endif() |
There was a problem hiding this comment.
I am personally not the biggest fan of utils libraries as they tend to become a hot mess of unrelated functions.
This clearly belongs to the synthesis part of the syrec library. Why not add it to one of the existing targets?
There was a problem hiding this comment.
A separate utility library might be overkill, now the header file of the library is only included in the synthesis as well as antlr-parser library, it is included in the latter to prevent having to link the synthesis library for a single header file, with the utilities library being removed from all other targets. @burgholzer Are these changes sufficient to resolve your comment?
…ng only a single header file
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR introduces the following changes in both the C++ as well as the python library.
C++:
syrec::AnnotatableQuantumComputation.syrec::Propertiespassed to the synthesis algorithms) generated and stored in thesyrec::AnnotatableQuantumComputation(queriable viasyrec::AnnotatableQuantumComputation::getInliningInformationOfQubit(...)), to provide debug information about the origin of the qubit to the user. This feature needs to be explicitly activated with the qubit label combination generation of the previous bullet point not being effected by this feature.syrec::QubitInlineStack,syrec::QubitInliningStack::QubitInliningStackEntryandsyrec::AnnotatableQuantumComputation::InlinedQubitInformationwere added.MAIN_MODULE_IDENTIFIER_CONFIG_KEYandGENERATE_INLINE_DEBUG_INFORMATION_CONFIG_KEYin\include\algorithms\syrec_synthesis.hppto improve the activation of synthesis features insyrec::Propertiesinstead of relying on hard-coded strings in the source files.Python:
.pyifiles are used to document the python package, as is the case in themqt-coreproject.The displayed qubit inline information when the feature is deactivated/activated is the following:
Inline information about a qubit can be selected in the
syrec-editorby:Fixes #278
Checklist: