source: trunk/sources/HeuristicLab.Problems.Instances.VehicleRouting/3.4/VRPInstanceProvider.cs @ 11478

Last change on this file since 11478 was 11478, checked in by pfleck, 8 years ago

#2229:

  • Added fall-back for solution parsing to try the own .opt-Format.
  • Parsing uses InvariantCulture instead of a specific one.
  • Small refactoring.
File size: 6.3 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2014 Heuristic and Evolutionary Algorithms Laboratory (HEAL)
4 *
5 * This file is part of HeuristicLab.
6 *
7 * HeuristicLab is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
11 *
12 * HeuristicLab is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with HeuristicLab. If not, see <http://www.gnu.org/licenses/>.
19 */
20#endregion
21
22using System;
23using System.Collections.Generic;
24using System.IO;
25using System.Linq;
26using System.Reflection;
27using System.Text.RegularExpressions;
28using HeuristicLab.Common;
29using ICSharpCode.SharpZipLib.Zip;
30
31namespace HeuristicLab.Problems.Instances.VehicleRouting {
32  public abstract class VRPInstanceProvider<TData> : ProblemInstanceProvider<TData>, IVRPInstanceProvider<TData> where TData : IVRPData {
33    protected abstract string FileName { get; }
34
35    public override IEnumerable<IDataDescriptor> GetDataDescriptors() {
36      var solutions = new Dictionary<string, string>();
37      var solutionsArchiveName = GetResourceName(FileName + @"\.opt\.zip");
38      if (!String.IsNullOrEmpty(solutionsArchiveName)) {
39        using (var solutionsZipFile = new ZipInputStream(GetType().Assembly.GetManifestResourceStream(solutionsArchiveName))) {
40          foreach (var entry in GetZipContents(solutionsZipFile))
41            solutions.Add(Path.GetFileNameWithoutExtension(entry) + "." + FileName, entry);
42        }
43      }
44      var instanceArchiveName = GetResourceName(FileName + @"\.zip");
45      if (String.IsNullOrEmpty(instanceArchiveName)) yield break;
46
47      using (var instanceStream = new ZipInputStream(GetType().Assembly.GetManifestResourceStream(instanceArchiveName))) {
48        foreach (var entry in GetZipContents(instanceStream).OrderBy(x => x, new NaturalStringComparer())) {
49          string solutionEntry = Path.GetFileNameWithoutExtension(entry) + "." + FileName;
50          yield return new VRPDataDescriptor(Path.GetFileNameWithoutExtension(entry), GetInstanceDescription(), entry, solutions.ContainsKey(solutionEntry) ? solutions[solutionEntry] : String.Empty);
51        }
52      }
53    }
54
55    public override TData LoadData(IDataDescriptor id) {
56      var descriptor = (VRPDataDescriptor)id;
57      var instanceArchiveName = GetResourceName(FileName + @"\.zip");
58      using (var instancesZipFile = new ZipFile(GetType().Assembly.GetManifestResourceStream(instanceArchiveName))) {
59        var entry = instancesZipFile.GetEntry(descriptor.InstanceIdentifier);
60        var stream = instancesZipFile.GetInputStream(entry);
61        var instance = LoadData(stream);
62        if (string.IsNullOrEmpty(instance.Name)) {
63          instance.Name = Path.GetFileNameWithoutExtension(entry.ToString());
64        }
65
66        if (!String.IsNullOrEmpty(descriptor.SolutionIdentifier)) {
67          var solutionsArchiveName = GetResourceName(FileName + @"\.opt\.zip");
68          using (var solutionsZipFile = new ZipFile(GetType().Assembly.GetManifestResourceStream(solutionsArchiveName))) {
69            entry = solutionsZipFile.GetEntry(descriptor.SolutionIdentifier);
70            stream = solutionsZipFile.GetInputStream(entry);
71            LoadSolution(stream, instance);
72          }
73        }
74
75        return instance;
76      }
77    }
78
79    #region IVRPInstanceProvider
80    public TData Import(string vrpFile, string tourFile) {
81      var data = ImportData(vrpFile);
82      if (!String.IsNullOrEmpty(tourFile)) {
83        LoadSolution(tourFile, data);
84      }
85      return data;
86    }
87
88    public void Export(TData instance, string path) {
89      ExportData(instance, path);
90    }
91    #endregion
92
93    protected virtual void LoadSolution(Stream stream, TData instance) {
94      LoadOptFile(stream, instance);
95    }
96
97    private void LoadOptFile(Stream stream, TData instance) {
98      List<List<int>> routes = new List<List<int>>();
99
100      using (StreamReader reader = new StreamReader(stream)) {
101        String line;
102        while ((line = reader.ReadLine()) != null) {
103          if (line.StartsWith("Route")) {
104            string[] token = line.Split(new string[] { " " }, StringSplitOptions.RemoveEmptyEntries);
105
106            List<int> route = new List<int>();
107
108            for (int i = 2; i < token.Length; i++) {
109              route.Add(int.Parse(token[i]) - 1);
110            }
111
112            routes.Add(route);
113          }
114
115          if (line.StartsWith("Solution")) {
116            if (routes.Any()) {
117              // Skip remaining solutions since only one "best solution" is stored
118              break;
119            }
120          }
121        }
122      }
123
124      instance.BestKnownTour = routes.Select(x => x.ToArray()).ToArray();
125    }
126
127    public void LoadSolution(string path, TData instance) {
128      try {
129        using (var stream = new FileStream(path, FileMode.Open)) {
130          LoadSolution(stream, instance);
131        }
132      } catch (Exception) {
133        // new stream necessary because first try already read from stream
134        using (var stream = new FileStream(path, FileMode.Open)) {
135          LoadOptFile(stream, instance); // Fallback to .opt-Format
136        }
137      }
138    }
139
140    protected abstract TData LoadData(Stream stream);
141
142    #region Helpers
143    protected virtual string GetResourceName(string fileName) {
144      return Assembly.GetExecutingAssembly().GetManifestResourceNames()
145              .Where(x => Regex.Match(x, @".*\.Data\." + fileName).Success).SingleOrDefault();
146    }
147
148    protected virtual string GetInstanceDescription() {
149      return "Embedded instance of plugin version " + Assembly.GetExecutingAssembly().GetCustomAttributes(typeof(AssemblyFileVersionAttribute), true).Cast<AssemblyFileVersionAttribute>().First().Version + ".";
150    }
151
152    protected IEnumerable<string> GetZipContents(ZipInputStream zipFile) {
153      ZipEntry entry;
154      while ((entry = zipFile.GetNextEntry()) != null) {
155        yield return entry.Name;
156      }
157    }
158    #endregion
159  }
160}
Note: See TracBrowser for help on using the repository browser.