Free cookie consent management tool by TermsFeed Policy Generator

source: trunk/sources/HeuristicLab.Operators/StochasticBranch.cs @ 1416

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

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

File size: 2.9 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  /// Branch of (one or) two operators that have different probabilities to get executed.
31  /// </summary>
32  public class StochasticBranch : 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="StochasticBranch"/> with two variable infos
40    /// (<c>Random</c> and <c>Probability</c>).
41    /// </summary>
42    public StochasticBranch()
43      : base() {
44      AddVariableInfo(new VariableInfo("Random", "Pseudo random number generator", typeof(IRandom), VariableKind.In));
45      AddVariableInfo(new VariableInfo("Probability", "Probability to choose first branch", typeof(DoubleData), VariableKind.In));
46    }
47
48    /// <summary>
49    /// Applies the operator of branch one with a specific probability on the given
50    /// <paramref name="scope"/>, or - if existent - with another probability operator of branch two. 
51    /// </summary>
52    /// <param name="scope">The scope to apply the operators on.</param>
53    /// <returns>A new <see cref="AtomicOperation"/> with either operator 1 or operator 2 applied
54    /// to the given <paramref name="scope"/> or <c>null</c>.</returns>
55    public override IOperation Apply(IScope scope) {
56      IRandom random = GetVariableValue<IRandom>("Random", scope, true);
57      DoubleData probability = GetVariableValue<DoubleData>("Probability", scope, true);
58
59      bool result = random.NextDouble() < probability.Data;
60      if ((result) && (SubOperators.Count > 0) && (SubOperators[0] != null))
61        return new AtomicOperation(SubOperators[0], scope);
62      else if ((!result) && (SubOperators.Count > 1) && (SubOperators[1] != null))
63        return new AtomicOperation(SubOperators[1], scope);
64      return null;
65    }
66  }
67}
Note: See TracBrowser for help on using the repository browser.