Changeset 850 for trunk/sources/HeuristicLab.Permutation/PartiallyMatchedCrossover.cs

Timestamp:

11/28/08 10:32:20 (16 years ago)

Author:

vdorfer

Message:

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

File:

• trunk/sources/HeuristicLab.Permutation/PartiallyMatchedCrossover.cs (modified) (2 diffs)

trunk/sources/HeuristicLab.Permutation/PartiallyMatchedCrossover.cs

@@ -27 +27 @@
 
 namespace HeuristicLab.Permutation {
+  /// <summary>
+  /// Performs a cross over permutation between two permuation arrays
+  /// by taking a randomly chosen interval from the first, keeping the position, 
+  /// then all positions from the second permutation which are still free in the child 
+  /// (the position is free and the value is "free")
+  /// and then missing ones from the second array in the order they occur in the second array.
+  /// </summary>
   public class PartiallyMatchedCrossover : PermutationCrossoverBase {
+    /// <inheritdoc select="summary"/>
     public override string Description {
       get { return @"TODO\r\nOperator description still missing ..."; }
     }
 
+    /// <summary>
+    /// Performs a cross over permuation of <paramref name="parent1"/> and <paramref name="parent2"/>
+    /// by taking a randomly chosen interval from <paramref name="parent1"/>, preserving the position, 
+    /// then all positions from <paramref name="parent2"/> which are still free in the child 
+    /// (the position is free and the value is "free")
+    /// and then missing ones from <paramref name="parent2"/> in the order they occur 
+    /// in <paramref name="parent2"/>.
+    /// </summary>
+    /// <param name="random">The random number generator.</param>
+    /// <param name="parent1">The parent scope 1 to cross over.</param>
+    /// <param name="parent2">The parent scope 2 to cross over.</param>
+    /// <returns>The created cross over permutation as int array.</returns>
     public static int[] Apply(IRandom random, int[] parent1, int[] parent2) {
       int length = parent1.Length;
@@ -66 +86 @@
     }
 
+    /// <summary>
+    /// Performs a cross over permuation of <paramref name="parent1"/> and <paramref name="parent2"/>
+    /// by taking a randomly chosen interval from <paramref name="parent1"/>, preserving the position, 
+    /// then all positions from <paramref name="parent2"/> which are still free in the child 
+    /// (the position is free and the value is "free")
+    /// and then missing ones from <paramref name="parent2"/> in the order they occur 
+    /// in <paramref name="parent2"/>.
+    /// </summary>
+    /// <remarks>Calls <see cref="Apply"/>.</remarks>
+    /// <param name="scope">The current scope.</param>
+    /// <param name="random">The random number generator.</param>
+    /// <param name="parent1">The parent scope 1 to cross over.</param>
+    /// <param name="parent2">The parent scope 2 to cross over.</param>
+    /// <returns>The created cross over permutation as int array.</returns>
     protected override int[] Cross(IScope scope, IRandom random, int[] parent1, int[] parent2) {
       return Apply(random, parent1, parent2);