Free cookie consent management tool by TermsFeed Policy Generator

source: trunk/sources/HeuristicLab.Routing.TSP/PathTSPEvaluatorBase.cs @ 1009

Last change on this file since 1009 was 884, checked in by vdorfer, 16 years ago

Created API documentation for HeuristicLab.Routing.TSP namespace (#331)

File size: 3.4 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2008 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.Text;
25using HeuristicLab.Core;
26using HeuristicLab.Data;
27using HeuristicLab.Operators;
28using HeuristicLab.Permutation;
29
30namespace HeuristicLab.Routing.TSP {
31  /// <summary>
32  /// Base class for TSP path evaluation, based on length calculation.
33  /// </summary>
34  public abstract class PathTSPEvaluatorBase : SingleObjectiveEvaluatorBase {
35    /// <summary>
36    /// Initializes a new instance of <see cref="PathTSPEvaluatorBase"/> with two variable infos
37    /// (<c>Coordinates</c> and <c>Permutation</c>).
38    /// </summary>
39    public PathTSPEvaluatorBase()
40      : base() {
41      AddVariableInfo(new VariableInfo("Coordinates", "City coordinates", typeof(DoubleMatrixData), VariableKind.In));
42      AddVariableInfo(new VariableInfo("Permutation", "Permutation representing a TSP solution in path encoding", typeof(Permutation.Permutation), VariableKind.In));
43    }
44
45    /// <summary>
46    /// Calculates the length of a whole path of the given <paramref name="scope"/>.
47    /// </summary>
48    /// <param name="scope">The scope where to evaluate the path.</param>
49    /// <returns>The calculated length.</returns>
50    protected sealed override double Evaluate(IScope scope) {
51      double[,] coordinates = GetVariableValue<DoubleMatrixData>("Coordinates", scope, true).Data;
52      int[] perm = GetVariableValue<Permutation.Permutation>("Permutation", scope, false).Data;
53      double length = 0;
54
55      for (int i = 0; i < perm.Length - 1; i++)
56        length += CalculateDistance(coordinates[perm[i], 0],
57                                    coordinates[perm[i], 1],
58                                    coordinates[perm[i + 1], 0],
59                                    coordinates[perm[i + 1], 1]);
60      length += CalculateDistance(coordinates[perm[perm.Length - 1], 0],
61                                  coordinates[perm[perm.Length - 1], 1],
62                                  coordinates[perm[0], 0],
63                                  coordinates[perm[0], 1]);
64      return length;
65    }
66
67    /// <summary>
68    /// Calculates the distance between two given points.
69    /// </summary>
70    /// <param name="x1">The x coordinate of point 1.</param>
71    /// <param name="y1">The y coordinate of point 1.</param>
72    /// <param name="x2">The x coordinate of point 2.</param>
73    /// <param name="y2">The y coordinate of point 2.</param>
74    /// <returns>The calculated distance.</returns>
75    protected abstract double CalculateDistance(double x1, double y1, double x2, double y2);
76  }
77}
Note: See TracBrowser for help on using the repository browser.