Changeset 1188 for trunk/sources/HeuristicLab.TestFunctions/TestFunctionEvaluatorBase.cs

Timestamp:

01/30/09 10:38:42 (15 years ago)

Author:

vdorfer

Message:

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

File:

• trunk/sources/HeuristicLab.TestFunctions/TestFunctionEvaluatorBase.cs (modified) (1 diff)

trunk/sources/HeuristicLab.TestFunctions/TestFunctionEvaluatorBase.cs

@@ -28 +28 @@
 
 namespace HeuristicLab.TestFunctions {
+  /// <summary>
+  /// Base class for a test function evaluator.
+  /// </summary>
   public abstract class TestFunctionEvaluatorBase : SingleObjectiveEvaluatorBase {
+    /// <summary>
+    /// Initializes a new instance of <see cref="TestFunctionEvaluatorBase"/> with one variable info
+    /// (<c>Point</c>).
+    /// </summary>
     public TestFunctionEvaluatorBase() {
       AddVariableInfo(new VariableInfo("Point", "n-dimensional point for which the test function should be evaluated", typeof(DoubleArrayData), VariableKind.In));
     }
 
+    /// <summary>
+    /// Evaluates the test function for a specific point.
+    /// </summary>
+    /// <remarks>Calls <see cref="EvaluateFunction(double[])"/>.</remarks>
+    /// <param name="scope">The current scope with the point for which to evaluate.</param>
+    /// <returns>The result value of the function at the given point.</returns>
     protected sealed override double Evaluate(IScope scope) {
       return EvaluateFunction(GetVariableValue<DoubleArrayData>("Point", scope, false).Data);
     }
 
+    /// <summary>
+    /// Evaluates the test function for a specific <paramref name="point"/>.
+    /// </summary>
+    /// <param name="point">N-dimensional point for which the test function should be evaluated.</param>
+    /// <returns>The result value of the function at the given point.</returns>
     protected abstract double EvaluateFunction(double[] point);
   }