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

trunk/sources/HeuristicLab.RealVector/RealVectorManipulatorBase.cs

@@ -27 +27 @@
 
 namespace HeuristicLab.RealVector {
+  /// <summary>
+  /// Base class for all real vector manipulators.
+  /// </summary>
   public abstract class RealVectorManipulatorBase : OperatorBase {
+    /// <summary>
+    /// Initializes a new instance of <see cref="RealVectorManipulatorBase"/> with two variable infos
+    /// (<c>Random</c> and <c>RealVector</c>).
+    /// </summary>
     public RealVectorManipulatorBase() {
       AddVariableInfo(new VariableInfo("Random", "Pseudo random number generator", typeof(IRandom), VariableKind.In));
@@ -33 +40 @@
     }
 
+    /// <summary>
+    /// Manipulates the real vector.
+    /// </summary>
+    /// <param name="scope">The current scope whose real vector to manipulate.</param>
+    /// <returns><c>null</c>.</returns>
     public override IOperation Apply(IScope scope) {
       IRandom random = GetVariableValue<IRandom>("Random", scope, true);
@@ -40 +52 @@
     }
 
+    /// <summary>
+    /// Manipulates the given real <paramref name="vector"/> with the given random number generator.
+    /// </summary>
+    /// <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 abstract double[] Manipulate(IScope scope, IRandom random, double[] vector);
   }