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

Improve macronode reduction function #49

Closed
wants to merge 14 commits into from
Closed

Conversation

ilan-tz
Copy link
Collaborator

@ilan-tz ilan-tz commented May 19, 2022

Context for changes

< Describe your changes. Make sure to include a summarized description of the changes and fixed issues in the format below consistent with CHANGELOG.md. You cannot place N/A here. >

  • New features:
    • < text goes here >
    • < text goes here >
  • Bug fixes:
    • < text goes here >
    • < text goes here >
  • Improvements:
    • < text goes here >
    • < text goes here >
  • Documentation changes:
    • < text goes here >
    • < text goes here >

Example usage and tests

< Add some example usage and tests showing how to utilize new features and fixes; otherwise, mark N/A below. >

  • Not Applicable

Performance results justifying changes

< If you have improved a feature you should support it with some benchmarking and scaling results, plots, etc.; otherwise, mark N/A below. >

  • Not Applicable

Workflow actions and tests

< In most cases, we need a set of unit tests that automatically and comprehensively test for newly added features. Discuss existing CI tests that cover the changes or any updates to the workflow here; otherwise, mark N/A below. >

  • Not Applicable

Expected benefits and drawbacks

< Summarize your justifications for the change and its benefits. Is there any drawback that exists today with the changes or may occur in the future? You cannot place N/A here. >

Expected benefits:

  • < text goes here >

Possible drawbacks:

  • < text goes here >

Related Github issues

< Explicitly, link any corresponding issue and update the status of the relevant GitHub issue here; otherwise, mark N/A below. >

  • Not Applicable

Checklist and integration statements

  • My Python and C++ codes follow the coding and commenting styles of this project as indicated by existing files. Specifically, the changes conform to given black, docformatter and pylint configurations.
  • I have performed a self-review of these changes, checked my code (including for codefactor compliance), and corrected misspellings to the best of my capacity. I have synced this branch with others as required.
  • I have added context for corresponding changes in documentation and README.md as needed.
  • I have added new workflow CI tests for corresponding changes, ensuring codecoverage 95% or better, and these pass locally for me.
  • I have updated CHANGELOG.md following the template. I recognize that the developers may revisit CHANGELOG.md and the versioning, and create a Special Release including my changes.

@codecov
Copy link

codecov bot commented May 19, 2022

Codecov Report

Merging #49 (5a74c7c) into main (d9c3c00) will decrease coverage by 0.02%.
The diff coverage is 98.29%.

❗ Current head 5a74c7c differs from pull request most recent head 831117b. Consider uploading reports for the commit 831117b to get more accurate results

@@            Coverage Diff             @@
##             main      #49      +/-   ##
==========================================
- Coverage   96.32%   96.30%   -0.03%     
==========================================
  Files          35       35              
  Lines        2123     2137      +14     
==========================================
+ Hits         2045     2058      +13     
- Misses         78       79       +1     
Impacted Files Coverage Δ
flamingpy/cv/macro_reduce.py 95.39% <98.11%> (-0.26%) ⬇️
flamingpy/examples/macro_reduce.py 96.87% <100.00%> (ø)
flamingpy/simulations.py 95.65% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d9c3c00...831117b. Read the comment docs.

Fold macronode reduction functions into their own class
Also move splitter_symp and invert_permutation to cv.ops
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant