Changeset 1176 for trunk/sources/HeuristicLab.BitVector/SinglePointCrossover.cs

Timestamp:

01/27/09 09:31:06 (16 years ago)

Author:

vdorfer

Message:

Created API documentation for HeuristicLab.BitVector and HeuristicLab.Constraints namespace and changed a comment in HeuristicLab.IntVector namespace(#331)

File:

• trunk/sources/HeuristicLab.BitVector/SinglePointCrossover.cs (modified) (2 diffs)

trunk/sources/HeuristicLab.BitVector/SinglePointCrossover.cs

@@ -26 +26 @@
 
 namespace HeuristicLab.BitVector {
+  /// <summary>
+  /// Single point crossover for bit vectors.
+  /// </summary>
   public class SinglePointCrossover : BitVectorCrossoverBase {
+    /// <inheritdoc select="summary"/>
     public override string Description {
       get { return "Single point crossover for bit vectors."; }
     }
 
+    /// <summary>
+    /// Performs a single point crossover at a randomly chosen position of the two 
+    /// given parent bit vectors.
+    /// </summary>
+    /// <param name="random">A random number generator.</param>
+    /// <param name="parent1">The first parent for crossover.</param>
+    /// <param name="parent2">The second parent for crossover.</param>
+    /// <returns>The newly created bit vector, resulting from the single point crossover.</returns>
     public static bool[] Apply(IRandom random, bool[] parent1, bool[] parent2) {
       int length = parent1.Length;
@@ -44 +56 @@
     }
 
+    /// <summary>
+    /// Performs a single point crossover at a randomly chosen position of the two 
+    /// given parent bit vectors.
+    /// </summary>
+    /// <param name="scope">The current scope.</param>
+    /// <param name="random">A random number generator.</param>
+    /// <param name="parent1">The first parent for crossover.</param>
+    /// <param name="parent2">The second parent for crossover.</param>
+    /// <returns>The newly created bit vector, resulting from the single point crossover.</returns>
     protected override bool[] Cross(IScope scope, IRandom random, bool[] parent1, bool[] parent2) {
       return Apply(random, parent1, parent2);