Unfathomable

Distance objects and conversions.

Note: While conversions and calculations should be correct - this is a learning exercise for me, so it may be better to roll your own calculations if you are concerned about performance or avoiding possible rounding errors/precision.

Examples:

Creating a distance object:

let 
  someDistance = newDistance(1.0, Kilometres)
  otherDistance = Distance(size: 100.0, units: Metres)
echo someDistance
echo otherDistance

Output:

1.0 Kilometres
100.0 Metres

Converting a distance object to a different unit of measurement:

var 
  someDistance = newDistance(1.0, Kilometres)
someDistance.to(Parsecs)
echo someDistance

Output:

3.240779289469757e-14 Parsecs

Getting the length of a distance object as a float without mutating the object:

let 
  someDistance = newDistance(1.0, Kilometres)
echo someDistance.sizeAs(Picometres)

Output:

1000000000000000.0

Creating a copy of a distance object in a different unit of measurement:

let 
  someDistance = newDistance(1.0, Kilometres)
  aNewDistance = someDistance.copyAs(Centimetres)
echo aNewDistance

Output:

100000.0 Centimetres

Arithmetic and boolean checks with distance objects:

let 
  someDistance = newDistance(1.0, Kilometres)
  otherDistance = Distance(size: 100.0, units: Metres)
  anotherDistance = newDistance(1000, Metres)
echo someDistance + otherDistance
echo someDistance - otherDistance
echo someDistance * otherDistance
echo someDistance / otherDistance
echo 2 * someDistance
echo someDistance * 2
echo someDistance / 2
echo someDistance > otherDistance
echo someDistance < otherDistance
echo someDistance == anotherDistance
echo someDistance != otherDistance
# In place arithmetic
someDistance += otherDistance
echo someDistance
someDistance -= otherDistance
echo someDistance
someDistance *= otherDistance
echo someDistance
someDistance /= otherDistance
echo someDistance

Output:

1.1 Kilometres
0.9 Kilometres
0.1 Kilometres
10.0 Kilometres
2.0 Kilometres
2.0 Kilometres
0.5 Kilometres
true
false
true
true
1.1 Kilometres
1.0 Kilometres
0.1 Kilometres
1.0 Kilometres

Find the distance between any points:

var 
  p1 = newPoint(40.7486, -73.9864)
  p2 = newPoint(26.22, -50.0)
  p3 = newPoint(-26.22, 50.0)

echo getVincentyDistance(p1, p2, Kilometres)
echo getVincentyDistance(p2, p3, Kilometres)
echo getVincentyDistance(p1, p2, p3, Kilometres)
echo getVincentyDistance(p1, p2, p3, p1, Kilometres)
echo p1 - p2
echo getHaversineDistance(p1, p2, Kilometres)
echo getHaversineDistance(p1, p2, p3, p1, Kilometres)

Output:

2731.048093986 Kilometres
12147.168393401 Kilometres
14878.216487387 Kilometres
29599.195015569 Kilometres
2733944.610522819 Metres
2733.944610522819 Kilometres
29588.23424886339 Kilometres

Find the shortest distance between a number of points:

const 
  DC = newPoint(38.9072, -77.0369)
  Philadelphia = newPoint(39.9526, -75.1652)
  NY = newPoint(40.7128, -74.0059)
echo getVincentyDistance(DC, NY, Philadelphia, Kilometres)
echo getHaversineDistance(DC, NY, Philadelphia, Kilometres)

Output:

457.650671384857 Kilometres
457.2093040782787 Kilometres