Free cookie consent management tool by TermsFeed Policy Generator

source: trunk/sources/HeuristicLab.Operators/ParallelSubScopesProcessor.cs @ 1009

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

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

File size: 2.1 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.Data;
27
28namespace HeuristicLab.Operators {
[801]29  /// <summary>
30  /// Performs <c>n</c> operators on <c>n</c> subscopes, operations can be executed in parallel.
31  /// </summary>
[2]32  public class ParallelSubScopesProcessor : OperatorBase {
[801]33    /// <inheritdoc select="summary"/>
[2]34    public override string Description {
35      get { return @"TODO\r\nOperator description still missing ..."; }
36    }
37
[801]38    /// <summary>
39    /// Applies <c>n</c> operators on all the <c>n</c> sub scopes of the given <paramref name="scope"/>.
40    /// </summary>
41    /// <param name="scope">The scope on whose sub scopes the operators are applied.</param>
42    /// <returns>A new <see cref="CompositeOperation"/> with the <c>i</c>th operator applied
43    /// on the <c>i</c>th sub scope, the <c>ExecuteInParallel</c> flag set to <c>true</c>.</returns>
[2]44    public override IOperation Apply(IScope scope) {
45      CompositeOperation next = new CompositeOperation();
46      next.ExecuteInParallel = true;
47      for (int i = 0; i < scope.SubScopes.Count; i++)
48        next.AddOperation(new AtomicOperation(SubOperators[i], scope.SubScopes[i]));
49      return next;
50    }
51  }
52}
Note: See TracBrowser for help on using the repository browser.