source: branches/ParameterBinding/HeuristicLab.Problems.TravelingSalesman/3.3/TravelingSalesmanProblem.cs @ 4787

Last change on this file since 4787 was 4787, checked in by abeham, 12 years ago

#1258

  • Updated binding according to discussion
  • Added small test case for the TSP
File size: 20.9 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    private TSPPopulationDiversityAnalyzer TSPPopulationDiversityAnalyzer {
134      get { return operators.OfType<TSPPopulationDiversityAnalyzer>().FirstOrDefault(); }
135    }
136    #endregion
137
138    [Storable]
139    private List<IOperator> operators;
140
141    [StorableConstructor]
142    private TravelingSalesmanProblem(bool deserializing) : base(deserializing) { }
143    private TravelingSalesmanProblem(TravelingSalesmanProblem original, Cloner cloner)
144      : base(original, cloner) {
145      this.operators = original.operators.Select(x => (IOperator)cloner.Clone(x)).ToList();
146      this.DistanceMatrixParameter.Value = original.DistanceMatrixParameter.Value;
147      AttachEventHandlers();
148    }
149    public override IDeepCloneable Clone(Cloner cloner) {
150      return new TravelingSalesmanProblem(this, cloner);
151    }
152    public TravelingSalesmanProblem()
153      : base() {
154      RandomPermutationCreator creator = new RandomPermutationCreator();
155      TSPRoundedEuclideanPathEvaluator evaluator = new TSPRoundedEuclideanPathEvaluator();
156
157      Parameters.Add(new ValueParameter<BoolValue>("Maximization", "Set to false as the Traveling Salesman Problem is a minimization problem.", new BoolValue(false)));
158      Parameters.Add(new ValueParameter<DoubleMatrix>("Coordinates", "The x- and y-Coordinates of the cities."));
159      Parameters.Add(new OptionalValueParameter<DoubleMatrix>("DistanceMatrix", "The matrix which contains the distances between the cities."));
160      Parameters.Add(new ValueParameter<BoolValue>("UseDistanceMatrix", "True if a distance matrix should be calculated and used for evaluation, otherwise false.", new BoolValue(true)));
161      Parameters.Add(new ValueParameter<IPermutationCreator>("SolutionCreator", "The operator which should be used to create new TSP solutions.", creator));
162      Parameters.Add(new ValueParameter<ITSPEvaluator>("Evaluator", "The operator which should be used to evaluate TSP solutions.", evaluator));
163      Parameters.Add(new OptionalValueParameter<DoubleValue>("BestKnownQuality", "The quality of the best known solution of this TSP instance."));
164      Parameters.Add(new OptionalValueParameter<Permutation>("BestKnownSolution", "The best known solution of this TSP instance."));
165
166      Coordinates = new DoubleMatrix(new double[,] {
167        { 100, 100 }, { 100, 200 }, { 100, 300 }, { 100, 400 },
168        { 200, 100 }, { 200, 200 }, { 200, 300 }, { 200, 400 },
169        { 300, 100 }, { 300, 200 }, { 300, 300 }, { 300, 400 },
170        { 400, 100 }, { 400, 200 }, { 400, 300 }, { 400, 400 }
171      });
172
173      creator.PermutationParameter.ActualName = "TSPTour";
174      evaluator.QualityParameter.ActualName = "TSPTourLength";
175      ParameterizeSolutionCreator();
176      ParameterizeEvaluator();
177
178      InitializeOperators();
179      AttachEventHandlers();
180
181      AddBinding("BestTSPSolutionAnalyzer.QualityParameter.ActualName", "Evaluator.QualityParameter.ActualName");
182      AddBinding("BestTSPSolutionAnalyzer.CoordinatesParameter.ActualName", "CoordinatesParameter.Name");
183      AddBinding("BestTSPSolutionAnalyzer.PermutationParameter.ActualName", "SolutionCreator.PermutationParameter.ActualName");
184      AddBinding("BestTSPSolutionAnalyzer.BestKnownQualityParameter.ActualName", "BestKnownQualityParameter.Name");
185      AddBinding("BestTSPSolutionAnalyzer.BestKnownSolutionParameter.ActualName", "BestKnownSolutionParameter.Name");
186      AddBinding("BestTSPSolutionAnalyzer.MaximizationParameter.ActualName", "MaximizationParameter.Name");
187      BestTSPSolutionAnalyzer.ResultsParameter.ActualName = "Results";
188    }
189
190    #region Events
191    public event EventHandler SolutionCreatorChanged;
192    private void OnSolutionCreatorChanged() {
193      EventHandler handler = SolutionCreatorChanged;
194      if (handler != null) handler(this, EventArgs.Empty);
195    }
196    public event EventHandler EvaluatorChanged;
197    private void OnEvaluatorChanged() {
198      EventHandler handler = EvaluatorChanged;
199      if (handler != null) handler(this, EventArgs.Empty);
200    }
201    public event EventHandler OperatorsChanged;
202    private void OnOperatorsChanged() {
203      EventHandler handler = OperatorsChanged;
204      if (handler != null) handler(this, EventArgs.Empty);
205    }
206    public event EventHandler Reset;
207    private void OnReset() {
208      EventHandler handler = Reset;
209      if (handler != null) handler(this, EventArgs.Empty);
210    }
211
212    private void CoordinatesParameter_ValueChanged(object sender, EventArgs e) {
213      Coordinates.ItemChanged += new EventHandler<EventArgs<int, int>>(Coordinates_ItemChanged);
214      Coordinates.Reset += new EventHandler(Coordinates_Reset);
215      ParameterizeSolutionCreator();
216      ClearDistanceMatrix();
217    }
218    private void Coordinates_ItemChanged(object sender, EventArgs<int, int> e) {
219      ClearDistanceMatrix();
220    }
221    private void Coordinates_Reset(object sender, EventArgs e) {
222      ParameterizeSolutionCreator();
223      ClearDistanceMatrix();
224    }
225    private void SolutionCreatorParameter_ValueChanged(object sender, EventArgs e) {
226      SolutionCreator.PermutationParameter.ActualNameChanged += new EventHandler(SolutionCreator_PermutationParameter_ActualNameChanged);
227      ParameterizeSolutionCreator();
228      ParameterizeEvaluator();
229      ParameterizeAnalyzers();
230      ParameterizeOperators();
231      OnSolutionCreatorChanged();
232    }
233    private void SolutionCreator_PermutationParameter_ActualNameChanged(object sender, EventArgs e) {
234      ParameterizeEvaluator();
235      ParameterizeAnalyzers();
236      ParameterizeOperators();
237    }
238    private void EvaluatorParameter_ValueChanged(object sender, EventArgs e) {
239      Evaluator.QualityParameter.ActualNameChanged += new EventHandler(Evaluator_QualityParameter_ActualNameChanged);
240      ParameterizeEvaluator();
241      UpdateMoveEvaluators();
242      ParameterizeAnalyzers();
243      ClearDistanceMatrix();
244      OnEvaluatorChanged();
245    }
246    private void Evaluator_QualityParameter_ActualNameChanged(object sender, EventArgs e) {
247      ParameterizeAnalyzers();
248    }
249    private void MoveGenerator_InversionMoveParameter_ActualNameChanged(object sender, EventArgs e) {
250      string name = ((ILookupParameter<InversionMove>)sender).ActualName;
251      foreach (IPermutationInversionMoveOperator op in Operators.OfType<IPermutationInversionMoveOperator>()) {
252        op.InversionMoveParameter.ActualName = name;
253      }
254    }
255    private void MoveGenerator_TranslocationMoveParameter_ActualNameChanged(object sender, EventArgs e) {
256      string name = ((ILookupParameter<TranslocationMove>)sender).ActualName;
257      foreach (IPermutationTranslocationMoveOperator op in Operators.OfType<IPermutationTranslocationMoveOperator>()) {
258        op.TranslocationMoveParameter.ActualName = name;
259      }
260    }
261    #endregion
262
263    #region Helpers
264    [StorableHook(HookType.AfterDeserialization)]
265    private void AfterDeserialization() {
266      // BackwardsCompatibility3.3
267      #region Backwards compatible code (remove with 3.4)
268      if (operators == null) InitializeOperators();
269      #endregion
270      AttachEventHandlers();
271    }
272
273    private void AttachEventHandlers() {
274      CoordinatesParameter.ValueChanged += new EventHandler(CoordinatesParameter_ValueChanged);
275      Coordinates.ItemChanged += new EventHandler<EventArgs<int, int>>(Coordinates_ItemChanged);
276      Coordinates.Reset += new EventHandler(Coordinates_Reset);
277      SolutionCreatorParameter.ValueChanged += new EventHandler(SolutionCreatorParameter_ValueChanged);
278      SolutionCreator.PermutationParameter.ActualNameChanged += new EventHandler(SolutionCreator_PermutationParameter_ActualNameChanged);
279      EvaluatorParameter.ValueChanged += new EventHandler(EvaluatorParameter_ValueChanged);
280      Evaluator.QualityParameter.ActualNameChanged += new EventHandler(Evaluator_QualityParameter_ActualNameChanged);
281    }
282
283    private void InitializeOperators() {
284      operators = new List<IOperator>();
285      operators.Add(new BestTSPSolutionAnalyzer());
286      operators.Add(new TSPAlleleFrequencyAnalyzer());
287      operators.Add(new TSPPopulationDiversityAnalyzer());
288      ParameterizeAnalyzers();
289      operators.AddRange(ApplicationManager.Manager.GetInstances<IPermutationOperator>().Cast<IOperator>());
290      ParameterizeOperators();
291      UpdateMoveEvaluators();
292      InitializeMoveGenerators();
293    }
294    private void InitializeMoveGenerators() {
295      foreach (IPermutationInversionMoveOperator op in Operators.OfType<IPermutationInversionMoveOperator>()) {
296        if (op is IMoveGenerator) {
297          op.InversionMoveParameter.ActualNameChanged += new EventHandler(MoveGenerator_InversionMoveParameter_ActualNameChanged);
298        }
299      }
300      foreach (IPermutationTranslocationMoveOperator op in Operators.OfType<IPermutationTranslocationMoveOperator>()) {
301        if (op is IMoveGenerator) {
302          op.TranslocationMoveParameter.ActualNameChanged += new EventHandler(MoveGenerator_TranslocationMoveParameter_ActualNameChanged);
303        }
304      }
305    }
306    private void UpdateMoveEvaluators() {
307      operators.RemoveAll(x => x is ISingleObjectiveMoveEvaluator);
308      foreach (ITSPPathMoveEvaluator op in ApplicationManager.Manager.GetInstances<ITSPPathMoveEvaluator>())
309        if (op.EvaluatorType == Evaluator.GetType()) {
310          operators.Add(op);
311        }
312      ParameterizeOperators();
313      OnOperatorsChanged();
314    }
315    private void ParameterizeSolutionCreator() {
316      SolutionCreator.LengthParameter.Value = new IntValue(Coordinates.Rows);
317      SolutionCreator.PermutationTypeParameter.Value = new PermutationType(PermutationTypes.RelativeUndirected);
318    }
319    private void ParameterizeEvaluator() {
320      if (Evaluator is ITSPPathEvaluator)
321        ((ITSPPathEvaluator)Evaluator).PermutationParameter.ActualName = SolutionCreator.PermutationParameter.ActualName;
322      if (Evaluator is ITSPCoordinatesPathEvaluator) {
323        ITSPCoordinatesPathEvaluator evaluator = (ITSPCoordinatesPathEvaluator)Evaluator;
324        evaluator.CoordinatesParameter.ActualName = CoordinatesParameter.Name;
325        evaluator.DistanceMatrixParameter.ActualName = DistanceMatrixParameter.Name;
326        evaluator.UseDistanceMatrixParameter.ActualName = UseDistanceMatrixParameter.Name;
327      }
328    }
329    private void ParameterizeAnalyzers() {
330      /*if (BestTSPSolutionAnalyzer != null) {
331        BestTSPSolutionAnalyzer.QualityParameter.ActualName = Evaluator.QualityParameter.ActualName;
332        BestTSPSolutionAnalyzer.CoordinatesParameter.ActualName = CoordinatesParameter.Name;
333        BestTSPSolutionAnalyzer.PermutationParameter.ActualName = SolutionCreator.PermutationParameter.ActualName;
334        BestTSPSolutionAnalyzer.ResultsParameter.ActualName = "Results";
335        BestTSPSolutionAnalyzer.BestKnownQualityParameter.ActualName = BestKnownQualityParameter.Name;
336        BestTSPSolutionAnalyzer.BestKnownSolutionParameter.ActualName = BestKnownSolutionParameter.Name;
337        BestTSPSolutionAnalyzer.MaximizationParameter.ActualName = MaximizationParameter.Name;
338      }*/
339
340      if (TSPAlleleFrequencyAnalyzer != null) {
341        TSPAlleleFrequencyAnalyzer.MaximizationParameter.ActualName = MaximizationParameter.Name;
342        TSPAlleleFrequencyAnalyzer.CoordinatesParameter.ActualName = CoordinatesParameter.Name;
343        TSPAlleleFrequencyAnalyzer.SolutionParameter.ActualName = SolutionCreator.PermutationParameter.ActualName;
344        TSPAlleleFrequencyAnalyzer.QualityParameter.ActualName = Evaluator.QualityParameter.ActualName;
345        TSPAlleleFrequencyAnalyzer.BestKnownSolutionParameter.ActualName = BestKnownSolutionParameter.Name;
346        TSPAlleleFrequencyAnalyzer.ResultsParameter.ActualName = "Results";
347      }
348
349      if (TSPPopulationDiversityAnalyzer != null) {
350        TSPPopulationDiversityAnalyzer.MaximizationParameter.ActualName = MaximizationParameter.Name;
351        TSPPopulationDiversityAnalyzer.SolutionParameter.ActualName = SolutionCreator.PermutationParameter.ActualName;
352        TSPPopulationDiversityAnalyzer.QualityParameter.ActualName = Evaluator.QualityParameter.ActualName;
353        TSPPopulationDiversityAnalyzer.ResultsParameter.ActualName = "Results";
354      }
355    }
356    private void ParameterizeOperators() {
357      foreach (IPermutationCrossover op in Operators.OfType<IPermutationCrossover>()) {
358        op.ParentsParameter.ActualName = SolutionCreator.PermutationParameter.ActualName;
359        op.ChildParameter.ActualName = SolutionCreator.PermutationParameter.ActualName;
360      }
361      foreach (IPermutationManipulator op in Operators.OfType<IPermutationManipulator>()) {
362        op.PermutationParameter.ActualName = SolutionCreator.PermutationParameter.ActualName;
363      }
364      foreach (IPermutationMoveOperator op in Operators.OfType<IPermutationMoveOperator>()) {
365        op.PermutationParameter.ActualName = SolutionCreator.PermutationParameter.ActualName;
366      }
367      foreach (ITSPPathMoveEvaluator op in Operators.OfType<ITSPPathMoveEvaluator>()) {
368        op.CoordinatesParameter.ActualName = CoordinatesParameter.Name;
369        op.DistanceMatrixParameter.ActualName = DistanceMatrixParameter.Name;
370        op.UseDistanceMatrixParameter.ActualName = UseDistanceMatrixParameter.Name;
371        op.QualityParameter.ActualName = Evaluator.QualityParameter.ActualName;
372        op.PermutationParameter.ActualName = SolutionCreator.PermutationParameter.ActualName;
373      }
374      string inversionMove = Operators.OfType<IMoveGenerator>().OfType<IPermutationInversionMoveOperator>().First().InversionMoveParameter.ActualName;
375      foreach (IPermutationInversionMoveOperator op in Operators.OfType<IPermutationInversionMoveOperator>())
376        op.InversionMoveParameter.ActualName = inversionMove;
377      string translocationMove = Operators.OfType<IMoveGenerator>().OfType<IPermutationTranslocationMoveOperator>().First().TranslocationMoveParameter.ActualName;
378      foreach (IPermutationTranslocationMoveOperator op in Operators.OfType<IPermutationTranslocationMoveOperator>())
379        op.TranslocationMoveParameter.ActualName = translocationMove;
380    }
381
382    private void ClearDistanceMatrix() {
383      DistanceMatrixParameter.Value = null;
384    }
385    #endregion
386
387    public void ImportFromTSPLIB(string tspFileName, string optimalTourFileName) {
388      TSPLIBParser tspParser = new TSPLIBParser(tspFileName);
389      tspParser.Parse();
390      Name = tspParser.Name + " TSP (imported from TSPLIB)";
391      if (!string.IsNullOrEmpty(tspParser.Comment)) Description = tspParser.Comment;
392      Coordinates = new DoubleMatrix(tspParser.Vertices);
393      if (tspParser.WeightType == TSPLIBParser.TSPLIBEdgeWeightType.EUC_2D) {
394        TSPRoundedEuclideanPathEvaluator evaluator = new TSPRoundedEuclideanPathEvaluator();
395        evaluator.QualityParameter.ActualName = "TSPTourLength";
396        Evaluator = evaluator;
397      } else if (tspParser.WeightType == TSPLIBParser.TSPLIBEdgeWeightType.GEO) {
398        TSPGeoPathEvaluator evaluator = new TSPGeoPathEvaluator();
399        evaluator.QualityParameter.ActualName = "TSPTourLength";
400        Evaluator = evaluator;
401      }
402      BestKnownQuality = null;
403      BestKnownSolution = null;
404
405      if (!string.IsNullOrEmpty(optimalTourFileName)) {
406        TSPLIBTourParser tourParser = new TSPLIBTourParser(optimalTourFileName);
407        tourParser.Parse();
408        if (tourParser.Tour.Length != Coordinates.Rows) throw new InvalidDataException("Length of optimal tour is not equal to number of cities.");
409        BestKnownSolution = new Permutation(PermutationTypes.RelativeUndirected, tourParser.Tour);
410      }
411      OnReset();
412    }
413    public void ImportFromTSPLIB(string tspFileName, string optimalTourFileName, double bestKnownQuality) {
414      ImportFromTSPLIB(tspFileName, optimalTourFileName);
415      BestKnownQuality = new DoubleValue(bestKnownQuality);
416    }
417  }
418}
Note: See TracBrowser for help on using the repository browser.