Free cookie consent management tool by TermsFeed Policy Generator

source: branches/CloningRefactoring/HeuristicLab.Problems.TravelingSalesman/3.3/TravelingSalesmanProblem.cs @ 4683

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

#922

  • Refactored HeuristicLab.Problems.TravelingSalesman
File size: 19.5 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2010 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.Drawing;
25using System.IO;
26using System.Linq;
27using HeuristicLab.Common;
28using HeuristicLab.Core;
29using HeuristicLab.Data;
30using HeuristicLab.Encodings.PermutationEncoding;
31using HeuristicLab.Optimization;
32using HeuristicLab.Parameters;
33using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
34using HeuristicLab.PluginInfrastructure;
35
36namespace HeuristicLab.Problems.TravelingSalesman {
37  [Item("Traveling Salesman Problem", "Represents a symmetric Traveling Salesman Problem.")]
38  [Creatable("Problems")]
39  [StorableClass]
40  public sealed class TravelingSalesmanProblem : ParameterizedNamedItem, ISingleObjectiveProblem, IStorableContent {
41    public string Filename { get; set; }
42
43    public override Image ItemImage {
44      get { return HeuristicLab.Common.Resources.VS2008ImageLibrary.Type; }
45    }
46
47    #region Parameter Properties
48    public ValueParameter<BoolValue> MaximizationParameter {
49      get { return (ValueParameter<BoolValue>)Parameters["Maximization"]; }
50    }
51    IParameter ISingleObjectiveProblem.MaximizationParameter {
52      get { return MaximizationParameter; }
53    }
54    public ValueParameter<DoubleMatrix> CoordinatesParameter {
55      get { return (ValueParameter<DoubleMatrix>)Parameters["Coordinates"]; }
56    }
57    public OptionalValueParameter<DoubleMatrix> DistanceMatrixParameter {
58      get { return (OptionalValueParameter<DoubleMatrix>)Parameters["DistanceMatrix"]; }
59    }
60    public ValueParameter<BoolValue> UseDistanceMatrixParameter {
61      get { return (ValueParameter<BoolValue>)Parameters["UseDistanceMatrix"]; }
62    }
63    public ValueParameter<IPermutationCreator> SolutionCreatorParameter {
64      get { return (ValueParameter<IPermutationCreator>)Parameters["SolutionCreator"]; }
65    }
66    IParameter IProblem.SolutionCreatorParameter {
67      get { return SolutionCreatorParameter; }
68    }
69    public ValueParameter<ITSPEvaluator> EvaluatorParameter {
70      get { return (ValueParameter<ITSPEvaluator>)Parameters["Evaluator"]; }
71    }
72    IParameter IProblem.EvaluatorParameter {
73      get { return EvaluatorParameter; }
74    }
75    public OptionalValueParameter<DoubleValue> BestKnownQualityParameter {
76      get { return (OptionalValueParameter<DoubleValue>)Parameters["BestKnownQuality"]; }
77    }
78    IParameter ISingleObjectiveProblem.BestKnownQualityParameter {
79      get { return BestKnownQualityParameter; }
80    }
81    public OptionalValueParameter<Permutation> BestKnownSolutionParameter {
82      get { return (OptionalValueParameter<Permutation>)Parameters["BestKnownSolution"]; }
83    }
84    #endregion
85
86    #region Properties
87    public DoubleMatrix Coordinates {
88      get { return CoordinatesParameter.Value; }
89      set { CoordinatesParameter.Value = value; }
90    }
91    public DoubleMatrix DistanceMatrix {
92      get { return DistanceMatrixParameter.Value; }
93      set { DistanceMatrixParameter.Value = value; }
94    }
95    public BoolValue UseDistanceMatrix {
96      get { return UseDistanceMatrixParameter.Value; }
97      set { UseDistanceMatrixParameter.Value = value; }
98    }
99    public IPermutationCreator SolutionCreator {
100      get { return SolutionCreatorParameter.Value; }
101      set { SolutionCreatorParameter.Value = value; }
102    }
103    ISolutionCreator IProblem.SolutionCreator {
104      get { return SolutionCreatorParameter.Value; }
105    }
106    public ITSPEvaluator Evaluator {
107      get { return EvaluatorParameter.Value; }
108      set { EvaluatorParameter.Value = value; }
109    }
110    ISingleObjectiveEvaluator ISingleObjectiveProblem.Evaluator {
111      get { return EvaluatorParameter.Value; }
112    }
113    IEvaluator IProblem.Evaluator {
114      get { return EvaluatorParameter.Value; }
115    }
116    public DoubleValue BestKnownQuality {
117      get { return BestKnownQualityParameter.Value; }
118      set { BestKnownQualityParameter.Value = value; }
119    }
120    public Permutation BestKnownSolution {
121      get { return BestKnownSolutionParameter.Value; }
122      set { BestKnownSolutionParameter.Value = value; }
123    }
124    public IEnumerable<IOperator> Operators {
125      get { return operators; }
126    }
127    private BestTSPSolutionAnalyzer BestTSPSolutionAnalyzer {
128      get { return operators.OfType<BestTSPSolutionAnalyzer>().FirstOrDefault(); }
129    }
130    private TSPAlleleFrequencyAnalyzer TSPAlleleFrequencyAnalyzer {
131      get { return operators.OfType<TSPAlleleFrequencyAnalyzer>().FirstOrDefault(); }
132    }
133    #endregion
134
135    [Storable]
136    private List<IOperator> operators;
137
138    [StorableConstructor]
139    private TravelingSalesmanProblem(bool deserializing) : base(deserializing) { }
140    private TravelingSalesmanProblem(TravelingSalesmanProblem original, Cloner cloner)
141      : base(original, cloner) {
142      this.operators = original.operators.Select(x => (IOperator)cloner.Clone(x)).ToList();
143      this.DistanceMatrixParameter.Value = original.DistanceMatrixParameter.Value;
144      AttachEventHandlers();
145    }
146    public override IDeepCloneable Clone(Cloner cloner) {
147      return new TravelingSalesmanProblem(this, cloner);
148    }
149    public TravelingSalesmanProblem()
150      : base() {
151      RandomPermutationCreator creator = new RandomPermutationCreator();
152      TSPRoundedEuclideanPathEvaluator evaluator = new TSPRoundedEuclideanPathEvaluator();
153
154      Parameters.Add(new ValueParameter<BoolValue>("Maximization", "Set to false as the Traveling Salesman Problem is a minimization problem.", new BoolValue(false)));
155      Parameters.Add(new ValueParameter<DoubleMatrix>("Coordinates", "The x- and y-Coordinates of the cities."));
156      Parameters.Add(new OptionalValueParameter<DoubleMatrix>("DistanceMatrix", "The matrix which contains the distances between the cities."));
157      Parameters.Add(new ValueParameter<BoolValue>("UseDistanceMatrix", "True if a distance matrix should be calculated and used for evaluation, otherwise false.", new BoolValue(true)));
158      Parameters.Add(new ValueParameter<IPermutationCreator>("SolutionCreator", "The operator which should be used to create new TSP solutions.", creator));
159      Parameters.Add(new ValueParameter<ITSPEvaluator>("Evaluator", "The operator which should be used to evaluate TSP solutions.", evaluator));
160      Parameters.Add(new OptionalValueParameter<DoubleValue>("BestKnownQuality", "The quality of the best known solution of this TSP instance."));
161      Parameters.Add(new OptionalValueParameter<Permutation>("BestKnownSolution", "The best known solution of this TSP instance."));
162
163      Coordinates = new DoubleMatrix(new double[,] {
164        { 100, 100 }, { 100, 200 }, { 100, 300 }, { 100, 400 },
165        { 200, 100 }, { 200, 200 }, { 200, 300 }, { 200, 400 },
166        { 300, 100 }, { 300, 200 }, { 300, 300 }, { 300, 400 },
167        { 400, 100 }, { 400, 200 }, { 400, 300 }, { 400, 400 }
168      });
169
170      creator.PermutationParameter.ActualName = "TSPTour";
171      evaluator.QualityParameter.ActualName = "TSPTourLength";
172      ParameterizeSolutionCreator();
173      ParameterizeEvaluator();
174
175      InitializeOperators();
176      AttachEventHandlers();
177    }
178
179    #region Events
180    public event EventHandler SolutionCreatorChanged;
181    private void OnSolutionCreatorChanged() {
182      EventHandler handler = SolutionCreatorChanged;
183      if (handler != null) handler(this, EventArgs.Empty);
184    }
185    public event EventHandler EvaluatorChanged;
186    private void OnEvaluatorChanged() {
187      EventHandler handler = EvaluatorChanged;
188      if (handler != null) handler(this, EventArgs.Empty);
189    }
190    public event EventHandler OperatorsChanged;
191    private void OnOperatorsChanged() {
192      EventHandler handler = OperatorsChanged;
193      if (handler != null) handler(this, EventArgs.Empty);
194    }
195    public event EventHandler Reset;
196    private void OnReset() {
197      EventHandler handler = Reset;
198      if (handler != null) handler(this, EventArgs.Empty);
199    }
200
201    private void CoordinatesParameter_ValueChanged(object sender, EventArgs e) {
202      Coordinates.ItemChanged += new EventHandler<EventArgs<int, int>>(Coordinates_ItemChanged);
203      Coordinates.Reset += new EventHandler(Coordinates_Reset);
204      ParameterizeSolutionCreator();
205      ClearDistanceMatrix();
206    }
207    private void Coordinates_ItemChanged(object sender, EventArgs<int, int> e) {
208      ClearDistanceMatrix();
209    }
210    private void Coordinates_Reset(object sender, EventArgs e) {
211      ParameterizeSolutionCreator();
212      ClearDistanceMatrix();
213    }
214    private void SolutionCreatorParameter_ValueChanged(object sender, EventArgs e) {
215      SolutionCreator.PermutationParameter.ActualNameChanged += new EventHandler(SolutionCreator_PermutationParameter_ActualNameChanged);
216      ParameterizeSolutionCreator();
217      ParameterizeEvaluator();
218      ParameterizeAnalyzers();
219      ParameterizeOperators();
220      OnSolutionCreatorChanged();
221    }
222    private void SolutionCreator_PermutationParameter_ActualNameChanged(object sender, EventArgs e) {
223      ParameterizeEvaluator();
224      ParameterizeAnalyzers();
225      ParameterizeOperators();
226    }
227    private void EvaluatorParameter_ValueChanged(object sender, EventArgs e) {
228      Evaluator.QualityParameter.ActualNameChanged += new EventHandler(Evaluator_QualityParameter_ActualNameChanged);
229      ParameterizeEvaluator();
230      UpdateMoveEvaluators();
231      ParameterizeAnalyzers();
232      ClearDistanceMatrix();
233      OnEvaluatorChanged();
234    }
235    private void Evaluator_QualityParameter_ActualNameChanged(object sender, EventArgs e) {
236      ParameterizeAnalyzers();
237    }
238    private void MoveGenerator_InversionMoveParameter_ActualNameChanged(object sender, EventArgs e) {
239      string name = ((ILookupParameter<InversionMove>)sender).ActualName;
240      foreach (IPermutationInversionMoveOperator op in Operators.OfType<IPermutationInversionMoveOperator>()) {
241        op.InversionMoveParameter.ActualName = name;
242      }
243    }
244    private void MoveGenerator_TranslocationMoveParameter_ActualNameChanged(object sender, EventArgs e) {
245      string name = ((ILookupParameter<TranslocationMove>)sender).ActualName;
246      foreach (IPermutationTranslocationMoveOperator op in Operators.OfType<IPermutationTranslocationMoveOperator>()) {
247        op.TranslocationMoveParameter.ActualName = name;
248      }
249    }
250    #endregion
251
252    #region Helpers
253    [StorableHook(HookType.AfterDeserialization)]
254    private void AfterDeserialization() {
255      // BackwardsCompatibility3.3
256      #region Backwards compatible code (remove with 3.4)
257      if (operators == null) InitializeOperators();
258      #endregion
259      AttachEventHandlers();
260    }
261
262    private void AttachEventHandlers() {
263      CoordinatesParameter.ValueChanged += new EventHandler(CoordinatesParameter_ValueChanged);
264      Coordinates.ItemChanged += new EventHandler<EventArgs<int, int>>(Coordinates_ItemChanged);
265      Coordinates.Reset += new EventHandler(Coordinates_Reset);
266      SolutionCreatorParameter.ValueChanged += new EventHandler(SolutionCreatorParameter_ValueChanged);
267      SolutionCreator.PermutationParameter.ActualNameChanged += new EventHandler(SolutionCreator_PermutationParameter_ActualNameChanged);
268      EvaluatorParameter.ValueChanged += new EventHandler(EvaluatorParameter_ValueChanged);
269      Evaluator.QualityParameter.ActualNameChanged += new EventHandler(Evaluator_QualityParameter_ActualNameChanged);
270    }
271
272    private void InitializeOperators() {
273      operators = new List<IOperator>();
274      operators.Add(new BestTSPSolutionAnalyzer());
275      operators.Add(new TSPAlleleFrequencyAnalyzer());
276      ParameterizeAnalyzers();
277      operators.AddRange(ApplicationManager.Manager.GetInstances<IPermutationOperator>().Cast<IOperator>());
278      ParameterizeOperators();
279      UpdateMoveEvaluators();
280      InitializeMoveGenerators();
281    }
282    private void InitializeMoveGenerators() {
283      foreach (IPermutationInversionMoveOperator op in Operators.OfType<IPermutationInversionMoveOperator>()) {
284        if (op is IMoveGenerator) {
285          op.InversionMoveParameter.ActualNameChanged += new EventHandler(MoveGenerator_InversionMoveParameter_ActualNameChanged);
286        }
287      }
288      foreach (IPermutationTranslocationMoveOperator op in Operators.OfType<IPermutationTranslocationMoveOperator>()) {
289        if (op is IMoveGenerator) {
290          op.TranslocationMoveParameter.ActualNameChanged += new EventHandler(MoveGenerator_TranslocationMoveParameter_ActualNameChanged);
291        }
292      }
293    }
294    private void UpdateMoveEvaluators() {
295      operators.RemoveAll(x => x is ISingleObjectiveMoveEvaluator);
296      foreach (ITSPPathMoveEvaluator op in ApplicationManager.Manager.GetInstances<ITSPPathMoveEvaluator>())
297        if (op.EvaluatorType == Evaluator.GetType()) {
298          operators.Add(op);
299        }
300      ParameterizeOperators();
301      OnOperatorsChanged();
302    }
303    private void ParameterizeSolutionCreator() {
304      SolutionCreator.LengthParameter.Value = new IntValue(Coordinates.Rows);
305      SolutionCreator.PermutationTypeParameter.Value = new PermutationType(PermutationTypes.RelativeUndirected);
306    }
307    private void ParameterizeEvaluator() {
308      if (Evaluator is ITSPPathEvaluator)
309        ((ITSPPathEvaluator)Evaluator).PermutationParameter.ActualName = SolutionCreator.PermutationParameter.ActualName;
310      if (Evaluator is ITSPCoordinatesPathEvaluator) {
311        ITSPCoordinatesPathEvaluator evaluator = (ITSPCoordinatesPathEvaluator)Evaluator;
312        evaluator.CoordinatesParameter.ActualName = CoordinatesParameter.Name;
313        evaluator.DistanceMatrixParameter.ActualName = DistanceMatrixParameter.Name;
314        evaluator.UseDistanceMatrixParameter.ActualName = UseDistanceMatrixParameter.Name;
315      }
316    }
317    private void ParameterizeAnalyzers() {
318      if (BestTSPSolutionAnalyzer != null) {
319        BestTSPSolutionAnalyzer.QualityParameter.ActualName = Evaluator.QualityParameter.ActualName;
320        BestTSPSolutionAnalyzer.CoordinatesParameter.ActualName = CoordinatesParameter.Name;
321        BestTSPSolutionAnalyzer.PermutationParameter.ActualName = SolutionCreator.PermutationParameter.ActualName;
322        BestTSPSolutionAnalyzer.ResultsParameter.ActualName = "Results";
323        BestTSPSolutionAnalyzer.BestKnownQualityParameter.ActualName = BestKnownQualityParameter.Name;
324        BestTSPSolutionAnalyzer.BestKnownSolutionParameter.ActualName = BestKnownSolutionParameter.Name;
325        BestTSPSolutionAnalyzer.MaximizationParameter.ActualName = MaximizationParameter.Name;
326      }
327
328      if (TSPAlleleFrequencyAnalyzer != null) {
329        TSPAlleleFrequencyAnalyzer.MaximizationParameter.ActualName = MaximizationParameter.Name;
330        TSPAlleleFrequencyAnalyzer.CoordinatesParameter.ActualName = CoordinatesParameter.Name;
331        TSPAlleleFrequencyAnalyzer.SolutionParameter.ActualName = SolutionCreator.PermutationParameter.ActualName;
332        TSPAlleleFrequencyAnalyzer.QualityParameter.ActualName = Evaluator.QualityParameter.ActualName;
333        TSPAlleleFrequencyAnalyzer.BestKnownSolutionParameter.ActualName = BestKnownSolutionParameter.Name;
334        TSPAlleleFrequencyAnalyzer.ResultsParameter.ActualName = "Results";
335      }
336    }
337    private void ParameterizeOperators() {
338      foreach (IPermutationCrossover op in Operators.OfType<IPermutationCrossover>()) {
339        op.ParentsParameter.ActualName = SolutionCreator.PermutationParameter.ActualName;
340        op.ChildParameter.ActualName = SolutionCreator.PermutationParameter.ActualName;
341      }
342      foreach (IPermutationManipulator op in Operators.OfType<IPermutationManipulator>()) {
343        op.PermutationParameter.ActualName = SolutionCreator.PermutationParameter.ActualName;
344      }
345      foreach (IPermutationMoveOperator op in Operators.OfType<IPermutationMoveOperator>()) {
346        op.PermutationParameter.ActualName = SolutionCreator.PermutationParameter.ActualName;
347      }
348      foreach (ITSPPathMoveEvaluator op in Operators.OfType<ITSPPathMoveEvaluator>()) {
349        op.CoordinatesParameter.ActualName = CoordinatesParameter.Name;
350        op.DistanceMatrixParameter.ActualName = DistanceMatrixParameter.Name;
351        op.UseDistanceMatrixParameter.ActualName = UseDistanceMatrixParameter.Name;
352        op.QualityParameter.ActualName = Evaluator.QualityParameter.ActualName;
353        op.PermutationParameter.ActualName = SolutionCreator.PermutationParameter.ActualName;
354      }
355      string inversionMove = Operators.OfType<IMoveGenerator>().OfType<IPermutationInversionMoveOperator>().First().InversionMoveParameter.ActualName;
356      foreach (IPermutationInversionMoveOperator op in Operators.OfType<IPermutationInversionMoveOperator>())
357        op.InversionMoveParameter.ActualName = inversionMove;
358      string translocationMove = Operators.OfType<IMoveGenerator>().OfType<IPermutationTranslocationMoveOperator>().First().TranslocationMoveParameter.ActualName;
359      foreach (IPermutationTranslocationMoveOperator op in Operators.OfType<IPermutationTranslocationMoveOperator>())
360        op.TranslocationMoveParameter.ActualName = translocationMove;
361    }
362
363    private void ClearDistanceMatrix() {
364      DistanceMatrixParameter.Value = null;
365    }
366    #endregion
367
368    public void ImportFromTSPLIB(string tspFileName, string optimalTourFileName) {
369      TSPLIBParser tspParser = new TSPLIBParser(tspFileName);
370      tspParser.Parse();
371      Name = tspParser.Name + " TSP (imported from TSPLIB)";
372      if (!string.IsNullOrEmpty(tspParser.Comment)) Description = tspParser.Comment;
373      Coordinates = new DoubleMatrix(tspParser.Vertices);
374      if (tspParser.WeightType == TSPLIBParser.TSPLIBEdgeWeightType.EUC_2D) {
375        TSPRoundedEuclideanPathEvaluator evaluator = new TSPRoundedEuclideanPathEvaluator();
376        evaluator.QualityParameter.ActualName = "TSPTourLength";
377        Evaluator = evaluator;
378      } else if (tspParser.WeightType == TSPLIBParser.TSPLIBEdgeWeightType.GEO) {
379        TSPGeoPathEvaluator evaluator = new TSPGeoPathEvaluator();
380        evaluator.QualityParameter.ActualName = "TSPTourLength";
381        Evaluator = evaluator;
382      }
383      BestKnownQuality = null;
384      BestKnownSolution = null;
385
386      if (!string.IsNullOrEmpty(optimalTourFileName)) {
387        TSPLIBTourParser tourParser = new TSPLIBTourParser(optimalTourFileName);
388        tourParser.Parse();
389        if (tourParser.Tour.Length != Coordinates.Rows) throw new InvalidDataException("Length of optimal tour is not equal to number of cities.");
390        BestKnownSolution = new Permutation(PermutationTypes.RelativeUndirected, tourParser.Tour);
391      }
392      OnReset();
393    }
394    public void ImportFromTSPLIB(string tspFileName, string optimalTourFileName, double bestKnownQuality) {
395      ImportFromTSPLIB(tspFileName, optimalTourFileName);
396      BestKnownQuality = new DoubleValue(bestKnownQuality);
397    }
398  }
399}
Note: See TracBrowser for help on using the repository browser.