added bound comparison

Author: zaibod

src/main/java/edu/kit/provideq/toolbox/BoundType.java

@@ -7,9 +7,21 @@ public enum BoundType {
   /**
    * An upper bound.
    */
-  UPPER,
+  UPPER {
+    @Override
+    public int compare(int bound, int actual) {
+      return 1 - (bound / actual);
+    }
+  },
   /**
    * A lower bound.
    */
-  LOWER
+  LOWER {
+    @Override
+    public int compare(int bound, int actual) {
+      return actual / bound - 1;
+    }
+  };
+
+  public abstract int compare(int bound, int actual);
 }

src/main/java/edu/kit/provideq/toolbox/api/EstimationRouter.java

@@ -10,13 +10,15 @@
 import static org.springframework.web.reactive.function.server.RequestPredicates.accept;
 import static org.springframework.web.reactive.function.server.ServerResponse.ok;
 
+import com.google.common.collect.Streams;
 import edu.kit.provideq.toolbox.meta.Problem;
 import edu.kit.provideq.toolbox.meta.ProblemManager;
 import edu.kit.provideq.toolbox.meta.ProblemManagerProvider;
 import edu.kit.provideq.toolbox.meta.ProblemType;
 import io.swagger.v3.oas.annotations.enums.ParameterIn;
 import java.util.NoSuchElementException;
 import java.util.UUID;
+import java.util.regex.Pattern;
 import org.springdoc.core.fn.builders.operation.Builder;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.context.annotation.Bean;
@@ -42,10 +44,15 @@ public class EstimationRouter {
 
   @Bean
   RouterFunction<ServerResponse> getEstimationRoutes() {
-    return managerProvider.getProblemManagers().stream()
-            .filter(manager -> manager.getType().getEstimator().isPresent())
-            .map(this::defineGetRoute)
-            .reduce(RouterFunction::and)
+    var managers = managerProvider.getProblemManagers();
+    return Streams.concat(
+            managers.stream()
+                    .filter(manager -> manager.getType().getEstimator().isPresent())
+                    .map(this::defineGetRoute),
+            managers.stream()
+                    .filter(manager -> manager.getType().getSolutionPattern() != null)
+                    .map(this::defineCompareRoute)
+    ).reduce(RouterFunction::and)
             .orElse(null);
   }
 
@@ -61,6 +68,18 @@ private RouterFunction<ServerResponse> defineGetRoute(ProblemManager<?, ?> manag
     ).build();
   }
 
+  /**
+   * Compare Operation: GET /problems/TYPE/{problemId}/bound/compare.
+   */
+  private RouterFunction<ServerResponse> defineCompareRoute(ProblemManager<?, ?> manager) {
+    return route().GET(
+            getCompareRouteForProblemType(manager.getType()),
+            accept(APPLICATION_JSON),
+            req -> handleCompare(manager, req),
+            ops -> handleCompareDocumentation(manager, ops)
+    ).build();
+  }
+
   private <InputT, ResultT> Mono<ServerResponse> handleGet(
           ProblemManager<InputT, ResultT> manager,
           ServerRequest req
@@ -80,6 +99,37 @@ private <InputT, ResultT> Mono<ServerResponse> handleGet(
     });
   }
 
+  private <InputT, ResultT> Mono<ServerResponse> handleCompare(
+          ProblemManager<InputT, ResultT> manager,
+          ServerRequest req
+  ) {
+    var problemId = req.pathVariable(PROBLEM_ID_PARAM_NAME);
+    var problem = findProblemOrThrow(manager, problemId);
+
+    if (problem.getSolution() == null) {
+      throw new ResponseStatusException(HttpStatus.BAD_REQUEST, "Problem not solved yet!");
+    }
+
+    if (problem.getBound().isEmpty()) {
+      throw new ResponseStatusException(HttpStatus.BAD_REQUEST, "Bound not estimated yet!");
+    }
+
+    int bound = Integer.parseInt(problem.getBound().get().bound().value());
+    var pattern = Pattern.compile(manager.getType().getSolutionPattern());
+    var solutionMatcher = pattern.matcher(problem.getSolution().getSolutionData().toString());
+    int solutionValue;
+    if (solutionMatcher.find()) {
+      solutionValue = Integer.parseInt(solutionMatcher.group(1));
+    } else {
+      throw new ResponseStatusException(HttpStatus.BAD_REQUEST, "Could not parse solution value!");
+    }
+
+    Integer comparison = problem.getBound().get().bound().boundType().compare(bound, solutionValue);
+
+    return ok().body(Mono.just(comparison), new ParameterizedTypeReference<>() {
+    });
+  }
+
   private void handleGetDocumentation(
           ProblemManager<?, ?> manager,
           Builder ops
@@ -96,12 +146,35 @@ private void handleGetDocumentation(
         );
   }
 
+  private void handleCompareDocumentation(
+          ProblemManager<?, ?> manager,
+          Builder ops
+  ) {
+    ProblemType<?, ?> problemType = manager.getType();
+    ops
+        .operationId(getCompareRouteForProblemType(problemType))
+        .tag(problemType.getId())
+        .description("Compares the solution value with the bound for "
+                + "the problem with the given ID.")
+        .parameter(parameterBuilder().in(ParameterIn.PATH).name(PROBLEM_ID_PARAM_NAME))
+        .response(responseBuilder()
+              .responseCode(String.valueOf(HttpStatus.OK.value()))
+              .content(getOkResponseContent())
+        );
+  }
+
   private static org.springdoc.core.fn.builders.content.Builder getOkResponseContent() {
     return contentBuilder()
             .mediaType(APPLICATION_JSON_VALUE)
             .schema(schemaBuilder().implementation(BoundDto.class));
   }
 
+  private static org.springdoc.core.fn.builders.content.Builder getComparisonResponseContent() {
+    return contentBuilder()
+            .mediaType(APPLICATION_JSON_VALUE)
+            .schema(schemaBuilder().implementation(Integer.class));
+  }
+
   private <InputT, ResultT> Problem<InputT, ResultT> findProblemOrThrow(
           ProblemManager<InputT, ResultT> manager,
           String id
@@ -122,6 +195,10 @@ private String getEstimationRouteForProblemType(ProblemType<?, ?> type) {
     return "/problems/%s/{%s}/bound".formatted(type.getId(), PROBLEM_ID_PARAM_NAME);
   }
 
+  private String getCompareRouteForProblemType(ProblemType<?, ?> type) {
+    return getEstimationRouteForProblemType(type) + "/compare";
+  }
+
   @Autowired
   void setManagerProvider(ProblemManagerProvider managerProvider) {
     this.managerProvider = managerProvider;

src/main/java/edu/kit/provideq/toolbox/demonstrators/DemonstratorConfiguration.java

@@ -17,6 +17,7 @@ public class DemonstratorConfiguration {
       "demonstrator",
       String.class,
       String.class,
+      null,
       null
   );
 

src/main/java/edu/kit/provideq/toolbox/featuremodel/anomaly/dead/DeadFeatureConfiguration.java

@@ -27,6 +27,7 @@ public class DeadFeatureConfiguration {
       "feature-model-anomaly-dead",
       String.class,
       String.class,
+      null,
       null
   );
 

src/main/java/edu/kit/provideq/toolbox/featuremodel/anomaly/voidmodel/VoidModelConfiguration.java

@@ -27,6 +27,7 @@ public class VoidModelConfiguration {
       "feature-model-anomaly-void",
       String.class,
       String.class,
+      null,
       null
   );
 

src/main/java/edu/kit/provideq/toolbox/knapsack/KnapsackConfiguration.java

@@ -1,5 +1,7 @@
 package edu.kit.provideq.toolbox.knapsack;
 
+import edu.kit.provideq.toolbox.Bound;
+import edu.kit.provideq.toolbox.BoundType;
 import edu.kit.provideq.toolbox.ResourceProvider;
 import edu.kit.provideq.toolbox.exception.MissingExampleException;
 import edu.kit.provideq.toolbox.knapsack.solvers.PythonKnapsackSolver;
@@ -8,8 +10,14 @@
 import edu.kit.provideq.toolbox.meta.ProblemManager;
 import edu.kit.provideq.toolbox.meta.ProblemType;
 import java.io.IOException;
+import java.util.AbstractMap;
+import java.util.ArrayList;
+import java.util.Comparator;
+import java.util.List;
+import java.util.Map;
 import java.util.Objects;
 import java.util.Set;
+import java.util.function.Function;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 
@@ -18,6 +26,41 @@
  */
 @Configuration
 public class KnapsackConfiguration {
+  /**
+   * an upper bound estimator by solving the greedy fractional knapsack problem.
+   */
+  private static final Function<String, Bound> estimator = input -> {
+    var parts = input.split("\n");
+    var weightLimit = Integer.parseInt(parts[parts.length - 1]);
+    // map item value to item weight
+    List<Map.Entry<Integer, Integer>> items = new ArrayList<>();
+    for (int i = 1; i < parts.length - 1; i++) {
+      var item = parts[i].split(" ");
+      items.add(new AbstractMap.SimpleEntry<>(
+              Integer.parseInt(item[1]),
+              Integer.parseInt(item[2]))
+      );
+    }
+    items.sort(Comparator.comparingInt(a -> -a.getKey() / a.getValue()));
+    // keep adding items until the weight limit is reached, then add a fraction of the next item
+    int bound = 0;
+    int currentWeight = 0;
+    while (currentWeight < weightLimit) {
+      var item = items.remove(0);
+      var value = item.getKey();
+      var weight = item.getValue();
+      if (currentWeight + weight <= weightLimit) {
+        bound += value;
+        currentWeight += weight;
+      } else {
+        var fraction = (weightLimit - currentWeight) / (double) weight;
+        bound += (int) (fraction * value);
+        break;
+      }
+    }
+    return new Bound(String.valueOf(bound), BoundType.UPPER);
+  };
+
   /**
    * An optimization problem:
    * For given items each with a weight and value, determine which items are part of a collection
@@ -28,7 +71,8 @@ public class KnapsackConfiguration {
       "knapsack",
         String.class,
         String.class,
-        null
+        estimator,
+        "^(\\d+)"
     );
 
   @Bean

src/main/java/edu/kit/provideq/toolbox/maxcut/MaxCutConfiguration.java

@@ -28,6 +28,7 @@ public class MaxCutConfiguration {
       "max-cut",
       String.class,
       String.class,
+      null,
       null
   );
 

src/main/java/edu/kit/provideq/toolbox/meta/ProblemType.java

@@ -12,6 +12,7 @@ public class ProblemType<InputT, ResultT> {
   private final Class<InputT> inputClass;
   private final Class<ResultT> resultClass;
   private final Function<InputT, Bound> estimator;
+  private final String solutionPattern;
 
   /**
    * Defines a new problem type.
@@ -26,12 +27,14 @@ public ProblemType(
       String id,
       Class<InputT> inputClass,
       Class<ResultT> resultClass,
-      Function<InputT, Bound> estimator
+      Function<InputT, Bound> estimator,
+      String solutionPattern
   ) {
     this.id = id;
     this.inputClass = inputClass;
     this.resultClass = resultClass;
     this.estimator = estimator;
+    this.solutionPattern = solutionPattern;
   }
 
   /**
@@ -62,6 +65,10 @@ public Optional<Function<InputT, Bound>> getEstimator() {
     return Optional.ofNullable(estimator);
   }
 
+  public String getSolutionPattern() {
+    return solutionPattern;
+  }
+
   @Override
   public String toString() {
     return "ProblemType{"

src/main/java/edu/kit/provideq/toolbox/qubo/QuboConfiguration.java

@@ -29,6 +29,7 @@ public class QuboConfiguration {
       "qubo",
       String.class,
       String.class,
+      null,
       null
   );
 

src/main/java/edu/kit/provideq/toolbox/sat/SatConfiguration.java

@@ -26,6 +26,7 @@ public class SatConfiguration {
       "sat",
       String.class,
       DimacsCnfSolution.class,
+      null,
       null
   );