Changeset 1157 for trunk/sources/HeuristicLab.IntVector/UniformOnePositionManipulator.cs

Timestamp:

01/21/09 11:36:53 (15 years ago)

Author:

vdorfer

Message:

Created API documentation for HeuristicLab.IntVector namespace and changed some comments in HeuristicLab.Random and HeuristicLab.Selection.Offspring namespace(#331)

File:

• trunk/sources/HeuristicLab.IntVector/UniformOnePositionManipulator.cs (modified) (3 diffs)

trunk/sources/HeuristicLab.IntVector/UniformOnePositionManipulator.cs

@@ -27 +27 @@
 
 namespace HeuristicLab.IntVector {
+  /// <summary>
+  /// Uniformly distributed change of a single position of an integer vector.
+  /// </summary>
   public class UniformOnePositionManipulator : IntVectorManipulatorBase {
+    /// <inheritdoc select="summary"/>
     public override string Description {
       get { return "Uniformly distributed change of a single position of an integer vector."; }
     }
 
+    /// <summary>
+    /// Initializes a new instance of <see cref="UniformOnePositionManipulator"/> with two variable infos
+    /// (<c>Minimum</c> and <c>Maximum</c>).
+    /// </summary>
     public UniformOnePositionManipulator() {
       AddVariableInfo(new VariableInfo("Minimum", "Minimum of the sampling range for the vector element (included)", typeof(IntData), VariableKind.In));
@@ -37 +45 @@
     }
 
+    /// <summary>
+    /// Changes randomly a single position in the given integer <paramref name="vector"/>.
+    /// </summary>
+    /// <param name="random">A random number generator.</param>
+    /// <param name="vector">The integer vector to manipulate.</param>
+    /// <param name="min">The minimum value of the sampling range for 
+    /// the vector element to change (inclusive).</param>
+    /// <param name="max">The maximum value of the sampling range for
+    /// the vector element to change (exclusive).</param>
+    /// <returns>The new integer vector that has been manipulated.</returns>
     public static int[] Apply(IRandom random, int[] vector, int min, int max) {
       int[] result = (int[])vector.Clone();
@@ -44 +62 @@
     }
 
+    /// <summary>
+    /// Changes randomly a single position in the given integer <paramref name="vector"/>.
+    /// </summary>
+    /// <remarks>Calls <see cref="Apply"/>.</remarks>
+    /// <param name="scope">The current scope.</param>
+    /// <param name="random">A random number generator.</param>
+    /// <param name="vector">The integer vector to manipulate.</param>
+    /// <returns>The new integer vector that has been manipulated.</returns>
     protected override int[] Manipulate(IScope scope, IRandom random, int[] vector) {
       int min = GetVariableValue<IntData>("Minimum", scope, true).Data;