Changeset 1184 for trunk/sources/HeuristicLab.RealVector/RealVectorCrossoverBase.cs

Timestamp:

01/28/09 10:20:40 (16 years ago)

Author:

vdorfer

Message:

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

File:

• trunk/sources/HeuristicLab.RealVector/RealVectorCrossoverBase.cs (modified) (3 diffs)

trunk/sources/HeuristicLab.RealVector/RealVectorCrossoverBase.cs

@@ -28 +28 @@
 
 namespace HeuristicLab.RealVector {
+  /// <summary>
+  /// Base class for all real vector crossover operators.
+  /// </summary>
   public abstract class RealVectorCrossoverBase : CrossoverBase {
+    /// <summary>
+    /// Initializes a new instance of <see cref="RealVectorCrossoverBase"/> with one variable info
+    /// (<c>RealVector</c>).
+    /// </summary>
     public RealVectorCrossoverBase()
       : base() {
@@ -34 +41 @@
     }
 
+    /// <summary>
+    /// Performs a crossover of two given parents.
+    /// </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>
+    /// <param name="child">The resulting child scope.</param>
     protected sealed override void Cross(IScope scope, IRandom random, IScope parent1, IScope parent2, IScope child) {
       DoubleArrayData vector1 = parent1.GetVariableValue<DoubleArrayData>("RealVector", false);
@@ -44 +59 @@
     }
 
+    /// <summary>
+    /// Performs a crossover of two given parents.
+    /// </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 real vector, resulting from the crossover operation.</returns>
     protected abstract double[] Cross(IScope scope, IRandom random, double[] parent1, double[] parent2);
   }