mirror of
https://github.com/wagesj45/CapyKit.git
synced 2024-11-13 19:53:36 -06:00
57 lines
2.4 KiB
Markdown
57 lines
2.4 KiB
Markdown
# GetDistance(Decimal, Decimal, Decimal, Decimal, MeasurementSystem) Method
|
||
|
||
|
||
Gets the distance between two points on earth using the `haversine` formula.
|
||
|
||
|
||
|
||
## Definition
|
||
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
|
||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
|
||
|
||
**C#**
|
||
``` C#
|
||
public static decimal GetDistance(
|
||
decimal latitudeOrigin,
|
||
decimal longitudeOrigin,
|
||
decimal latitudeDestination,
|
||
decimal longitudeDestination,
|
||
MeasurementSystem measurementSystem = MeasurementSystem.Imperial
|
||
)
|
||
```
|
||
**F#**
|
||
``` F#
|
||
static member GetDistance :
|
||
latitudeOrigin : decimal *
|
||
longitudeOrigin : decimal *
|
||
latitudeDestination : decimal *
|
||
longitudeDestination : decimal *
|
||
?measurementSystem : MeasurementSystem
|
||
(* Defaults:
|
||
let _measurementSystem = defaultArg measurementSystem MeasurementSystem.Imperial
|
||
*)
|
||
-> decimal
|
||
```
|
||
|
||
|
||
|
||
#### Parameters
|
||
<dl><dt> <a href="https://learn.microsoft.com/dotnet/api/system.decimal" target="_blank" rel="noopener noreferrer">Decimal</a></dt><dd>The latitude origin.</dd><dt> <a href="https://learn.microsoft.com/dotnet/api/system.decimal" target="_blank" rel="noopener noreferrer">Decimal</a></dt><dd>The longitude origin.</dd><dt> <a href="https://learn.microsoft.com/dotnet/api/system.decimal" target="_blank" rel="noopener noreferrer">Decimal</a></dt><dd>The latitude destination.</dd><dt> <a href="https://learn.microsoft.com/dotnet/api/system.decimal" target="_blank" rel="noopener noreferrer">Decimal</a></dt><dd>The longitude destination.</dd><dt> <a href="T_CapyKit_Enumerations_MeasurementSystem.md">MeasurementSystem</a> (Optional)</dt><dd>(Optional) The measurement system.</dd></dl>
|
||
|
||
#### Return Value
|
||
<a href="https://learn.microsoft.com/dotnet/api/system.decimal" target="_blank" rel="noopener noreferrer">Decimal</a>
|
||
The distance.
|
||
|
||
## Remarks
|
||
Uses the <a href="https://www.movable-type.co.uk/scripts/latlong.html">
|
||
|
||
haversine</a> formula to calculate the "as-the-crow-flies" distance between two points on earth.
|
||
|
||
## See Also
|
||
|
||
|
||
#### Reference
|
||
<a href="T_CapyKit_Helpers_CalculationHelper.md">CalculationHelper Class</a>
|
||
<a href="Overload_CapyKit_Helpers_CalculationHelper_GetDistance.md">GetDistance Overload</a>
|
||
<a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>
|
||
<a href="M_CapyKit_Helpers_CalculationHelper_GetDistance_1.md">GetDistance(Double, Double, Double, Double, MeasurementSystem)</a>
|