Free cookie consent management tool by TermsFeed Policy Generator

source: branches/Persistence Test/HeuristicLab.Routing.TSP/3.3/TSPTourInjector.cs @ 3644

Last change on this file since 3644 was 1530, checked in by gkronber, 16 years ago

Moved source files of plugins Hive ... Visualization.Test into version-specific sub-folders. #576

File size: 3.1 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  /// Injects a new TSP tour in a given scope with all its neccessary variables.
33  /// </summary>
34  public class TSPTourInjector : OperatorBase {
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="TSPTourInjector"/> with three variable infos
42    /// (<c>Coordinates</c>, <c>Permutation</c> and <c>Tour</c>).
43    /// </summary>
44    public TSPTourInjector() {
45      AddVariableInfo(new VariableInfo("Coordinates", "City coordinates", typeof(DoubleMatrixData), VariableKind.In));
46      AddVariableInfo(new VariableInfo("Permutation", "Permutation representing a TSP solution in path encoding", typeof(Permutation.Permutation), VariableKind.In));
47      AddVariableInfo(new VariableInfo("Tour", "Object representing a whole TSP tour", typeof(TSPTour), VariableKind.New | VariableKind.Out));
48    }
49
50    /// <summary>
51    /// Adds a new <see cref="TSPTour"/> to the given <paramref name="scope"/> with all
52    /// its neccessary variables.
53    /// </summary>
54    /// <param name="scope">The current scope where to inject the TSP tour.</param>
55    /// <returns><c>null</c>.</returns>
56    public override IOperation Apply(IScope scope) {
57      DoubleMatrixData coordinates = GetVariableValue<DoubleMatrixData>("Coordinates", scope, true);
58      Permutation.Permutation permutation = GetVariableValue<Permutation.Permutation>("Permutation", scope, false);
59      TSPTour tour = GetVariableValue<TSPTour>("Tour", scope, false, false);
60      if (tour == null) {
61        tour = new TSPTour(coordinates, permutation);
62        IVariableInfo info = GetVariableInfo("Tour");
63        if (info.Local)
64          AddVariable(new Variable(info.ActualName, tour));
65        else
66          scope.AddVariable(new Variable(scope.TranslateName(info.FormalName), tour));
67      } else {
68        tour.Coordinates = coordinates;
69        tour.Tour = permutation;
70      }
71      return null;
72    }
73  }
74}
Note: See TracBrowser for help on using the repository browser.