fix(rhumb-bearing): return NaN for coincident points#3082
Open
JSap0914 wants to merge 1 commit into
Open
Conversation
When start and end points are identical, rhumbBearing() was returning 0 (north) because Math.atan2(0, 0) === 0. This is misleading since no bearing can be defined for a zero-length segment. The Geodesy library (which this implementation is adapted from) explicitly guards for this case and returns NaN. Align turf's behaviour accordingly. Closes Turfjs#2478
JSap0914
added a commit
to JSap0914/turf
that referenced
this pull request
Jun 27, 2026
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.
Bug
When start and end points are identical (coincident),
rhumbBearing()returns0(north). This is incorrect — a bearing is geometrically undefined for a zero-length segment. Returning0silently implies a northward direction where there is none.Closes #2478
Root Cause
calculateRhumbBearingcomputesMath.atan2(deltaLambda, deltaPsi). For coincident points both values are0, andMath.atan2(0, 0) === 0in JavaScript — producing a spurious bearing of0°.The Geodesy library that this implementation is adapted from (latlon-spherical.js) explicitly checks for this case and returns
NaN.Fix
Added an early-exit guard in
calculateRhumbBearing:This matches the Geodesy reference behaviour and is consistent with what the regular
bearingfunction also produces for coincident points (sinceMath.atan2(0,0)behaviour is identical there).Verification
Output: