Free cookie consent management tool by TermsFeed Policy Generator

source: trunk/sources/HeuristicLab.Selection/RandomSelector.cs @ 1096

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

Created API documentation for HeuristicLab.Selection 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;
26
27namespace HeuristicLab.Selection {
28  /// <summary>
29  /// Copies or moves a defined number of sub scopes from a source scope to a target scope, being selected
30  /// randomly.
31  /// </summary>
32  public class RandomSelector : StochasticSelectorBase {
33    /// <inheritdoc select="summary"/>
34    public override string Description {
35      get { return @"TODO\r\nOperator description still missing ..."; }
36    }
37
38    /// <summary>
39    /// Copies or moves a number of sub scopes (<paramref name="selected"/>) from <paramref name="source"/>
40    /// to the <paramref name="target"/>, chosen randomly.
41    /// </summary>
42    /// <param name="random">The random number generator.</param>
43    /// <param name="source">The source scope from which to copy/move the sub scopes.</param>
44    /// <param name="selected">The number of sub scopes to move.</param>
45    /// <param name="target">The target where to copy/move the sub scopes.</param>
46    /// <param name="copySelected">Boolean flag whether the sub scopes shall be copied or moved.</param>
47    protected override void Select(IRandom random, IScope source, int selected, IScope target, bool copySelected) {
48      for (int i = 0; i < selected; i++) {
49        if (copySelected) {
50          target.AddSubScope((IScope)source.SubScopes[random.Next(source.SubScopes.Count)].Clone());
51        } else {
52          IScope s = source.SubScopes[random.Next(source.SubScopes.Count)];
53          source.RemoveSubScope(s);
54          target.AddSubScope(s);
55        }
56      }
57    }
58  }
59}
Note: See TracBrowser for help on using the repository browser.