Free cookie consent management tool by TermsFeed Policy Generator

source: branches/2913_MatlabScriptProblemInstanceProvider/HeuristicLab.Problems.TravelingSalesman/3.3/Analyzers/BestTSPSolutionAnalyzer.cs

Last change on this file was 15583, checked in by swagner, 7 years ago

#2640: Updated year of copyrights in license headers

File size: 6.5 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2018 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.Linq;
23using HeuristicLab.Common;
24using HeuristicLab.Core;
25using HeuristicLab.Data;
26using HeuristicLab.Encodings.PermutationEncoding;
27using HeuristicLab.Operators;
28using HeuristicLab.Optimization;
29using HeuristicLab.Parameters;
30using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
31
32namespace HeuristicLab.Problems.TravelingSalesman {
33  /// <summary>
34  /// An operator for analyzing the best solution of Traveling Salesman Problems given in path representation using city coordinates.
35  /// </summary>
36  [Item("BestTSPSolutionAnalyzer", "An operator for analyzing the best solution of Traveling Salesman Problems given in path representation using city coordinates.")]
37  [StorableClass]
38  public sealed class BestTSPSolutionAnalyzer : SingleSuccessorOperator, IAnalyzer, ISingleObjectiveOperator {
39    public bool EnabledByDefault {
40      get { return true; }
41    }
42
43    public LookupParameter<BoolValue> MaximizationParameter {
44      get { return (LookupParameter<BoolValue>)Parameters["Maximization"]; }
45    }
46    public LookupParameter<DoubleMatrix> CoordinatesParameter {
47      get { return (LookupParameter<DoubleMatrix>)Parameters["Coordinates"]; }
48    }
49    public ScopeTreeLookupParameter<Permutation> PermutationParameter {
50      get { return (ScopeTreeLookupParameter<Permutation>)Parameters["Permutation"]; }
51    }
52    public ScopeTreeLookupParameter<DoubleValue> QualityParameter {
53      get { return (ScopeTreeLookupParameter<DoubleValue>)Parameters["Quality"]; }
54    }
55    public LookupParameter<PathTSPTour> BestSolutionParameter {
56      get { return (LookupParameter<PathTSPTour>)Parameters["BestSolution"]; }
57    }
58    public ValueLookupParameter<ResultCollection> ResultsParameter {
59      get { return (ValueLookupParameter<ResultCollection>)Parameters["Results"]; }
60    }
61    public LookupParameter<DoubleValue> BestKnownQualityParameter {
62      get { return (LookupParameter<DoubleValue>)Parameters["BestKnownQuality"]; }
63    }
64    public LookupParameter<Permutation> BestKnownSolutionParameter {
65      get { return (LookupParameter<Permutation>)Parameters["BestKnownSolution"]; }
66    }
67
68    [StorableConstructor]
69    private BestTSPSolutionAnalyzer(bool deserializing) : base(deserializing) { }
70    private BestTSPSolutionAnalyzer(BestTSPSolutionAnalyzer original, Cloner cloner) : base(original, cloner) { }
71    public override IDeepCloneable Clone(Cloner cloner) {
72      return new BestTSPSolutionAnalyzer(this, cloner);
73    }
74    public BestTSPSolutionAnalyzer()
75      : base() {
76      Parameters.Add(new LookupParameter<BoolValue>("Maximization", "True if the problem is a maximization problem."));
77      Parameters.Add(new LookupParameter<DoubleMatrix>("Coordinates", "The x- and y-Coordinates of the cities."));
78      Parameters.Add(new ScopeTreeLookupParameter<Permutation>("Permutation", "The TSP solutions given in path representation from which the best solution should be analyzed."));
79      Parameters.Add(new ScopeTreeLookupParameter<DoubleValue>("Quality", "The qualities of the TSP solutions which should be analyzed."));
80      Parameters.Add(new LookupParameter<PathTSPTour>("BestSolution", "The best TSP solution."));
81      Parameters.Add(new ValueLookupParameter<ResultCollection>("Results", "The result collection where the best TSP solution should be stored."));
82      Parameters.Add(new LookupParameter<DoubleValue>("BestKnownQuality", "The quality of the best known solution of this TSP instance."));
83      Parameters.Add(new LookupParameter<Permutation>("BestKnownSolution", "The best known solution of this TSP instance."));
84
85      MaximizationParameter.Hidden = true;
86      CoordinatesParameter.Hidden = true;
87      PermutationParameter.Hidden = true;
88      QualityParameter.Hidden = true;
89      BestSolutionParameter.Hidden = true;
90      ResultsParameter.Hidden = true;
91      BestKnownQualityParameter.Hidden = true;
92      BestKnownSolutionParameter.Hidden = true;
93    }
94
95    public override IOperation Apply() {
96      DoubleMatrix coordinates = CoordinatesParameter.ActualValue;
97      ItemArray<Permutation> permutations = PermutationParameter.ActualValue;
98      ItemArray<DoubleValue> qualities = QualityParameter.ActualValue;
99      ResultCollection results = ResultsParameter.ActualValue;
100      bool max = MaximizationParameter.ActualValue.Value;
101      DoubleValue bestKnownQuality = BestKnownQualityParameter.ActualValue;
102
103      int i = -1;
104      if (!max)
105        i = qualities.Select((x, index) => new { index, x.Value }).OrderBy(x => x.Value).First().index;
106      else i = qualities.Select((x, index) => new { index, x.Value }).OrderByDescending(x => x.Value).First().index;
107
108      if (bestKnownQuality == null ||
109          max && qualities[i].Value > bestKnownQuality.Value ||
110          !max && qualities[i].Value < bestKnownQuality.Value) {
111        BestKnownQualityParameter.ActualValue = new DoubleValue(qualities[i].Value);
112        BestKnownSolutionParameter.ActualValue = (Permutation)permutations[i].Clone();
113      }
114
115      PathTSPTour tour = BestSolutionParameter.ActualValue;
116      if (tour == null) {
117        tour = new PathTSPTour(coordinates, (Permutation)permutations[i].Clone(), new DoubleValue(qualities[i].Value));
118        BestSolutionParameter.ActualValue = tour;
119        results.Add(new Result("Best TSP Solution", tour));
120      } else {
121        if (max && tour.Quality.Value < qualities[i].Value ||
122          !max && tour.Quality.Value > qualities[i].Value) {
123          tour.Coordinates = coordinates;
124          tour.Permutation = (Permutation)permutations[i].Clone();
125          tour.Quality.Value = qualities[i].Value;
126        }
127      }
128
129      return base.Apply();
130    }
131  }
132}
Note: See TracBrowser for help on using the repository browser.