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

Create vincenty.rs #818

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

dev-priyanshu15
Copy link

@dev-priyanshu15 dev-priyanshu15 commented Oct 13, 2024

Description
This pull request introduces the Vincenty formula implementation for calculating geodesic distance between two points on the Earth's surface, using the WGS84 ellipsoid model. This formula offers more accuracy than the Haversine formula by accounting for the Earth's ellipsoidal shape, making it suitable for applications requiring precise distance measurements.

Changes made:

Added a new vincenty.rs module to implement the Vincenty algorithm.
Updated mod.rs to include pub mod vincenty;.
Updated DIRECTORY.md with a link to the new module.
The Vincenty formula is an iterative method that is more accurate for long-distance calculations on the Earth’s ellipsoid model. For more details, see Vincenty’s Formula.

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist:

  • I ran bellow commands using the latest version of rust nightly.
  • [x ] I ran cargo clippy --all -- -D warnings just before my last commit and fixed any issue that was found.
  • [x ] I ran cargo fmt just before my last commit.
  • [x ] I ran cargo test just before my last commit and all tests passed.
  • [x ] I added my algorithm to the corresponding mod.rs file within its own folder, and in any parent folder(s).
  • [x ] I added my algorithm to DIRECTORY.md with the correct link.
  • [ x] I checked COUNTRIBUTING.md and my code follows its guidelines.

Please make sure that if there is a test that takes too long to run ( > 300ms), you #[ignore] that or
try to optimize your code or make the test easier to run. We have this rule because we have hundreds of
tests to run; If each one of them took 300ms, we would have to wait for a long time.

@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.36%. Comparing base (0dbaff5) to head (ffbc851).

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #818   +/-   ##
=======================================
  Coverage   95.36%   95.36%           
=======================================
  Files         311      311           
  Lines       22673    22673           
=======================================
  Hits        21623    21623           
  Misses       1050     1050           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@sozelfist
Copy link
Contributor

Could you please review the CONTRIBUTING guidelines before submitting your PR? For adding a new algorithm, you can refer to #695 as a good example of how it should be structured.

A quick reminder: please avoid submitting PRs just for Hacktoberfest. We welcome contributions, but we prioritize quality over quantity. Ensure that your PR solves a relevant problem and follows the best practices outlined in the CONTRIBUTING guidelines.

@sozelfist sozelfist mentioned this pull request Oct 16, 2024
10 tasks
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.

3 participants