Changeset 881 for trunk/sources/HeuristicLab.Evolutionary/CrossoverBase.cs

Timestamp:

12/01/08 13:47:10 (15 years ago)

Author:

vdorfer

Message:

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

File:

• trunk/sources/HeuristicLab.Evolutionary/CrossoverBase.cs (modified) (3 diffs)

trunk/sources/HeuristicLab.Evolutionary/CrossoverBase.cs

@@ -27 +27 @@
 
 namespace HeuristicLab.Evolutionary {
+  /// <summary>
+  /// Base class for crossing over operators.
+  /// </summary>
   public abstract class CrossoverBase : OperatorBase {
+    /// <summary>
+    /// Initializes a new instance of <see cref="CrossoverBase"/> with one variable info (<c>Random</c>).
+    /// </summary>
     public CrossoverBase()
       : base() {
@@ -33 +39 @@
     }
 
+    /// <summary>
+    /// Replaces the parents (the sub scopes of the current <paramref name="scope"/>) with created children
+    /// by crossing over of two adjacent sub scopes.
+    /// </summary>
+    /// <exception cref="InvalidOperationException">Thrown when the size of the mating pool 
+    /// is not even.</exception>
+    /// <param name="scope">The current scope whose sub scopes shall be parents.</param>
+    /// <returns><c>null</c>.</returns>
     public override IOperation Apply(IScope scope) {
       IRandom random = GetVariableValue<IRandom>("Random", scope, true);
@@ -53 +67 @@
     }
 
+    /// <summary>
+    /// Performs a cross over of <paramref name="parent1"/> and <paramref name="parent2"/>
+    /// to create a new <paramref name="child"/>.
+    /// </summary>
+    /// <param name="scope">The current scope.</param>
+    /// <param name="random">A 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>
+    /// <param name="child">The resulting child of the cross over.</param>
     protected abstract void Cross(IScope scope, IRandom random, IScope parent1, IScope parent2, IScope child);
   }