Merge branch 'master' of https://github.com/mork-optimization/mork

Author: rmartinsanta

.github/workflows/build.yml

@@ -1,4 +1,4 @@
-name: Build
+name: Sonar analysis and build
 on:
   push:
     branches:

.github/workflows/docs.yml

@@ -0,0 +1,52 @@
+name: Publish docs 
+
+on:
+  push:
+    branches:
+      - master 
+permissions:
+  contents: write
+  pages: write
+  id-token: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+          cache: 'pip'
+      - run: pip install -r mkdocs-requirements.txt
+      
+      - name: Set up JDK 21
+        uses: graalvm/setup-graalvm@v1
+        with:
+          java-version: '21'
+          distribution: 'graalvm'
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+      - name: Cache Maven packages
+        uses: actions/cache@v4
+        with:
+          path: ~/.m2
+          key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
+          restore-keys: ${{ runner.os }}-m2
+
+      - run: mvn compile javadoc:javadoc javadoc:aggregate
+      - run: mkdocs build
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: site/
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{steps.deployment.outputs.page_url}}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -41,4 +41,12 @@ hs_err_pid*
 target
 .DS_Store
 
-venv
+venv
+
+docs/apidocs
+solutions*
+results*
+log*
+.benchmark
+**/docs
+/example-graphs/instances/

CHANGELOG.md

@@ -1,6 +1,10 @@
 # Developing
+
+# v0.22
+- (Breaking) Simplify VNS implementation. New doc page for VNS.
 - (Fix) Irace integration with v4.2
 - (Fix) #228: Instance selector failed to copy instances if they were not in the root instance folder
+- (New) #129: New Excel serializer, allows users to extend the raw data and should have better performance in most cases.
 
 # v0.21
 - (New) Objective class: a class that represents an objective function of a problem. Each Objective has a name, a direction (minimize or maximize), and functions for extracting the value of the objective from Moves and from Solutions. See docs for a detailed description.

CNAME

@@ -0,0 +1 @@
+docs.mork-optimization.com

aggregate-report/pom.xml

@@ -17,27 +17,39 @@
         <dependency>
             <groupId>es.urjc.etsii.grafo</groupId>
             <artifactId>autoconfig</artifactId>
-            <version>0.22-SNAPSHOT</version>
         </dependency>
         <dependency>
             <groupId>es.urjc.etsii.grafo</groupId>
             <artifactId>mork-common</artifactId>
-            <version>0.22-SNAPSHOT</version>
         </dependency>
         <dependency>
             <groupId>es.urjc.etsii.grafo</groupId>
             <artifactId>mork</artifactId>
-            <version>0.22-SNAPSHOT</version>
         </dependency>
         <dependency>
             <groupId>es.urjc.etsii.grafo</groupId>
-            <artifactId>TSP</artifactId>
-            <version>0.22-SNAPSHOT</version>
+            <artifactId>tsp</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>es.urjc.etsii.grafo</groupId>
+            <artifactId>graphs</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>es.urjc.etsii.grafo</groupId>
+            <artifactId>bmssc</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>es.urjc.etsii.grafo</groupId>
+            <artifactId>flayouts</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>es.urjc.etsii.grafo</groupId>
+            <artifactId>vrpod</artifactId>
         </dependency>
         <dependency>
             <groupId>es.urjc.etsii.grafo</groupId>
             <artifactId>integration-tests</artifactId>
-            <version>0.22-SNAPSHOT</version>
+            <scope>test</scope>
         </dependency>
     </dependencies>
 
@@ -46,7 +58,7 @@
             <plugin>
                 <groupId>org.jacoco</groupId>
                 <artifactId>jacoco-maven-plugin</artifactId>
-                <version>0.8.12</version>
+                <version>${mjacoco.version}</version>
                 <executions>
                     <execution>
                         <id>jacoco-report-aggregate</id>

autoconfig/src/main/java/es/urjc/etsii/grafo/autoconfig/controller/AutoconfigDebugController.java

@@ -10,7 +10,6 @@
 import es.urjc.etsii.grafo.autoconfig.irace.IraceRuntimeConfiguration;
 import es.urjc.etsii.grafo.config.SolverConfig;
 import jakarta.servlet.http.HttpServletRequest;
-import org.springframework.context.annotation.Profile;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.RestController;
 
@@ -72,11 +71,50 @@ public Object getInventory(){
         return this.inventory.getInventory();
     }
 
+    @GetMapping("/auto/debug/toIraceConfig/**")
+    public Object toIraceConfig(HttpServletRequest request){
+        String url = request.getRequestURI();
+        String[] parts = url.split("/toIraceConfig/");
+        if(parts.length != 2){
+            return Map.of("error", "Invalid URL format. Expected format: /toIraceConfig/{commandLine}");
+        }
+        String cmdline = URLDecoder.decode(parts[1], StandardCharsets.UTF_8);
+        cmdline = cleanCmdLine(cmdline);
+        Map<String, String> params = extractParameters(cmdline);
+        var line1 = new StringBuilder();
+        var line2 = new StringBuilder();
+        for(var entry: params.entrySet()){
+            line1.append(entry.getKey()).append("\t");
+            line2.append(entry.getValue()).append("\t");
+        }
+        return Map.of("iraceConfig", line1.toString().trim() + "\n" + line2.toString().trim());
+    }
+
+    private static Map<String, String> extractParameters(String cmdline) {
+        Map<String, String> params = new LinkedHashMap<>();
+        for(var pair: cmdline.split("\\s+")) {
+            if (pair.contains("=")) {
+                var parts = pair.split("=");
+                if (parts.length == 2) {
+                    params.put(parts[0], parts[1]);
+                } else {
+                    throw new IllegalArgumentException("Invalid parameter format: " + pair);
+                }
+            } else {
+                throw new IllegalArgumentException("Parameter without value: " + pair);
+            }
+        }
+        return params;
+    }
+
     @GetMapping("/auto/debug/decode/**")
     public Object decode(HttpServletRequest request){
         String url = request.getRequestURI();
-        String cmdline = url.split("/decode/")[1];
-        cmdline = URLDecoder.decode(cmdline, StandardCharsets.UTF_8);
+        String[] parts = url.split("/decode/");
+        if(parts.length != 2){
+            return Map.of("error", "Invalid URL format. Expected format: /toIraceConfig/{commandLine}");
+        }
+        String cmdline = URLDecoder.decode(parts[1], StandardCharsets.UTF_8);
         cmdline = cleanCmdLine(cmdline);
 
         var config = cmdline.startsWith("ROOT")?

autoconfig/src/test/java/es/urjc/etsii/grafo/autoconfig/testutil/ComponentWhitelistDuringTesting.java

@@ -1,7 +1,7 @@
 package es.urjc.etsii.grafo.autoconfig.testutil;
 
 import es.urjc.etsii.grafo.algorithms.SimpleAlgorithm;
-import es.urjc.etsii.grafo.algorithms.VNS;
+import es.urjc.etsii.grafo.algorithms.vns.VNS;
 import es.urjc.etsii.grafo.algorithms.multistart.MultiStartAlgorithm;
 import es.urjc.etsii.grafo.autoconfig.fakecomponents.*;
 import es.urjc.etsii.grafo.autoconfig.inventory.WhitelistInventoryFilter;

autoconfig/src/test/resources/serializers.yml

@@ -51,10 +51,6 @@ serializers:
     # Enable XLSX results serializer, set to false to skip serializing results to Excel 2007+
     enabled: true
 
-    # Defines how to handle calculated values when serializing to Excel 2007+
-    # Possible values: java, excel, auto.
-    calculationMode: auto
-
     # When generating the pivot table, should algorithms be in rows or columns?
     # True: Instances per row, algorithms in columns
     # False: Algorithms in rows, instances in columns

common/src/main/java/es/urjc/etsii/grafo/algorithms/SimpleAlgorithm.java

@@ -61,12 +61,24 @@ public SimpleAlgorithm(
      */
     @Override
     public S algorithm(I instance) {
+        var solution = constructive(instance);
+        solution = localSearch(solution);
+        return solution;
+    }
+
+    /**
+     * <p>Construct a solution first by calling the correct Java constructor and then
+     * initialize it using the provided constructive method.</p>
+     *
+     * @param instance a I object.
+     * @return a S object.
+     */
+    protected S constructive(I instance) {
         var solution = this.newSolution(instance);
         solution = constructive.construct(solution);
         assert Context.validate(solution);
         Metrics.addCurrentObjectives(solution);
         printStatus("Constructive", solution);
-        solution = localSearch(solution);
         return solution;
     }