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.

Sign up for GitHub

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

Jump to bottom

Improve internal error handling, add unit tests for WiRoot and Airy #11

Open
wants to merge 24 commits into
base: dev
Choose a base branch
from
Open

Improve internal error handling, add unit tests for WiRoot and Airy #11

wants to merge 24 commits into from
+634 −249

Conversation

aromanielloNTIA
Copy link
Member

  • Improve internal error handling by implementing exceptions for error cases which previously returned valid (i.e. correctly typed numbers) but incorrect results.
  • Minimize the LFMF wrapper around LFMF_CPP so that all validation occurs in LFMF_CPP
  • Modify Airy validation to reflect that, for Airy functions of the third kind (WONE, WTWO, DWONE, DWTWO), the scaling should be HUFFORD or WAIT (not NONE).
  • Modify Airy to move some variable declarations closer to where they are used
  • Convert enums to enum classes to better enforce their usage
  • Add unit tests for Airy and WiRoot

@aromanielloNTIA
Shorten enum name for AiryKind and AiryScaling
35ebcf1
@aromanielloNTIA
Convert enums to enum classes, always use namespace
3fe6179
@aromanielloNTIA
Throw std::invalid_argument for invalid inputs
bedb701 
Avoids requiring the caller to know that they may get junk values indicating invalid input error conditions.
@aromanielloNTIA
Fixes for use of enum class
a1e04de
@aromanielloNTIA
Cleanup Airy
a9453fc 
De-FORTRANizing things a bit. Moving variable declaration closer to usage, reducing scope where possible. Cleaning up comment formats that clang-format mangled.
@aromanielloNTIA
docs formatting
5c40c55
@aromanielloNTIA
Throw invalid_argument exception for bad inputs
bee0311
@aromanielloNTIA
Throw range_error when N is out of range
552148b 
Instead of returning zero silently
@aromanielloNTIA
Remove endl from error message text
a951b7e
@aromanielloNTIA
Add unit tests for WiRoot
208e58b
@aromanielloNTIA
Throw runtime error if root finding fails
5e2efe7
@aromanielloNTIA
Expand WiRoot test coverage
d22397c
@aromanielloNTIA
Make LFMF a thin wrapper around LFMF_CPP
3221eaa 
Moves all validation into LFMF_CPP so that nothing gets skipped when using different entrypoints. Previously polarization validation was skipped when using LFMF_CPP
@aromanielloNTIA
Update ValidationPolarization declaration
0ca63a0
@aromanielloNTIA
Use C++ entrypoint and types in driver
fec8022
@aromanielloNTIA
Improve test fixture use, remove invalid test cases
b8d32d3 
Test cases have been removed that are no longer valid after moving polarization enum validation into LFMF_CPP
@aromanielloNTIA
Add WiRoot tests to CMakeLists.txt
dc6c1fd
@aromanielloNTIA
Fix file name
65ffde9
@aromanielloNTIA
Add documentation
4b00a14
@aromanielloNTIA
Make test fixture setup protected
1a3bf33
@aromanielloNTIA
Allow AIRYD and BAIRYD
7f634d7
@aromanielloNTIA
Clarify usage of scaling
572c9e8 
Scaling has no effect if kind is AIRY, BAIRY, AIRYD, or BAIRYD.

Scaling=NONE should not be used with WONE, WTWO, DWONE, or DWTWO. Instead, only HUFFORD or WAIT scaling should be used for these values of `kind`.

Added checks to ensure correct usage at the beginning of the function and removed a condition which this change made irrelevant. Updated documentation.
@aromanielloNTIA
Add tests for Airy
62159a6
@aromanielloNTIA aromanielloNTIA self-assigned this Jan 15, 2025
This was linked to issues Jan 15, 2025
Error handling inside WiRoot() should be improved #9
Open
Airy() exits early when inputs specify derivatives of Airy functions of the first or second kind #10
Open
@aromanielloNTIA aromanielloNTIA added enhancement New feature or request documentation Improvements or additions to documentation labels Jan 15, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@aromanielloNTIA aromanielloNTIA

Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
1 participant
@aromanielloNTIA