source: branches/2520_PersistenceReintegration/HeuristicLab.Operators/3.3/StochasticBranch.cs @ 16453

Last change on this file since 16453 was 16453, checked in by jkarder, 2 years ago

#2520: updated year of copyrights

File size: 3.5 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2019 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 HeuristicLab.Common;
23using HeuristicLab.Core;
24using HeuristicLab.Data;
25using HeuristicLab.Parameters;
26using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
27
28namespace HeuristicLab.Operators {
29  /// <summary>
30  /// A branch of two operators which are executed with a specified probability.
31  /// </summary>
32  [Item("StochasticBranch", "A branch of two operators which are executed with a specified probability.")]
33  [StorableClass]
34  public class StochasticBranch : SingleSuccessorOperator {
35    public LookupParameter<IRandom> RandomParameter {
36      get { return (LookupParameter<IRandom>)Parameters["Random"]; }
37    }
38    public ValueLookupParameter<DoubleValue> ProbabilityParameter {
39      get { return (ValueLookupParameter<DoubleValue>)Parameters["Probability"]; }
40    }
41    protected OperatorParameter FirstBranchParameter {
42      get { return (OperatorParameter)Parameters["FirstBranch"]; }
43    }
44    protected OperatorParameter SecondBranchParameter {
45      get { return (OperatorParameter)Parameters["SecondBranch"]; }
46    }
47    public IOperator FirstBranch {
48      get { return FirstBranchParameter.Value; }
49      set { FirstBranchParameter.Value = value; }
50    }
51    public IOperator SecondBranch {
52      get { return SecondBranchParameter.Value; }
53      set { SecondBranchParameter.Value = value; }
54    }
55
56    [StorableConstructor]
57    protected StochasticBranch(bool deserializing) : base(deserializing) { }
58    protected StochasticBranch(StochasticBranch original, Cloner cloner)
59      : base(original, cloner) {
60    }
61    public StochasticBranch()
62      : base() {
63      Parameters.Add(new LookupParameter<IRandom>("Random", "A pseudo random number generator."));
64      Parameters.Add(new ValueLookupParameter<DoubleValue>("Probability", "The probability to execute the first branch."));
65      Parameters.Add(new OperatorParameter("FirstBranch", "The operator which is executed with the given probability."));
66      Parameters.Add(new OperatorParameter("SecondBranch", "The operator which is executed if the first branch is not executed."));
67    }
68
69    public override IDeepCloneable Clone(Cloner cloner) {
70      return new StochasticBranch(this, cloner);
71    }
72
73    public override IOperation Apply() {
74      OperationCollection next = new OperationCollection(base.Apply());
75      if (RandomParameter.ActualValue.NextDouble() < ProbabilityParameter.ActualValue.Value) {
76        if (FirstBranch != null) next.Insert(0, ExecutionContext.CreateOperation(FirstBranch));
77      } else {
78        if (SecondBranch != null) next.Insert(0, ExecutionContext.CreateOperation(SecondBranch));
79      }
80      return next;
81    }
82  }
83}
Note: See TracBrowser for help on using the repository browser.