Free cookie consent management tool by TermsFeed Policy Generator

source: trunk/sources/HeuristicLab.Selection/LeftReducer.cs @ 1184

Last change on this file since 1184 was 817, checked in by vdorfer, 16 years ago

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

File size: 1.8 KB
RevLine 
[2]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.Operators;
27
28namespace HeuristicLab.Selection {
[817]29  /// <summary>
30  /// Takes only sub scopes from the left child of the tree.
31  /// </summary>
[2]32  public class LeftReducer : ReducerBase {
[817]33    /// <inheritdoc select="summary"/>
[2]34    public override string Description {
35      get { return @"TODO\r\nOperator description still missing ..."; }
36    }
37
[817]38    /// <summary>
39    /// Takes only the sub scopes from the left sub scope of the tree.
40    /// </summary>
41    /// <param name="scope">The current scope.</param>
42    /// <returns>All sub scopes from the left part of the tree.</returns>
[2]43    protected override ICollection<IScope> Reduce(IScope scope) {
44      List<IScope> subScopes = new List<IScope>();
45
46      if (scope.SubScopes.Count > 0)
47        subScopes.AddRange(scope.SubScopes[0].SubScopes);
48      return subScopes;
49    }
50  }
51}
Note: See TracBrowser for help on using the repository browser.