Free cookie consent management tool by TermsFeed Policy Generator

source: trunk/sources/HeuristicLab.TestFunctions/SumSquaresEvaluator.cs @ 1196

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

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

File size: 2.3 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;
25
26namespace HeuristicLab.TestFunctions {
27  /// <summary>
28  /// Sum Squares Function<br/>
29  /// Domain:  [-10.0 , 10.0]^n<br/>
30  /// Optimum: 0.0 at (0.0, 0.0, ..., 0.0)
31  /// </summary>
32  public class SumSquaresEvaluator : TestFunctionEvaluatorBase {
33    /// <inheritdoc select="summary"/>
34    public override string Description {
35      get { return
36@"Sum Squares Function
37
38Domain:  [-10.0 , 10.0]^n
39Optimum: 0.0 at (0.0, 0.0, ..., 0.0)";
40          }
41    }
42
43    /// <summary>
44    /// Evaluates the test function for a specific <paramref name="point"/>.
45    /// </summary>
46    /// <param name="point">N-dimensional point for which the test function should be evaluated.</param>
47    /// <returns>The result value of the Sum Squares function at the given point.</returns>
48    public static double Apply(double[] point) {
49      double result = 0;
50      for (int i = 0; i < point.Length; i++) {
51        result += i * point[i] * point[i];
52      }
53      return result;
54    }
55
56    /// <summary>
57    /// Evaluates the test function for a specific <paramref name="point"/>.
58    /// </summary>
59    /// <remarks>Calls <see cref="Apply"/>.</remarks>
60    /// <param name="point">N-dimensional point for which the test function should be evaluated.</param>
61    /// <returns>The result value of the Sum Squares function at the given point.</returns>
62    protected override double EvaluateFunction(double[] point) {
63      return Apply(point);
64    }
65  }
66}
Note: See TracBrowser for help on using the repository browser.