source: branches/2520_PersistenceReintegration/HeuristicLab.Analysis/3.3/QualityAnalysis/BestAverageWorstQualityAnalyzer.cs @ 16453

Last change on this file since 16453 was 16453, checked in by jkarder, 10 months ago

#2520: updated year of copyrights

File size: 11.7 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 System;
23using HeuristicLab.Common;
24using HeuristicLab.Core;
25using HeuristicLab.Data;
26using HeuristicLab.Operators;
27using HeuristicLab.Optimization;
28using HeuristicLab.Optimization.Operators;
29using HeuristicLab.Parameters;
30using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
31
32namespace HeuristicLab.Analysis {
33  /// <summary>
34  /// An operator which analyzes the best, average and worst quality of solutions in the scope tree.
35  /// </summary>
36  [Item("BestAverageWorstQualityAnalyzer", "An operator which analyzes the best, average and worst quality of solutions in the scope tree.")]
37  [StorableClass]
38  public sealed class BestAverageWorstQualityAnalyzer : AlgorithmOperator, IAnalyzer, ISingleObjectiveOperator {
39    #region Parameter properties
40    public ValueLookupParameter<BoolValue> MaximizationParameter {
41      get { return (ValueLookupParameter<BoolValue>)Parameters["Maximization"]; }
42    }
43    public ScopeTreeLookupParameter<DoubleValue> QualityParameter {
44      get { return (ScopeTreeLookupParameter<DoubleValue>)Parameters["Quality"]; }
45    }
46    public ValueLookupParameter<DoubleValue> BestKnownQualityParameter {
47      get { return (ValueLookupParameter<DoubleValue>)Parameters["BestKnownQuality"]; }
48    }
49    public ValueLookupParameter<DoubleValue> BestQualityParameter {
50      get { return (ValueLookupParameter<DoubleValue>)Parameters["BestQuality"]; }
51    }
52    public ValueLookupParameter<DoubleValue> CurrentBestQualityParameter {
53      get { return (ValueLookupParameter<DoubleValue>)Parameters["CurrentBestQuality"]; }
54    }
55    public ValueLookupParameter<DoubleValue> CurrentAverageQualityParameter {
56      get { return (ValueLookupParameter<DoubleValue>)Parameters["CurrentAverageQuality"]; }
57    }
58    public ValueLookupParameter<DoubleValue> CurrentWorstQualityParameter {
59      get { return (ValueLookupParameter<DoubleValue>)Parameters["CurrentWorstQuality"]; }
60    }
61    public ValueLookupParameter<DataTable> QualitiesParameter {
62      get { return (ValueLookupParameter<DataTable>)Parameters["Qualities"]; }
63    }
64    public ValueLookupParameter<DoubleValue> AbsoluteDifferenceBestKnownToBestParameter {
65      get { return (ValueLookupParameter<DoubleValue>)Parameters["AbsoluteDifferenceBestKnownToBest"]; }
66    }
67    public ValueLookupParameter<PercentValue> RelativeDifferenceBestKnownToBestParameter {
68      get { return (ValueLookupParameter<PercentValue>)Parameters["RelativeDifferenceBestKnownToBest"]; }
69    }
70    public ValueLookupParameter<ResultCollection> ResultsParameter {
71      get { return (ValueLookupParameter<ResultCollection>)Parameters["Results"]; }
72    }
73    #endregion
74
75    #region Properties
76    public bool EnabledByDefault {
77      get { return true; }
78    }
79    private BestQualityMemorizer BestQualityMemorizer {
80      get { return (BestQualityMemorizer)OperatorGraph.InitialOperator; }
81    }
82    private BestAverageWorstQualityCalculator BestAverageWorstQualityCalculator {
83      get { return (BestAverageWorstQualityCalculator)BestQualityMemorizer.Successor; }
84    }
85    #endregion
86
87    #region Storing & Cloning
88    [StorableConstructor]
89    private BestAverageWorstQualityAnalyzer(bool deserializing) : base(deserializing) { }
90    private BestAverageWorstQualityAnalyzer(BestAverageWorstQualityAnalyzer original, Cloner cloner)
91      : base(original, cloner) {
92      Initialize();
93    }
94    public override IDeepCloneable Clone(Cloner cloner) {
95      return new BestAverageWorstQualityAnalyzer(this, cloner);
96    }
97    #endregion
98    public BestAverageWorstQualityAnalyzer()
99      : base() {
100      #region Create parameters
101      Parameters.Add(new ValueLookupParameter<BoolValue>("Maximization", "True if the problem is a maximization problem, otherwise false."));
102      Parameters.Add(new ScopeTreeLookupParameter<DoubleValue>("Quality", "The value which represents the quality of a solution."));
103      Parameters.Add(new ValueLookupParameter<DoubleValue>("BestKnownQuality", "The best known quality value found so far."));
104      Parameters.Add(new ValueLookupParameter<DoubleValue>("BestQuality", "The best quality value found in the current run."));
105      Parameters.Add(new ValueLookupParameter<DoubleValue>("CurrentBestQuality", "The best quality value found in the current population."));
106      Parameters.Add(new ValueLookupParameter<DoubleValue>("CurrentAverageQuality", "The average quality value of all solutions in the current population."));
107      Parameters.Add(new ValueLookupParameter<DoubleValue>("CurrentWorstQuality", "The worst quality value found in the current population."));
108      Parameters.Add(new ValueLookupParameter<DataTable>("Qualities", "The data table to store the current best, current average, current worst, best and best known quality value."));
109      Parameters.Add(new ValueLookupParameter<DoubleValue>("AbsoluteDifferenceBestKnownToBest", "The absolute difference of the best known quality value to the best quality value."));
110      Parameters.Add(new ValueLookupParameter<PercentValue>("RelativeDifferenceBestKnownToBest", "The relative difference of the best known quality value to the best quality value."));
111      Parameters.Add(new ValueLookupParameter<ResultCollection>("Results", "The results collection where the analysis values should be stored."));
112
113      BestQualityParameter.Hidden = true;
114      CurrentBestQualityParameter.Hidden = true;
115      CurrentAverageQualityParameter.Hidden = true;
116      CurrentWorstQualityParameter.Hidden = true;
117      QualitiesParameter.Hidden = true;
118      AbsoluteDifferenceBestKnownToBestParameter.Hidden = true;
119      RelativeDifferenceBestKnownToBestParameter.Hidden = true;
120      #endregion
121
122      #region Create operators
123      BestQualityMemorizer bestQualityMemorizer = new BestQualityMemorizer();
124      BestAverageWorstQualityCalculator bestAverageWorstQualityCalculator = new BestAverageWorstQualityCalculator();
125      DataTableValuesCollector dataTableValuesCollector = new DataTableValuesCollector();
126      QualityDifferenceCalculator qualityDifferenceCalculator = new QualityDifferenceCalculator();
127      ResultsCollector resultsCollector = new ResultsCollector();
128
129      bestQualityMemorizer.BestQualityParameter.ActualName = BestQualityParameter.Name;
130      bestQualityMemorizer.MaximizationParameter.ActualName = MaximizationParameter.Name;
131      bestQualityMemorizer.QualityParameter.ActualName = QualityParameter.Name;
132      bestQualityMemorizer.QualityParameter.Depth = QualityParameter.Depth;
133
134      bestAverageWorstQualityCalculator.AverageQualityParameter.ActualName = CurrentAverageQualityParameter.Name;
135      bestAverageWorstQualityCalculator.BestQualityParameter.ActualName = CurrentBestQualityParameter.Name;
136      bestAverageWorstQualityCalculator.MaximizationParameter.ActualName = MaximizationParameter.Name;
137      bestAverageWorstQualityCalculator.QualityParameter.ActualName = QualityParameter.Name;
138      bestAverageWorstQualityCalculator.QualityParameter.Depth = QualityParameter.Depth;
139      bestAverageWorstQualityCalculator.WorstQualityParameter.ActualName = CurrentWorstQualityParameter.Name;
140
141      dataTableValuesCollector.CollectedValues.Add(new LookupParameter<DoubleValue>("CurrentBestQuality", null, CurrentBestQualityParameter.Name));
142      dataTableValuesCollector.CollectedValues.Add(new LookupParameter<DoubleValue>("CurrentAverageQuality", null, CurrentAverageQualityParameter.Name));
143      dataTableValuesCollector.CollectedValues.Add(new LookupParameter<DoubleValue>("CurrentWorstQuality", null, CurrentWorstQualityParameter.Name));
144      dataTableValuesCollector.CollectedValues.Add(new LookupParameter<DoubleValue>("BestQuality", null, BestQualityParameter.Name));
145      dataTableValuesCollector.CollectedValues.Add(new LookupParameter<DoubleValue>("BestKnownQuality", null, BestKnownQualityParameter.Name));
146      dataTableValuesCollector.DataTableParameter.ActualName = QualitiesParameter.Name;
147
148      qualityDifferenceCalculator.AbsoluteDifferenceParameter.ActualName = AbsoluteDifferenceBestKnownToBestParameter.Name;
149      qualityDifferenceCalculator.FirstQualityParameter.ActualName = BestKnownQualityParameter.Name;
150      qualityDifferenceCalculator.RelativeDifferenceParameter.ActualName = RelativeDifferenceBestKnownToBestParameter.Name;
151      qualityDifferenceCalculator.SecondQualityParameter.ActualName = BestQualityParameter.Name;
152
153      resultsCollector.CollectedValues.Add(new LookupParameter<DoubleValue>("CurrentBestQuality", null, CurrentBestQualityParameter.Name));
154      resultsCollector.CollectedValues.Add(new LookupParameter<DoubleValue>("CurrentAverageQuality", null, CurrentAverageQualityParameter.Name));
155      resultsCollector.CollectedValues.Add(new LookupParameter<DoubleValue>("CurrentWorstQuality", null, CurrentWorstQualityParameter.Name));
156      resultsCollector.CollectedValues.Add(new LookupParameter<DoubleValue>("BestQuality", null, BestQualityParameter.Name));
157      resultsCollector.CollectedValues.Add(new LookupParameter<DoubleValue>("BestKnownQuality", null, BestKnownQualityParameter.Name));
158      resultsCollector.CollectedValues.Add(new LookupParameter<DoubleValue>("AbsoluteDifferenceBestKnownToBest", null, AbsoluteDifferenceBestKnownToBestParameter.Name));
159      resultsCollector.CollectedValues.Add(new LookupParameter<PercentValue>("RelativeDifferenceBestKnownToBest", null, RelativeDifferenceBestKnownToBestParameter.Name));
160      resultsCollector.CollectedValues.Add(new LookupParameter<DataTable>(QualitiesParameter.Name));
161      resultsCollector.ResultsParameter.ActualName = ResultsParameter.Name;
162      #endregion
163
164      #region Create operator graph
165      OperatorGraph.InitialOperator = bestQualityMemorizer;
166      bestQualityMemorizer.Successor = bestAverageWorstQualityCalculator;
167      bestAverageWorstQualityCalculator.Successor = dataTableValuesCollector;
168      dataTableValuesCollector.Successor = qualityDifferenceCalculator;
169      qualityDifferenceCalculator.Successor = resultsCollector;
170      resultsCollector.Successor = null;
171      #endregion
172
173      Initialize();
174    }
175
176    [StorableHook(HookType.AfterDeserialization)]
177    private void AfterDeserialization() {
178      Initialize();
179      // BackwardsCompatibility3.3
180      #region Backwards compatible code, remove with 3.4
181      if (Parameters["Results"] is ValueLookupParameter<VariableCollection>) {
182        Parameters.Remove("Results");
183        Parameters.Add(new ValueLookupParameter<ResultCollection>("Results", "The results collection where the analysis values should be stored."));
184      }
185      #endregion
186    }
187
188    private void Initialize() {
189      QualityParameter.DepthChanged += new EventHandler(QualityParameter_DepthChanged);
190    }
191
192    private void QualityParameter_DepthChanged(object sender, System.EventArgs e) {
193      BestQualityMemorizer.QualityParameter.Depth = QualityParameter.Depth;
194      BestAverageWorstQualityCalculator.QualityParameter.Depth = QualityParameter.Depth;
195    }
196  }
197}
Note: See TracBrowser for help on using the repository browser.