Changeset 17251

Timestamp:

09/13/19 11:37:59 (5 years ago)

Author:

abeham

Message:

#2521: finished refactoring TSP

Location:

branches/2521_ProblemRefactoring

Files:

• HeuristicLab.Data/3.3/ValueTypeMatrix.cs (modified) (1 diff)
• HeuristicLab.Optimizer/3.3/StartPage.cs (modified) (4 diffs)
• HeuristicLab.Problems.Instances.TSPLIB/3.3/TSPLIBTSPInstanceProvider.cs (modified) (1 diff)
• HeuristicLab.Problems.TravelingSalesman.Views/3.3/CoordinatesTSPDataView.Designer.cs (added)
• HeuristicLab.Problems.TravelingSalesman.Views/3.3/CoordinatesTSPDataView.cs (added)
• HeuristicLab.Problems.TravelingSalesman.Views/3.3/EuclideanTSPDataView.Designer.cs (added)
• HeuristicLab.Problems.TravelingSalesman.Views/3.3/EuclideanTSPDataView.cs (added)
• HeuristicLab.Problems.TravelingSalesman.Views/3.3/HeuristicLab.Problems.TravelingSalesman.Views-3.3.csproj (modified) (2 diffs)
• HeuristicLab.Problems.TravelingSalesman.Views/3.3/MatrixTSPDataView.Designer.cs (modified) (8 diffs)
• HeuristicLab.Problems.TravelingSalesman.Views/3.3/MatrixTSPDataView.cs (modified) (5 diffs)
• HeuristicLab.Problems.TravelingSalesman.Views/3.3/MatrixTSPDataView.resx (deleted)
• HeuristicLab.Problems.TravelingSalesman.Views/3.3/TSPSolutionView.resx (deleted)
• HeuristicLab.Problems.TravelingSalesman/3.3/TSP.cs (modified) (4 diffs)
• HeuristicLab.Problems.TravelingSalesman/3.3/TSPData.cs (modified) (11 diffs)

branches/2521_ProblemRefactoring/HeuristicLab.Data/3.3/ValueTypeMatrix.cs

@@ -190 +190 @@
 
     public virtual ValueTypeMatrix<T> AsReadOnly() {
-      ValueTypeMatrix<T> readOnlyValueTypeMatrix = (ValueTypeMatrix<T>)this.Clone();
+      if (readOnly) return this;
+      var readOnlyValueTypeMatrix = (ValueTypeMatrix<T>)this.Clone();
       readOnlyValueTypeMatrix.readOnly = true;
       return readOnlyValueTypeMatrix;

branches/2521_ProblemRefactoring/HeuristicLab.Optimizer/3.3/StartPage.cs

@@ -22 +22 @@
 using System;
 using System.Collections.Generic;
+using System.Drawing;
 using System.IO;
 using System.Linq;
@@ -110 +111 @@
         }
 
-      } catch {
       } finally {
         OnAllSamplesLoaded();
@@ -120 +120 @@
       using (var stream = assembly.GetManifestResourceStream(name)) {
         var serializer = new ProtoBufSerializer();
-        var item = (NamedItem)serializer.Deserialize(stream, false);
+        NamedItem item;
+        try {
+          item = (NamedItem)serializer.Deserialize(stream, false);
+        } catch {
+          item = new ErrorMessage(name, "Sample failed to load!");
+        }
         OnSampleLoaded(item, group, 1.0 / count);
       }
@@ -197 +202 @@
       Properties.Settings.Default.Save();
     }
+
+    [Item("Error Message", "")]
+    class ErrorMessage : NamedItem {
+      public override Image ItemImage => Common.Resources.VSImageLibrary.Error;
+
+      protected ErrorMessage(ErrorMessage original, Cloner cloner) : base(original, cloner) { }
+      public ErrorMessage(string error, string description) : base(error, description) { }
+
+      public override IDeepCloneable Clone(Cloner cloner) {
+        return new ErrorMessage(this, cloner);
+      }
+    }
   }
 }

branches/2521_ProblemRefactoring/HeuristicLab.Problems.Instances.TSPLIB/3.3/TSPLIBTSPInstanceProvider.cs

@@ -96 +96 @@
     }
 
+    public override bool CanExportData => true;
+
+    public override void ExportData(TSPData instance, string path) {
+      using (var writer = new StreamWriter(File.OpenWrite(path))) {
+        writer.WriteLine("NAME: " + instance.Name);
+        writer.WriteLine("TYPE: TSP");
+        writer.WriteLine("COMMENT: " + instance.Description.Replace(Environment.NewLine, " \\\\ " ));
+        writer.WriteLine("DIMENSION: " + instance.Dimension);
+
+        if (instance.DistanceMeasure == DistanceMeasure.Euclidean) {
+          // TSPLIB only knows rounded euclidean distance
+          instance.Distances = instance.GetDistanceMatrix();
+          instance.DistanceMeasure = DistanceMeasure.Direct;
+        }
+
+        if (instance.DistanceMeasure == DistanceMeasure.Direct) {
+          writer.WriteLine("EDGE_WEIGHT_TYPE: EXPLICIT");
+          writer.WriteLine("EDGE_WEIGHT_FORMAT: UPPER_ROW");
+          if (instance.Coordinates != null && instance.Coordinates.GetLength(1) == 2) {
+            writer.WriteLine("DISPLAY_DATA_TYPE: TWOD_DISPLAY");
+          }
+        } else {
+          writer.Write("EDGE_WEIGHT_TYPE: ");
+          switch (instance.DistanceMeasure) {
+            case DistanceMeasure.RoundedEuclidean:
+              writer.WriteLine("EUC_2D");
+              break;
+            case DistanceMeasure.UpperEuclidean:
+              writer.WriteLine("CEIL_2D");
+              break;
+            case DistanceMeasure.Att:
+              writer.WriteLine("ATT");
+              break;
+            case DistanceMeasure.Geo:
+              writer.WriteLine("GEO");
+              break;
+            case DistanceMeasure.Manhattan:
+              writer.WriteLine("MAN_2D");
+              break;
+            case DistanceMeasure.Maximum:
+              writer.WriteLine("MAX_2D");
+              break;
+            default: throw new InvalidOperationException("Unknown distance measure: " + instance.DistanceMeasure);
+          }
+          writer.WriteLine("DISPLAY_DATA_TYPE: COORD_DISPLAY");
+        }
+
+        if (instance.DistanceMeasure == DistanceMeasure.Direct) {
+          writer.WriteLine("EDGE_WEIGHT_SECTION");
+          for (var i = 0; i < instance.Distances.GetLength(0) - 1; i++) {
+            for (var j = i + 1; j < instance.Distances.GetLength(1); j++) {
+              writer.Write(instance.Distances[i, j] + " ");
+            }
+            writer.WriteLine();
+          }
+        }
+
+        if (instance.Coordinates != null && instance.Coordinates.GetLength(1) == 2) {
+          if (instance.DistanceMeasure == DistanceMeasure.Direct)
+            writer.WriteLine("DISPLAY_DATA_SECTION");
+          else writer.WriteLine("NODE_COORD_SECTION");
+          for (var i = 1; i <= instance.Coordinates.GetLength(0); i++) {
+            writer.WriteLine(i + " " + instance.Coordinates[i - 1, 0] + " " + instance.Coordinates[i - 1, 1]);
+          }
+        }
+        writer.WriteLine("EOF");
+        writer.Flush();
+      }
+    }
   }
 }

branches/2521_ProblemRefactoring/HeuristicLab.Problems.TravelingSalesman.Views/3.3/HeuristicLab.Problems.TravelingSalesman.Views-3.3.csproj

@@ -123 +123 @@
   </ItemGroup>
   <ItemGroup>
+    <Compile Include="CoordinatesTSPDataView.cs">
+      <SubType>UserControl</SubType>
+    </Compile>
+    <Compile Include="CoordinatesTSPDataView.Designer.cs">
+      <DependentUpon>CoordinatesTSPDataView.cs</DependentUpon>
+    </Compile>
+    <Compile Include="EuclideanTSPDataView.cs">
+      <SubType>UserControl</SubType>
+    </Compile>
+    <Compile Include="EuclideanTSPDataView.Designer.cs">
+      <DependentUpon>EuclideanTSPDataView.cs</DependentUpon>
+    </Compile>
     <Compile Include="MatrixTSPDataView.cs">
       <SubType>UserControl</SubType>
@@ -235 +247 @@
       <Private>False</Private>
     </ProjectReference>
-  </ItemGroup>
-  <ItemGroup>
-    <EmbeddedResource Include="MatrixTSPDataView.resx">
-      <DependentUpon>MatrixTSPDataView.cs</DependentUpon>
-    </EmbeddedResource>
-    <EmbeddedResource Include="TSPSolutionView.resx">
-      <DependentUpon>TSPSolutionView.cs</DependentUpon>
-    </EmbeddedResource>
   </ItemGroup>
   <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />

branches/2521_ProblemRefactoring/HeuristicLab.Problems.TravelingSalesman.Views/3.3/MatrixTSPDataView.Designer.cs

@@ -26 +26 @@
       this.tabControl = new System.Windows.Forms.TabControl();
       this.distancesTabPage = new System.Windows.Forms.TabPage();
-      this.setMatrixButton = new System.Windows.Forms.Button();
+      this.distanceMatrixView = new HeuristicLab.Data.Views.StringConvertibleMatrixView();
       this.coordinatesTabPage = new System.Windows.Forms.TabPage();
-      this.distanceMatrixView = new HeuristicLab.Data.Views.StringConvertibleMatrixView();
       this.coordinatesSplitContainer = new System.Windows.Forms.SplitContainer();
-      this.setCoordinatesButton = new System.Windows.Forms.Button();
       this.coordinatesMatrixView = new HeuristicLab.Data.Views.StringConvertibleMatrixView();
       this.coordinatesPictureBox = new System.Windows.Forms.PictureBox();
+      ((System.ComponentModel.ISupportInitialize)(this.errorProvider)).BeginInit();
       this.tabControl.SuspendLayout();
       this.distancesTabPage.SuspendLayout();
@@ -43 +42 @@
       this.SuspendLayout();
       // 
+      // nameTextBox
+      // 
+      this.errorProvider.SetIconAlignment(this.nameTextBox, System.Windows.Forms.ErrorIconAlignment.MiddleLeft);
+      this.errorProvider.SetIconPadding(this.nameTextBox, 2);
+      this.nameTextBox.Size = new System.Drawing.Size(688, 20);
+      // 
+      // infoLabel
+      // 
+      this.infoLabel.Location = new System.Drawing.Point(752, 3);
+      // 
       // tabControl
       // 
+      this.tabControl.Anchor = ((System.Windows.Forms.AnchorStyles)((((System.Windows.Forms.AnchorStyles.Top | System.Windows.Forms.AnchorStyles.Bottom) 
+            | System.Windows.Forms.AnchorStyles.Left) 
+            | System.Windows.Forms.AnchorStyles.Right)));
       this.tabControl.Controls.Add(this.distancesTabPage);
       this.tabControl.Controls.Add(this.coordinatesTabPage);
-      this.tabControl.Dock = System.Windows.Forms.DockStyle.Fill;
-      this.tabControl.Location = new System.Drawing.Point(0, 0);
+      this.tabControl.Location = new System.Drawing.Point(0, 26);
       this.tabControl.Name = "tabControl";
       this.tabControl.SelectedIndex = 0;
-      this.tabControl.Size = new System.Drawing.Size(771, 596);
+      this.tabControl.Size = new System.Drawing.Size(771, 570);
       this.tabControl.TabIndex = 1;
       // 
       // distancesTabPage
       // 
-      this.distancesTabPage.Controls.Add(this.setMatrixButton);
       this.distancesTabPage.Controls.Add(this.distanceMatrixView);
       this.distancesTabPage.Location = new System.Drawing.Point(4, 22);
       this.distancesTabPage.Name = "distancesTabPage";
       this.distancesTabPage.Padding = new System.Windows.Forms.Padding(3);
-      this.distancesTabPage.Size = new System.Drawing.Size(763, 570);
+      this.distancesTabPage.Size = new System.Drawing.Size(763, 544);
       this.distancesTabPage.TabIndex = 0;
       this.distancesTabPage.Text = "Distances";
       this.distancesTabPage.UseVisualStyleBackColor = true;
       // 
-      // setMatrixButton
+      // distanceMatrixView
       // 
-      this.setMatrixButton.Location = new System.Drawing.Point(6, 6);
-      this.setMatrixButton.Name = "setMatrixButton";
-      this.setMatrixButton.Size = new System.Drawing.Size(26, 23);
-      this.setMatrixButton.TabIndex = 1;
-      this.setMatrixButton.Text = "Set";
-      this.setMatrixButton.TextImageRelation = System.Windows.Forms.TextImageRelation.ImageBeforeText;
-      this.setMatrixButton.UseVisualStyleBackColor = true;
-      this.setMatrixButton.Click += new System.EventHandler(this.SetMatrixButton_Click);
+      this.distanceMatrixView.Caption = "StringConvertibleMatrix View";
+      this.distanceMatrixView.Content = null;
+      this.distanceMatrixView.Dock = System.Windows.Forms.DockStyle.Fill;
+      this.distanceMatrixView.Location = new System.Drawing.Point(3, 3);
+      this.distanceMatrixView.Name = "distanceMatrixView";
+      this.distanceMatrixView.ReadOnly = false;
+      this.distanceMatrixView.ShowRowsAndColumnsTextBox = true;
+      this.distanceMatrixView.ShowStatisticalInformation = true;
+      this.distanceMatrixView.Size = new System.Drawing.Size(757, 538);
+      this.distanceMatrixView.TabIndex = 0;
       // 
       // coordinatesTabPage
@@ -88 +100 @@
       this.coordinatesTabPage.UseVisualStyleBackColor = true;
       // 
-      // distanceMatrixView
-      // 
-      this.distanceMatrixView.Anchor = ((System.Windows.Forms.AnchorStyles)((((System.Windows.Forms.AnchorStyles.Top | System.Windows.Forms.AnchorStyles.Bottom) 
-            | System.Windows.Forms.AnchorStyles.Left) 
-            | System.Windows.Forms.AnchorStyles.Right)));
-      this.distanceMatrixView.Caption = "StringConvertibleMatrix View";
-      this.distanceMatrixView.Content = null;
-      this.distanceMatrixView.Location = new System.Drawing.Point(6, 35);
-      this.distanceMatrixView.Name = "distanceMatrixView";
-      this.distanceMatrixView.ReadOnly = false;
-      this.distanceMatrixView.ShowRowsAndColumnsTextBox = true;
-      this.distanceMatrixView.ShowStatisticalInformation = true;
-      this.distanceMatrixView.Size = new System.Drawing.Size(751, 529);
-      this.distanceMatrixView.TabIndex = 0;
-      // 
       // coordinatesSplitContainer
       // 
@@ -111 +108 @@
       // coordinatesSplitContainer.Panel1
       // 
-      this.coordinatesSplitContainer.Panel1.Controls.Add(this.setCoordinatesButton);
       this.coordinatesSplitContainer.Panel1.Controls.Add(this.coordinatesMatrixView);
       // 
@@ -121 +117 @@
       this.coordinatesSplitContainer.TabIndex = 0;
       // 
-      // setCoordinatesButton
-      // 
-      this.setCoordinatesButton.Location = new System.Drawing.Point(3, 3);
-      this.setCoordinatesButton.Name = "setCoordinatesButton";
-      this.setCoordinatesButton.Size = new System.Drawing.Size(26, 23);
-      this.setCoordinatesButton.TabIndex = 2;
-      this.setCoordinatesButton.Text = "Set";
-      this.setCoordinatesButton.TextImageRelation = System.Windows.Forms.TextImageRelation.ImageBeforeText;
-      this.setCoordinatesButton.UseVisualStyleBackColor = true;
-      this.setCoordinatesButton.Click += new System.EventHandler(this.SetCoordinatesButton_Click);
-      // 
       // coordinatesMatrixView
       // 
-      this.coordinatesMatrixView.Anchor = ((System.Windows.Forms.AnchorStyles)((((System.Windows.Forms.AnchorStyles.Top | System.Windows.Forms.AnchorStyles.Bottom) 
-            | System.Windows.Forms.AnchorStyles.Left) 
-            | System.Windows.Forms.AnchorStyles.Right)));
       this.coordinatesMatrixView.Caption = "StringConvertibleMatrix View";
       this.coordinatesMatrixView.Content = null;
-      this.coordinatesMatrixView.Location = new System.Drawing.Point(0, 32);
+      this.coordinatesMatrixView.Dock = System.Windows.Forms.DockStyle.Fill;
+      this.coordinatesMatrixView.Location = new System.Drawing.Point(0, 0);
       this.coordinatesMatrixView.Name = "coordinatesMatrixView";
       this.coordinatesMatrixView.ReadOnly = false;
       this.coordinatesMatrixView.ShowRowsAndColumnsTextBox = true;
       this.coordinatesMatrixView.ShowStatisticalInformation = true;
-      this.coordinatesMatrixView.Size = new System.Drawing.Size(249, 532);
+      this.coordinatesMatrixView.Size = new System.Drawing.Size(252, 564);
       this.coordinatesMatrixView.TabIndex = 1;
       // 
@@ -163 +146 @@
       this.Name = "MatrixTSPDataView";
       this.Size = new System.Drawing.Size(771, 596);
+      this.Controls.SetChildIndex(this.tabControl, 0);
+      this.Controls.SetChildIndex(this.nameLabel, 0);
+      this.Controls.SetChildIndex(this.nameTextBox, 0);
+      this.Controls.SetChildIndex(this.infoLabel, 0);
+      ((System.ComponentModel.ISupportInitialize)(this.errorProvider)).EndInit();
       this.tabControl.ResumeLayout(false);
       this.distancesTabPage.ResumeLayout(false);
@@ -172 +160 @@
       ((System.ComponentModel.ISupportInitialize)(this.coordinatesPictureBox)).EndInit();
       this.ResumeLayout(false);
+      this.PerformLayout();
 
     }
@@ -183 +172 @@
     private Data.Views.StringConvertibleMatrixView coordinatesMatrixView;
     private System.Windows.Forms.TabPage distancesTabPage;
-    private System.Windows.Forms.Button setMatrixButton;
     private System.Windows.Forms.PictureBox coordinatesPictureBox;
-    private System.Windows.Forms.Button setCoordinatesButton;
   }
 }

branches/2521_ProblemRefactoring/HeuristicLab.Problems.TravelingSalesman.Views/3.3/MatrixTSPDataView.cs

@@ -20 +20 @@
 #endregion
 
-using System;
-using System.ComponentModel;
 using System.Drawing;
 using System.Windows.Forms;
-using HeuristicLab.Common.Resources;
 using HeuristicLab.Core.Views;
 using HeuristicLab.Data;
@@ -33 +30 @@
   [View("Matrix TSP Data View")]
   [Content(typeof(MatrixTSPData), IsDefaultView = true)]
-  public partial class MatrixTSPDataView : ItemView {
+  public partial class MatrixTSPDataView : NamedItemView {
 
     public new MatrixTSPData Content {
@@ -42 +39 @@
     public MatrixTSPDataView() {
       InitializeComponent();
-      setMatrixButton.Text = string.Empty;
-      setMatrixButton.Image = VSImageLibrary.Edit;
-      setCoordinatesButton.Text = string.Empty;
-      setCoordinatesButton.Image = VSImageLibrary.Edit;
     }
-
-    #region Content Events
-    protected override void RegisterContentEvents() {
-      base.RegisterContentEvents();
-      Content.PropertyChanged += ContentOnPropertyChanged;
-      if (Content.DisplayCoordinates != null) {
-        Content.DisplayCoordinates.Reset += ContentDisplayCoordinatesOnChanged;
-        Content.DisplayCoordinates.ItemChanged += ContentDisplayCoordinatesOnChanged;
-      }
-    }
-
-    protected override void DeregisterContentEvents() {
-      base.DeregisterContentEvents();
-      Content.PropertyChanged -= ContentOnPropertyChanged;
-      if (Content.DisplayCoordinates != null) {
-        Content.DisplayCoordinates.Reset -= ContentDisplayCoordinatesOnChanged;
-        Content.DisplayCoordinates.ItemChanged -= ContentDisplayCoordinatesOnChanged;
-      }
-    }
-
-    private void ContentOnPropertyChanged(object sender, PropertyChangedEventArgs e) {
-      switch (e.PropertyName) {
-        case nameof(Content.Matrix):
-          distanceMatrixView.Content = Content.Matrix;
-          break;
-        case nameof(Content.DisplayCoordinates):
-          if (coordinatesMatrixView.Content != null) {
-            coordinatesMatrixView.Content.Reset -= ContentDisplayCoordinatesOnChanged;
-            coordinatesMatrixView.Content.ItemChanged -= ContentDisplayCoordinatesOnChanged;
-          }
-          if (Content.DisplayCoordinates != null) {
-            Content.DisplayCoordinates.Reset += ContentDisplayCoordinatesOnChanged;
-            Content.DisplayCoordinates.ItemChanged += ContentDisplayCoordinatesOnChanged;
-          }
-          coordinatesMatrixView.Content = Content.DisplayCoordinates;
-          GenerateImage();
-          break;
-      }
-    }
-
-    private void ContentDisplayCoordinatesOnChanged(object sender, EventArgs e) {
-      GenerateImage();
-    }
-    #endregion
 
     protected override void OnContentChanged() {
@@ -107 +56 @@
     protected override void SetEnabledStateOfControls() {
       base.SetEnabledStateOfControls();
-      setMatrixButton.Enabled = !ReadOnly && !Locked && Content != null;
-      setCoordinatesButton.Enabled = !ReadOnly && !Locked && Content != null;
       distanceMatrixView.Enabled = !ReadOnly && !Locked && Content != null;
       coordinatesMatrixView.Enabled = !ReadOnly && !Locked && Content != null;
@@ -152 +99 @@
       }
     }
-
-    private void SetCoordinatesButton_Click(object sender, EventArgs e) {
-      if (Content.DisplayCoordinates != null) {
-        Content.DisplayCoordinates.Reset -= ContentDisplayCoordinatesOnChanged;
-        Content.DisplayCoordinates.ItemChanged -= ContentDisplayCoordinatesOnChanged;
-      }
-      var items = Math.Max(Content.Matrix.Rows, 1);
-      Content.DisplayCoordinates = new DoubleMatrix(items, 2);
-    }
-
-    private void SetMatrixButton_Click(object sender, EventArgs e) {
-      MessageBox.Show("Not yet implemented");
-    }
   }
 }

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

@@ -37 +37 @@
   [Creatable(CreatableAttribute.Categories.CombinatorialProblems, Priority = 100)]
   [StorableType("8415476a-69de-45ad-95be-298ed7c97e84")]
-  public class TSP : PermutationProblem, IProblemInstanceConsumer<TSPData> {
+  public class TSP : PermutationProblem, IProblemInstanceConsumer<TSPData>, IProblemInstanceExporter<TSPData> {
     /// <summary>
     /// This limit governs when a distance matrix is used. For all problems smaller than that, the distance matrix is
@@ -70 +70 @@
       Parameters.Add(TSPDataParameter = new ValueParameter<ITSPData>("TSPData", "The main parameters of the TSP."));
       Parameters.Add(BestKnownSolutionParameter = new OptionalValueParameter<ITSPSolution>("BestKnownSolution", "The best known solution."));
-      
-      TSPData = new EuclideanTSPData() {
-        Coordinates = new DoubleMatrix(new double[,] {
-        { 100, 100 }, { 100, 200 }, { 100, 300 }, { 100, 400 },
-        { 200, 100 }, { 200, 200 }, { 200, 300 }, { 200, 400 },
-        { 300, 100 }, { 300, 200 }, { 300, 300 }, { 300, 400 },
-        { 400, 100 }, { 400, 200 }, { 400, 300 }, { 400, 400 }
-        }),
-        Rounding = EuclideanTSPData.RoundingMode.Midpoint
-      };
+
+      TSPData = new EuclideanTSPData();
 
       InitializeOperators();
@@ -144 +136 @@
         || data.DistanceMeasure == DistanceMeasure.Maximum
         || data.Dimension <= DistanceMatrixSizeLimit) {
-        TSPData = new MatrixTSPData(data.GetDistanceMatrix(), data.Coordinates);
+        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.Distances, data.Coordinates);
+        TSPData = new MatrixTSPData(data.Name, data.Distances, data.Coordinates) { Description = data.Description };
       } else {
         switch (data.DistanceMeasure) {
           case DistanceMeasure.Euclidean:
-            TSPData = new EuclideanTSPData(data.Coordinates) { Rounding = EuclideanTSPData.RoundingMode.None };
+            TSPData = new EuclideanTSPData(data.Name, data.Coordinates, EuclideanTSPData.DistanceRounding.None) { Description = data.Description };
             break;
           case DistanceMeasure.RoundedEuclidean:
-            TSPData = new EuclideanTSPData(data.Coordinates) { Rounding = EuclideanTSPData.RoundingMode.Midpoint };
+            TSPData = new EuclideanTSPData(data.Name, data.Coordinates, EuclideanTSPData.DistanceRounding.Midpoint) { Description = data.Description };
             break;
           case DistanceMeasure.UpperEuclidean:
-            TSPData = new EuclideanTSPData(data.Coordinates) { Rounding = EuclideanTSPData.RoundingMode.Ceiling };
+            TSPData = new EuclideanTSPData(data.Name, data.Coordinates, EuclideanTSPData.DistanceRounding.Ceiling) { Description = data.Description };
             break;
           case DistanceMeasure.Geo:
-            TSPData = new GeoTSPData(data.Coordinates);
+            TSPData = new GeoTSPData(data.Name, data.Coordinates) { Description = data.Description };
             break;
           default:
@@ -184 +176 @@
     }
 
+    public TSPData Export() {
+      var instance = TSPData.Export();
+      if (!double.IsNaN(BestKnownQuality))
+        instance.BestKnownQuality = BestKnownQuality;
+      if (BestKnownSolution?.Tour != null)
+        instance.BestKnownTour = BestKnownSolution.Tour.ToArray();
+      return instance;
+    }
+
     protected override void OnEncodingChanged() {
       base.OnEncodingChanged();

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

@@ -21 +21 @@
 
 using System;
-using System.ComponentModel;
 using HEAL.Attic;
 using HeuristicLab.Common;
@@ -27 +26 @@
 using HeuristicLab.Data;
 using HeuristicLab.Encodings.PermutationEncoding;
+using HeuristicLab.Problems.Instances;
 
 namespace HeuristicLab.Problems.TravelingSalesman {
   [StorableType("1a9bf60c-b6a6-4c95-8e99-5a2dec0ee892")]
-  public interface ITSPData : IItem {
+  public interface ITSPData : INamedItem {
     double GetDistance(int fromCity, int toCity);
     ITSPSolution GetSolution(Permutation tspTour, double tourLength);
+    TSPData Export();
   }
 
   [Item("Matrix-based TSP Data", "TSP that is representd by a distance matrix.")]
   [StorableType("4df58a35-679d-4414-b815-9450ae100823")]
-  public sealed class MatrixTSPData : Item, ITSPData, INotifyPropertyChanged {
-
-    [Storable]
-    public DoubleMatrix Matrix { get; private set; }
-
-    [Storable]
-    private DoubleMatrix displayCoordinates;
-    public DoubleMatrix DisplayCoordinates {
-      get => displayCoordinates;
-      set {
-        if (displayCoordinates == value) return;
-        displayCoordinates = value;
-        OnPropertyChanged(nameof(DisplayCoordinates));
-      }
-    }
+  public sealed class MatrixTSPData : NamedItem, ITSPData {
+    [Storable] public DoubleMatrix Matrix { get; private set; }
+    [Storable] public DoubleMatrix DisplayCoordinates { get; private set; }
 
     [StorableConstructor]
@@ -57 +46 @@
     private MatrixTSPData(MatrixTSPData original, Cloner cloner) : base(original, cloner) {
       Matrix = original.Matrix;
-      displayCoordinates = cloner.Clone(original.displayCoordinates);
+      DisplayCoordinates = original.DisplayCoordinates;
     }
     public MatrixTSPData() {
-      Matrix = new DoubleMatrix(new double[0, 0], @readonly: true);
-      DisplayCoordinates = null;
-    }
-    public MatrixTSPData(double[,] matrix, double[,] coordinates = null) {
+      Name = TSPDefaultInstance.Name;
+      Matrix = TSPDefaultInstance.Distances;
+      DisplayCoordinates = TSPDefaultInstance.Coordinates;
+    }
+    public MatrixTSPData(string name, double[,] matrix, double[,] coordinates = null) {
+      if (coordinates != null && coordinates.GetLength(1) != 2)
+        throw new ArgumentException("Argument must have exactly two columns.", nameof(coordinates));
+      if (coordinates != null && coordinates.GetLength(0) != matrix.GetLength(0))
+        throw new ArgumentException("Unequal number of rows in " + nameof(matrix) + " and " + nameof(coordinates) + ".");
+      Name = name;
       Matrix = new DoubleMatrix(matrix, @readonly: true);
-      if (coordinates != null) DisplayCoordinates = new DoubleMatrix(coordinates);
-      if (DisplayCoordinates != null && DisplayCoordinates.Columns != 2)
+      if (coordinates != null) DisplayCoordinates = new DoubleMatrix(coordinates, @readonly: true);
+    }
+    public MatrixTSPData(string name, DoubleMatrix matrix, DoubleMatrix coordinates = null) {
+      if (coordinates != null && coordinates.Columns != 2)
         throw new ArgumentException("Argument must have exactly two columns.", nameof(coordinates));
-      if (DisplayCoordinates != null && DisplayCoordinates.Rows != Matrix.Rows)
+      if (coordinates != null && coordinates.Rows != matrix.Rows)
         throw new ArgumentException("Unequal number of rows in " + nameof(matrix) + " and " + nameof(coordinates) + ".");
+      Name = name;
+      Matrix = (DoubleMatrix)matrix.AsReadOnly();
+      DisplayCoordinates = (DoubleMatrix)coordinates?.AsReadOnly();
     }
 
@@ -80 +80 @@
     }
 
-    public void SetMatrix(double[,] matrix, double[,] coordinates = null) {
-      Matrix = new DoubleMatrix(matrix, @readonly: true);
-      OnPropertyChanged(nameof(Matrix));
-      if (coordinates == null) DisplayCoordinates = null;
-      else DisplayCoordinates = new DoubleMatrix(coordinates);
-      if (DisplayCoordinates != null && DisplayCoordinates.Columns != 2)
-        throw new ArgumentException("Argument must have exactly two columns.", nameof(coordinates));
-      if (DisplayCoordinates != null && DisplayCoordinates.Rows != Matrix.Rows)
-        throw new ArgumentException("Unequal number of rows in " + nameof(matrix) + " and " + nameof(coordinates) + ".");
-    }
-
-    public void SetMatrix(DoubleMatrix matrix, DoubleMatrix coordinates = null) {
-      Matrix = (DoubleMatrix)matrix.AsReadOnly();
-      OnPropertyChanged(nameof(Matrix));
-      DisplayCoordinates = (DoubleMatrix)coordinates?.Clone();
-      if (DisplayCoordinates != null && DisplayCoordinates.Columns != 2)
-        throw new ArgumentException("Argument must have exactly two columns.", nameof(coordinates));
-      if (DisplayCoordinates != null && DisplayCoordinates.Rows != Matrix.Rows)
-        throw new ArgumentException("Unequal number of rows in " + nameof(matrix) + " and " + nameof(coordinates) + ".");
-    }
-
     public double GetDistance(int fromCity, int toCity) => Matrix[fromCity, toCity];
 
-
-    public event PropertyChangedEventHandler PropertyChanged;
-    private void OnPropertyChanged(string property) {
-      PropertyChanged?.Invoke(this, new PropertyChangedEventArgs(property));
+    public TSPData Export() {
+      return new TSPData() {
+        Name = name,
+        Description = description,
+        Coordinates = DisplayCoordinates?.CloneAsMatrix(),
+        Dimension = Matrix.Rows,
+        DistanceMeasure = DistanceMeasure.Direct,
+        Distances = Matrix.CloneAsMatrix()
+      };
     }
   }
@@ -112 +96 @@
   [Item("Coordinates-based TSP Data", "TSP that is represented by coordinates of locations.")]
   [StorableType("3955d07a-d43c-4a01-9505-d2effb1ea865")]
-  public abstract class CoordinatesTSPData : Item, ITSPData {
-    [Storable]
-    public DoubleMatrix Coordinates { get; set; }
+  public abstract class CoordinatesTSPData : NamedItem, ITSPData {
+    [Storable] public DoubleMatrix Coordinates { get; private set; }
 
     [StorableConstructor]
     protected CoordinatesTSPData(StorableConstructorFlag _) : base(_) { }
     protected CoordinatesTSPData(CoordinatesTSPData original, Cloner cloner) : base(original, cloner) {
-      Coordinates = cloner.Clone(original.Coordinates);
+      Coordinates = original.Coordinates;
     }
     protected CoordinatesTSPData() : base() {
-      Coordinates = new DoubleMatrix();
-    }
-    protected CoordinatesTSPData(double[,] coordinates) : base() {
+      Name = TSPDefaultInstance.Name;
+      Coordinates = TSPDefaultInstance.Coordinates;
+    }
+    protected CoordinatesTSPData(string name, double[,] coordinates) : base() {
       if (coordinates == null) throw new ArgumentNullException(nameof(coordinates));
       if (coordinates.GetLength(1) != 2) throw new ArgumentException("Argument must have exactly two columns.", nameof(coordinates));
-      Coordinates = new DoubleMatrix(coordinates);
+      Name = name;
+      Coordinates = new DoubleMatrix(coordinates, @readonly: true);
+    }
+    protected CoordinatesTSPData(string name, DoubleMatrix coordinates) : base() {
+      if (coordinates == null) throw new ArgumentNullException(nameof(coordinates));
+      if (coordinates.Columns != 2) throw new ArgumentException("Argument must have exactly two columns.", nameof(coordinates));
+      Name = name;
+      Coordinates = (DoubleMatrix)coordinates.AsReadOnly();
     }
 
@@ -140 +131 @@
       return new TSPSolution(Coordinates, tour, new DoubleValue(tourLength));
     }
+
+    public abstract TSPData Export();
   }
 
@@ -145 +138 @@
   [StorableType("4bf58348-cd98-46c5-a4c0-55f486ca88b4")]
   public sealed class EuclideanTSPData : CoordinatesTSPData {
-    public enum RoundingMode { None, Midpoint, Ceiling }
+    public enum DistanceRounding { None, Midpoint, Ceiling }
 
     [Storable]
-    public RoundingMode Rounding { get; set; }
+    public DistanceRounding Rounding { get; private set; }
 
     [StorableConstructor]
@@ -155 +148 @@
       Rounding = original.Rounding;
     }
-    public EuclideanTSPData() : base() { }
-    public EuclideanTSPData(double[,] coordinates) : base(coordinates) { }
+    public EuclideanTSPData()
+      : base() {
+      Rounding = DistanceRounding.Midpoint;
+    }
+    public EuclideanTSPData(string name, double[,] coordinates, DistanceRounding rounding = DistanceRounding.None)
+      : base(name, coordinates) {
+      Rounding = rounding;
+    }
+    public EuclideanTSPData(string name, DoubleMatrix coordinates, DistanceRounding rounding = DistanceRounding.None)
+      : base(name, coordinates) {
+      Rounding = rounding;
+    }
 
     public override IDeepCloneable Clone(Cloner cloner) {
@@ -165 +168 @@
       var dist = Math.Sqrt((fromX - toX) * (fromX - toX) + (fromY - toY) * (fromY - toY));
       switch (Rounding) {
-        case RoundingMode.None: return dist;
-        case RoundingMode.Midpoint: return Math.Round(dist);
-        case RoundingMode.Ceiling: return Math.Ceiling(dist);
+        case DistanceRounding.None: return dist;
+        case DistanceRounding.Midpoint: return Math.Round(dist);
+        case DistanceRounding.Ceiling: return Math.Ceiling(dist);
         default: throw new InvalidOperationException("Unknown rounding mode " + Rounding);
       }
+    }
+
+    public override TSPData Export() {
+      var data = new TSPData() {
+        Name = name,
+        Description = description,
+        Coordinates = Coordinates.CloneAsMatrix(),
+        Dimension = Coordinates.Rows
+      };
+      switch (Rounding) {
+        case DistanceRounding.None: data.DistanceMeasure = DistanceMeasure.Euclidean; break;
+        case DistanceRounding.Midpoint: data.DistanceMeasure = DistanceMeasure.RoundedEuclidean; break;
+        case DistanceRounding.Ceiling: data.DistanceMeasure = DistanceMeasure.UpperEuclidean; break;
+      }
+      return data;
     }
   }
@@ -183 +201 @@
     private GeoTSPData(GeoTSPData original, Cloner cloner) : base(original, cloner) { }
     public GeoTSPData() : base() { }
-    public GeoTSPData(double[,] coordinates) : base(coordinates) { }
+    public GeoTSPData(string name, double[,] coordinates) : base(name, coordinates) { }
+    public GeoTSPData(string name, DoubleMatrix coordinates) : base(name, coordinates) { }
 
     public override IDeepCloneable Clone(Cloner cloner) {
@@ -210 +229 @@
       return PI * (Math.Truncate(x) + 5.0 * (x - Math.Truncate(x)) / 3.0) / 180.0;
     }
+
+    public override TSPData Export() {
+      return new TSPData() {
+        Name = name,
+        Description = description,
+        Coordinates = Coordinates.CloneAsMatrix(),
+        Dimension = Coordinates.Rows,
+        DistanceMeasure = DistanceMeasure.Geo
+      };
+    }
+  }
+
+  internal static class TSPDefaultInstance {
+    internal static readonly DoubleMatrix Distances = new DoubleMatrix(new double[,] {
+{ 0, 100, 200, 300, 100, 141, 224, 316, 200, 224, 283, 361, 300, 316, 361, 424 },
+{ 100, 0, 100, 200, 141, 100, 141, 224, 224, 200, 224, 283, 316, 300, 316, 361 },
+{ 200, 100, 0, 100, 224, 141, 100, 141, 283, 224, 200, 224, 361, 316, 300, 316 },
+{ 300, 200, 100, 0, 316, 224, 141, 100, 361, 283, 224, 200, 424, 361, 316, 300 },
+{ 100, 141, 224, 316, 0, 100, 200, 300, 100, 141, 224, 316, 200, 224, 283, 361 },
+{ 141, 100, 141, 224, 100, 0, 100, 200, 141, 100, 141, 224, 224, 200, 224, 283 },
+{ 224, 141, 100, 141, 200, 100, 0, 100, 224, 141, 100, 141, 283, 224, 200, 224 },
+{ 316, 224, 141, 100, 300, 200, 100, 0, 316, 224, 141, 100, 361, 283, 224, 200 },
+{ 200, 224, 283, 361, 100, 141, 224, 316, 0, 100, 200, 300, 100, 141, 224, 316 },
+{ 224, 200, 224, 283, 141, 100, 141, 224, 100, 0, 100, 200, 141, 100, 141, 224 },
+{ 283, 224, 200, 224, 224, 141, 100, 141, 200, 100, 0, 100, 224, 141, 100, 141 },
+{ 361, 283, 224, 200, 316, 224, 141, 100, 300, 200, 100, 0, 316, 224, 141, 100 },
+{ 300, 316, 361, 424, 200, 224, 283, 361, 100, 141, 224, 316, 0, 100, 200, 300 },
+{ 316, 300, 316, 361, 224, 200, 224, 283, 141, 100, 141, 224, 100, 0, 100, 200 },
+{ 361, 316, 300, 316, 283, 224, 200, 224, 224, 141, 100, 141, 200, 100, 0, 100 },
+{ 424, 361, 316, 300, 361, 283, 224, 200, 316, 224, 141, 100, 300, 200, 100, 0 },
+}, @readonly: true);
+    internal static readonly DoubleMatrix Coordinates = new DoubleMatrix(new double[,] {
+{ 100, 100 }, { 100, 200 }, { 100, 300 }, { 100, 400 },
+{ 200, 100 }, { 200, 200 }, { 200, 300 }, { 200, 400 },
+{ 300, 100 }, { 300, 200 }, { 300, 300 }, { 300, 400 },
+{ 400, 100 }, { 400, 200 }, { 400, 300 }, { 400, 400 }
+}, @readonly: true);
+    internal static readonly string Name = "HL TSP Default";
   }
 }