[Added] settings for branch and bound algorithm

Author: Daniel García

app/src/main/java/com/tripletres/platformscience/domain/AssignDriversToShipmentsUseCase.kt

@@ -2,11 +2,11 @@ package com.tripletres.platformscience.domain
 
 import com.tripletres.platformscience.data.repo.DriverRepository
 import com.tripletres.platformscience.data.repo.ShipmentRepository
+import com.tripletres.platformscience.domain.algorithm.AssignationAlgorithmType
+import com.tripletres.platformscience.domain.algorithm.BranchAndBoundAlgorithm
 import com.tripletres.platformscience.domain.algorithm.GreedyAssignationAlgorithm
-import com.tripletres.platformscience.domain.model.Driver
-import com.tripletres.platformscience.domain.model.Shipment
-import com.tripletres.platformscience.domain.model.asDriverList
-import com.tripletres.platformscience.domain.model.asShipmentList
+import com.tripletres.platformscience.domain.algorithm.IAssignationAlgorithm
+import com.tripletres.platformscience.domain.model.*
 import javax.inject.Inject
 
 /**
@@ -18,11 +18,14 @@ class AssignDriversToShipmentsUseCase @Inject constructor(
     private val saveDriversAssigned: SaveDriversAssignedToShipmentsUseCase,
 ) {
 
-    suspend operator fun invoke(): List<Driver> {
+    // Can be changed for your favorite algorithm
+    private val defaultAlgorithm = AssignationAlgorithmType.BRANCH.name
+
+    suspend operator fun invoke(algorithm: String?): List<Driver> {
         val drivers = driverRepository.getDriversFromDB().asDriverList()
         val shipments = shipmentRepository.getShipmentsFromDB().asShipmentList()
 
-        val driverAssigned = assignDriversToShipment(drivers, shipments)
+        val driverAssigned = assignDriversToShipment(drivers, shipments, algorithm)
         //Save in assigned drivers
         saveDriversAssigned(driverAssigned)
         return driverAssigned
@@ -31,8 +34,23 @@ class AssignDriversToShipmentsUseCase @Inject constructor(
     /**
      * Perform assignation of shipments to drivers
      */
-    private fun assignDriversToShipment(drivers: List<Driver>, shipments: List<Shipment>): List<Driver> {
-        return ShipmentDriverAssignation(GreedyAssignationAlgorithm()).execute(drivers, shipments)
+    private fun assignDriversToShipment(
+        drivers: List<Driver>,
+        shipments: List<Shipment>,
+        algorithm: String?,
+    ): List<Driver> {
+        return ShipmentDriverAssignation(defineAlgorithm(algorithm)).execute(drivers, shipments)
+    }
+
+    /**
+     * Gets assignation algorithm from type or default
+     */
+    private fun defineAlgorithm(algorithm: String?): IAssignationAlgorithm {
+        val type = algorithm ?: defaultAlgorithm
+        return when (type.toAssignationAlgorithmType()) {
+            AssignationAlgorithmType.GREEDY -> GreedyAssignationAlgorithm()
+            AssignationAlgorithmType.BRANCH -> BranchAndBoundAlgorithm()
+        }
     }
 
 }

app/src/main/java/com/tripletres/platformscience/domain/algorithm/AssignationAlgorithmType.kt

@@ -0,0 +1,9 @@
+package com.tripletres.platformscience.domain.algorithm
+
+/**
+ * To identify what type of algorithm to use
+ */
+enum class AssignationAlgorithmType {
+    GREEDY,
+    BRANCH,
+}

app/src/main/java/com/tripletres/platformscience/domain/model/Converter.kt

@@ -3,6 +3,7 @@ package com.tripletres.platformscience.domain.model
 import com.tripletres.platformscience.data.db.driver.DriverAssignationEntity
 import com.tripletres.platformscience.data.db.driver.DriverEntity
 import com.tripletres.platformscience.data.db.shipment.ShipmentEntity
+import com.tripletres.platformscience.domain.algorithm.AssignationAlgorithmType
 import com.tripletres.platformscience.ui.model.DriverItem
 import com.tripletres.platformscience.ui.model.ShipmentItem
 
@@ -57,3 +58,14 @@ fun Driver.asDriverEntity(): DriverEntity {
 }
 
 private fun Shipment.asShipmentEntity(): ShipmentEntity = ShipmentEntity(this.id, this.address)
+
+/**
+ * Algorithm type converter
+ */
+fun String.toAssignationAlgorithmType(): AssignationAlgorithmType {
+    return when (this) {
+        "GREEDY" -> AssignationAlgorithmType.GREEDY
+        "BRANCH_BOUND" -> AssignationAlgorithmType.BRANCH
+        else -> TODO("No available")
+    }
+}

app/src/main/java/com/tripletres/platformscience/ui/view/splash/SplashViewModel.kt

@@ -6,6 +6,10 @@ import com.tripletres.platformscience.domain.AssignDriversToShipmentsUseCase
 import com.tripletres.platformscience.domain.LoadDriversShipmentsUseCase
 import com.tripletres.platformscience.ui.model.DriverItem
 import com.tripletres.platformscience.util.LogUtils
+import com.tripletres.platformscience.util.SimpleSettingsUtil
+import com.tripletres.platformscience.util.SimpleSettingsUtil.Companion.ALGORITHM
+import com.tripletres.platformscience.util.SimpleSettingsUtil.Companion.DB_OR_API
+import com.tripletres.platformscience.util.SimpleSettingsUtil.Companion.DB_OR_API_DEF
 import dagger.hilt.android.lifecycle.HiltViewModel
 import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.flow.MutableStateFlow
@@ -21,6 +25,7 @@ import javax.inject.Inject
 class SplashViewModel @Inject constructor(
     private val loadDriversShipmentsUseCase: LoadDriversShipmentsUseCase,
     private val assignDriversToShipmentsUseCase: AssignDriversToShipmentsUseCase,
+    private val settings: SimpleSettingsUtil,
 ) : ViewModel() {
 
     private val _uiState = MutableStateFlow(SplashUiState())
@@ -34,17 +39,16 @@ class SplashViewModel @Inject constructor(
         viewModelScope.launch(Dispatchers.IO) {
             loadDriversShipmentsUseCase(getCachedSetting())
             updateStatus(SplashUiStatus.ASSIGNING)
-            assignDriversToShipmentsUseCase()
+            assignDriversToShipmentsUseCase(getAlgorithmSetting())
             updateStatus(SplashUiStatus.DONE)
-            val drivers: List<DriverItem> = emptyList()
-            LogUtils.d("Drivers: ${drivers.toString()}")
         }
     }
 
     private fun updateStatus(newStatus: SplashUiStatus) {
         _uiState.update { state -> state.copy(status = newStatus) }
     }
 
-    private fun getCachedSetting() = true //TODO: settings from user
+    private fun getCachedSetting() = settings.getPreference(DB_OR_API) == DB_OR_API_DEF
+    private fun getAlgorithmSetting() = settings.getPreference(ALGORITHM)
 
 }

app/src/main/java/com/tripletres/platformscience/util/SimpleSettingsUtil.kt

@@ -20,11 +20,15 @@ class SimpleSettingsUtil @Inject constructor(@ApplicationContext val context: Co
         const val DB_OR_API_API = "API" //API option
         const val ALGORITHM: String = "ALGORITHM"
         const val ALGORITHM_GREEDY: String = "GREEDY"
-        const val ALGORITHM_DEF: String = ALGORITHM_GREEDY //TODO: change for constant
+        const val ALGORITHM_BRANCH_BOUND: String = "BRANCH_BOUND"
+        const val ALGORITHM_DEF: String = ALGORITHM_BRANCH_BOUND
 
         //TODO: Add more algorithms
         fun allAlgorithms(): List<String> {
-            return listOf(ALGORITHM_GREEDY)
+            return listOf(
+                ALGORITHM_GREEDY,
+                ALGORITHM_BRANCH_BOUND
+            )
         }
 
     }