fix: clamp lower bound of arcsin argument in get_apparent_wind() to prevent silent NaN#171
Open
abhinavsudhik wants to merge 1 commit into52North:mainfrom
Open
Conversation
…revent silent NaN Closes 52North#170
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Related Issue / Discussion:
Fixes Issue #170
Changes:
direct_power_boat.py— added lower-bound clamp forarg_arcsinin
get_apparent_wind()(lines 235–241)Further Details:
Summary:
The
get_apparent_wind()method computesarg_arcsinas the argument fornp.arcsin(),which requires its input to be within [-1, 1]. Due to floating-point rounding,
arg_arcsincan produce slightly below -1 (e.g. -1.0000000001).
To rectify this error , the values of arg_arcsin are clamped back to the bound.
Before: Only the upper bound (
arg_arcsin > 1) was clamped. The lower bound(
arg_arcsin < -1) was unhandled, causingnp.arcsin()to silently returnNaN,corrupting apparent wind angle, power, and fuel calculations.
After: A symmetric
elifbranch now clamps the lower bound to-1when theviolation is within rounding tolerance (< 0.000001), consistent with the existing
upper-bound logic.
Dependencies:
No new dependencies required.
PR Checklist:
In the context of this PR, I:
and received positive feedback on this matter
and am waiting for feedback
(WeatherRoutingTool/tests) that allow the simple testing of the
new/modified functionalities. All (previous and new) unit tests
execute without new error messages.
at the time of the contribution