source: branches/TerminationCriteria/HeuristicLab.Termination/3.3/ThresholdTerminator.cs @ 12444

Last change on this file since 12444 was 12444, checked in by pfleck, 4 years ago

#2027

  • Removed ISingleValueTerminator and used ThresholdTerminator for the View instead.
  • Added missing description in SingleObjectiveQualityTerminator.
  • Added ITerminationBasedOperator which contains the terminate-flag.
File size: 3.5 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2015 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 HeuristicLab.Common;
24using HeuristicLab.Core;
25using HeuristicLab.Data;
26using HeuristicLab.Parameters;
27using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
28
29namespace HeuristicLab.Termination {
30  [Item("ThresholdTerminator", "Base class for all termination criteria which specifies some threshold.")]
31  [StorableClass]
32  public abstract class ThresholdTerminator<T> : Terminator where T : class, IItem, IStringConvertibleValue, new() {
33    [Storable]
34    private IFixedValueParameter<T> thresholdParameter;
35    public IFixedValueParameter<T> ThresholdParameter {
36      get { return thresholdParameter; }
37      set {
38        if (value == null) throw new ArgumentNullException("Threshold parameter must not be null.");
39        if (value.Value == null) throw new ArgumentNullException("Threshold parameter value must not be null.");
40        if (thresholdParameter == value) return;
41
42        if (thresholdParameter != null) Parameters.Remove(thresholdParameter);
43        thresholdParameter = value;
44        Parameters.Add(thresholdParameter);
45        OnThresholdParameterChanged();
46      }
47    }
48
49    public T Threshold {
50      get { return ThresholdParameter.Value; }
51    }
52
53    [StorableConstructor]
54    protected ThresholdTerminator(bool deserializing) : base(deserializing) { }
55    [StorableHook(HookType.AfterDeserialization)]
56    private void AfterDeserialization() {
57      Initialize();
58    }
59    protected ThresholdTerminator(ThresholdTerminator<T> original, Cloner cloner)
60      : base(original, cloner) {
61      thresholdParameter = cloner.Clone(original.thresholdParameter);
62      Initialize();
63    }
64    protected ThresholdTerminator()
65      : this(new T()) { }
66    protected ThresholdTerminator(T threshold)
67      : base() {
68      if (threshold == null) throw new ArgumentNullException("threshold");
69      thresholdParameter = new FixedValueParameter<T>("Threshold", "The limit of the termiation criterion.", threshold);
70      Parameters.Add(thresholdParameter);
71      Initialize();
72    }
73
74    private void Initialize() {
75      RegisterThresholdParameterEvents();
76    }
77    private void RegisterThresholdParameterEvents() {
78      Threshold.ValueChanged += new EventHandler(Threshold_ValueChanged);
79    }
80    private void OnThresholdParameterChanged() {
81      RegisterThresholdParameterEvents();
82    }
83
84    private void Threshold_ValueChanged(object sender, EventArgs e) {
85      OnThresholdChanged();
86    }
87    protected virtual void OnThresholdChanged() {
88      OnToStringChanged();
89    }
90
91    public override string ToString() {
92      if (ThresholdParameter.Value == null) return Name;
93      else return Name + ": " + ThresholdParameter.Value;
94    }
95  }
96}
Note: See TracBrowser for help on using the repository browser.