Skip to content

Conversation

@m-fila
Copy link
Member

@m-fila m-fila commented May 26, 2025

This is a breaking change

The algorithm keyword argument will be mandatory in jet_reconstruct, which effectively removes calling jet_reconstruct with power. The power will be still a keyword argument:

  • required for generalized algorithms (GenKt and EEKt)
  • ignore by other algorithms (appropriate power will be assigned internally instead of using the value from argument)

This allows to simplify the logic a bit and also will be easier to support in C-bindings #88
A few internal functions are removed. The internal algorithm2power dictionary now maps both pp and ee algorithms to their power, dictionary going in opposite direction is removed

Internal algorithms (_plain_jet_reconstruct etc) assume that algorithm and p given to them is consistent and won't check it or resolve again

Closes #129

@m-fila m-fila requested a review from graeme-a-stewart May 26, 2025 07:03
@m-fila m-fila added the interface change Breaking changes to any public interfaces label May 26, 2025
@m-fila m-fila force-pushed the mandatory_alg_arg branch from 7ec250c to 5601e08 Compare May 26, 2025 07:09
@m-fila
Copy link
Member Author

m-fila commented May 26, 2025

CI fails to setup the Julia actions

Warning: Failed to download action 'https://api.github.com/repos/julia-actions/setup-julia/tarball/5c9647d97b78a5debe5164e9eec09d653d29bd71'. Error: Response status code does not indicate success: 504 (Gateway Timeout). 
Warning: Back off 20.944 seconds before retry.
Error: Response status code does not indicate success: 504 (Gateway Timeout).

I think it's something with GitHub as I can download the links they can't without issues

OK looks like it was temporary outage

@codecov
Copy link

codecov bot commented May 26, 2025

Codecov Report

Attention: Patch coverage is 94.11765% with 1 line in your changes missing coverage. Please review.

Project coverage is 74.96%. Comparing base (8a91752) to head (968c983).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
src/GenericAlgo.jl 66.66% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #161      +/-   ##
==========================================
- Coverage   75.23%   74.96%   -0.28%     
==========================================
  Files          20       20              
  Lines        1284     1270      -14     
==========================================
- Hits          966      952      -14     
  Misses        318      318              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Member

@graeme-a-stewart graeme-a-stewart left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for doing this @m-fila! It looks very complete to me, just a few minor issues to clean up in the README.md.

@graeme-a-stewart graeme-a-stewart added this to the 1.0.0 Release milestone Jun 16, 2025
@graeme-a-stewart graeme-a-stewart added the documentation Improvements or additions to documentation label Jun 16, 2025
Copy link
Member

@graeme-a-stewart graeme-a-stewart left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is GTG now!

@graeme-a-stewart graeme-a-stewart merged commit 28a3e0d into JuliaHEP:main Jun 16, 2025
12 checks passed
@m-fila m-fila deleted the mandatory_alg_arg branch June 16, 2025 13:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation interface change Breaking changes to any public interfaces

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Deprecate calling jet_reconstruct with only a power

3 participants