Changeset 1188 for trunk/sources/HeuristicLab.TestFunctions/SphereEvaluator.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/SphereEvaluator.cs (modified) (3 diffs)

trunk/sources/HeuristicLab.TestFunctions/SphereEvaluator.cs

@@ -28 +28 @@
 
 namespace HeuristicLab.TestFunctions {
+  /// <summary>
+  /// Sphere Function<br/>
+  /// Domain:  [-5.12 , 5.12]^n<br/>
+  /// Optimum: 0.0 at (0, 0, ..., 0)
+  /// </summary>
   public class SphereEvaluator : TestFunctionEvaluatorBase {
+    /// <inheritdoc select="summary"/>
     public override string Description {
       get { return
@@ -38 +44 @@
     }
 
+    /// <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 Sphere function at the given point.</returns>
     public static double Apply(double[] point) {
       double result = 0;
@@ -45 +56 @@
     }
 
+    /// <summary>
+    /// Evaluates the test function for a specific <paramref name="point"/>.
+    /// </summary>
+    /// <remarks>Calls <see cref="Apply"/>.</remarks>
+    /// <param name="point">N-dimensional point for which the test function should be evaluated.</param>
+    /// <returns>The result value of the Sphere function at the given point.</returns>
     protected override double EvaluateFunction(double[] point) {
       return Apply(point);