Merge pull request georust#1297 from urschrei/haversine-citation-fix

Fix citation location of mean earth radius
urschrei · Jan 10, 2025 · 1335472 · 1335472
2 parents e5dddd6 + 2cc675f
commit 1335472
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 8 deletions.
diff --git a/geo-types/CHANGES.md b/geo-types/CHANGES.md
@@ -2,6 +2,7 @@
 
 ## Unreleased
 
+- Fix page location of citation for mean earth radius used in Haversine calculations
 - Implement `RTreeObject` for `Triangle`.
 - Implement `AsRef<Coord>` for `Point` and `Coord`.
 

diff --git a/geo/src/algorithm/haversine_distance.rs b/geo/src/algorithm/haversine_distance.rs
@@ -9,8 +9,13 @@ use num_traits::FromPrimitive;
 ///
 /// [haversine formula]: https://en.wikipedia.org/wiki/Haversine_formula
 ///
-/// *Note*: this implementation uses a mean earth radius of 6371.088 km, based on the [recommendation of
-/// the IUGG](ftp://athena.fsv.cvut.cz/ZFG/grs80-Moritz.pdf)
+/// *Note*: this implementation uses a mean earth radius of 6371.0088 km (6_371_008.7714 m), based on the recommendation of
+/// the IUGG:
+///
+/// Moritz, H. (2000). Geodetic Reference System 1980. Journal of Geodesy, 74(1), 128–133. doi:10.1007/s001900050278
+/// "Derived Geometric Constants: **R1: mean radius**" (p131)
+/// - <https://link.springer.com/article/10.1007%2Fs001900050278>
+/// - <https://sci-hub.se/https://doi.org/10.1007/s001900050278>
 pub trait HaversineDistance<T, Rhs = Self> {
     /// Determine the distance between two geometries using the [haversine
     /// formula].

diff --git a/geo/src/algorithm/line_measures/metric_spaces/haversine.rs b/geo/src/algorithm/line_measures/metric_spaces/haversine.rs
@@ -10,8 +10,13 @@ use crate::{CoordFloat, Point, MEAN_EARTH_RADIUS};
 ///
 /// # References
 ///
-/// *Note*: this implementation uses a mean earth radius of 6371.088 km, based on the [recommendation of
-/// the IUGG](ftp://athena.fsv.cvut.cz/ZFG/grs80-Moritz.pdf)
+/// *Note*: this implementation uses a mean earth radius of 6371.0088 km (6_371_008.7714 m), based on the recommendation of
+/// the IUGG:
+///
+/// Moritz, H. (2000). Geodetic Reference System 1980. Journal of Geodesy, 74(1), 128–133. doi:10.1007/s001900050278
+/// "Derived Geometric Constants: **R1: mean radius**" (p131)
+/// - <https://link.springer.com/article/10.1007%2Fs001900050278>
+/// - <https://sci-hub.se/https://doi.org/10.1007/s001900050278>
 ///
 /// [haversine formula]: https://en.wikipedia.org/wiki/Haversine_formula//
 /// [great circle]: https://en.wikipedia.org/wiki/Great_circle

diff --git a/geo/src/lib.rs b/geo/src/lib.rs
@@ -264,10 +264,10 @@ extern crate log;
 /// Mean radius of Earth in meters
 /// This is the value recommended by the IUGG:
 /// Moritz, H. (2000). Geodetic Reference System 1980. Journal of Geodesy, 74(1), 128–133. doi:10.1007/s001900050278
-/// "Derived Geometric Constants: mean radius" (p133)
-/// https://link.springer.com/article/10.1007%2Fs001900050278
-/// https://sci-hub.se/https://doi.org/10.1007/s001900050278
-/// https://en.wikipedia.org/wiki/Earth_radius#Mean_radius
+/// "Derived Geometric Constants: **R1: mean radius**" (p131)
+/// - <https://link.springer.com/article/10.1007%2Fs001900050278>
+/// - <https://sci-hub.se/https://doi.org/10.1007/s001900050278>
+/// - <https://en.wikipedia.org/wiki/Earth_radius#Mean_radius>
 const MEAN_EARTH_RADIUS: f64 = 6371008.8;
 
 // Radius of Earth at the equator in meters (derived from the WGS-84 ellipsoid)