Skip to content

📝 Add documentation for DD package #831

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 20 commits into from
Feb 25, 2025
Merged

📝 Add documentation for DD package #831

merged 20 commits into from
Feb 25, 2025

Conversation

burgholzer
Copy link
Member

@burgholzer burgholzer commented Feb 17, 2025

Description

This pull request includes extensive documentation updates for the DD Package of MQT Core.

It also adds two new convenience methods for statevector simulation and unitary construction to the mqt.core.dd Python module.

Fixes #814

Checklist:

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

@burgholzer burgholzer self-assigned this Feb 17, 2025
@burgholzer burgholzer added documentation Improvements or additions to documentation DD Anything related to the DD package c++ Anything related to C++ code labels Feb 17, 2025
@burgholzer burgholzer added this to the DD Package Improvements milestone Feb 17, 2025
Copy link

codecov bot commented Feb 17, 2025

Codecov Report

Attention: Patch coverage is 95.45455% with 3 lines in your changes missing coverage. Please review.

Project coverage is 92.3%. Comparing base (47730e7) to head (7d61947).

Files with missing lines Patch % Lines
src/dd/FunctionalityConstruction.cpp 82.3% 3 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@          Coverage Diff          @@
##            main    #831   +/-   ##
=====================================
  Coverage   92.3%   92.3%           
=====================================
  Files        127     127           
  Lines      13520   13555   +35     
  Branches    2081    2086    +5     
=====================================
+ Hits       12487   12522   +35     
  Misses      1033    1033           
Flag Coverage Δ
cpp 92.1% <95.4%> (+<0.1%) ⬆️
python 99.7% <ø> (ø)
Files with missing lines Coverage Δ
include/mqt-core/dd/CachedEdge.hpp 84.2% <ø> (ø)
include/mqt-core/dd/Complex.hpp 100.0% <ø> (ø)
include/mqt-core/dd/ComplexValue.hpp 87.5% <ø> (ø)
include/mqt-core/dd/ComputeTable.hpp 100.0% <100.0%> (ø)
include/mqt-core/dd/Edge.hpp 94.1% <ø> (ø)
include/mqt-core/dd/Operations.hpp 75.5% <100.0%> (ø)
include/mqt-core/dd/Package.hpp 96.8% <100.0%> (ø)
include/mqt-core/dd/Simulation.hpp 100.0% <ø> (ø)
include/mqt-core/dd/UnaryComputeTable.hpp 92.0% <100.0%> (-0.6%) ⬇️
src/dd/Simulation.cpp 93.5% <100.0%> (ø)
... and 1 more

garbage collection would otherwise erase all previous statistics from these tables.

Signed-off-by: burgholzer <[email protected]>
Signed-off-by: burgholzer <[email protected]>
@burgholzer burgholzer force-pushed the document-dd-package branch 2 times, most recently from 416ebca to 93eafe4 Compare February 24, 2025 21:46
@burgholzer burgholzer force-pushed the document-dd-package branch 2 times, most recently from 7d61947 to d30169d Compare February 25, 2025 10:56
@burgholzer burgholzer enabled auto-merge February 25, 2025 10:58
@burgholzer burgholzer merged commit fc6bb4b into main Feb 25, 2025
52 of 55 checks passed
@burgholzer burgholzer deleted the document-dd-package branch February 25, 2025 11:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c++ Anything related to C++ code DD Anything related to the DD package documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

📝 Add documentation for DD package
1 participant