added comment

Author: vadzim-vys

libnavigation-core/src/main/java/com/mapbox/navigation/core/fasterroute/FasterRouteOptions.kt

@@ -3,6 +3,19 @@ package com.mapbox.navigation.core.fasterroute
 import com.mapbox.navigation.base.ExperimentalMapboxNavigationAPI
 
 @ExperimentalMapboxNavigationAPI
-data class FasterRouteOptions(
-    val maxSimilarityToExistingRoute: Double = 0.5
-)
+class FasterRouteOptions internal constructor(
+    val maxSimilarityToExistingRoute: Double
+) {
+    class Builder {
+
+        private val maxSimilarityToExistingRoute = 0.5
+
+        fun maxSimilarityToExistingRoute(value: Double) {
+            assert(value in 0.0..1.0) { "similarity should be a value between 0 and 1" }
+        }
+
+        fun build() = FasterRouteOptions(maxSimilarityToExistingRoute)
+    }
+}
+
+

libnavigation-core/src/main/java/com/mapbox/navigation/core/fasterroute/SimilarRoutes.kt

@@ -5,6 +5,9 @@ import com.mapbox.navigation.base.route.NavigationRoute
 import com.mapbox.navigation.base.utils.DecodeUtils.completeGeometryToPoints
 import com.mapbox.turf.TurfMeasurement
 
+/***
+ * The function uses summary of route leg which is not guaranteed to have a stable format.
+ */
 internal fun calculateDescriptionSimilarity(a: NavigationRoute, b: NavigationRoute): Double {
     val firstSummary = parseSummaries(a)
     val secondSummary = parseSummaries(b)

libnavigation-core/src/test/java/com/mapbox/navigation/core/fasterroute/FasterRouteTrackerTest.kt

@@ -73,5 +73,5 @@ class FasterRouteTrackerTest {
 }
 
 internal fun createFasterRoutesTracker() = FasterRouteTracker(
-    FasterRouteOptions(maxSimilarityToExistingRoute = 0.5)
+    FasterRouteOptions.Builder().build()
 )

qa-test-app/src/main/java/com/mapbox/navigation/qa_test_app/view/AlternativeRouteActivity.kt

@@ -150,9 +150,7 @@ class AlternativeRouteActivity : AppCompatActivity(), OnMapLongClickListener {
     @OptIn(ExperimentalMapboxNavigationAPI::class)
     private val fasterRoutes by lazy {
         mapboxNavigation.createFasterRoutes(
-            FasterRouteOptions(
-                maxSimilarityToExistingRoute = 0.5
-            )
+            FasterRouteOptions.Builder().build()
         )
     }