Free cookie consent management tool by TermsFeed Policy Generator

source: branches/Operator Architecture Refactoring/HeuristicLab.Operators/Sorter.cs @ 1708

Last change on this file since 1708 was 801, checked in by vdorfer, 16 years ago

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

File size: 2.8 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;
27
28namespace HeuristicLab.Operators {
29  /// <summary>
30  /// Sorts all sub scopes of a given scope.
31  /// </summary>
32  public class Sorter : OperatorBase {
33    /// <inheritdoc select="summary"/>
34    public override string Description {
35      get { return @"TODO\r\nOperator description still missing ..."; }
36    }
37
38    /// <summary>
39    /// Initializes a new instance of <see cref="Sorter"/> with two variable infos
40    /// (<c>Descending</c> and <c>Value</c>).
41    /// </summary>
42    public Sorter()
43      : base() {
44      AddVariableInfo(new VariableInfo("Descending", "Sort in descending order", typeof(BoolData), VariableKind.In));
45      AddVariableInfo(new VariableInfo("Value", "Sorting value", typeof(DoubleData), VariableKind.In));
46    }
47
48    /// <summary>
49    /// Sorts all sub scopes of the given <paramref name="scope"/>.
50    /// </summary>
51    /// <remarks>Calls <see cref="IScope.ReorderSubScopes"/>.</remarks>
52    /// <param name="scope">The scope where to apply the sorting.</param>
53    /// <returns><c>null</c>.</returns>
54    public override IOperation Apply(IScope scope) {
55      bool descending = GetVariableValue<BoolData>("Descending", scope, true).Data;
56      double[] keys = new double[scope.SubScopes.Count];
57      int[] sequence = new int[keys.Length];
58
59      for (int i = 0; i < keys.Length; i++) {
60        keys[i] = scope.SubScopes[i].GetVariableValue<DoubleData>("Value", false).Data;
61        sequence[i] = i;
62      }
63
64      Array.Sort<double, int>(keys, sequence);
65
66      if (descending) {
67        int temp;
68        for (int i = 0; i < sequence.Length / 2; i++) {
69          temp = sequence[i];
70          sequence[i] = sequence[sequence.Length - 1 - i];
71          sequence[sequence.Length - 1 - i] = temp;
72        }
73      }
74      scope.ReorderSubScopes(sequence);
75
76      return null;
77    }
78  }
79}
Note: See TracBrowser for help on using the repository browser.