source: branches/HeuristicLab.Problems.Orienteering/HeuristicLab.Problems.Instances.Orienteering/3.3/SchildeOPInstanceProvider.cs @ 11260

#region License Information
/* HeuristicLab
 * Copyright (C) 2002-2014 Heuristic and Evolutionary Algorithms Laboratory (HEAL)
 *
 * This file is part of HeuristicLab.
 *
 * HeuristicLab is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * HeuristicLab is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with HeuristicLab. If not, see <http://www.gnu.org/licenses/>.
 */
#endregion

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Reflection;
using System.Text.RegularExpressions;
using HeuristicLab.Problems.Instances.Types;
using ICSharpCode.SharpZipLib.Zip;

namespace HeuristicLab.Problems.Instances.Orienteering {
  public class SchildeOPInstanceProvider : ProblemInstanceProvider<OPData> {
    public override string Name {
      get { return "Schilde OP instances"; }
    }
    public override string Description {
      get { return "Modified Tsiligirdes (1984) and Chao (1996) instances by Schilde."; }
    }
    public override string ReferencePublication {
      get { return "Metaheuristics for the bi-objective orienteering problem (Michael Schilde, Karl F. Doerner, Richard F. Hartl, Guenter Kiechle)"; }
    }
    public override Uri WebLink {
      get { return new Uri("http://prolog.univie.ac.at/research/OP/"); }
    }

    private const string FileName = "SchildeOP";

    public override IEnumerable<IDataDescriptor> GetDataDescriptors() {
      var instanceArchiveName = GetResourceName(FileName + @"\.zip");
      if (String.IsNullOrEmpty(instanceArchiveName)) yield break;

      using (var instanceStream = new ZipInputStream(GetType().Assembly.GetManifestResourceStream(instanceArchiveName))) {
        foreach (var entry in GetZipContents(instanceStream).OrderBy(x => x)) {
          yield return new OPDataDescriptor(Path.GetFileNameWithoutExtension(entry), GetInstanceDescription(), entry);
        }
      }
    }
    public override OPData LoadData(IDataDescriptor id) {
      var descriptor = (OPDataDescriptor)id;
      var instanceArchiveName = GetResourceName(FileName + @"\.zip");
      var parser = new SchildeOPParser();
      using (var instancesZipFile = new ZipFile(GetType().Assembly.GetManifestResourceStream(instanceArchiveName))) {
        var entry = instancesZipFile.GetEntry(descriptor.InstanceIdentifier);
        using (var stream = instancesZipFile.GetInputStream(entry)) {
          parser.Parse(stream);
          var instance = LoadInstance(parser);

          instance.Name = id.Name;
          instance.Description = id.Description;

          return instance;
        }
      }
    }

    public override bool CanImportData {
      get { return true; }
    }
    public override OPData ImportData(string path) {
      var parser = new SchildeOPParser();
      parser.Parse(path);
      var instance = LoadInstance(parser);

      instance.Name = Path.GetFileName(path);
      instance.Description = "Loaded from file \"" + path + "\" on " + DateTime.Now.ToString();

      return instance;
    }

    private OPData LoadInstance(SchildeOPParser parser) {
      return new OPData {
        Dimension = parser.Coordinates.GetLength(0),
        Coordinates = parser.Coordinates,
        Distances = parser.Distances,
        MaximumDistance = parser.UpperBoundConstraint,
        StartingPoint = parser.StartingPoint,
        TerminusPoint = parser.TerminusPoint,
        Scores = Enumerable.Range(0, parser.Scores.GetLength(0)).Select(i => parser.Scores[i, 0]).ToArray()
      };
    }

    protected virtual string GetResourceName(string fileName) {
      return Assembly.GetExecutingAssembly().GetManifestResourceNames()
        .SingleOrDefault(x => Regex.Match(x, @".*\.Data\." + fileName).Success);
    }
    protected IEnumerable<string> GetZipContents(ZipInputStream zipFile) {
      ZipEntry entry;
      while ((entry = zipFile.GetNextEntry()) != null) {
        yield return entry.Name;
      }
    }
    protected virtual string GetInstanceDescription() {
      return "Embedded instance of plugin version " + Assembly.GetExecutingAssembly().GetCustomAttributes(typeof(AssemblyFileVersionAttribute), true).Cast<AssemblyFileVersionAttribute>().First().Version + ".";
    }
  }
}