Free cookie consent management tool by TermsFeed Policy Generator

source: branches/HeuristicLab.Problems.Orienteering/HeuristicLab.Problems.Orienteering/3.3/OrienteeringProblem.cs @ 11321

Last change on this file since 11321 was 11321, checked in by pfleck, 10 years ago

#2208

  • Added IOrienteeringEvaluator interface
  • Defined parameters in IOrienteeringEvaluator
File size: 18.9 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2014 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.IO;
24using System.Linq;
25using HeuristicLab.Common;
26using HeuristicLab.Core;
27using HeuristicLab.Data;
28using HeuristicLab.Encodings.IntegerVectorEncoding;
29using HeuristicLab.Optimization;
30using HeuristicLab.Parameters;
31using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
32using HeuristicLab.Problems.Instances;
33using HeuristicLab.Problems.Instances.Types;
34
35namespace HeuristicLab.Problems.Orienteering {
36
37  [Item("Orienteering Problem", "Represents a single objective Orienteering Problem.")]
38  [Creatable("Problems")]
39  [StorableClass]
40  public sealed class OrienteeringProblem
41    : SingleObjectiveHeuristicOptimizationProblem<IOrienteeringEvaluator, IOrienteeringSolutionCreator>,
42    IStorableContent, IProblemInstanceConsumer<OPData>, IProblemInstanceConsumer<TSPData>, IProblemInstanceConsumer<CVRPData> {
43
44    public string Filename { get; set; }
45
46    #region Parameter Properties
47    public OptionalValueParameter<DoubleMatrix> CoordinatesParameter {
48      get { return (OptionalValueParameter<DoubleMatrix>)Parameters["Coordinates"]; }
49    }
50    public ValueParameter<DistanceMatrix> DistanceMatrixParameter {
51      get { return (ValueParameter<DistanceMatrix>)Parameters["DistanceMatrix"]; }
52    }
53
54    public ValueParameter<IntValue> StartingPointParameter {
55      get { return (ValueParameter<IntValue>)Parameters["StartingPoint"]; }
56    }
57    public ValueParameter<IntValue> TerminalPointParameter {
58      get { return (ValueParameter<IntValue>)Parameters["TerminalPoint"]; }
59    }
60    public ValueParameter<DoubleValue> MaximumDistanceParameter {
61      get { return (ValueParameter<DoubleValue>)Parameters["MaximumDistance"]; }
62    }
63    public ValueParameter<DoubleArray> ScoresParameter {
64      get { return (ValueParameter<DoubleArray>)Parameters["Scores"]; }
65    }
66    public ValueParameter<DoubleValue> PointVisitingCostsParameter {
67      get { return (ValueParameter<DoubleValue>)Parameters["PointVisitingCosts"]; }
68    }
69
70    public OptionalValueParameter<IntegerVector> BestKnownSolutionParameter {
71      get { return (OptionalValueParameter<IntegerVector>)Parameters["BestKnownSolution"]; }
72    }
73    #endregion
74
75    #region Properties
76    public DoubleMatrix Coordinates {
77      get { return CoordinatesParameter.Value; }
78      set { CoordinatesParameter.Value = value; }
79    }
80    public DistanceMatrix DistanceMatrix {
81      get { return DistanceMatrixParameter.Value; }
82      set { DistanceMatrixParameter.Value = value; }
83    }
84    public IntValue StartingPoint {
85      get { return StartingPointParameter.Value; }
86      set { StartingPointParameter.Value = value; }
87    }
88    public IntValue TerminalPoint {
89      get { return TerminalPointParameter.Value; }
90      set { TerminalPointParameter.Value = value; }
91    }
92    public DoubleValue MaximumDistance {
93      get { return MaximumDistanceParameter.Value; }
94      set { MaximumDistanceParameter.Value = value; }
95    }
96    public DoubleArray Scores {
97      get { return ScoresParameter.Value; }
98      set { ScoresParameter.Value = value; }
99    }
100    public DoubleValue PointVisitingCosts {
101      get { return PointVisitingCostsParameter.Value; }
102      set { PointVisitingCostsParameter.Value = value; }
103    }
104    public IntegerVector BestKnownSolution {
105      get { return BestKnownSolutionParameter.Value; }
106      set { BestKnownSolutionParameter.Value = value; }
107    }
108    private BestOrienteeringSolutionAnalyser BestOrienteeringSolutionAnalyser {
109      get { return Operators.OfType<BestOrienteeringSolutionAnalyser>().SingleOrDefault(); }
110    }
111    #endregion
112
113    [StorableConstructor]
114    private OrienteeringProblem(bool deserializing)
115      : base(deserializing) {
116    }
117    private OrienteeringProblem(OrienteeringProblem original, Cloner cloner)
118      : base(original, cloner) {
119      RegisterEventHandlers();
120    }
121    public override IDeepCloneable Clone(Cloner cloner) {
122      return new OrienteeringProblem(this, cloner);
123    }
124    public OrienteeringProblem()
125      : base(new OrienteeringEvaluator(), new GreedyOrienteeringTourCreator()) {
126      Parameters.Add(new OptionalValueParameter<DoubleMatrix>("Coordinates", "The x- and y-Coordinates of the points."));
127      Parameters.Add(new ValueParameter<DistanceMatrix>("DistanceMatrix", "The matrix which contains the distances between the points."));
128      Parameters.Add(new ValueParameter<IntValue>("StartingPoint", "Index of the starting point.", new IntValue(0)));
129      Parameters.Add(new ValueParameter<IntValue>("TerminalPoint", "Index of the ending point.", new IntValue(0)));
130      Parameters.Add(new ValueParameter<DoubleValue>("MaximumDistance", "The maximum distance constraint for a Orienteering solution."));
131      Parameters.Add(new ValueParameter<DoubleArray>("Scores", "The scores of the points."));
132      Parameters.Add(new ValueParameter<DoubleValue>("PointVisitingCosts", "The costs for visiting a point."));
133      Parameters.Add(new OptionalValueParameter<IntegerVector>("BestKnownSolution", "The best known solution of this Orienteering instance."));
134
135      Maximization.Value = true;
136      MaximizationParameter.Hidden = true;
137
138      SolutionCreator.IntegerVectorParameter.ActualName = "OrienteeringSolution";
139
140      InitializeInitialOrienteeringInstance();
141
142      ParameterizeSolutionCreator();
143      ParameterizeEvaluator();
144
145      InitializeOperators();
146      RegisterEventHandlers();
147    }
148
149    #region Events
150    protected override void OnSolutionCreatorChanged() {
151      base.OnSolutionCreatorChanged();
152      SolutionCreator.IntegerVectorParameter.ActualNameChanged += SolutionCreator_IntegerVectorParameter_ActualNameChanged;
153      ParameterizeSolutionCreator();
154      ParameterizeEvaluator();
155      ParameterizeAnalyzer();
156      ParameterizeOperators();
157    }
158    protected override void OnEvaluatorChanged() {
159      base.OnEvaluatorChanged();
160      ParameterizeEvaluator();
161      ParameterizeAnalyzer();
162    }
163    private void SolutionCreator_IntegerVectorParameter_ActualNameChanged(object sender, EventArgs e) {
164      ParameterizeEvaluator();
165      ParameterizeAnalyzer();
166      ParameterizeOperators();
167    }
168    private void CoordinatesParameter_ValueChanged(object sender, EventArgs e) {
169      if (Coordinates != null) {
170        Coordinates.ItemChanged += new EventHandler<EventArgs<int, int>>(CoordinatesValue_ItemChanged);
171        Coordinates.Reset += new EventHandler(CoordinatesValue_Reset);
172      }
173      ParameterizeSolutionCreator();
174      UpdateDistanceMatrix();
175    }
176    private void CoordinatesValue_ItemChanged(object sender, EventArgs<int, int> e) {
177      UpdateDistanceMatrix();
178    }
179    private void CoordinatesValue_Reset(object sender, EventArgs e) {
180      ParameterizeSolutionCreator();
181      UpdateDistanceMatrix();
182    }
183    private void StartingPointParameter_ValueChanged(object sender, EventArgs e) {
184      ParameterizeEvaluator();
185      ParameterizeAnalyzer();
186    }
187
188    private void TerminalPointParameter_ValueChanged(object sender, EventArgs e) {
189      ParameterizeEvaluator();
190      ParameterizeAnalyzer();
191    }
192    private void MaximumDistanceParameter_ValueChanged(object sender, EventArgs e) {
193      ParameterizeEvaluator();
194      ParameterizeAnalyzer();
195    }
196    private void ScoresParameter_ValueChanged(object sender, EventArgs e) {
197      ParameterizeEvaluator();
198      ParameterizeAnalyzer();
199      ParameterizeSolutionCreator();
200
201      ScoresParameter.Value.Reset += new EventHandler(ScoresValue_Reset);
202    }
203    private void ScoresValue_Reset(object sender, EventArgs e) {
204      ParameterizeSolutionCreator();
205    }
206    private void PointVisitingCostsParameter_ValueChanged(object sender, EventArgs e) {
207      ParameterizeEvaluator();
208      ParameterizeAnalyzer();
209    }
210    #endregion
211
212    #region Helpers
213    [StorableHook(HookType.AfterDeserialization)]
214    private void AfterDeserialization() {
215      RegisterEventHandlers();
216    }
217
218    private void RegisterEventHandlers() {
219      SolutionCreator.IntegerVectorParameter.ActualNameChanged += SolutionCreator_IntegerVectorParameter_ActualNameChanged;
220
221      CoordinatesParameter.ValueChanged += CoordinatesParameter_ValueChanged;
222      if (CoordinatesParameter.Value != null) {
223        CoordinatesParameter.Value.ItemChanged += CoordinatesValue_ItemChanged;
224        CoordinatesParameter.Value.Reset += CoordinatesValue_Reset;
225      }
226
227      StartingPointParameter.ValueChanged += StartingPointParameter_ValueChanged;
228      TerminalPointParameter.ValueChanged += TerminalPointParameter_ValueChanged;
229      MaximumDistanceParameter.ValueChanged += MaximumDistanceParameter_ValueChanged;
230
231      ScoresParameter.ValueChanged += ScoresParameter_ValueChanged;
232      ScoresParameter.Value.Reset += ScoresValue_Reset;
233      PointVisitingCostsParameter.ValueChanged += PointVisitingCostsParameter_ValueChanged;
234    }
235
236    private void ParameterizeSolutionCreator() {
237      SolutionCreator.DistanceMatrixParameter.ActualName = DistanceMatrixParameter.Name;
238      SolutionCreator.ScoresParameter.ActualName = ScoresParameter.Name;
239      SolutionCreator.MaximumDistanceParameter.ActualName = MaximumDistanceParameter.Name;
240      SolutionCreator.StartingPointParameter.ActualName = StartingPointParameter.Name;
241      SolutionCreator.TerminalPointParameter.ActualName = TerminalPointParameter.Name;
242      SolutionCreator.PointVisitingCostsParameter.ActualName = PointVisitingCostsParameter.Name;
243    }
244    private void ParameterizeEvaluator() {
245      Evaluator.IntegerVectorParameter.ActualName = SolutionCreator.IntegerVectorParameter.ActualName;
246      Evaluator.ScoresParameter.ActualName = ScoresParameter.Name;
247      Evaluator.DistanceMatrixParameter.ActualName = DistanceMatrixParameter.Name;
248      Evaluator.MaximumDistanceParameter.ActualName = MaximumDistanceParameter.Name;
249      Evaluator.PointVisitingCostsParameter.ActualName = PointVisitingCostsParameter.Name;
250    }
251    private void ParameterizeAnalyzer() {
252      if (BestOrienteeringSolutionAnalyser != null) {
253        BestOrienteeringSolutionAnalyser.QualityParameter.ActualName = Evaluator.QualityParameter.ActualName;
254
255        BestOrienteeringSolutionAnalyser.IntegerVector.ActualName = SolutionCreator.IntegerVectorParameter.ActualName;
256        BestOrienteeringSolutionAnalyser.CoordinatesParameter.ActualName = CoordinatesParameter.Name;
257        BestOrienteeringSolutionAnalyser.ScoresParameter.ActualName = ScoresParameter.Name;
258
259        BestOrienteeringSolutionAnalyser.ResultsParameter.ActualName = "Results";
260        BestOrienteeringSolutionAnalyser.BestKnownQualityParameter.ActualName = BestKnownQualityParameter.Name;
261        BestOrienteeringSolutionAnalyser.BestKnownSolutionParameter.ActualName = BestKnownSolutionParameter.Name;
262      }
263    }
264    private void InitializeOperators() {
265      Operators.Add(new BestOrienteeringSolutionAnalyser());
266      ParameterizeAnalyzer();
267
268      Operators.Add(new OrienteeringLocalImprovementOperator());
269      Operators.Add(new OrienteeringShakingOperator());
270      ParameterizeOperators();
271    }
272    private void ParameterizeOperators() {
273      foreach (var op in Operators.OfType<OrienteeringLocalImprovementOperator>()) {
274        op.IntegerVectorParameter.ActualName = SolutionCreator.IntegerVectorParameter.ActualName;
275        op.DistanceMatrixParameter.ActualName = DistanceMatrixParameter.Name;
276        op.ScoresParameter.ActualName = ScoresParameter.Name;
277        op.MaximumDistanceParameter.ActualName = MaximumDistanceParameter.Name;
278        op.StartingPointParameter.ActualName = StartingPointParameter.Name;
279        op.TerminalPointParameter.ActualName = TerminalPointParameter.Name;
280        op.PointVisitingCostsParameter.ActualName = PointVisitingCostsParameter.Name;
281      }
282      foreach (var op in Operators.OfType<OrienteeringShakingOperator>()) {
283        op.IntegerVectorParameter.ActualName = SolutionCreator.IntegerVectorParameter.ActualName;
284        op.DistanceMatrixParameter.ActualName = DistanceMatrixParameter.Name;
285        op.ScoresParameter.ActualName = ScoresParameter.Name;
286        op.MaximumDistanceParameter.ActualName = MaximumDistanceParameter.Name;
287        op.StartingPointParameter.ActualName = StartingPointParameter.Name;
288        op.TerminalPointParameter.ActualName = TerminalPointParameter.Name;
289        op.PointVisitingCostsParameter.ActualName = PointVisitingCostsParameter.Name;
290      }
291    }
292    #endregion
293
294    private DistanceMatrix CalculateDistanceMatrix(double[,] coordinates) {
295      var distances = DistanceHelper.GetDistanceMatrix(DistanceMeasure.Euclidean, coordinates, null, coordinates.GetLength(0));
296
297      return new DistanceMatrix(distances);
298    }
299    private void UpdateDistanceMatrix() {
300      if (Coordinates == null) {
301        DistanceMatrix = new DistanceMatrix(0, 0);
302        return;
303      }
304
305      var coordinates = Coordinates;
306      int dimension = coordinates.Rows;
307      var distances = new double[dimension, dimension];
308      for (int i = 0; i < dimension - 1; i++) {
309        for (int j = i + 1; j < dimension; j++) {
310          double x1 = coordinates[i, 0];
311          double y1 = coordinates[i, 1];
312          double x2 = coordinates[j, 0];
313          double y2 = coordinates[j, 1];
314          distances[i, j] = Math.Sqrt((x1 - x2) * (x1 - x2) + (y1 - y2) * (y1 - y2));
315          distances[j, i] = distances[i, j];
316        }
317      }
318      DistanceMatrix = new DistanceMatrix(distances);
319    }
320
321    private void InitializeInitialOrienteeringInstance() {
322      var coordinates = new double[21, 2] {
323        {  4.60,  7.10 }, {  5.70, 11.40 }, {  4.40, 12.30 }, {  2.80, 14.30 }, {  3.20, 10.30 },
324        {  3.50,  9.80 }, {  4.40,  8.40 }, {  7.80, 11.00 }, {  8.80,  9.80 }, {  7.70,  8.20 },
325        {  6.30,  7.90 }, {  5.40,  8.20 }, {  5.80,  6.80 }, {  6.70,  5.80 }, { 13.80, 13.10 },
326        { 14.10, 14.20 }, { 11.20, 13.60 }, {  9.70, 16.40 }, {  9.50, 18.80 }, {  4.70, 16.80 },
327        {  5.00,  5.60 }
328      };
329      Coordinates = new DoubleMatrix(coordinates);
330      DistanceMatrix = CalculateDistanceMatrix(coordinates);
331
332      StartingPoint.Value = 0;
333      TerminalPoint.Value = 20;
334      MaximumDistance.Value = 30;
335
336      Scores = new DoubleArray(new double[21] { 0, 20, 20, 30, 15, 15, 10, 20, 20, 20, 15, 10, 10, 25, 40, 40, 30, 30, 50, 30, 0 });
337    }
338
339    public void Load(OPData data) {
340      if (data.Coordinates == null && data.Distances == null)
341        throw new InvalidDataException("The given instance specifies no coordinates or distance matrix!");
342      if (data.Coordinates != null && data.Coordinates.GetLength(1) != 2)
343        throw new InvalidDataException("The coordinates of the given instance are not in the right format, there need to be one row for each customer and two columns for the x and y coordinates.");
344
345      // Clear old solutions
346      BestKnownQuality = null;
347      BestKnownSolution = null;
348
349      Name = data.Name;
350      Description = data.Description;
351
352      Coordinates = data.Coordinates != null ? new DoubleMatrix(data.Coordinates) : null;
353      if (data.Distances != null)
354        DistanceMatrix = new DistanceMatrix(data.Distances);
355      else
356        DistanceMatrix = new DistanceMatrix(data.GetDistanceMatrix());
357
358      StartingPoint = new IntValue(data.StartingPoint);
359      TerminalPoint = new IntValue(data.TerminalPoint);
360
361      PointVisitingCosts = new DoubleValue(data.PointVisitingCosts);
362      MaximumDistance = new DoubleValue(data.MaximumDistance);
363      Scores = new DoubleArray(data.Scores);
364    }
365
366    public void Load(TSPData data) {
367      if (data.Coordinates == null && data.Distances == null)
368        throw new InvalidDataException("The given instance specifies no coordinates or distance matrix!");
369      if (data.Coordinates != null && data.Coordinates.GetLength(1) != 2)
370        throw new InvalidDataException("The coordinates of the given instance are not in the right format, there need to be one row for each customer and two columns for the x and y coordinates.");
371
372      // Clear old solutions
373      BestKnownQuality = null;
374      BestKnownSolution = null;
375
376      Name = data.Name;
377      Description = data.Description;
378
379      Coordinates = data.Coordinates != null ? new DoubleMatrix(data.Coordinates) : null;
380      if (data.Distances != null)
381        DistanceMatrix = new DistanceMatrix(data.Distances);
382      else
383        DistanceMatrix = new DistanceMatrix(data.GetDistanceMatrix());
384
385      StartingPoint = new IntValue(0); // First city is interpreted as start point
386      TerminalPoint = new IntValue(data.Dimension - 1); // Last city is interpreted als end point
387
388      PointVisitingCosts = new DoubleValue(0);
389      MaximumDistance = new DoubleValue(DistanceMatrix.Average() * 5.0); // distance from start to end first to last city is interpreted as maximum distance
390      Scores = new DoubleArray(Enumerable.Repeat(1.0, data.Dimension).ToArray()); // all scores are 1
391    }
392
393    public void Load(CVRPData data) {
394      if (data.Coordinates == null && data.Distances == null)
395        throw new InvalidDataException("The given instance specifies no coordinates or distance matrix!");
396      if (data.Coordinates != null && data.Coordinates.GetLength(1) != 2)
397        throw new InvalidDataException("The coordinates of the given instance are not in the right format, there need to be one row for each customer and two columns for the x and y coordinates.");
398
399      // Clear old solutions
400      BestKnownQuality = null;
401      BestKnownSolution = null;
402
403      Name = data.Name;
404      Description = data.Description;
405
406      Coordinates = data.Coordinates != null ? new DoubleMatrix(data.Coordinates) : null;
407      DistanceMatrix = data.Distances != null
408        ? new DistanceMatrix(data.Distances)
409        : CalculateDistanceMatrix(data.Coordinates);
410
411      StartingPoint = new IntValue(0); // Depot is interpreted as start point
412      TerminalPoint = new IntValue(0); // Depot is interpreted als end point
413
414      PointVisitingCosts = new DoubleValue(0);
415      MaximumDistance = new DoubleValue(data.Capacity * 2); // capacity is interpreted as max distance
416      Scores = new DoubleArray(data.Demands); // demands are interpreted as scores
417    }
418  }
419}
Note: See TracBrowser for help on using the repository browser.