memilio icon indicating copy to clipboard operation
memilio copied to clipboard

899 new add gamma distribution and other parameters to state age function 1

Open lenaploetzke opened this issue 10 months ago • 3 comments

Changes and Information

Please briefly list the changes (main added features, changed items, or corrected bugs) made:

  • added the parameters location and scale to StateAgeFunction
  • added three state age functions
  • added tests

If need be, add additional information and what the reviewer should look out for in particular:

Merge Request - Guideline Checklist

Please check our git workflow. Use the draft feature if the Pull Request is not yet ready to review.

Checks by code author

  • [x] Every addressed issue is linked (use the "Closes #ISSUE" keyword below)
  • [x] New code adheres to coding guidelines
  • [x] No large data files have been added (files should in sum not exceed 100 KB, avoid PDFs, Word docs, etc.)
  • [x] Tests are added for new functionality and a local test run was successful (with and without OpenMP)
  • [x] Appropriate documentation for new functionality has been added (Doxygen in the code and Markdown files if necessary)
  • [x] Proper attention to licenses, especially no new third-party software with conflicting license has been added
  • [ ] (For ABM development) Checked benchmark results and ran and posted a local test above from before and after development to ensure performance is monitored.

Checks by code reviewer(s)

  • [ ] Corresponding issue(s) is/are linked and addressed
  • [ ] Code is clean of development artifacts (no deactivated or commented code lines, no debugging printouts, etc.)
  • [ ] Appropriate unit tests have been added, CI passes, code coverage and performance is acceptable (did not decrease)
  • [ ] No large data files added in the whole history of commits(files should in sum not exceed 100 KB, avoid PDFs, Word docs, etc.)
  • [ ] On merge, add 2-5 lines with the changes (main added features, changed items, or corrected bugs) to the merge-commit-message. This can be taken from the briefly-list-the-changes above (best case) or the separate commit messages (worst case).

Closes #929.

lenaploetzke avatar Apr 11 '24 14:04 lenaploetzke

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 96.42%. Comparing base (deefc27) to head (92d7a37). Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1004      +/-   ##
==========================================
+ Coverage   96.36%   96.42%   +0.06%     
==========================================
  Files         130      130              
  Lines       10209    10360     +151     
==========================================
+ Hits         9838     9990     +152     
+ Misses        371      370       -1     

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

codecov[bot] avatar Apr 11 '24 15:04 codecov[bot]

Can you merge the main branch so that the get_mean method is already included here?

annawendler avatar Apr 29 '24 12:04 annawendler

Nice work!

I was wondering if we should rename ExponentialDecay to ExponentialSurvivalFunction. This would be consistent with the other new SAFs and describe better what it is used for. I'm not sure if SmootherCosineSurvivalFunction is a good name as I don't know if there is a name for the associated distribution, but I guess we should at least mention that this is a survival function as well in the documentation.

I like this idea and renamed ExponentialDecay. I also agree, that the name SmootherCosineSurvivalFunction is not appropriate, but put in the docu.

lenaploetzke avatar May 10 '24 11:05 lenaploetzke