Changeset 3151 for trunk/sources/HeuristicLab.Problems.TSP/3.3/TSPLIBParser.cs

Timestamp:

03/21/10 23:55:23 (14 years ago)

Author:

swagner

Message:

Implemented import of optimal TSP solutions (#924).

File:

• trunk/sources/HeuristicLab.Problems.TSP/3.3/TSPLIBParser.cs (modified) (10 diffs)

trunk/sources/HeuristicLab.Problems.TSP/3.3/TSPLIBParser.cs

@@ -26 +26 @@
 namespace HeuristicLab.Problems.TSP {
   /// <summary>
-  /// Parses a *.tsp file in the TSPLIB format and extracts its information about a TSP.
+  /// Parses a *.tsp file in TSPLIB format and extracts its information about a TSP.
   /// </summary>
   public class TSPLIBParser {
@@ -32 +32 @@
     private const int NAME = 1;
     private const int TYPE = 2;
-    private const int DIM = 3;
-    private const int WEIGHTTYPE = 4;
-    private const int NODETYPE = 5;
-    private const int NODESECTION = 6;
+    private const int COMMENT = 3;
+    private const int DIM = 4;
+    private const int WEIGHTTYPE = 5;
+    private const int NODETYPE = 6;
+    private const int NODESECTION = 7;
 
     private StreamReader source;
 
-    private string myName;
+    private string name;
     /// <summary>
     /// Gets the name of the parsed TSP.
     /// </summary>
     public string Name {
-      get { return myName; }
-    }
-    private double[,] myVertices;
+      get { return name; }
+    }
+    private string comment;
+    /// <summary>
+    /// Gets the comment of the parsed TSP.
+    /// </summary>
+    public string Comment {
+      get { return comment; }
+    }
+    private double[,] vertices;
     /// <summary>
     /// Gets the vertices of the parsed TSP.
     /// </summary>
     public double[,] Vertices {
-      get { return myVertices; }
-    }
-    private int myWeightType;
+      get { return vertices; }
+    }
+    private int weightType;
     /// <summary>
     /// Gets the weight type of the parsed TSP.
     /// </summary>
     public int WeightType {
-      get { return myWeightType; }
-    }
-
-    /// <summary>
-    /// Initializes a new instance of <see cref="TSPParser"/> with the given <paramref name="path"/>.
-    /// </summary>
-    /// <exception cref="ArgumentException">Thrown when the input file name is not in TSP format (*.tsp)
+      get { return weightType; }
+    }
+
+    /// <summary>
+    /// Initializes a new instance of <see cref="TSPLIBParser"/> with the given <paramref name="path"/>.
+    /// </summary>
+    /// <exception cref="ArgumentException">Thrown if the input file is not a TSPLIB TSP file (*.tsp)
     /// </exception>
     /// <param name="path">The path where the TSP is stored.</param>
     public TSPLIBParser(String path) {
       if (!path.EndsWith(".tsp"))
-        throw new ArgumentException("Input file name has to be in TSP format (*.tsp)");
+        throw new ArgumentException("Input file has to be a TSPLIB TSP file (*.tsp).");
 
       source = new StreamReader(path);
-      myName = path;
-      myVertices = null;
-      myWeightType = -1;
-    }
-
-    /// <summary>
-    /// Reads the TSP file and parses the elements.
-    /// </summary>
-    /// <exception cref="InvalidDataException">Thrown when file contains unknown (edge) types.</exception>
+      name = path;
+      comment = string.Empty;
+      vertices = null;
+      weightType = -1;
+    }
+
+    /// <summary>
+    /// Reads the TSPLIB TSP file and parses the elements.
+    /// </summary>
+    /// <exception cref="InvalidDataException">Thrown if the file has an invalid format or contains invalid data.</exception>
     public void Parse() {
       int section = -1;
@@ -100 +109 @@
               typeIsChecked = true;
               break;
+            case COMMENT:
+              ReadComment(str);
+              break;
             case DIM:
               InitVerticesArray(str);
@@ -118 +130 @@
 
       if (!(typeIsChecked && weightTypeIsChecked))
-        throw new InvalidDataException("File contains unknown (edge) types");
+        throw new InvalidDataException("Input file does not contain type or edge weight type information.");
     }
 
@@ -136 +148 @@
       if (token.Equals("type", StringComparison.OrdinalIgnoreCase))
         return TYPE;
+      if (token.Equals("comment", StringComparison.OrdinalIgnoreCase))
+        return COMMENT;
       if (token.Equals("dimension", StringComparison.OrdinalIgnoreCase))
         return DIM;
@@ -150 +164 @@
     private void ReadName(string str) {
       string[] tokens = str.Split(new string[] { ":" }, StringSplitOptions.None);
-      myName = tokens[tokens.Length - 1].Trim();
+      name = tokens[tokens.Length - 1].Trim();
     }
 
@@ -158 +172 @@
       string type = tokens[tokens.Length - 1].Trim();
       if (!type.Equals("tsp", StringComparison.OrdinalIgnoreCase))
-        throw new InvalidDataException("Input data format is not \"TSP\"");
+        throw new InvalidDataException("Input file type is not \"TSP\"");
+    }
+
+    private void ReadComment(string str) {
+      string[] tokens = str.Split(new string[] { ":" }, StringSplitOptions.None);
+      comment = tokens[tokens.Length - 1].Trim();
     }
 
@@ -166 +185 @@
 
       int dim = Int32.Parse(dimension);
-      myVertices = new double[dim, 2];
+      vertices = new double[dim, 2];
     }
 
@@ -174 +193 @@
 
       if (type.Equals("euc_2d", StringComparison.OrdinalIgnoreCase))
-        myWeightType = 0;
+        weightType = 0;
       else if (type.Equals("geo", StringComparison.OrdinalIgnoreCase))
-        myWeightType = 1;
+        weightType = 1;
       else
-        throw new InvalidDataException("Unsupported type of edge weights");
+        throw new InvalidDataException("Input file contains an unsupported edge weight type (only \"EUC_2D\" and \"GEO\" are supported).");
     }
 
@@ -186 +205 @@
 
       if (!type.Equals("twod_coords", StringComparison.OrdinalIgnoreCase))
-        throw new InvalidDataException("Unsupported node type");
+        throw new InvalidDataException("Input file contains an unsupported node coordinates type (only \"TWOD_COORDS\" is supported).");
     }
 
     private void ReadVertices() {
-      if (myVertices == null)
-        throw new InvalidDataException("Dimension not found");
-
-      for (int i = 0; i < (myVertices.Length / 2); i++) {
+      if (vertices == null)
+        throw new InvalidDataException("Input file does not contain dimension information.");
+
+      for (int i = 0; i < (vertices.Length / 2); i++) {
         string str = source.ReadLine();
         string[] tokens = str.Split(new string[] { " " }, StringSplitOptions.RemoveEmptyEntries);
 
         if (tokens.Length != 3)
-          throw new InvalidDataException("Invalid node format");
+          throw new InvalidDataException("Input file contains invalid node coordinates.");
 
         CultureInfo culture = new CultureInfo("en-US");
-        myVertices[i, 0] = Double.Parse(tokens[1], culture.NumberFormat);
-        myVertices[i, 1] = Double.Parse(tokens[2], culture.NumberFormat);
+        vertices[i, 0] = double.Parse(tokens[1], culture.NumberFormat);
+        vertices[i, 1] = double.Parse(tokens[2], culture.NumberFormat);
       }
     }