source: branches/2839_HiveProjectManagement/HeuristicLab.Analysis/3.3/QualityAnalysis/QualityDifferenceCalculator.cs @ 16057

Last change on this file since 16057 was 16057, checked in by jkarder, 15 months ago

#2839:

File size: 4.0 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2018 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.Operators;
26using HeuristicLab.Parameters;
27using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
28
29namespace HeuristicLab.Analysis {
30  /// <summary>
31  /// An operator which calculates the absolute and relative difference of two quality values.
32  /// </summary>
33  [Item("QualityDifferenceCalculator", "An operator which calculates the absolute and relative difference of two quality values.")]
34  [StorableClass]
35  public class QualityDifferenceCalculator : SingleSuccessorOperator {
36    public IValueLookupParameter<DoubleValue> FirstQualityParameter {
37      get { return (IValueLookupParameter<DoubleValue>)Parameters["FirstQuality"]; }
38    }
39    public IValueLookupParameter<DoubleValue> SecondQualityParameter {
40      get { return (IValueLookupParameter<DoubleValue>)Parameters["SecondQuality"]; }
41    }
42    public IValueLookupParameter<DoubleValue> AbsoluteDifferenceParameter {
43      get { return (IValueLookupParameter<DoubleValue>)Parameters["AbsoluteDifference"]; }
44    }
45    public IValueLookupParameter<PercentValue> RelativeDifferenceParameter {
46      get { return (IValueLookupParameter<PercentValue>)Parameters["RelativeDifference"]; }
47    }
48
49    #region Storing & Cloning
50    [StorableConstructor]
51    protected QualityDifferenceCalculator(bool deserializing) : base(deserializing) { }
52    protected QualityDifferenceCalculator(QualityDifferenceCalculator original, Cloner cloner) : base(original, cloner) { }
53    public override IDeepCloneable Clone(Cloner cloner) {
54      return new QualityDifferenceCalculator(this, cloner);
55    }
56    #endregion
57    public QualityDifferenceCalculator()
58      : base() {
59      Parameters.Add(new ValueLookupParameter<DoubleValue>("FirstQuality", "The first quality value from which the difference to the second quality value is calculated."));
60      Parameters.Add(new ValueLookupParameter<DoubleValue>("SecondQuality", "The second quality value from which the difference from the first quality value is calculated."));
61      Parameters.Add(new ValueLookupParameter<DoubleValue>("AbsoluteDifference", "The absolute difference of the first and second quality value."));
62      Parameters.Add(new ValueLookupParameter<PercentValue>("RelativeDifference", "The relative difference of the first and second quality value."));
63    }
64
65    public override IOperation Apply() {
66      DoubleValue first = FirstQualityParameter.ActualValue;
67      DoubleValue second = SecondQualityParameter.ActualValue;
68
69      if ((first != null) && (second != null)) {
70        double absolute = second.Value - first.Value;
71        double relative = first.Value == 0 ? double.NaN : absolute / first.Value;
72
73        if (AbsoluteDifferenceParameter.ActualValue == null) AbsoluteDifferenceParameter.ActualValue = new DoubleValue(absolute);
74        else AbsoluteDifferenceParameter.ActualValue.Value = absolute;
75        if (RelativeDifferenceParameter.ActualValue == null) RelativeDifferenceParameter.ActualValue = new PercentValue(relative);
76        else RelativeDifferenceParameter.ActualValue.Value = relative;
77      }
78      return base.Apply();
79    }
80  }
81}
Note: See TracBrowser for help on using the repository browser.