Free cookie consent management tool by TermsFeed Policy Generator

source: trunk/sources/HeuristicLab.Operators/ConditionalBranch.cs @ 911

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

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

File size: 2.9 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  /// Branch of (one or)two operators whose executions depend on a specific condition.
31  /// </summary>
[2]32  public class ConditionalBranch : OperatorBase {
[801]33    /// <inheritdoc select="summary"/>
[2]34    public override string Description {
[49]35      get { return @"ConditionalBranch expects to have 1 or 2 sub-operators.
36It will return the 1st sub-operator if ""Condition"" is true and the 2nd sub-operator if ""Condition"" equals to false.
37
38In case a 2nd sub-operator does not exist and ""Condition"" would equal to false, Conditional Branch will not return a new operation."; }
[2]39    }
40
[801]41    /// <summary>
42    /// Initializes a new instance of <see cref="ConditionalBranch"/> with one variable info
43    /// (<c>Condition</c>).
44    /// </summary>
[2]45    public ConditionalBranch()
46      : base() {
47      AddVariableInfo(new VariableInfo("Condition", "A boolean variable that decides the branch", typeof(BoolData), VariableKind.In));
48    }
49
[801]50    /// <summary>
51    /// Applies the operator of branch one under a specific condition on the given
52    /// <paramref name="scope"/>, or - if existent - operator of branch two if the condition could not
53    /// be fulfilled.
54    /// </summary>
55    /// <param name="scope">The scope to apply the operators on.</param>
56    /// <returns>A new <see cref="AtomicOperation"/> with either operator 1 or operator 2 applied
57    /// to the given <paramref name="scope"/> or <c>null</c>.</returns>
[2]58    public override IOperation Apply(IScope scope) {
59      BoolData resultData = GetVariableValue<BoolData>("Condition", scope, true);
60      bool result = resultData.Data;
61
62      if ((result) && (SubOperators.Count > 0) && (SubOperators[0] != null))
63        return new AtomicOperation(SubOperators[0], scope);
64      else if ((!result) && (SubOperators.Count > 1) && (SubOperators[1] != null))
65        return new AtomicOperation(SubOperators[1], scope);
66      return null;
67    }
68  }
69}
Note: See TracBrowser for help on using the repository browser.