Changeset 17335 for branches/2521_ProblemRefactoring/HeuristicLab.Problems.TravelingSalesman

Timestamp:

10/17/19 21:40:30 (5 years ago)

Author:

abeham

Message:

#2521: Refactored pTSP to use compositional pattern

Location:

branches/2521_ProblemRefactoring/HeuristicLab.Problems.TravelingSalesman/3.3

Files:

• TSP.cs (modified) (3 diffs)
• TSPData.cs (modified) (8 diffs)
• TSPSolution.cs (modified) (5 diffs)

branches/2521_ProblemRefactoring/HeuristicLab.Problems.TravelingSalesman/3.3/TSP.cs

@@ -143 +143 @@
       Description = data.Description;
 
-      if (data.Dimension <= DistanceMatrixSizeLimit) {
-        TSPData = new MatrixTSPData(data.Name, data.GetDistanceMatrix(), data.Coordinates) { Description = data.Description };
-      } else if (data.DistanceMeasure == DistanceMeasure.Direct && data.Distances != null) {
-        TSPData = new MatrixTSPData(data.Name, data.Distances, data.Coordinates) { Description = data.Description };
-      } else {
-        switch (data.DistanceMeasure) {
-          case DistanceMeasure.Att:
-            TSPData = new AttTSPData(data.Name, data.Coordinates) { Description = data.Description };
-            break;
-          case DistanceMeasure.Euclidean:
-            TSPData = new EuclideanTSPData(data.Name, data.Coordinates, EuclideanTSPData.DistanceRounding.None) { Description = data.Description };
-            break;
-          case DistanceMeasure.RoundedEuclidean:
-            TSPData = new EuclideanTSPData(data.Name, data.Coordinates, EuclideanTSPData.DistanceRounding.Midpoint) { Description = data.Description };
-            break;
-          case DistanceMeasure.UpperEuclidean:
-            TSPData = new EuclideanTSPData(data.Name, data.Coordinates, EuclideanTSPData.DistanceRounding.Ceiling) { Description = data.Description };
-            break;
-          case DistanceMeasure.Geo:
-            TSPData = new GeoTSPData(data.Name, data.Coordinates) { Description = data.Description };
-            break;
-          case DistanceMeasure.Manhattan:
-            TSPData = new ManhattanTSPData(data.Name, data.Coordinates) { Description = data.Description };
-            break;
-          case DistanceMeasure.Maximum:
-            TSPData = new MaximumTSPData(data.Name, data.Coordinates) { Description = data.Description };
-            break;
-          default:
-            throw new System.IO.InvalidDataException("An unknown distance measure is given in the instance!");
-        }
-      }
+      TSPData = GetDataFromInstance(data);
       BestKnownSolution = null;
       BestKnownQuality = double.NaN;
@@ -181 +151 @@
           var tour = new Permutation(PermutationTypes.RelativeUndirected, data.BestKnownTour);
           var tourLength = Evaluate(tour);
-          BestKnownSolution = new TSPSolution(data.Coordinates != null ? new DoubleMatrix(data.Coordinates) : null, tour, new DoubleValue(tourLength));
+          BestKnownSolution = new TSPSolution(TSPData, tour, new DoubleValue(tourLength));
           BestKnownQuality = tourLength;
         } catch (InvalidOperationException) {
@@ -191 +161 @@
       }
       OnReset();
+    }
+
+    public static ITSPData GetDataFromInstance(TSPData input) {
+      ITSPData tspData = null;
+      if (input.Dimension <= DistanceMatrixSizeLimit) {
+        tspData = new MatrixTSPData(input.Name, input.GetDistanceMatrix(), input.Coordinates) { Description = input.Description };
+      } else if (input.DistanceMeasure == DistanceMeasure.Direct && input.Distances != null) {
+        tspData = new MatrixTSPData(input.Name, input.Distances, input.Coordinates) { Description = input.Description };
+      } else {
+        switch (input.DistanceMeasure) {
+          case DistanceMeasure.Att:
+            tspData = new AttTSPData(input.Name, input.Coordinates) { Description = input.Description };
+            break;
+          case DistanceMeasure.Euclidean:
+            tspData = new EuclideanTSPData(input.Name, input.Coordinates, EuclideanTSPData.DistanceRounding.None) { Description = input.Description };
+            break;
+          case DistanceMeasure.RoundedEuclidean:
+            tspData = new EuclideanTSPData(input.Name, input.Coordinates, EuclideanTSPData.DistanceRounding.Midpoint) { Description = input.Description };
+            break;
+          case DistanceMeasure.UpperEuclidean:
+            tspData = new EuclideanTSPData(input.Name, input.Coordinates, EuclideanTSPData.DistanceRounding.Ceiling) { Description = input.Description };
+            break;
+          case DistanceMeasure.Geo:
+            tspData = new GeoTSPData(input.Name, input.Coordinates) { Description = input.Description };
+            break;
+          case DistanceMeasure.Manhattan:
+            tspData = new ManhattanTSPData(input.Name, input.Coordinates) { Description = input.Description };
+            break;
+          case DistanceMeasure.Maximum:
+            tspData = new MaximumTSPData(input.Name, input.Coordinates) { Description = input.Description };
+            break;
+          default:
+            throw new System.IO.InvalidDataException("An unknown distance measure is given in the instance!");
+        }
+      }
+      return tspData;
     }
 

branches/2521_ProblemRefactoring/HeuristicLab.Problems.TravelingSalesman/3.3/TSPData.cs

@@ -40 +40 @@
   [Item("Matrix-based TSP Data", "TSP that is representd by a distance matrix.")]
   [StorableType("4df58a35-679d-4414-b815-9450ae100823")]
-  public class MatrixTSPData : NamedItem, ITSPData {
-    [Storable] public DoubleMatrix Matrix { get; protected set; }
-    [Storable] public DoubleMatrix DisplayCoordinates { get; protected set; }
+  public sealed class MatrixTSPData : NamedItem, ITSPData {
+    [Storable] public DoubleMatrix Matrix { get; private set; }
+    [Storable] public DoubleMatrix DisplayCoordinates { get; private set; }
 
     public int Cities => Matrix.Rows;
 
     [StorableConstructor]
-    protected  MatrixTSPData(StorableConstructorFlag _) : base(_) { }
-    protected MatrixTSPData(MatrixTSPData original, Cloner cloner) : base(original, cloner) {
+    private  MatrixTSPData(StorableConstructorFlag _) : base(_) { }
+    private MatrixTSPData(MatrixTSPData original, Cloner cloner) : base(original, cloner) {
       Matrix = original.Matrix;
       DisplayCoordinates = original.DisplayCoordinates;
@@ -76 +76 @@
     }
 
-    public virtual ITSPSolution GetSolution(Permutation tour, double tourLength) {
-      return new TSPSolution(DisplayCoordinates, tour, new DoubleValue(tourLength));
+    public ITSPSolution GetSolution(Permutation tour, double tourLength) {
+      return new TSPSolution(this, tour, new DoubleValue(tourLength));
     }
 
@@ -135 +135 @@
 
     public virtual ITSPSolution GetSolution(Permutation tour, double tourLength) {
-      return new TSPSolution(Coordinates, tour, new DoubleValue(tourLength));
+      return new TSPSolution(this, tour, new DoubleValue(tourLength));
     }
 
@@ -143 +143 @@
   [Item("Euclidean TSP Data", "TSP that is represented by coordinates in an Euclidean plane.")]
   [StorableType("4bf58348-cd98-46c5-a4c0-55f486ca88b4")]
-  public class EuclideanTSPData : CoordinatesTSPData {
+  public sealed class EuclideanTSPData : CoordinatesTSPData {
     public enum DistanceRounding { None, Midpoint, Ceiling }
 
     [Storable]
-    public DistanceRounding Rounding { get; protected set; }
-
-    [StorableConstructor]
-    protected EuclideanTSPData(StorableConstructorFlag _) : base(_) { }
-    protected EuclideanTSPData(EuclideanTSPData original, Cloner cloner) : base(original, cloner) {
+    public DistanceRounding Rounding { get; private set; }
+
+    [StorableConstructor]
+    private EuclideanTSPData(StorableConstructorFlag _) : base(_) { }
+    private EuclideanTSPData(EuclideanTSPData original, Cloner cloner) : base(original, cloner) {
       Rounding = original.Rounding;
     }
@@ -199 +199 @@
   [Item("Geo TSP Data", "TSP that is represented by geo coordinates.")]
   [StorableType("dc859a89-e6c2-4af3-a3b6-9aa3041b14a9")]
-  public class GeoTSPData : CoordinatesTSPData {
-    [StorableConstructor]
-    protected GeoTSPData(StorableConstructorFlag _) : base(_) { }
-    protected GeoTSPData(GeoTSPData original, Cloner cloner) : base(original, cloner) { }
+  public sealed class GeoTSPData : CoordinatesTSPData {
+    [StorableConstructor]
+    private GeoTSPData(StorableConstructorFlag _) : base(_) { }
+    private GeoTSPData(GeoTSPData original, Cloner cloner) : base(original, cloner) { }
     public GeoTSPData() : base() { }
     public GeoTSPData(string name, double[,] coordinates) : base(name, coordinates) { }
@@ -228 +228 @@
   [Item("ATT TSP Data", "TSP that is represented by ATT coordinates.")]
   [StorableType("d7a0add3-6ec1-42e0-b1d7-b6454694d485")]
-  public class AttTSPData : CoordinatesTSPData {
-    [StorableConstructor]
-    protected AttTSPData(StorableConstructorFlag _) : base(_) { }
-    protected AttTSPData(AttTSPData original, Cloner cloner) : base(original, cloner) { }
+  public sealed class AttTSPData : CoordinatesTSPData {
+    [StorableConstructor]
+    private AttTSPData(StorableConstructorFlag _) : base(_) { }
+    private AttTSPData(AttTSPData original, Cloner cloner) : base(original, cloner) { }
     public AttTSPData() : base() { }
     public AttTSPData(string name, double[,] coordinates) : base(name, coordinates) { }
@@ -257 +257 @@
   [Item("Manhattan TSP Data", "TSP that is represented by Manhattan coordinates.")]
   [StorableType("5f1ef9e2-cbd1-400e-8f87-6855f091fc9e")]
-  public class ManhattanTSPData : CoordinatesTSPData {
-    [StorableConstructor]
-    protected ManhattanTSPData(StorableConstructorFlag _) : base(_) { }
-    protected ManhattanTSPData(ManhattanTSPData original, Cloner cloner) : base(original, cloner) { }
+  public sealed class ManhattanTSPData : CoordinatesTSPData {
+    [StorableConstructor]
+    private ManhattanTSPData(StorableConstructorFlag _) : base(_) { }
+    private ManhattanTSPData(ManhattanTSPData original, Cloner cloner) : base(original, cloner) { }
     public ManhattanTSPData() : base() { }
     public ManhattanTSPData(string name, double[,] coordinates) : base(name, coordinates) { }
@@ -286 +286 @@
   [Item("Manhattan TSP Data", "TSP that is represented by the maximum absolute distance in either x or y coordinates.")]
   [StorableType("c6294a6c-fe62-4906-9765-4bc306d3e4a8")]
-  public class MaximumTSPData : CoordinatesTSPData {
-    [StorableConstructor]
-    protected MaximumTSPData(StorableConstructorFlag _) : base(_) { }
-    protected MaximumTSPData(MaximumTSPData original, Cloner cloner) : base(original, cloner) { }
+  public sealed class MaximumTSPData : CoordinatesTSPData {
+    [StorableConstructor]
+    private MaximumTSPData(StorableConstructorFlag _) : base(_) { }
+    private MaximumTSPData(MaximumTSPData original, Cloner cloner) : base(original, cloner) { }
     public MaximumTSPData() : base() { }
     public MaximumTSPData(string name, double[,] coordinates) : base(name, coordinates) { }

branches/2521_ProblemRefactoring/HeuristicLab.Problems.TravelingSalesman/3.3/TSPSolution.cs

@@ -31 +31 @@
   [StorableType("f08a63d9-0b83-4944-9251-42925baeb872")]
   public interface ITSPSolution : IItem, INotifyPropertyChanged {
-    DoubleMatrix Coordinates { get; }
+    ITSPData TSPData { get; }
     Permutation Tour { get; }
     DoubleValue TourLength { get; }
@@ -41 +41 @@
   [Item("TSP Solution", "Represents a tour of a Traveling Salesman Problem given in path representation which can be visualized in the GUI.")]
   [StorableType("38d1aac3-3047-40d9-bcf9-4b3ca0b9f95c")]
-  public class TSPSolution : Item, ITSPSolution {
+  public sealed class TSPSolution : Item, ITSPSolution {
     public static new Image StaticItemImage {
       get { return HeuristicLab.Common.Resources.VSImageLibrary.Image; }
@@ -47 +47 @@
 
     [Storable]
-    private DoubleMatrix coordinates;
-    public DoubleMatrix Coordinates {
-      get { return coordinates; }
+    private ITSPData tspData;
+    public ITSPData TSPData {
+      get { return tspData; }
       set {
-        if (coordinates == value) return;
-        coordinates = value;
-        OnPropertyChanged(nameof(Coordinates));
+        if (tspData == value) return;
+        tspData = value;
+        OnPropertyChanged(nameof(TSPData));
       }
     }
@@ -79 +79 @@
 
     [StorableConstructor]
-    protected TSPSolution(StorableConstructorFlag _) : base(_) { }
-    protected TSPSolution(TSPSolution original, Cloner cloner)
+    private TSPSolution(StorableConstructorFlag _) : base(_) { }
+    private TSPSolution(TSPSolution original, Cloner cloner)
       : base(original, cloner) {
-      this.coordinates = cloner.Clone(original.coordinates);
+      this.tspData = cloner.Clone(original.tspData);
       this.tour = cloner.Clone(original.tour);
       this.tourLength = cloner.Clone(original.tourLength);
     }
     public TSPSolution() : base() { }
-    public TSPSolution(DoubleMatrix coordinates)
+    public TSPSolution(ITSPData data)
       : base() {
-      this.coordinates = coordinates;
+      this.tspData = data;
     }
-    public TSPSolution(DoubleMatrix coordinates, Permutation permutation)
+    public TSPSolution(ITSPData data, Permutation permutation)
       : base() {
-      this.coordinates = coordinates;
+      this.tspData = data;
       this.tour = permutation;
     }
-    public TSPSolution(DoubleMatrix coordinates, Permutation permutation, DoubleValue quality)
+    public TSPSolution(ITSPData data, Permutation permutation, DoubleValue quality)
       : base() {
-      this.coordinates = coordinates;
+      this.tspData = data;
       this.tour = permutation;
       this.tourLength = quality;
@@ -108 +108 @@
 
     public event PropertyChangedEventHandler PropertyChanged;
-    protected void OnPropertyChanged(string property) {
+    private void OnPropertyChanged(string property) {
       PropertyChanged?.Invoke(this, new PropertyChangedEventArgs(property));
     }