chore: use declarative shadow variables in VRPTW (#60)

Author: triceo

src/main/java/ai/timefold/solver/benchmarks/competitive/cvrplib/CVRPLIBConfiguration.java

@@ -15,6 +15,7 @@
 import ai.timefold.solver.core.api.score.buildin.hardsoftlong.HardSoftLongScore;
 import ai.timefold.solver.core.config.constructionheuristic.ConstructionHeuristicPhaseConfig;
 import ai.timefold.solver.core.config.localsearch.LocalSearchPhaseConfig;
+import ai.timefold.solver.core.config.solver.PreviewFeature;
 import ai.timefold.solver.core.config.solver.SolverConfig;
 import ai.timefold.solver.core.config.solver.termination.TerminationConfig;
 
@@ -58,6 +59,7 @@ private static SolverConfig getCommunityEditionSolverConfig(CVRPLIBDataset datas
                 .withUnimprovedSecondsSpentLimit(AbstractCompetitiveBenchmark.UNIMPROVED_SECONDS_TERMINATION)
                 .withBestScoreLimit(HardSoftLongScore.ofSoft(threshold.longValue()).toString());
         return new SolverConfig()
+                .withPreviewFeature(PreviewFeature.DECLARATIVE_SHADOW_VARIABLES)
                 .withSolutionClass(VehicleRoutingSolution.class)
                 .withEntityClasses(Vehicle.class, Customer.class, TimeWindowedCustomer.class)
                 .withConstraintProviderClass(VehicleRoutingConstraintProvider.class)

src/main/java/ai/timefold/solver/benchmarks/examples/vehiclerouting/domain/timewindowed/TimeWindowedCustomer.java

@@ -2,9 +2,9 @@
 
 import ai.timefold.solver.benchmarks.examples.vehiclerouting.domain.Customer;
 import ai.timefold.solver.benchmarks.examples.vehiclerouting.domain.location.Location;
-import ai.timefold.solver.benchmarks.examples.vehiclerouting.domain.timewindowed.solver.ArrivalTimeUpdatingVariableListener;
 import ai.timefold.solver.core.api.domain.entity.PlanningEntity;
 import ai.timefold.solver.core.api.domain.variable.ShadowVariable;
+import ai.timefold.solver.core.preview.api.domain.variable.declarative.ShadowSources;
 
 import com.fasterxml.jackson.annotation.JsonIgnore;
 
@@ -68,8 +68,7 @@ public void setServiceDuration(long serviceDuration) {
      */
     // Arguable, to adhere to API specs (although this works), nextCustomer should also be a source,
     // because this shadow must be triggered after nextCustomer (but there is no need to be triggered by nextCustomer)
-    @ShadowVariable(variableListenerClass = ArrivalTimeUpdatingVariableListener.class, sourceVariableName = "vehicle")
-    @ShadowVariable(variableListenerClass = ArrivalTimeUpdatingVariableListener.class, sourceVariableName = "previousCustomer")
+    @ShadowVariable(supplierName = "arrivalTimeSupplier")
     public Long getArrivalTime() {
         return arrivalTime;
     }
@@ -78,6 +77,31 @@ public void setArrivalTime(Long arrivalTime) {
         this.arrivalTime = arrivalTime;
     }
 
+    @ShadowSources({ "vehicle", "previousCustomer.arrivalTime" })
+    public Long arrivalTimeSupplier() {
+        if (vehicle == null) {
+            return null;
+        }
+
+        Long departureTime;
+        if (previousCustomer == null) {
+            departureTime = ((TimeWindowedDepot) vehicle.getDepot()).getMinStartTime();
+        } else {
+            departureTime = getPreviousCustomer().getDepartureTime();
+        }
+
+        if (departureTime == null) {
+            return null;
+        }
+
+        return departureTime + getDistanceFromPreviousStandstill();
+    }
+
+    @Override
+    public TimeWindowedCustomer getPreviousCustomer() {
+        return (TimeWindowedCustomer) super.getPreviousCustomer();
+    }
+
     // ************************************************************************
     // Complex methods
     // ************************************************************************

src/main/java/ai/timefold/solver/benchmarks/examples/vehiclerouting/domain/timewindowed/solver/ArrivalTimeUpdatingVariableListener.java

@@ -13,6 +13,7 @@
 import ai.timefold.solver.core.api.solver.SolverFactory;
 import ai.timefold.solver.core.config.score.director.ScoreDirectorFactoryConfig;
 import ai.timefold.solver.core.config.solver.EnvironmentMode;
+import ai.timefold.solver.core.config.solver.PreviewFeature;
 import ai.timefold.solver.core.config.solver.SolverConfig;
 import ai.timefold.solver.core.impl.domain.solution.descriptor.SolutionDescriptor;
 import ai.timefold.solver.core.impl.localsearch.DefaultLocalSearchPhase;
@@ -98,6 +99,7 @@ private Solution_ readOriginalSolution() {
     protected MoveRepository<Solution_> buildMoveRepository(SolutionDescriptor<Solution_> solutionDescriptor) {
         // Build the top-level local search move selector as the solver would've built it.
         var solverConfig = new SolverConfig()
+                .withPreviewFeature(PreviewFeature.DECLARATIVE_SHADOW_VARIABLES)
                 .withEnvironmentMode(EnvironmentMode.PHASE_ASSERT)
                 .withSolutionClass(solutionDescriptor.getSolutionClass())
                 .withEntityClasses(solutionDescriptor.getEntityClassSet().toArray(new Class[0]))

src/main/java/ai/timefold/solver/benchmarks/micro/scoredirector/problems/AbstractProblem.java

@@ -1,5 +1,7 @@
 package ai.timefold.solver.benchmarks.micro.scoredirector.problems;
 
+import java.util.EnumSet;
+
 import ai.timefold.solver.benchmarks.examples.vehiclerouting.domain.Customer;
 import ai.timefold.solver.benchmarks.examples.vehiclerouting.domain.Vehicle;
 import ai.timefold.solver.benchmarks.examples.vehiclerouting.domain.VehicleRoutingSolution;
@@ -11,6 +13,7 @@
 import ai.timefold.solver.benchmarks.micro.scoredirector.Example;
 import ai.timefold.solver.benchmarks.micro.scoredirector.ScoreDirectorType;
 import ai.timefold.solver.core.config.score.director.ScoreDirectorFactoryConfig;
+import ai.timefold.solver.core.config.solver.PreviewFeature;
 import ai.timefold.solver.core.impl.domain.solution.descriptor.SolutionDescriptor;
 import ai.timefold.solver.persistence.common.api.domain.solution.SolutionFileIO;
 
@@ -34,8 +37,8 @@ protected ScoreDirectorFactoryConfig buildScoreDirectorFactoryConfig(ScoreDirect
 
     @Override
     protected SolutionDescriptor<VehicleRoutingSolution> buildSolutionDescriptor() {
-        return SolutionDescriptor.buildSolutionDescriptor(VehicleRoutingSolution.class, Vehicle.class, Customer.class,
-                TimeWindowedCustomer.class);
+        return SolutionDescriptor.buildSolutionDescriptor(EnumSet.of(PreviewFeature.DECLARATIVE_SHADOW_VARIABLES),
+                VehicleRoutingSolution.class, Vehicle.class, Customer.class, TimeWindowedCustomer.class);
     }
 
     @Override

src/main/java/ai/timefold/solver/benchmarks/micro/scoredirector/problems/VehicleRoutingProblem.java

@@ -5,7 +5,7 @@
     <!--<environmentMode>FULL_ASSERT</environmentMode>-->
     <!-- To solve faster by saturating multiple CPU cores -->
     <!--<moveThreadCount>AUTO</moveThreadCount>-->
-
+    <enablePreviewFeature>DECLARATIVE_SHADOW_VARIABLES</enablePreviewFeature>
     <solutionClass>ai.timefold.solver.benchmarks.examples.vehiclerouting.domain.VehicleRoutingSolution</solutionClass>
     <entityClass>ai.timefold.solver.benchmarks.examples.vehiclerouting.domain.Vehicle</entityClass>
     <entityClass>ai.timefold.solver.benchmarks.examples.vehiclerouting.domain.Customer</entityClass>

src/main/resources/ai/timefold/solver/benchmarks/examples/vehiclerouting/vehicleRoutingSolverConfig.xml

@@ -24,6 +24,7 @@ void runConstructionHeuristics(CVRPLIBDataset dataset) {
         var config = CVRPLIBConfiguration.ENTERPRISE_EDITION.getSolverConfig(dataset);
         var phases = config.getPhaseConfigList().subList(0, 1); // Keep only CH.
         config.setPhaseConfigList(phases);
+        config.setMoveThreadCount("1"); // So that the tests can efficiently run in parallel, while still being MT.
 
         var solverFactory = SolverFactory.create(config);
         var solver = solverFactory.buildSolver();

src/test/java/ai/timefold/solver/benchmarks/competitive/cvrplib/CVRPLIBDatasetTest.java

@@ -24,6 +24,7 @@ void runConstructionHeuristics(TSPLIBDataset dataset) {
         var config = TSPLIBConfiguration.ENTERPRISE_EDITION.getSolverConfig(dataset);
         var phases = config.getPhaseConfigList().subList(0, 1); // Keep only CH.
         config.setPhaseConfigList(phases);
+        config.setMoveThreadCount("1"); // So that the tests can efficiently run in parallel, while still being MT.
 
         var solverFactory = SolverFactory.create(config);
         var solver = solverFactory.buildSolver();