source: branches/2520_PersistenceReintegration/HeuristicLab.Analysis/3.3/ValueAnalysis/MinAverageMaxValueAnalyzer.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: 12.8 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 minimum, average and maximum of a value in the scope tree.
35  /// </summary>
36  [Item("MinAverageMaxValueAnalyzer", "An operator which analyzes the minimum, average and maximum of a value in the scope tree.")]
37  [StorableClass]
38  public sealed class MinAverageMaxValueAnalyzer : AlgorithmOperator, IAnalyzer {
39    #region Parameter properties
40    public ScopeTreeLookupParameter<DoubleValue> ValueParameter {
41      get { return (ScopeTreeLookupParameter<DoubleValue>)Parameters["Value"]; }
42    }
43    public ValueLookupParameter<DoubleValue> MinValueParameter {
44      get { return (ValueLookupParameter<DoubleValue>)Parameters["MinValue"]; }
45    }
46    public ValueLookupParameter<DoubleValue> AverageValueParameter {
47      get { return (ValueLookupParameter<DoubleValue>)Parameters["AverageValue"]; }
48    }
49    public ValueLookupParameter<DoubleValue> MaxValueParameter {
50      get { return (ValueLookupParameter<DoubleValue>)Parameters["MaxValue"]; }
51    }
52    public ValueLookupParameter<DataTable> ValuesParameter {
53      get { return (ValueLookupParameter<DataTable>)Parameters["Values"]; }
54    }
55    public ValueLookupParameter<VariableCollection> ResultsParameter {
56      get { return (ValueLookupParameter<VariableCollection>)Parameters["Results"]; }
57    }
58    public ValueParameter<BoolValue> CollectMinValueInResultsParameter {
59      get { return (ValueParameter<BoolValue>)Parameters["CollectMinValueInResults"]; }
60    }
61    public ValueParameter<BoolValue> CollectMaxValueInResultsParameter {
62      get { return (ValueParameter<BoolValue>)Parameters["CollectMaxValueInResults"]; }
63    }
64    public ValueParameter<BoolValue> CollectAverageValueInResultsParameter {
65      get { return (ValueParameter<BoolValue>)Parameters["CollectAverageValueInResults"]; }
66    }
67    #endregion
68
69    #region Properties
70    public bool EnabledByDefault {
71      get { return true; }
72    }
73    private MinAverageMaxValueCalculator MinAverageMaxValueCalculator {
74      get { return (MinAverageMaxValueCalculator)OperatorGraph.InitialOperator; }
75    }
76    private BoolValue CollectMinValueInResults {
77      get { return CollectMinValueInResultsParameter.Value; }
78    }
79    private BoolValue CollectMaxValueInResults {
80      get { return CollectMaxValueInResultsParameter.Value; }
81    }
82    private BoolValue CollectAverageValueInResults {
83      get { return CollectAverageValueInResultsParameter.Value; }
84    }
85    #endregion
86
87    [Storable]
88    private ResultsCollector resultsCollector;
89
90    #region Storing & Cloning
91    [StorableConstructor]
92    private MinAverageMaxValueAnalyzer(bool deserializing) : base(deserializing) { }
93    private MinAverageMaxValueAnalyzer(MinAverageMaxValueAnalyzer original, Cloner cloner)
94      : base(original, cloner) {
95      resultsCollector = cloner.Clone(original.resultsCollector);
96      RegisterEventHandlers();
97    }
98    public override IDeepCloneable Clone(Cloner cloner) {
99      return new MinAverageMaxValueAnalyzer(this, cloner);
100    }
101    #endregion
102    public MinAverageMaxValueAnalyzer()
103      : base() {
104      #region Create parameters
105      Parameters.Add(new ScopeTreeLookupParameter<DoubleValue>("Value", "The value contained in the scope tree which should be analyzed."));
106      Parameters.Add(new ValueLookupParameter<DoubleValue>("MinValue", "The minimum of the value."));
107      Parameters.Add(new ValueParameter<BoolValue>("CollectMinValueInResults", "Determines if the minimum of the value should also be stored in the results.", new BoolValue(true)));
108      Parameters.Add(new ValueLookupParameter<DoubleValue>("AverageValue", "The average of the value."));
109      Parameters.Add(new ValueParameter<BoolValue>("CollectAverageValueInResults", "Determines if the average of the value should also be stored in the results.", new BoolValue(true)));
110      Parameters.Add(new ValueLookupParameter<DoubleValue>("MaxValue", "The maximum of the value."));
111      Parameters.Add(new ValueParameter<BoolValue>("CollectMaxValueInResults", "Determines if the maximum of the value should also be stored in the results.", new BoolValue(true)));
112      Parameters.Add(new ValueLookupParameter<DataTable>("Values", "The data table to store the minimum, average and maximum of the value."));
113      Parameters.Add(new ValueLookupParameter<VariableCollection>("Results", "The results collection where the analysis values should be stored."));
114      #endregion
115
116      #region Create operators
117      MinAverageMaxValueCalculator minAverageMaxValueCalculator = new MinAverageMaxValueCalculator();
118      DataTableValuesCollector dataTableValuesCollector = new DataTableValuesCollector();
119      resultsCollector = new ResultsCollector();
120
121      minAverageMaxValueCalculator.AverageValueParameter.ActualName = AverageValueParameter.Name;
122      minAverageMaxValueCalculator.MaxValueParameter.ActualName = MaxValueParameter.Name;
123      minAverageMaxValueCalculator.MinValueParameter.ActualName = MinValueParameter.Name;
124      minAverageMaxValueCalculator.ValueParameter.ActualName = ValueParameter.Name;
125      minAverageMaxValueCalculator.ValueParameter.Depth = ValueParameter.Depth;
126
127      dataTableValuesCollector.CollectedValues.Add(new LookupParameter<DoubleValue>("MinValue", null, MinValueParameter.Name));
128      dataTableValuesCollector.CollectedValues.Add(new LookupParameter<DoubleValue>("AverageValue", null, AverageValueParameter.Name));
129      dataTableValuesCollector.CollectedValues.Add(new LookupParameter<DoubleValue>("MaxValue", null, MaxValueParameter.Name));
130      dataTableValuesCollector.DataTableParameter.ActualName = ValuesParameter.Name;
131
132      if (CollectMinValueInResults.Value)
133        resultsCollector.CollectedValues.Add(new LookupParameter<DoubleValue>("MinValue", null, MinValueParameter.Name));
134      if (CollectAverageValueInResults.Value)
135        resultsCollector.CollectedValues.Add(new LookupParameter<DoubleValue>("AverageValue", null, AverageValueParameter.Name));
136      if (CollectMaxValueInResults.Value)
137        resultsCollector.CollectedValues.Add(new LookupParameter<DoubleValue>("MaxValue", null, MaxValueParameter.Name));
138      resultsCollector.CollectedValues.Add(new LookupParameter<DataTable>(ValuesParameter.Name));
139      resultsCollector.ResultsParameter.ActualName = ResultsParameter.Name;
140      #endregion
141
142      #region Create operator graph
143      OperatorGraph.InitialOperator = minAverageMaxValueCalculator;
144      minAverageMaxValueCalculator.Successor = dataTableValuesCollector;
145      dataTableValuesCollector.Successor = resultsCollector;
146      resultsCollector.Successor = null;
147      #endregion
148
149      RegisterEventHandlers();
150    }
151
152    [StorableHook(HookType.AfterDeserialization)]
153    private void AfterDeserialization() {
154      RegisterEventHandlers();
155    }
156
157    private void RegisterEventHandlers() {
158      ValueParameter.DepthChanged += new EventHandler(ValueParameter_DepthChanged);
159      CollectMinValueInResultsParameter.ValueChanged += new EventHandler(CollectMinValueInResultsParameter_ValueChanged);
160      CollectMinValueInResultsParameter.Value.ValueChanged += new EventHandler(CollectMinValueInResultsParameter_Value_ValueChanged);
161      CollectMaxValueInResultsParameter.ValueChanged += new EventHandler(CollectMaxValueInResultsParameter_ValueChanged);
162      CollectMaxValueInResultsParameter.Value.ValueChanged += new EventHandler(CollectMaxValueInResultsParameter_Value_ValueChanged);
163      CollectAverageValueInResultsParameter.ValueChanged += new EventHandler(CollectAverageValueInResultsParameter_ValueChanged);
164      CollectAverageValueInResultsParameter.Value.ValueChanged += new EventHandler(CollectAverageValueInResultsParameter_Value_ValueChanged);
165    }
166
167    private void CollectAverageValueInResultsParameter_ValueChanged(object sender, EventArgs e) {
168      IParameter avgValueParameter;
169      resultsCollector.CollectedValues.TryGetValue("AverageValue", out avgValueParameter);
170      if (CollectAverageValueInResults.Value && avgValueParameter == null)
171        resultsCollector.CollectedValues.Add(new LookupParameter<DoubleValue>("AverageValue", null, AverageValueParameter.Name));
172      else if (!CollectAverageValueInResults.Value && avgValueParameter != null)
173        resultsCollector.CollectedValues.Remove(avgValueParameter);
174      CollectAverageValueInResultsParameter.Value.ValueChanged += new EventHandler(CollectAverageValueInResultsParameter_Value_ValueChanged);
175    }
176
177    private void CollectAverageValueInResultsParameter_Value_ValueChanged(object sender, EventArgs e) {
178      IParameter avgValueParameter;
179      resultsCollector.CollectedValues.TryGetValue("AverageValue", out avgValueParameter);
180      if (CollectAverageValueInResults.Value && avgValueParameter == null)
181        resultsCollector.CollectedValues.Add(new LookupParameter<DoubleValue>("AverageValue", null, AverageValueParameter.Name));
182      else if (!CollectAverageValueInResults.Value && avgValueParameter != null)
183        resultsCollector.CollectedValues.Remove(avgValueParameter);
184    }
185
186    private void CollectMaxValueInResultsParameter_ValueChanged(object sender, EventArgs e) {
187      IParameter maxValueParameter;
188      resultsCollector.CollectedValues.TryGetValue("MaxValue", out maxValueParameter);
189      if (CollectMaxValueInResults.Value && maxValueParameter == null)
190        resultsCollector.CollectedValues.Add(new LookupParameter<DoubleValue>("MaxValue", null, MaxValueParameter.Name));
191      else if (!CollectMaxValueInResults.Value && maxValueParameter != null)
192        resultsCollector.CollectedValues.Remove(maxValueParameter);
193      CollectMaxValueInResultsParameter.Value.ValueChanged += new EventHandler(CollectMaxValueInResultsParameter_Value_ValueChanged);
194    }
195
196    private void CollectMaxValueInResultsParameter_Value_ValueChanged(object sender, EventArgs e) {
197      IParameter maxValueParameter;
198      resultsCollector.CollectedValues.TryGetValue("MaxValue", out maxValueParameter);
199      if (CollectMaxValueInResults.Value && maxValueParameter == null)
200        resultsCollector.CollectedValues.Add(new LookupParameter<DoubleValue>("MaxValue", null, MaxValueParameter.Name));
201      else if (!CollectMaxValueInResults.Value && maxValueParameter != null)
202        resultsCollector.CollectedValues.Remove(maxValueParameter);
203    }
204
205    private void CollectMinValueInResultsParameter_ValueChanged(object sender, EventArgs e) {
206      IParameter minValueParameter;
207      resultsCollector.CollectedValues.TryGetValue("MinValue", out minValueParameter);
208      if (CollectMinValueInResults.Value && minValueParameter == null)
209        resultsCollector.CollectedValues.Add(new LookupParameter<DoubleValue>("MinValue", null, MinValueParameter.Name));
210      else if (!CollectMinValueInResults.Value && minValueParameter != null)
211        resultsCollector.CollectedValues.Remove(minValueParameter);
212      CollectMinValueInResultsParameter.Value.ValueChanged += new EventHandler(CollectMinValueInResultsParameter_Value_ValueChanged);
213    }
214
215    private void CollectMinValueInResultsParameter_Value_ValueChanged(object sender, EventArgs e) {
216      IParameter minValueParameter;
217      resultsCollector.CollectedValues.TryGetValue("MinValue", out minValueParameter);
218      if (CollectMinValueInResults.Value && minValueParameter == null)
219        resultsCollector.CollectedValues.Add(new LookupParameter<DoubleValue>("MinValue", null, MinValueParameter.Name));
220      else if (!CollectMinValueInResults.Value && minValueParameter != null)
221        resultsCollector.CollectedValues.Remove(minValueParameter);
222    }
223
224    private void ValueParameter_DepthChanged(object sender, System.EventArgs e) {
225      MinAverageMaxValueCalculator.ValueParameter.Depth = ValueParameter.Depth;
226    }
227  }
228}
Note: See TracBrowser for help on using the repository browser.