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

trunk/sources/HeuristicLab.RealVector/SelfAdaptiveNormalAllPositionsManipulator.cs

@@ -28 +28 @@
 
 namespace HeuristicLab.RealVector {
+  /// <summary>
+  /// Manipulates each dimension in the real vector with the mutation strength given 
+  /// in the strategy parameter vector.
+  /// </summary>
   public class SelfAdaptiveNormalAllPositionsManipulator : RealVectorManipulatorBase {
+    /// <inheritdoc select="summary"/>
     public override string Description {
       get { return @"Manipulates each dimension in the real vector with the mutation strength given in the strategy parameter vector"; }
     }
 
+    /// <summary>
+    /// Initializes a new instance of <see cref="SelfAdaptiveNormalAllPositionsManipulator"/> with one
+    /// variable info (<c>StrategyVector</c>).
+    /// </summary>
     public SelfAdaptiveNormalAllPositionsManipulator()
       : base() {
@@ -38 +47 @@
     }
 
+    /// <summary>
+    /// Performs a self adaptive normally distributed all position manipulation on the given 
+    /// <paramref name="vector"/>.
+    /// </summary>
+    /// <exception cref="InvalidOperationException">Thrown when the strategy vector is not
+    /// as long as the vector to get manipulated.</exception>
+    /// <param name="strategyParameters">The strategy vector determining the strength of the mutation.</param>
+    /// <param name="random">A random number generator.</param>
+    /// <param name="vector">The real vector to manipulate.</param>
+    /// <returns>The manipulated real vector.</returns>
     public static double[] Apply(double[] strategyParameters, IRandom random, double[] vector) {
       NormalDistributedRandom N = new NormalDistributedRandom(random, 0.0, 1.0);
@@ -46 +65 @@
     }
 
+    /// <summary>
+    /// Performs a self adaptive normally distributed all position manipulation on the given 
+    /// <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 manipulated real vector.</returns>
     protected override double[] Manipulate(IScope scope, IRandom random, double[] vector) {
       double[] strategyVector = scope.GetVariableValue<DoubleArrayData>("StrategyVector", true).Data;