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

Fix slope calculation; add alternative methods #31

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

Conversation

spahrenk
Copy link
Contributor

Description

  • These changes address issues with calculating slope used for cubic splines.
  • Three methods are available from which the user can select for slope calculation: quadratic, cardinal, and finite-difference
  • Tests were expanded to verify expected results in all three cases. The default "quadratic" method is used, unless otherwise specified.
  • The markdown file was expanded to inlcude some background theory. Documentation for multi-axis spline was not expanded.

Author Progress Checklist:

  • Open draft pull request
    • Make title clearly understandable in a standalone change log context
    • Assign yourself the issue
    • Add at least one label (enhancement, bug, or maintenance)
    • Link the issue(s) addressed by this PR (under "Development" in the sidebar menu)
  • Make code changes (if you haven't already)
  • Self-review of code
    • My code follows the style guidelines of this project
    • I have added comments to my code, particularly in hard-to-understand areas
    • I have only committed the necessary changes for this fix or feature
    • I have made corresponding changes to the documentation
    • My changes generate no new warnings
    • I have ensured that my fix is effective or that my feature works as intended by:
      • exercising the code changes in the test framework, and/or
      • manually verifying the changes (as explained in the the pull request description above)
    • My changes pass all local tests
    • My changes successfully passes CI checks
    • Add any unit test for proof and documentation.
    • Merge in main branch and address resulting conflicts and/or test failures.
  • Move pull request out of draft mode and assign reviewers
  • Iterate with reviewers until all changes are approved
    • Make changes in response to reviewer comments
    • Merge in main branch and address resulting conflicts and/or test failures.
    • Re-request review in GitHub

Reviewer Checklist:

  • Read the pull request description
  • Perform a code review on GitHub
  • Confirm all CI checks pass and there are no build warnings
  • Pull, build, and run automated tests locally
  • Perform manual tests of the fix or feature locally
  • Add any review comments, if applicable
  • Submit review in GitHub as either
    • Request changes, or
    • Approve
  • Iterate with author until all changes are approved

@spahrenk spahrenk self-assigned this Jun 26, 2023
Copy link
Contributor

Choose a reason for hiding this comment

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

I think we plan to leave the Readme file as a general overview with basic build and usage instructions, and keep detailed documentation in a separate location, but this content is a great start for docs.
My 2c, if I were a user of btwxt I would prefer a tutorial-style walkthrough of the theory rather than a textbook chapter; i.e. instead of concrete applications being "left as an exercise to the reader," they are instead peppered throughout the derivations, helping users understand the behavior of the library for specific choices, and not only its most generalized mathematical theory.

@codecov-commenter
Copy link

Codecov Report

Merging #31 (5045a2e) into main (9bab8ed) will increase coverage by 3.76%.
The diff coverage is 86.30%.

@@            Coverage Diff             @@
##             main      #31      +/-   ##
==========================================
+ Coverage   82.56%   86.32%   +3.76%     
==========================================
  Files           5        6       +1     
  Lines         453      563     +110     
==========================================
+ Hits          374      486     +112     
+ Misses         79       77       -2     
Flag Coverage Δ
integration 86.32% <86.30%> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
include/btwxt/grid-axis.h 0.00% <0.00%> (ø)
include/btwxt/grid-point-data.h 0.00% <0.00%> (ø)
include/btwxt/logging.h 0.00% <0.00%> (ø)
src/regular-grid-interpolator-implementation.h 13.79% <13.79%> (ø)
src/grid-axis.cpp 87.07% <87.07%> (-6.26%) ⬇️
src/regular-grid-interpolator.cpp 92.70% <92.68%> (+5.96%) ⬆️

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.

3 participants