Changeset 15229 for branches/BinPackingExtension/HeuristicLab.Problems.BinPacking/3.3/Algorithms

Timestamp:

07/13/17 15:22:59 (7 years ago)

Author:

abeham

Message:

#2762:

• Implemented review comments
• Fixed ResidualSpaceBestFitExtremePointPermutationDecoder by sorting from smallest to largest (merit function should be minimized)
• Some restructuring of the methods

File:

• branches/BinPackingExtension/HeuristicLab.Problems.BinPacking/3.3/Algorithms/3D/ExtremePointAlgorithm.cs (modified) (6 diffs)

branches/BinPackingExtension/HeuristicLab.Problems.BinPacking/3.3/Algorithms/3D/ExtremePointAlgorithm.cs

@@ -41 +41 @@
   [StorableClass]
   [Creatable(CreatableAttribute.Categories.SingleSolutionAlgorithms, Priority = 180)]
-  public class ExtremePointAlgorithm : BasicAlgorithm {
+  public sealed class ExtremePointAlgorithm : BasicAlgorithm {
 
     public override Type ProblemType {
@@ -57 +57 @@
 
     [Storable]
-    private IValueParameter<EnumValue<SortingMethod>> sortingMethodParameter;
+    private readonly IValueParameter<EnumValue<SortingMethod>> sortingMethodParameter;
     public IValueParameter<EnumValue<SortingMethod>> SortingMethodParameter {
       get { return sortingMethodParameter; }
@@ -63 +63 @@
 
     [Storable]
-    private IValueParameter<EnumValue<FittingMethod>> fittingMethodParameter;
+    private readonly IValueParameter<EnumValue<FittingMethod>> fittingMethodParameter;
     public IValueParameter<EnumValue<FittingMethod>> FittingMethodParameter {
       get { return fittingMethodParameter; }
@@ -69 +69 @@
 
     [Storable]
-    private IValueParameter<PercentValue> deltaParameter;
+    private readonly IValueParameter<PercentValue> deltaParameter;
     public IValueParameter<PercentValue> DeltaParameter {
       get { return deltaParameter; }
@@ -75 +75 @@
 
     [StorableConstructor]
-    protected ExtremePointAlgorithm(bool deserializing) : base(deserializing) { }
-    protected ExtremePointAlgorithm(ExtremePointAlgorithm original, Cloner cloner)
+    private ExtremePointAlgorithm(bool deserializing) : base(deserializing) { }
+    private ExtremePointAlgorithm(ExtremePointAlgorithm original, Cloner cloner)
       : base(original, cloner) {
       sortingMethodParameter = cloner.Clone(original.sortingMethodParameter);
@@ -112 +112 @@
       if (result == null) throw new InvalidOperationException("No result obtained!");
 
-      Results.Add(new Result("Best Solution", result.Item1));
-      Results.Add(new Result("Best Solution Quality", new DoubleValue(result.Item2)));
+      Results.Add(new Result("Best Solution",
+        "The best found solution",
+        result.Item1));
+      Results.Add(new Result("Best Solution Quality",
+        "The quality of the best found solution according to the evaluator",
+        new DoubleValue(result.Item2)));
 
       var binUtil = new BinUtilizationEvaluator();
       var packRatio = new PackingRatioEvaluator();
-      Results.Add(new Result("Best Solution Bin Count", new IntValue(result.Item1.NrOfBins)));
-      Results.Add(new Result("Best Solution Bin Utilization", new PercentValue(Math.Round(binUtil.Evaluate(result.Item1), 3))));
+      Results.Add(new Result("Best Solution Bin Count",
+        "The number of bins in the best found solution",
+        new IntValue(result.Item1.NrOfBins)));
+      Results.Add(new Result("Best Solution Bin Utilization",
+        "The utilization given in percentage as calculated by the BinUtilizationEvaluator (total used space / total available space)",
+        new PercentValue(Math.Round(binUtil.Evaluate(result.Item1), 3))));
 
       if (result.Item3.HasValue && sorting.Length > 1)
-        Results.Add(new Result("Best Sorting Method", new EnumValue<SortingMethod>(result.Item3.Value)));
+        Results.Add(new Result("Best Sorting Method",
+          "The sorting method that found the best solution",
+          new EnumValue<SortingMethod>(result.Item3.Value)));
       if (result.Item4.HasValue && fitting.Length > 1)
-        Results.Add(new Result("Best Fitting Method", new EnumValue<FittingMethod>(result.Item4.Value)));
+        Results.Add(new Result("Best Fitting Method",
+          "The fitting method that found the best solution",
+          new EnumValue<FittingMethod>(result.Item4.Value)));
     }