Changeset 1184 for trunk/sources/HeuristicLab.RealVector/MichalewiczNonUniformOnePositionManipulator.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/MichalewiczNonUniformOnePositionManipulator.cs (modified) (4 diffs)

trunk/sources/HeuristicLab.RealVector/MichalewiczNonUniformOnePositionManipulator.cs

@@ -27 +27 @@
 
 namespace HeuristicLab.RealVector {
+  /// <summary>
+  /// Michalewicz, Z. (1992). Genetic Algorithms + Data Structures = Evolution Programs<br/>
+  /// Non-uniformly distributed change of one position of a real vector.
+  /// </summary>
   public class MichalewiczNonUniformOnePositionManipulator : RealVectorManipulatorBase {
+    /// <inheritdoc select="summary"/>
     public override string Description {
       get { return
@@ -37 +42 @@
     }
 
+    /// <summary>
+    /// Initializes a new instance of <see cref="MichalewiczNonUniformOnePositionManipulator"/> with five 
+    /// variable infos (<c>Minimum</c>, <c>Maximum</c>, <c>CurrentGeneration</c>, <c>MaximumGenerations</c>
+    /// and <c>GenerationsDependency</c>).
+    /// </summary>
     public MichalewiczNonUniformOnePositionManipulator()
       : base() {
@@ -49 +59 @@
     }
 
+    /// <summary>
+    /// Performs a non uniformly distributed one position manipulation on the given 
+    /// real <paramref name="vector"/>, published by Z. Michalewicz, 1992.
+    /// </summary>
+    /// <remarks>Calls <see cref="Apply"/>.</remarks>
+    /// <param name="scope">The current scope.</param>
+    /// <param name="random">The random number generator.</param>
+    /// <param name="vector">The real vector to manipulate.</param>
+    /// <returns>The manipulated real vector.</returns>
     protected override double[] Manipulate(IScope scope, IRandom random, double[] vector) {
       double min = GetVariableValue<DoubleData>("Minimum", scope, true).Data;
@@ -58 +77 @@
     }
 
+    /// <summary>
+    /// Performs a non uniformly distributed one position manipulation on the given 
+    /// real <paramref name="vector"/>, published by Z. Michalewicz, 1992.
+    /// </summary>
+    /// <param name="random">The random number generator.</param>
+    /// <param name="vector">The real vector to manipulate.</param>
+    /// <param name="min">The minimum value of the sampling range for the vector element (inclusive).</param>
+    /// <param name="max">The maximum value of the sampling range for the vector element (exclusive).</param>
+    /// <param name="currentGeneration">The current generation of the algorithm.</param>
+    /// <param name="maximumGenerations">Maximum number of generations.</param>
+    /// <param name="generationsDependency">Specifies the degree of dependency on the number of generations.</param>
+    /// <returns>The manipulated real vector.</returns>
     public static double[] Apply(IRandom random, double[] vector, double min, double max, int currentGeneration, int maximumGenerations, int generationsDependency) {
       int length = vector.Length;