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

Add customizable GeodesicMeasure #1311

Merged
merged 2 commits into from
Feb 14, 2025
Merged

Conversation

michaelkirk
Copy link
Member

  • I agree to follow the project's code of conduct.
  • I added an entry to CHANGES.md if knowledge of this change could be valuable to users.

Building on #1298, adds the ability to customize your geoid for Karney geodesic calculations.

Note: this bumps MSRV to 1.80 (released 6+ months ago) in order to utilize LazyLock.

Perf: No measurable difference in the benchmarks

geodesic distance f64   time:   [421.15 ns 423.53 ns 426.07 ns]
                        change: [-1.7862% -1.2409% -0.7204%] (p = 0.00 < 0.05)
                        Change within noise threshold.

@michaelkirk michaelkirk force-pushed the mkirk/customizable-geodesic branch 2 times, most recently from 8358da0 to d952d7e Compare February 3, 2025 22:56
/// Distances are computed using [geodesic lines] and are measured **in meters**.
///
/// [`GeodesicMeasure`] allows creating a geodesic model with custom values for the equatorial
/// radius (`A`) and the inverse flattening factor (`F`). Unless you have special needs, just use
Copy link
Member

Choose a reason for hiding this comment

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

The most minor of nits: we should try not to use "just" in our public docs IMO, as it assumes a degree of knowledge / familiarity that the reader may not have (we are actually very good about this, barring some instances floating around in Haversine examples)

Copy link
Member Author

Choose a reason for hiding this comment

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

This is a good nit. "just" is something I'm largely trying to strike from my writing. It usually doesn't add anything, is sometimes ambiguous, and sometimes condescending.

I've removed a few other instances in 1d9005e

Note: this bumps MSRV to 1.80 (released 6+ months ago) in order to
utilize `LazyLock`.

Perf: No measurable difference in the benchmarks

    geodesic distance f64   time:   [421.15 ns 423.53 ns 426.07 ns]
                            change: [-1.7862% -1.2409% -0.7204%] (p = 0.00 < 0.05)
                            Change within noise threshold.
@michaelkirk michaelkirk force-pushed the mkirk/customizable-geodesic branch from d952d7e to 1d9005e Compare February 14, 2025 23:22
@michaelkirk michaelkirk added this pull request to the merge queue Feb 14, 2025
Merged via the queue into main with commit bf4809e Feb 14, 2025
18 checks passed
@michaelkirk michaelkirk deleted the mkirk/customizable-geodesic branch February 14, 2025 23:28
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.

2 participants