Free cookie consent management tool by TermsFeed Policy Generator

source: trunk/sources/HeuristicLab.ES/VariableStrengthRepeatingManipulator.cs @ 1035

Last change on this file since 1035 was 896, checked in by vdorfer, 16 years ago

Created API documentation for HeuristicLab.ES namespace and changed documentation of some Description properties (#331)

File size: 3.0 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.Linq;
25using System.Text;
26using HeuristicLab.Core;
27using HeuristicLab.Data;
28using HeuristicLab.Random;
29
30namespace HeuristicLab.ES {
31  /// <summary>
32  /// Applies its sub operator a number of times depending on the <c>ShakingFactor</c>.
33  /// </summary>
34  public class VariableStrengthRepeatingManipulator : OperatorBase {
35    /// <inheritdoc select="summary"/>
36    public override string Description {
37      get { return @"Applies its suboperator a number of times depending on the ShakingFactor"; }
38    }
39
40    /// <summary>
41    /// Initializes a new instance of <see cref="VariableStrengthRepeatingManipulator"/> with two variable
42    /// infos (<c>Random</c> and <c>ShakingFactor</c>).
43    /// </summary>
44    public VariableStrengthRepeatingManipulator()
45      : base() {
46      AddVariableInfo(new VariableInfo("Random", "Pseudo random number generator", typeof(IRandom), VariableKind.In));
47      AddVariableInfo(new VariableInfo("ShakingFactor", "Determines the strength of the mutation (repeated application of the operator)", typeof(DoubleData), VariableKind.In));
48    }
49
50    /// <summary>
51    /// Applies its suboperator a number of times depending on the <c>ShakingFactor</c>.
52    /// </summary>
53    /// <param name="scope">The current scope where to apply the operator.</param>
54    /// <returns>A new <see cref="CompositeOperation"/>, containing a specified number of
55    /// the same operations with the same operator, the number depending on the <c>ShakingFactor</c>.</returns>
56    public override IOperation Apply(IScope scope) {
57      IRandom random = GetVariableValue<IRandom>("Random", scope, true);
58      double shakingFactor = scope.GetVariableValue<DoubleData>("ShakingFactor", true).Data;
59      NormalDistributedRandom N = new NormalDistributedRandom(random, 1.0, shakingFactor);
60      int strength = (int)Math.Ceiling(Math.Abs(N.NextDouble()));
61      if (strength == 0) strength = 1;
62
63      CompositeOperation co = new CompositeOperation();
64      co.ExecuteInParallel = false;
65      for (int i = 0; i < strength; i++) {
66        co.AddOperation(new AtomicOperation(SubOperators[0], scope));
67      }
68
69      return co;
70    }
71  }
72}
Note: See TracBrowser for help on using the repository browser.