Skip to content
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

📝 Add documentation for DD package #831

Open
wants to merge 11 commits into
base: main
Choose a base branch
from
Open

Conversation

burgholzer
Copy link
Member

@burgholzer burgholzer commented Feb 17, 2025

Description

This pull request includes extensive documentation updates for the DD package C++ module of MQT Core.

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 (092f88a) to head (4208b2a).
Report is 3 commits behind head on main.

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%   -0.1%     
=======================================
  Files        127     127             
  Lines      13509   13544     +35     
  Branches    2080    2085      +5     
=======================================
+ Hits       12476   12506     +30     
- Misses      1033    1038      +5     
Flag Coverage Δ
cpp 92.0% <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.3% <100.0%> (-0.4%) ⬇️
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.4% <100.0%> (ø)
... and 1 more

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
Status: In Progress
Status: In Progress
Development

Successfully merging this pull request may close these issues.

📝 Add documentation for DD package
1 participant