Free cookie consent management tool by TermsFeed Policy Generator

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

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

Created API documentation for HeuristicLab.ES namespace and changed documentation of some Description properties (#331)

File size: 2.8 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  /// Evaluates the TSP path by using values in the distance matrix.
33  /// </summary>
34  public class DistanceMatrixPathTSPEvaluator : SingleObjectiveEvaluatorBase {
35    /// <inheritdoc select="summary"/>
36    public override string Description {
37      get { return @"TODO\r\nOperator description still missing ..."; }
38    }
39
40    /// <summary>
41    /// Initializes a new instance of <see cref="DistanceMatrixPathTSPEvaluator"/> with two variable
42    /// infos (<c>Permutation</c>, <c>DistanceMatrix</c>).
43    /// </summary>
44    public DistanceMatrixPathTSPEvaluator()
45      : base() {
46      AddVariableInfo(new VariableInfo("Permutation", "Permutation representing a TSP solution in path encoding", typeof(Permutation.Permutation), VariableKind.In));
47      AddVariableInfo(new VariableInfo("DistanceMatrix", "Distance matrix containing all distances between cities", typeof(DoubleMatrixData), VariableKind.In));
48    }
49
50    /// <summary>
51    /// Calculates the length of the path in the given <paramref name="scope"/> by taking the
52    /// values of the distance matrix.
53    /// </summary>
54    /// <param name="scope">The current scope with the permutation and the distance matrix.</param>
55    /// <returns>The calculated length.</returns>
56    protected override double Evaluate(IScope scope) {
57      double[,] distanceMatrix = GetVariableValue<DoubleMatrixData>("DistanceMatrix", scope, true).Data;
58      int[] perm = GetVariableValue<Permutation.Permutation>("Permutation", scope, false).Data;
59      double length = 0;
60
61      for (int i = 0; i < perm.Length - 1; i++)
62        length += distanceMatrix[perm[i], perm[i + 1]];
63      length += distanceMatrix[perm[perm.Length - 1], perm[0]];
64      return length;
65    }
66  }
67}
Note: See TracBrowser for help on using the repository browser.