Free cookie consent management tool by TermsFeed Policy Generator

source: trunk/sources/HeuristicLab.TestFunctions/SphereEvaluator.cs @ 1454

Last change on this file since 1454 was 1188, checked in by vdorfer, 16 years ago

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

File size: 2.4 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2008 Heuristic and Evolutionary Algorithms Laboratory (HEAL)
4 *
5 * This file is part of HeuristicLab.
6 *
7 * HeuristicLab is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
11 *
12 * HeuristicLab is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with HeuristicLab. If not, see <http://www.gnu.org/licenses/>.
19 */
20#endregion
21
22using System;
23using System.Collections.Generic;
24using System.Text;
25using HeuristicLab.Core;
26using HeuristicLab.Data;
27using HeuristicLab.Operators;
28
29namespace HeuristicLab.TestFunctions {
30  /// <summary>
31  /// Sphere Function<br/>
32  /// Domain:  [-5.12 , 5.12]^n<br/>
33  /// Optimum: 0.0 at (0, 0, ..., 0)
34  /// </summary>
35  public class SphereEvaluator : TestFunctionEvaluatorBase {
36    /// <inheritdoc select="summary"/>
37    public override string Description {
38      get { return
39@"Sphere Function
40
41Domain:  [-5.12 , 5.12]^n
42Optimum: 0.0 at (0, 0, ..., 0)";
43          }
44    }
45
46    /// <summary>
47    /// Evaluates the test function for a specific <paramref name="point"/>.
48    /// </summary>
49    /// <param name="point">N-dimensional point for which the test function should be evaluated.</param>
50    /// <returns>The result value of the Sphere function at the given point.</returns>
51    public static double Apply(double[] point) {
52      double result = 0;
53      for (int i = 0; i < point.Length; i++)
54        result += point[i] * point[i];
55      return result;
56    }
57
58    /// <summary>
59    /// Evaluates the test function for a specific <paramref name="point"/>.
60    /// </summary>
61    /// <remarks>Calls <see cref="Apply"/>.</remarks>
62    /// <param name="point">N-dimensional point for which the test function should be evaluated.</param>
63    /// <returns>The result value of the Sphere function at the given point.</returns>
64    protected override double EvaluateFunction(double[] point) {
65      return Apply(point);
66    }
67  }
68}
Note: See TracBrowser for help on using the repository browser.