Free cookie consent management tool by TermsFeed Policy Generator

source: branches/Operator Architecture Refactoring/HeuristicLab.Permutation/PermutationCrossoverBase.cs @ 1181

Last change on this file since 1181 was 850, checked in by vdorfer, 16 years ago

Created API documentation for HeuristicLab.Permutation namespace (#331)

File size: 3.7 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.Evolutionary;
27
28namespace HeuristicLab.Permutation {
29  /// <summary>
30  /// Base class for cross over permutations.
31  /// </summary>
32  public abstract class PermutationCrossoverBase : CrossoverBase {
33    /// <summary>
34    /// Initializes a new instance of <see cref="PermutationCrossoverBase"/> with one variable info
35    /// (<c>Permutation</c>).
36    /// </summary>
37    public PermutationCrossoverBase()
38      : base() {
39      AddVariableInfo(new VariableInfo("Permutation", "Parent and child permutations", typeof(Permutation), VariableKind.In | VariableKind.New));
40    }
41
42    /// <summary>
43    /// Performs a cross over permutation of <paramref name="parent1"/> and <paramref name="parent2"/> with
44    /// the given random number generator (<paramref name="random"/>) to create a new
45    /// <paramref name="child"/>.
46    /// </summary>
47    /// <exception cref="InvalidOperationException">Thrown when the two permutations have a different
48    /// length.</exception>
49    /// <remarks>Calls <see cref="Cross(HeuristicLab.Core.IScope, HeuristicLab.Core.IRandom, int[], int[])"/>.</remarks>
50    /// <param name="scope">The scope where to get the actual child variable name.</param>
51    /// <param name="random">The random number generator.</param>
52    /// <param name="parent1">The parent scope 1 to cross over.</param>
53    /// <param name="parent2">The parent scope 2 to cross over.</param>
54    /// <param name="child">The child scope which to assign the permutated data.</param>
55    protected sealed override void Cross(IScope scope, IRandom random, IScope parent1, IScope parent2, IScope child) {
56      Permutation perm1 = parent1.GetVariableValue<Permutation>("Permutation", false);
57      Permutation perm2 = parent2.GetVariableValue<Permutation>("Permutation", false);
58
59      if (perm1.Data.Length != perm2.Data.Length) throw new InvalidOperationException("Cannot apply crossover to permutations of different length.");
60
61      int[] result = Cross(scope, random, perm1.Data, perm2.Data);
62      child.AddVariable(new Variable(scope.TranslateName("Permutation"), new Permutation(result)));
63    }
64
65    /// <summary>
66    /// Performs a cross over permutation of <paramref name="parent1"/> and <paramref name="parent2"/> with
67    /// the given random number generator (<paramref name="random"/>) .
68    /// </summary>
69    /// <param name="scope">The scope of the variables.</param>
70    /// <param name="random">The random number generator.</param>
71    /// <param name="parent1">The parent scope 1 to cross over.</param>
72    /// <param name="parent2">The parent scope 2 to cross over.</param>
73    /// <returns>The created cross over permutation as int array.</returns>
74    protected abstract int[] Cross(IScope scope, IRandom random, int[] parent1, int[] parent2);
75  }
76}
Note: See TracBrowser for help on using the repository browser.