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

trunk/sources/HeuristicLab.RealVector/BoundsChecker.cs

@@ -27 +27 @@
 
 namespace HeuristicLab.RealVector {
+  /// <summary>
+  /// Checks if all elements of a real vector are inside a given minimum and maximum value. 
+  /// If not, the elements are corrected.
+  /// </summary>
   public class BoundsChecker : OperatorBase {
+    /// <inheritdoc select="summary"/>
     public override string Description {
       get { return "Checks if all elements of a real vector are inside a given minimum and maximum value. If not, elements are corrected."; }
     }
 
+    /// <summary>
+    /// Initializes a new instance of <see cref="BoundsChecker"/> with three variable infos
+    /// (<c>RealVector</c>, <c>Minimum</c> and <c>Maximum</c>).
+    /// </summary>
     public BoundsChecker()
       : base() {
@@ -39 +48 @@
     }
 
+    /// <summary>
+    /// Checks if all elements of the given <paramref name="vector"/> are inside the given minimum 
+    /// and maximum value and if not they are corrected.
+    /// </summary>
+    /// <param name="min">The minimum value of the range (inclusive).</param>
+    /// <param name="max">The maximum value of the range (inclusive).</param>
+    /// <param name="vector">The vector to check.</param>
+    /// <returns>The corrected real vector.</returns>
     public static double[] Apply(double min, double max, double[] vector) {
       int length = vector.Length;
@@ -50 +67 @@
     }
 
+    /// <summary>
+    /// Checks if all elements of the given <paramref name="vector"/> are inside the given minimum 
+    /// and maximum value and if not they are corrected.
+    /// </summary>
+    /// <remarks>Calls <see cref="Apply(double, double, double[])"/>.</remarks>
+    /// <param name="scope">The current scope.</param>
+    /// <returns><c>null</c>.</returns>
     public override IOperation Apply(IScope scope) {
       DoubleArrayData vector = GetVariableValue<DoubleArrayData>("RealVector", scope, false);