[12367] | 1 | #region License Information
|
---|
| 2 | /* HeuristicLab
|
---|
[14185] | 3 | * Copyright (C) 2002-2016 Heuristic and Evolutionary Algorithms Laboratory (HEAL)
|
---|
[12367] | 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 |
|
---|
[12408] | 22 | using System;
|
---|
[12367] | 23 | using HeuristicLab.Common;
|
---|
| 24 | using HeuristicLab.Core;
|
---|
[12408] | 25 | using HeuristicLab.Data;
|
---|
[12367] | 26 | using HeuristicLab.Parameters;
|
---|
| 27 | using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
|
---|
| 28 |
|
---|
[12529] | 29 | namespace HeuristicLab.Optimization {
|
---|
[12402] | 30 | [Item("ThresholdTerminator", "Base class for all termination criteria which specifies some threshold.")]
|
---|
[12367] | 31 | [StorableClass]
|
---|
[12444] | 32 | public abstract class ThresholdTerminator<T> : Terminator where T : class, IItem, IStringConvertibleValue, new() {
|
---|
[12411] | 33 | [Storable]
|
---|
| 34 | private IFixedValueParameter<T> thresholdParameter;
|
---|
[12405] | 35 | public IFixedValueParameter<T> ThresholdParameter {
|
---|
[12411] | 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 | }
|
---|
[12367] | 47 | }
|
---|
| 48 |
|
---|
[12405] | 49 | public T Threshold {
|
---|
| 50 | get { return ThresholdParameter.Value; }
|
---|
| 51 | }
|
---|
| 52 |
|
---|
[12367] | 53 | [StorableConstructor]
|
---|
[12402] | 54 | protected ThresholdTerminator(bool deserializing) : base(deserializing) { }
|
---|
[12367] | 55 | [StorableHook(HookType.AfterDeserialization)]
|
---|
| 56 | private void AfterDeserialization() {
|
---|
| 57 | Initialize();
|
---|
| 58 | }
|
---|
[12402] | 59 | protected ThresholdTerminator(ThresholdTerminator<T> original, Cloner cloner)
|
---|
[12367] | 60 | : base(original, cloner) {
|
---|
[12411] | 61 | thresholdParameter = cloner.Clone(original.thresholdParameter);
|
---|
[12367] | 62 | Initialize();
|
---|
| 63 | }
|
---|
[12408] | 64 | protected ThresholdTerminator()
|
---|
| 65 | : this(new T()) { }
|
---|
| 66 | protected ThresholdTerminator(T threshold)
|
---|
[12367] | 67 | : base() {
|
---|
[12408] | 68 | if (threshold == null) throw new ArgumentNullException("threshold");
|
---|
[12411] | 69 | thresholdParameter = new FixedValueParameter<T>("Threshold", "The limit of the termiation criterion.", threshold);
|
---|
| 70 | Parameters.Add(thresholdParameter);
|
---|
[12367] | 71 | Initialize();
|
---|
| 72 | }
|
---|
| 73 |
|
---|
| 74 | private void Initialize() {
|
---|
[12411] | 75 | RegisterThresholdParameterEvents();
|
---|
[12367] | 76 | }
|
---|
[12436] | 77 | private void RegisterThresholdParameterEvents() {
|
---|
| 78 | Threshold.ValueChanged += new EventHandler(Threshold_ValueChanged);
|
---|
| 79 | }
|
---|
| 80 | private void OnThresholdParameterChanged() {
|
---|
| 81 | RegisterThresholdParameterEvents();
|
---|
| 82 | }
|
---|
[12367] | 83 |
|
---|
[12408] | 84 | private void Threshold_ValueChanged(object sender, EventArgs e) {
|
---|
| 85 | OnThresholdChanged();
|
---|
| 86 | }
|
---|
| 87 | protected virtual void OnThresholdChanged() {
|
---|
| 88 | OnToStringChanged();
|
---|
| 89 | }
|
---|
| 90 |
|
---|
[12367] | 91 | public override string ToString() {
|
---|
| 92 | if (ThresholdParameter.Value == null) return Name;
|
---|
| 93 | else return Name + ": " + ThresholdParameter.Value;
|
---|
| 94 | }
|
---|
| 95 | }
|
---|
| 96 | } |
---|