source: branches/HeuristicLab.Hive_Milestone2/sources/HeuristicLab.Routing.TSP/3.2/DistanceMatrixPathTSPEvaluator.cs @ 4539

#region License Information
/* HeuristicLab
 * Copyright (C) 2002-2008 Heuristic and Evolutionary Algorithms Laboratory (HEAL)
 *
 * This file is part of HeuristicLab.
 *
 * HeuristicLab is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * HeuristicLab is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with HeuristicLab. If not, see <http://www.gnu.org/licenses/>.
 */
#endregion

using System;
using System.Collections.Generic;
using System.Text;
using HeuristicLab.Core;
using HeuristicLab.Data;
using HeuristicLab.Operators;
using HeuristicLab.Permutation;

namespace HeuristicLab.Routing.TSP {
  /// <summary>
  /// Evaluates the TSP path by using values in the distance matrix.
  /// </summary>
  public class DistanceMatrixPathTSPEvaluator : SingleObjectiveEvaluatorBase {
    /// <inheritdoc select="summary"/>
    public override string Description {
      get { return @"TODO\r\nOperator description still missing ..."; }
    }

    /// <summary>
    /// Initializes a new instance of <see cref="DistanceMatrixPathTSPEvaluator"/> with two variable 
    /// infos (<c>Permutation</c>, <c>DistanceMatrix</c>).
    /// </summary>
    public DistanceMatrixPathTSPEvaluator()
      : base() {
      AddVariableInfo(new VariableInfo("Permutation", "Permutation representing a TSP solution in path encoding", typeof(Permutation.Permutation), VariableKind.In));
      AddVariableInfo(new VariableInfo("DistanceMatrix", "Distance matrix containing all distances between cities", typeof(DoubleMatrixData), VariableKind.In));
    }

    /// <summary>
    /// Calculates the length of the path in the given <paramref name="scope"/> by taking the 
    /// values of the distance matrix.
    /// </summary>
    /// <param name="scope">The current scope with the permutation and the distance matrix.</param>
    /// <returns>The calculated length.</returns>
    protected override double Evaluate(IScope scope) {
      double[,] distanceMatrix = GetVariableValue<DoubleMatrixData>("DistanceMatrix", scope, true).Data;
      int[] perm = GetVariableValue<Permutation.Permutation>("Permutation", scope, false).Data;
      double length = 0;

      for (int i = 0; i < perm.Length - 1; i++)
        length += distanceMatrix[perm[i], perm[i + 1]];
      length += distanceMatrix[perm[perm.Length - 1], perm[0]];
      return length;
    }
  }
}