chore: set mixed models as a preview feature

Author: zepfred

core/src/main/java/ai/timefold/solver/core/config/solver/PreviewFeature.java

@@ -22,6 +22,7 @@ public enum PreviewFeature {
     DECLARATIVE_SHADOW_VARIABLES,
     DIVERSIFIED_LATE_ACCEPTANCE,
     PLANNING_SOLUTION_DIFF,
+    MIXED_MODELS,
     /**
      * Unlike other preview features, Move Streams are an active research project.
      * It is intended to simplify the creation of custom moves, eventually replacing move selectors.

core/src/main/java/ai/timefold/solver/core/impl/heuristic/HeuristicConfigPolicy.java

@@ -28,7 +28,7 @@
 
 public class HeuristicConfigPolicy<Solution_> {
 
-    private final Set<PreviewFeature> previewFeatureList;
+    private final Set<PreviewFeature> previewFeatureSet;
     private final EnvironmentMode environmentMode;
     private final String logIndentation;
     private final Integer moveThreadCount;
@@ -50,7 +50,7 @@ public class HeuristicConfigPolicy<Solution_> {
     private final Map<String, ValueMimicRecorder<Solution_>> valueMimicRecorderMap = new HashMap<>();
 
     private HeuristicConfigPolicy(Builder<Solution_> builder) {
-        this.previewFeatureList = builder.previewFeatureList;
+        this.previewFeatureSet = builder.previewFeatureSet;
         this.environmentMode = builder.environmentMode;
         this.logIndentation = builder.logIndentation;
         this.moveThreadCount = builder.moveThreadCount;
@@ -134,7 +134,7 @@ public Random getRandom() {
 
     public Builder<Solution_> cloneBuilder() {
         return new Builder<Solution_>()
-                .withPreviewFeatureList(previewFeatureList)
+                .withPreviewFeatureSet(previewFeatureSet)
                 .withEnvironmentMode(environmentMode)
                 .withMoveThreadCount(moveThreadCount)
                 .withMoveThreadBufferSize(moveThreadBufferSize)
@@ -229,11 +229,11 @@ public ThreadFactory buildThreadFactory(ChildThreadType childThreadType) {
     }
 
     public void ensurePreviewFeature(PreviewFeature previewFeature) {
-        ensurePreviewFeature(previewFeature, previewFeatureList);
+        ensurePreviewFeature(previewFeature, previewFeatureSet);
     }
 
-    public static void ensurePreviewFeature(PreviewFeature previewFeature, Collection<PreviewFeature> previewFeatureList) {
-        if (previewFeatureList == null || !previewFeatureList.contains(previewFeature)) {
+    public static void ensurePreviewFeature(PreviewFeature previewFeature, Collection<PreviewFeature> previewFeatureSet) {
+        if (previewFeatureSet == null || !previewFeatureSet.contains(previewFeature)) {
             throw new IllegalStateException("""
                     The preview feature %s is not enabled.
                     Maybe add %s to <enablePreviewFeature> in your configuration file?"""
@@ -248,7 +248,7 @@ public String toString() {
 
     public static class Builder<Solution_> {
 
-        private Set<PreviewFeature> previewFeatureList;
+        private Set<PreviewFeature> previewFeatureSet;
         private EnvironmentMode environmentMode;
         private Integer moveThreadCount;
         private Integer moveThreadBufferSize;
@@ -269,8 +269,8 @@ public static class Builder<Solution_> {
         private Class<? extends NearbyDistanceMeter<?, ?>> nearbyDistanceMeterClass;
         private Random random;
 
-        public Builder<Solution_> withPreviewFeatureList(Set<PreviewFeature> previewFeatureList) {
-            this.previewFeatureList = previewFeatureList;
+        public Builder<Solution_> withPreviewFeatureSet(Set<PreviewFeature> previewFeatureSet) {
+            this.previewFeatureSet = previewFeatureSet;
             return this;
         }
 

core/src/main/java/ai/timefold/solver/core/impl/solver/DefaultSolverFactory.java

@@ -131,7 +131,7 @@ public <Score_ extends Score<Score_>> ScoreDirectorFactory<Solution_, Score_> ge
         var previewFeaturesEnabled = solverConfig.getEnablePreviewFeatureSet();
 
         var configPolicy = new HeuristicConfigPolicy.Builder<Solution_>()
-                .withPreviewFeatureList(previewFeaturesEnabled)
+                .withPreviewFeatureSet(previewFeaturesEnabled)
                 .withEnvironmentMode(environmentMode)
                 .withMoveThreadCount(moveThreadCount)
                 .withMoveThreadBufferSize(solverConfig.getMoveThreadBufferSize())
@@ -142,6 +142,9 @@ public <Score_ extends Score<Score_>> ScoreDirectorFactory<Solution_, Score_> ge
                 .withSolutionDescriptor(solutionDescriptor)
                 .withClassInstanceCache(ClassInstanceCache.create())
                 .build();
+        if (solutionDescriptor.hasBothBasicAndListVariables()) {
+            configPolicy.ensurePreviewFeature(PreviewFeature.MIXED_MODELS);
+        }
         var basicPlumbingTermination = new BasicPlumbingTermination<Solution_>(isDaemon);
         var termination = buildTermination(basicPlumbingTermination, configPolicy, configOverride);
         var phaseList = buildPhaseList(configPolicy, bestSolutionRecaller, termination);

core/src/test/java/ai/timefold/solver/core/impl/constructionheuristic/placer/entity/QueuedMultiplePlacerFactoryTest.java

@@ -78,6 +78,7 @@ void testPlacersForConstructionHeuristic() {
 
         placer.solvingStarted(solverScope);
         var phaseScope = mock(AbstractPhaseScope.class);
+        when(phaseScope.getSolverScope()).thenReturn(solverScope);
         when(phaseScope.getScoreDirector()).thenReturn(scoreDirector);
         placer.phaseStarted(phaseScope);
 
@@ -195,6 +196,7 @@ void testPinnedPlacersForConstructionHeuristic() {
 
         placer.solvingStarted(solverScope);
         var phaseScope = mock(AbstractPhaseScope.class);
+        when(phaseScope.getSolverScope()).thenReturn(solverScope);
         when(phaseScope.getScoreDirector()).thenReturn(scoreDirector);
         placer.phaseStarted(phaseScope);
 

core/src/test/java/ai/timefold/solver/core/impl/solver/DefaultSolverTest.java

@@ -1643,6 +1643,7 @@ void solveMixedModel() {
         var solverConfig = PlannerTestUtils.buildSolverConfig(
                 TestdataMixedSolution.class, TestdataMixedEntity.class, TestdataMixedValue.class,
                 TestdataMixedOtherValue.class)
+                .withPreviewFeature(PreviewFeature.MIXED_MODELS)
                 .withPhases(new ConstructionHeuristicPhaseConfig(),
                         new LocalSearchPhaseConfig().withTerminationConfig(new TerminationConfig().withStepCountLimit(16)))
                 .withEasyScoreCalculatorClass(TestdataMixedEasyScoreCalculator.class);
@@ -1669,6 +1670,7 @@ void solveMixedModelWithSortManner(Pair<EntitySorterManner, ValueSorterManner> s
         var solverConfig = PlannerTestUtils.buildSolverConfig(
                 TestdataMixedSolution.class, TestdataMixedEntity.class, TestdataMixedValue.class,
                 TestdataMixedOtherValue.class)
+                .withPreviewFeature(PreviewFeature.MIXED_MODELS)
                 .withPhases(new ConstructionHeuristicPhaseConfig(),
                         new LocalSearchPhaseConfig()
                                 .withMoveSelectorConfig(
@@ -1699,6 +1701,7 @@ void solvePinnedMixedModel() {
         var solverConfig = PlannerTestUtils.buildSolverConfig(
                 TestdataMixedSolution.class, TestdataMixedEntity.class, TestdataMixedValue.class,
                 TestdataMixedOtherValue.class)
+                .withPreviewFeature(PreviewFeature.MIXED_MODELS)
                 .withPhases(new ConstructionHeuristicPhaseConfig())
                 .withEasyScoreCalculatorClass(TestdataMixedEasyScoreCalculator.class);
 
@@ -1717,6 +1720,7 @@ void solvePinnedMixedModel() {
     void solveUnassignedMixedModel() {
         var solverConfig = PlannerTestUtils.buildSolverConfig(
                 TestdataUnassignedMixedSolution.class, TestdataUnassignedMixedEntity.class)
+                .withPreviewFeature(PreviewFeature.MIXED_MODELS)
                 .withPhases(new ConstructionHeuristicPhaseConfig(),
                         new LocalSearchPhaseConfig().withTerminationConfig(new TerminationConfig().withStepCountLimit(16)))
                 .withEasyScoreCalculatorClass(TestdataUnassignedMixedEasyScoreCalculator.class);
@@ -1743,6 +1747,7 @@ void solveUnassignedMixedModel() {
     void solvePinnedAndUnassignedMixedModel() {
         var solverConfig = PlannerTestUtils.buildSolverConfig(
                 TestdataUnassignedMixedSolution.class, TestdataUnassignedMixedEntity.class)
+                .withPreviewFeature(PreviewFeature.MIXED_MODELS)
                 .withPhases(new ConstructionHeuristicPhaseConfig(),
                         new LocalSearchPhaseConfig().withTerminationConfig(new TerminationConfig().withStepCountLimit(16)))
                 .withEasyScoreCalculatorClass(TestdataUnassignedMixedEasyScoreCalculator.class);
@@ -1805,6 +1810,7 @@ void solveCustomConfigMixedModel() {
         var solverConfig = PlannerTestUtils.buildSolverConfig(
                 TestdataMixedSolution.class, TestdataMixedEntity.class, TestdataMixedValue.class,
                 TestdataMixedOtherValue.class)
+                .withPreviewFeature(PreviewFeature.MIXED_MODELS)
                 .withPhases(new ConstructionHeuristicPhaseConfig()
                         .withEntityPlacerConfigList(valuePlacerConfig, entityPlacerConfig),
                         new LocalSearchPhaseConfig().withTerminationConfig(new TerminationConfig().withStepCountLimit(16)))
@@ -1866,6 +1872,7 @@ void solveMoveConfigMixedModel(MoveSelectorConfig moveSelectionConfig) {
         var solverConfig = PlannerTestUtils.buildSolverConfig(
                 TestdataMixedSolution.class, TestdataMixedEntity.class, TestdataMixedValue.class,
                 TestdataMixedOtherValue.class)
+                .withPreviewFeature(PreviewFeature.MIXED_MODELS)
                 .withPhases(new ConstructionHeuristicPhaseConfig(), localSearchConfig)
                 .withEasyScoreCalculatorClass(TestdataMixedEasyScoreCalculator.class);
 
@@ -1938,6 +1945,7 @@ void solveMultiEntityMoveConfigMixedModel(MoveSelectorConfig moveSelectionConfig
         var solverConfig = PlannerTestUtils.buildSolverConfig(
                 TestdataMixedMultiEntitySolution.class, TestdataMixedMultiEntityFirstEntity.class,
                 TestdataMixedMultiEntitySecondEntity.class)
+                .withPreviewFeature(PreviewFeature.MIXED_MODELS)
                 .withPhases(constructionHeuristicConfig, localSearchConfig)
                 .withEasyScoreCalculatorClass(TestdataMixedEntityEasyScoreCalculator.class);