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

Timestamp:

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

Author:

vdorfer

Message:

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

File:

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

trunk/sources/HeuristicLab.RealVector/UniformOnePositionManipulator.cs

@@ -27 +27 @@
 
 namespace HeuristicLab.RealVector {
+  /// <summary>
+  /// Uniformly distributed change of a single position of a real vector.
+  /// </summary>
   public class UniformOnePositionManipulator : RealVectorManipulatorBase {
+    /// <inheritdoc select="summary"/>
     public override string Description {
       get { return "Uniformly distributed change of a single position of a real 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(DoubleData), VariableKind.In));
@@ -37 +45 @@
     }
 
+    /// <summary>
+    /// Changes randomly a single position in the given real <paramref name="vector"/>.
+    /// </summary>
+    /// <param name="random">A 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 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 real vector that has been manipulated.</returns>
     public static double[] Apply(IRandom random, double[] vector, double min, double max) {
       double[] result = (double[])vector.Clone();
@@ -44 +62 @@
     }
 
+    /// <summary>
+    /// Changes randomly a single position in the given real <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 real vector to manipulate.</param>
+    /// <returns>The new real vector that has been manipulated.</returns>
     protected override double[] Manipulate(IScope scope, IRandom random, double[] vector) {
       double min = GetVariableValue<DoubleData>("Minimum", scope, true).Data;