Refactor search strategy to improve readability

4 files changed, 34 insertions, 62 deletions

diff --git a/subprojects/store-dse/src/main/java/tools/refinery/store/dse/Strategy.java b/subprojects/store-dse/src/main/java/tools/refinery/store/dse/Strategy.java
index 409fe8a6..c60a4410 100644
--- a/subprojects/store-dse/src/main/java/tools/refinery/store/dse/Strategy.java
+++ b/subprojects/store-dse/src/main/java/tools/refinery/store/dse/Strategy.java
@@ -7,7 +7,7 @@ package tools.refinery.store.dse;
 
 public interface Strategy {
 
-        void initStrategy(DesignSpaceExplorationAdapter designSpaceExplorationAdapter);
+        void initialize(DesignSpaceExplorationAdapter designSpaceExplorationAdapter);
 
         void explore();
 }
diff --git a/subprojects/store-dse/src/main/java/tools/refinery/store/dse/internal/DesignSpaceExplorationAdapterImpl.java b/subprojects/store-dse/src/main/java/tools/refinery/store/dse/internal/DesignSpaceExplorationAdapterImpl.java
index 008b2dab..04bba885 100644
--- a/subprojects/store-dse/src/main/java/tools/refinery/store/dse/internal/DesignSpaceExplorationAdapterImpl.java
+++ b/subprojects/store-dse/src/main/java/tools/refinery/store/dse/internal/DesignSpaceExplorationAdapterImpl.java
@@ -52,10 +52,6 @@ public class DesignSpaceExplorationAdapterImpl implements DesignSpaceExploration
 
         private final Map<Version, Fitness> fitnessCache = new HashMap<>();
 
-        public List<Version> getTrajectory() {
-                return new ArrayList<>(trajectory);
-        }
-
         public DesignSpaceExplorationAdapterImpl(Model model, DesignSpaceExplorationStoreAdapterImpl storeAdapter) {
                 this.model = model;
                 this.storeAdapter = storeAdapter;
@@ -75,11 +71,16 @@ public class DesignSpaceExplorationAdapterImpl implements DesignSpaceExploration
                 objectives = storeAdapter.getObjectives();
                 statesAndTraversedActivations = new HashMap<>();
                 strategy = storeAdapter.getStrategy();
+                strategy.initialize(this);
                 modelVisualizerAdapter = model.tryGetAdapter(ModelVisualizerAdapter.class).orElse(null);
                 isVisualizationEnabled = modelVisualizerAdapter != null;
 
         }
 
+        public List<Version> getTrajectory() {
+                return new ArrayList<>(trajectory);
+        }
+
         @Override
         public Model getModel() {
                 return model;
@@ -94,7 +95,6 @@ public class DesignSpaceExplorationAdapterImpl implements DesignSpaceExploration
         public List<Version> explore() {
                 var state = model.commit();
                 trajectory.add(state);
-                strategy.initStrategy(this);
                 strategy.explore();
                 if (isVisualizationEnabled) {
                         modelVisualizerAdapter.visualize();
diff --git a/subprojects/store-dse/src/main/java/tools/refinery/store/dse/strategy/BestFirstStrategy.java b/subprojects/store-dse/src/main/java/tools/refinery/store/dse/strategy/BestFirstStrategy.java
index 0883d3d7..047b204a 100644
--- a/subprojects/store-dse/src/main/java/tools/refinery/store/dse/strategy/BestFirstStrategy.java
+++ b/subprojects/store-dse/src/main/java/tools/refinery/store/dse/strategy/BestFirstStrategy.java
@@ -22,8 +22,8 @@ public class BestFirstStrategy implements Strategy {
 
         private DesignSpaceExplorationAdapter dseAdapter;
 
-        private final int maxDepth;
-        private final int maxSolutions;
+        private int maxDepth = Integer.MAX_VALUE;
+        private int maxSolutions = Integer.MAX_VALUE;
         private boolean backTrackIfSolution = true;
         private boolean onlyBetterFirst = false;
 
@@ -50,25 +50,18 @@ public class BestFirstStrategy implements Strategy {
                 }
         }
 
-        public BestFirstStrategy() {
-                this(-1);
-        }
-
-        public BestFirstStrategy(int maxDepth) {
-                this(maxDepth, -1);
-        }
-
-        public BestFirstStrategy(int maxDepth, int maxSolutions) {
-                if (maxDepth < 0) {
-                        this.maxDepth = Integer.MAX_VALUE;
-                } else {
+        public BestFirstStrategy withDepthLimit(int maxDepth) {
+                if (maxDepth >= 0) {
                         this.maxDepth = maxDepth;
                 }
-                if (maxSolutions < 0) {
-                        this.maxSolutions = Integer.MAX_VALUE;
-                } else {
+                return this;
+        }
+
+        public BestFirstStrategy withSolutionLimit(int maxSolutions) {
+                if (maxSolutions >= 0) {
                         this.maxSolutions = maxSolutions;
                 }
+                return this;
         }
 
         public BestFirstStrategy continueIfHardObjectivesFulfilled() {
@@ -82,7 +75,7 @@ public class BestFirstStrategy implements Strategy {
         }
 
         @Override
-        public void initStrategy(DesignSpaceExplorationAdapter designSpaceExplorationAdapter) {
+        public void initialize(DesignSpaceExplorationAdapter designSpaceExplorationAdapter) {
                 this.dseAdapter = designSpaceExplorationAdapter;
                 final ObjectiveComparatorHelper objectiveComparatorHelper = dseAdapter.getObjectiveComparatorHelper();
 
diff --git a/subprojects/store-dse/src/main/java/tools/refinery/store/dse/strategy/DepthFirstStrategy.java b/subprojects/store-dse/src/main/java/tools/refinery/store/dse/strategy/DepthFirstStrategy.java
index 425e1e01..5f7f61b8 100644
--- a/subprojects/store-dse/src/main/java/tools/refinery/store/dse/strategy/DepthFirstStrategy.java
+++ b/subprojects/store-dse/src/main/java/tools/refinery/store/dse/strategy/DepthFirstStrategy.java
@@ -1,12 +1,8 @@
-/*******************************************************************************
- * Copyright (c) 2010-2016, Andras Szabolcs Nagy, Zoltan Ujhelyi and Daniel Varro
- * Copyright (c) 2023 The Refinery Authors <https://refinery.tools/>
- * This program and the accompanying materials are made available under the
- * terms of the Eclipse Public License v. 2.0 which is available at
- * http://www.eclipse.org/legal/epl-v20.html.
+/*
+ * SPDX-FileCopyrightText: 2021-2023 The Refinery Authors <https://refinery.tools/>
  *
  * SPDX-License-Identifier: EPL-2.0
- *******************************************************************************/
+ */
 package tools.refinery.store.dse.strategy;
 
 import tools.refinery.store.dse.DesignSpaceExplorationAdapter;
@@ -17,38 +13,31 @@ public class DepthFirstStrategy implements Strategy {
 
         private DesignSpaceExplorationAdapter dseAdapter;
 
-        private int maxDepth;
-        private int maxSolutions;
-        private boolean backTrackIfSolution = true;
+        private int maxDepth = Integer.MAX_VALUE;
+        private int maxSolutions = Integer.MAX_VALUE;
+        private boolean backtrackFromSolution = true;
 
-        public DepthFirstStrategy() {
-                this(-1);
-        }
-
-        public DepthFirstStrategy(int maxDepth) {
-                this(maxDepth, -1);
-        }
-
-        public DepthFirstStrategy(int maxDepth, int maxSolutions) {
-                if (maxDepth < 0) {
-                        this.maxDepth = Integer.MAX_VALUE;
-                } else {
+        public DepthFirstStrategy withDepthLimit(int maxDepth) {
+                if (maxDepth >= 0) {
                         this.maxDepth = maxDepth;
                 }
-                if (maxSolutions < 0) {
-                        this.maxSolutions = Integer.MAX_VALUE;
-                } else {
+                return this;
+        }
+
+        public DepthFirstStrategy withSolutionLimit(int maxSolutions) {
+                if (maxSolutions >= 0) {
                         this.maxSolutions = maxSolutions;
                 }
+                return this;
         }
 
         public DepthFirstStrategy continueIfHardObjectivesFulfilled() {
-                backTrackIfSolution = false;
+                backtrackFromSolution = false;
                 return this;
         }
 
         @Override
-        public void initStrategy(DesignSpaceExplorationAdapter designSpaceExplorationAdapter) {
+        public void initialize(DesignSpaceExplorationAdapter designSpaceExplorationAdapter) {
                 this.dseAdapter = designSpaceExplorationAdapter;
         }
 
@@ -59,22 +48,18 @@ public class DepthFirstStrategy implements Strategy {
                 }
                 while (dseAdapter.getSolutions().size() < maxSolutions) {
                         if (!checkAndHandleGlobalConstraints()) {
-                                // Global constraint is not satisfied and cannot backtrack.
                                 return;
                         }
-                        // Global constraint is not satisfied, backtrack.
 
                         Fitness fitness = dseAdapter.getFitness();
                         if (fitness.isSatisfiesHardObjectives()) {
                                 dseAdapter.newSolution();
-                                if (backTrackIfSolution && !dseAdapter.backtrack()) {
-                                        // Found a solution but cannot backtrack.
+                                if (backtrackFromSolution && !dseAdapter.backtrack()) {
                                         return;
                                 }
                         }
 
                         if (!checkAndHandleDepth()) {
-                                // Reached max depth but cannot backtrack.
                                 return;
                         }
 
@@ -87,24 +72,18 @@ public class DepthFirstStrategy implements Strategy {
         }
 
         private boolean checkAndHandleGlobalConstraints() {
-                // Global constraint is not satisfied and cannot backtrack.
                 return dseAdapter.checkGlobalConstraints() || dseAdapter.backtrack();
-                // Global constraint is satisfied or backtrack.
         }
 
         private boolean checkAndHandleDepth() {
-                // Reached max depth but cannot backtrack.
                 return dseAdapter.getDepth() < maxDepth || dseAdapter.backtrack();
-                // Reached max depth or backtrack.
         }
 
         private boolean backtrackToLastUntraversed() {
                 while (dseAdapter.getUntraversedActivations().isEmpty()) {
                         if (!dseAdapter.backtrack()) {
-                                // No more transitions from current state and cannot backtrack.
                                 return false;
                         }
-                        // No more transitions from current state, backtrack.
                 }
                 return true;
         }