Free cookie consent management tool by TermsFeed Policy Generator

source: trunk/sources/HeuristicLab.Problems.TravelingSalesman/3.3/TravelingSalesmanProblem.cs @ 6938

Last change on this file since 6938 was 6938, checked in by abeham, 13 years ago

#1663

  • Added an *Operators* parameter in Problem
  • Adapted KnapsackProblem, OnemaxProblem, SingleObjectiveTestFunctionProblem, TravelingSalesmanProblem, and VehicleRoutingProblem to derive from SingleObjectiveHeuristicOptimizationProblem<U, V>, renamed and marked old list as obsolete. Note that QuadraticAssignmentProblem, as well as the new DataAnalysisProblems already derived from that class. ArtificialAntProblem was not yet modified.
  • Added some test lists and adapted SamplesTest
  • Added plugin dependencies that the unit test was complaining about
File size: 16.9 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2011 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 HeuristicLab.Common;
27using HeuristicLab.Core;
28using HeuristicLab.Data;
29using HeuristicLab.Encodings.PermutationEncoding;
30using HeuristicLab.Optimization;
31using HeuristicLab.Parameters;
32using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
33using HeuristicLab.PluginInfrastructure;
34
35namespace HeuristicLab.Problems.TravelingSalesman {
36  [Item("Traveling Salesman Problem", "Represents a symmetric Traveling Salesman Problem.")]
37  [Creatable("Problems")]
38  [StorableClass]
39  public sealed class TravelingSalesmanProblem : SingleObjectiveHeuristicOptimizationProblem<ITSPEvaluator, IPermutationCreator>, IStorableContent {
40    public string Filename { get; set; }
41
42    #region Parameter Properties
43    public ValueParameter<DoubleMatrix> CoordinatesParameter {
44      get { return (ValueParameter<DoubleMatrix>)Parameters["Coordinates"]; }
45    }
46    public OptionalValueParameter<DistanceMatrix> DistanceMatrixParameter {
47      get { return (OptionalValueParameter<DistanceMatrix>)Parameters["DistanceMatrix"]; }
48    }
49    public ValueParameter<BoolValue> UseDistanceMatrixParameter {
50      get { return (ValueParameter<BoolValue>)Parameters["UseDistanceMatrix"]; }
51    }
52    public OptionalValueParameter<Permutation> BestKnownSolutionParameter {
53      get { return (OptionalValueParameter<Permutation>)Parameters["BestKnownSolution"]; }
54    }
55    #endregion
56
57    #region Properties
58    public DoubleMatrix Coordinates {
59      get { return CoordinatesParameter.Value; }
60      set { CoordinatesParameter.Value = value; }
61    }
62    public DistanceMatrix DistanceMatrix {
63      get { return DistanceMatrixParameter.Value; }
64      set { DistanceMatrixParameter.Value = value; }
65    }
66    public BoolValue UseDistanceMatrix {
67      get { return UseDistanceMatrixParameter.Value; }
68      set { UseDistanceMatrixParameter.Value = value; }
69    }
70    public Permutation BestKnownSolution {
71      get { return BestKnownSolutionParameter.Value; }
72      set { BestKnownSolutionParameter.Value = value; }
73    }
74    private BestTSPSolutionAnalyzer BestTSPSolutionAnalyzer {
75      get { return Operators.OfType<BestTSPSolutionAnalyzer>().FirstOrDefault(); }
76    }
77    private TSPAlleleFrequencyAnalyzer TSPAlleleFrequencyAnalyzer {
78      get { return Operators.OfType<TSPAlleleFrequencyAnalyzer>().FirstOrDefault(); }
79    }
80    private TSPPopulationDiversityAnalyzer TSPPopulationDiversityAnalyzer {
81      get { return Operators.OfType<TSPPopulationDiversityAnalyzer>().FirstOrDefault(); }
82    }
83    #endregion
84
85    // BackwardsCompatibility3.3
86    #region Backwards compatible code, remove with 3.4
87    [Obsolete]
88    [Storable(Name = "operators")]
89    private IEnumerable<IOperator> oldOperators {
90      get { return null; }
91      set {
92        if (value != null && value.Any())
93          Operators.AddRange(value);
94      }
95    }
96    #endregion
97
98    [StorableConstructor]
99    private TravelingSalesmanProblem(bool deserializing) : base(deserializing) { }
100    private TravelingSalesmanProblem(TravelingSalesmanProblem original, Cloner cloner)
101      : base(original, cloner) {
102      AttachEventHandlers();
103    }
104    public override IDeepCloneable Clone(Cloner cloner) {
105      return new TravelingSalesmanProblem(this, cloner);
106    }
107    public TravelingSalesmanProblem()
108      : base(new TSPRoundedEuclideanPathEvaluator(), new RandomPermutationCreator()) {
109
110      Parameters.Add(new ValueParameter<DoubleMatrix>("Coordinates", "The x- and y-Coordinates of the cities."));
111      Parameters.Add(new OptionalValueParameter<DistanceMatrix>("DistanceMatrix", "The matrix which contains the distances between the cities."));
112      Parameters.Add(new ValueParameter<BoolValue>("UseDistanceMatrix", "True if a distance matrix should be calculated and used for evaluation, otherwise false.", new BoolValue(true)));
113      Parameters.Add(new OptionalValueParameter<Permutation>("BestKnownSolution", "The best known solution of this TSP instance."));
114
115      MaximizationParameter.Hidden = true;
116      DistanceMatrixParameter.ReactOnValueToStringChangedAndValueItemImageChanged = false;
117
118      Coordinates = new DoubleMatrix(new double[,] {
119        { 100, 100 }, { 100, 200 }, { 100, 300 }, { 100, 400 },
120        { 200, 100 }, { 200, 200 }, { 200, 300 }, { 200, 400 },
121        { 300, 100 }, { 300, 200 }, { 300, 300 }, { 300, 400 },
122        { 400, 100 }, { 400, 200 }, { 400, 300 }, { 400, 400 }
123      });
124
125      SolutionCreator.PermutationParameter.ActualName = "TSPTour";
126      Evaluator.QualityParameter.ActualName = "TSPTourLength";
127      ParameterizeSolutionCreator();
128      ParameterizeEvaluator();
129
130      InitializeOperators();
131      AttachEventHandlers();
132    }
133
134    #region Events
135    protected override void OnSolutionCreatorChanged() {
136      base.OnSolutionCreatorChanged();
137      SolutionCreator.PermutationParameter.ActualNameChanged += new EventHandler(SolutionCreator_PermutationParameter_ActualNameChanged);
138      ParameterizeSolutionCreator();
139      ParameterizeEvaluator();
140      ParameterizeAnalyzers();
141      ParameterizeOperators();
142    }
143    protected override void OnEvaluatorChanged() {
144      base.OnEvaluatorChanged();
145      Evaluator.QualityParameter.ActualNameChanged += new EventHandler(Evaluator_QualityParameter_ActualNameChanged);
146      ParameterizeEvaluator();
147      UpdateMoveEvaluators();
148      ParameterizeAnalyzers();
149      ClearDistanceMatrix();
150    }
151    private void CoordinatesParameter_ValueChanged(object sender, EventArgs e) {
152      Coordinates.ItemChanged += new EventHandler<EventArgs<int, int>>(Coordinates_ItemChanged);
153      Coordinates.Reset += new EventHandler(Coordinates_Reset);
154      ParameterizeSolutionCreator();
155      ClearDistanceMatrix();
156    }
157    private void Coordinates_ItemChanged(object sender, EventArgs<int, int> e) {
158      ClearDistanceMatrix();
159    }
160    private void Coordinates_Reset(object sender, EventArgs e) {
161      ParameterizeSolutionCreator();
162      ClearDistanceMatrix();
163    }
164    private void SolutionCreator_PermutationParameter_ActualNameChanged(object sender, EventArgs e) {
165      ParameterizeEvaluator();
166      ParameterizeAnalyzers();
167      ParameterizeOperators();
168    }
169    private void Evaluator_QualityParameter_ActualNameChanged(object sender, EventArgs e) {
170      ParameterizeAnalyzers();
171    }
172    #endregion
173
174    #region Helpers
175    [StorableHook(HookType.AfterDeserialization)]
176    private void AfterDeserialization() {
177      // BackwardsCompatibility3.3
178      #region Backwards compatible code (remove with 3.4)
179      OptionalValueParameter<DoubleMatrix> oldDistanceMatrixParameter = Parameters["DistanceMatrix"] as OptionalValueParameter<DoubleMatrix>;
180      if (oldDistanceMatrixParameter != null) {
181        Parameters.Remove(oldDistanceMatrixParameter);
182        Parameters.Add(new OptionalValueParameter<DistanceMatrix>("DistanceMatrix", "The matrix which contains the distances between the cities."));
183        DistanceMatrixParameter.GetsCollected = oldDistanceMatrixParameter.GetsCollected;
184        DistanceMatrixParameter.ReactOnValueToStringChangedAndValueItemImageChanged = false;
185        if (oldDistanceMatrixParameter.Value != null) {
186          DoubleMatrix oldDM = oldDistanceMatrixParameter.Value;
187          DistanceMatrix newDM = new DistanceMatrix(oldDM.Rows, oldDM.Columns, oldDM.ColumnNames, oldDM.RowNames);
188          newDM.SortableView = oldDM.SortableView;
189          for (int i = 0; i < newDM.Rows; i++)
190            for (int j = 0; j < newDM.Columns; j++)
191              newDM[i, j] = oldDM[i, j];
192          DistanceMatrixParameter.Value = (DistanceMatrix)newDM.AsReadOnly();
193        }
194      }
195
196      if (Operators.Count == 0) InitializeOperators();
197      #endregion
198      AttachEventHandlers();
199    }
200
201    private void AttachEventHandlers() {
202      CoordinatesParameter.ValueChanged += new EventHandler(CoordinatesParameter_ValueChanged);
203      Coordinates.ItemChanged += new EventHandler<EventArgs<int, int>>(Coordinates_ItemChanged);
204      Coordinates.Reset += new EventHandler(Coordinates_Reset);
205      SolutionCreator.PermutationParameter.ActualNameChanged += new EventHandler(SolutionCreator_PermutationParameter_ActualNameChanged);
206      Evaluator.QualityParameter.ActualNameChanged += new EventHandler(Evaluator_QualityParameter_ActualNameChanged);
207    }
208
209    private void InitializeOperators() {
210      Operators.Add(new BestTSPSolutionAnalyzer());
211      Operators.Add(new TSPAlleleFrequencyAnalyzer());
212      Operators.Add(new TSPPopulationDiversityAnalyzer());
213      ParameterizeAnalyzers();
214      Operators.AddRange(ApplicationManager.Manager.GetInstances<IPermutationOperator>().Cast<IOperator>());
215      ParameterizeOperators();
216      UpdateMoveEvaluators();
217    }
218    private void UpdateMoveEvaluators() {
219      Operators.RemoveAll(x => x is ISingleObjectiveMoveEvaluator);
220      foreach (ITSPPathMoveEvaluator op in ApplicationManager.Manager.GetInstances<ITSPPathMoveEvaluator>())
221        if (op.EvaluatorType == Evaluator.GetType()) {
222          Operators.Add(op);
223        }
224      ParameterizeOperators();
225      OnOperatorsChanged();
226    }
227    private void ParameterizeSolutionCreator() {
228      SolutionCreator.LengthParameter.Value = new IntValue(Coordinates.Rows);
229      SolutionCreator.LengthParameter.Hidden = true;
230      SolutionCreator.PermutationTypeParameter.Value = new PermutationType(PermutationTypes.RelativeUndirected);
231      SolutionCreator.PermutationTypeParameter.Hidden = true;
232    }
233    private void ParameterizeEvaluator() {
234      if (Evaluator is ITSPPathEvaluator) {
235        ITSPPathEvaluator evaluator = (ITSPPathEvaluator)Evaluator;
236        evaluator.PermutationParameter.ActualName = SolutionCreator.PermutationParameter.ActualName;
237        evaluator.PermutationParameter.Hidden = true;
238      }
239      if (Evaluator is ITSPCoordinatesPathEvaluator) {
240        ITSPCoordinatesPathEvaluator evaluator = (ITSPCoordinatesPathEvaluator)Evaluator;
241        evaluator.CoordinatesParameter.ActualName = CoordinatesParameter.Name;
242        evaluator.CoordinatesParameter.Hidden = true;
243        evaluator.DistanceMatrixParameter.ActualName = DistanceMatrixParameter.Name;
244        evaluator.DistanceMatrixParameter.Hidden = true;
245        evaluator.UseDistanceMatrixParameter.ActualName = UseDistanceMatrixParameter.Name;
246        evaluator.UseDistanceMatrixParameter.Hidden = true;
247      }
248    }
249    private void ParameterizeAnalyzers() {
250      if (BestTSPSolutionAnalyzer != null) {
251        BestTSPSolutionAnalyzer.QualityParameter.ActualName = Evaluator.QualityParameter.ActualName;
252        BestTSPSolutionAnalyzer.CoordinatesParameter.ActualName = CoordinatesParameter.Name;
253        BestTSPSolutionAnalyzer.PermutationParameter.ActualName = SolutionCreator.PermutationParameter.ActualName;
254        BestTSPSolutionAnalyzer.ResultsParameter.ActualName = "Results";
255        BestTSPSolutionAnalyzer.BestKnownQualityParameter.ActualName = BestKnownQualityParameter.Name;
256        BestTSPSolutionAnalyzer.BestKnownSolutionParameter.ActualName = BestKnownSolutionParameter.Name;
257        BestTSPSolutionAnalyzer.MaximizationParameter.ActualName = MaximizationParameter.Name;
258      }
259
260      if (TSPAlleleFrequencyAnalyzer != null) {
261        TSPAlleleFrequencyAnalyzer.MaximizationParameter.ActualName = MaximizationParameter.Name;
262        TSPAlleleFrequencyAnalyzer.CoordinatesParameter.ActualName = CoordinatesParameter.Name;
263        TSPAlleleFrequencyAnalyzer.DistanceMatrixParameter.ActualName = DistanceMatrixParameter.Name;
264        TSPAlleleFrequencyAnalyzer.SolutionParameter.ActualName = SolutionCreator.PermutationParameter.ActualName;
265        TSPAlleleFrequencyAnalyzer.QualityParameter.ActualName = Evaluator.QualityParameter.ActualName;
266        TSPAlleleFrequencyAnalyzer.BestKnownSolutionParameter.ActualName = BestKnownSolutionParameter.Name;
267        TSPAlleleFrequencyAnalyzer.ResultsParameter.ActualName = "Results";
268      }
269
270      if (TSPPopulationDiversityAnalyzer != null) {
271        TSPPopulationDiversityAnalyzer.MaximizationParameter.ActualName = MaximizationParameter.Name;
272        TSPPopulationDiversityAnalyzer.SolutionParameter.ActualName = SolutionCreator.PermutationParameter.ActualName;
273        TSPPopulationDiversityAnalyzer.QualityParameter.ActualName = Evaluator.QualityParameter.ActualName;
274        TSPPopulationDiversityAnalyzer.ResultsParameter.ActualName = "Results";
275      }
276    }
277    private void ParameterizeOperators() {
278      foreach (IPermutationCrossover op in Operators.OfType<IPermutationCrossover>()) {
279        op.ParentsParameter.ActualName = SolutionCreator.PermutationParameter.ActualName;
280        op.ParentsParameter.Hidden = true;
281        op.ChildParameter.ActualName = SolutionCreator.PermutationParameter.ActualName;
282        op.ChildParameter.Hidden = true;
283      }
284      foreach (IPermutationManipulator op in Operators.OfType<IPermutationManipulator>()) {
285        op.PermutationParameter.ActualName = SolutionCreator.PermutationParameter.ActualName;
286        op.PermutationParameter.Hidden = true;
287      }
288      foreach (IPermutationMoveOperator op in Operators.OfType<IPermutationMoveOperator>()) {
289        op.PermutationParameter.ActualName = SolutionCreator.PermutationParameter.ActualName;
290        op.PermutationParameter.Hidden = true;
291      }
292      foreach (ITSPPathMoveEvaluator op in Operators.OfType<ITSPPathMoveEvaluator>()) {
293        op.CoordinatesParameter.ActualName = CoordinatesParameter.Name;
294        op.CoordinatesParameter.Hidden = true;
295        op.DistanceMatrixParameter.ActualName = DistanceMatrixParameter.Name;
296        op.DistanceMatrixParameter.Hidden = true;
297        op.UseDistanceMatrixParameter.ActualName = UseDistanceMatrixParameter.Name;
298        op.UseDistanceMatrixParameter.Hidden = true;
299        op.QualityParameter.ActualName = Evaluator.QualityParameter.ActualName;
300        op.QualityParameter.Hidden = true;
301        op.PermutationParameter.ActualName = SolutionCreator.PermutationParameter.ActualName;
302        op.PermutationParameter.Hidden = true;
303      }
304      foreach (IPermutationMultiNeighborhoodShakingOperator op in Operators.OfType<IPermutationMultiNeighborhoodShakingOperator>()) {
305        op.PermutationParameter.ActualName = SolutionCreator.PermutationParameter.ActualName;
306        op.PermutationParameter.Hidden = true;
307      }
308    }
309
310    private void ClearDistanceMatrix() {
311      DistanceMatrixParameter.Value = null;
312    }
313    #endregion
314
315    public void ImportFromTSPLIB(string tspFileName, string optimalTourFileName) {
316      TSPLIBParser tspParser = new TSPLIBParser(tspFileName);
317      tspParser.Parse();
318      Name = tspParser.Name + " TSP (imported from TSPLIB)";
319      if (!string.IsNullOrEmpty(tspParser.Comment)) Description = tspParser.Comment;
320      Coordinates = new DoubleMatrix(tspParser.Vertices);
321      if (tspParser.WeightType == TSPLIBParser.TSPLIBEdgeWeightType.EUC_2D) {
322        TSPRoundedEuclideanPathEvaluator evaluator = new TSPRoundedEuclideanPathEvaluator();
323        evaluator.QualityParameter.ActualName = "TSPTourLength";
324        Evaluator = evaluator;
325      } else if (tspParser.WeightType == TSPLIBParser.TSPLIBEdgeWeightType.GEO) {
326        TSPGeoPathEvaluator evaluator = new TSPGeoPathEvaluator();
327        evaluator.QualityParameter.ActualName = "TSPTourLength";
328        Evaluator = evaluator;
329      }
330      BestKnownQuality = null;
331      BestKnownSolution = null;
332
333      if (!string.IsNullOrEmpty(optimalTourFileName)) {
334        TSPLIBTourParser tourParser = new TSPLIBTourParser(optimalTourFileName);
335        tourParser.Parse();
336        if (tourParser.Tour.Length != Coordinates.Rows) throw new InvalidDataException("Length of optimal tour is not equal to number of cities.");
337        BestKnownSolution = new Permutation(PermutationTypes.RelativeUndirected, tourParser.Tour);
338      }
339      OnReset();
340    }
341    public void ImportFromTSPLIB(string tspFileName, string optimalTourFileName, double bestKnownQuality) {
342      ImportFromTSPLIB(tspFileName, optimalTourFileName);
343      BestKnownQuality = new DoubleValue(bestKnownQuality);
344    }
345  }
346}
Note: See TracBrowser for help on using the repository browser.