Add euclidean distance function to Location. (#176)

CHANGELOG.md

@@ -19,6 +19,7 @@ All notable changes to this project will be documented in this file.
 - Add `PreEvaluationHooks` before evaluation of `TSCs` and `Segments` in `TSCEvaluation`.
 - Add pre-defined `MinNodesInTSCHook` and `MinTicksPerSegmentHook`.
 - Add `identifier` field to `TSC`.
+- Add `euclideanDistance` function to `Location`.
 - Add `vehicleType` field to `Vehicle`.
 
 ### Changed

stars-data-av/src/main/kotlin/tools/aqua/stars/data/av/dataclasses/Location.kt

@@ -17,11 +17,23 @@
 
 package tools.aqua.stars.data.av.dataclasses
 
+import kotlin.math.pow
+import kotlin.math.sqrt
+
 /**
  * Data class for 3D locations.
  *
  * @property x The x ordinate.
  * @property y The y ordinate.
  * @property z The z ordinate.
  */
-data class Location(val x: Double, val y: Double, val z: Double)
+data class Location(val x: Double, val y: Double, val z: Double) {
+  companion object {
+    /**
+     * Calculates the Euclidean distance between two locations, i.e., the square root of the sum of
+     * the squared ordinates.
+     */
+    fun euclideanDistance(loc1: Location, loc2: Location): Double =
+        sqrt((loc1.x - loc2.x).pow(2) + (loc1.y - loc2.y).pow(2) + (loc1.z - loc2.z).pow(2))
+  }
+}