source: branches/CloningRefactoring/HeuristicLab.Analysis/3.3/MinAverageMaxValueAnalyzer.cs @ 4677

Last change on this file since 4677 was 4677, checked in by abeham, 10 years ago

#922

  • Refactored HeuristicLab.Analysis
File size: 10.2 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2010 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    private MinAverageMaxValueCalculator MinAverageMaxValueCalculator {
71      get { return (MinAverageMaxValueCalculator)OperatorGraph.InitialOperator; }
72    }
73    private BoolValue CollectMinValueInResults {
74      get { return CollectMinValueInResultsParameter.Value; }
75    }
76    private BoolValue CollectMaxValueInResults {
77      get { return CollectMaxValueInResultsParameter.Value; }
78    }
79    private BoolValue CollectAverageValueInResults {
80      get { return CollectAverageValueInResultsParameter.Value; }
81    }
82    #endregion
83    [Storable]
84    private ResultsCollector resultsCollector;
85
86    #region Storing & Cloning
87    [StorableConstructor]
88    private MinAverageMaxValueAnalyzer(bool deserializing) : base(deserializing) { }
89    private MinAverageMaxValueAnalyzer(MinAverageMaxValueAnalyzer original, Cloner cloner)
90      : base(original, cloner) {
91      Initialize();
92    }
93    public override IDeepCloneable Clone(Cloner cloner) {
94      return new MinAverageMaxValueAnalyzer(this, cloner);
95    }
96    #endregion
97    public MinAverageMaxValueAnalyzer()
98      : base() {
99      #region Create parameters
100      Parameters.Add(new ScopeTreeLookupParameter<DoubleValue>("Value", "The value contained in the scope tree which should be analyzed."));
101      Parameters.Add(new ValueLookupParameter<DoubleValue>("MinValue", "The minimum of the value."));
102      Parameters.Add(new ValueParameter<BoolValue>("CollectMinValueInResults", "Determines if the minimum of the value should also be stored in the results.", new BoolValue(true)));
103      Parameters.Add(new ValueLookupParameter<DoubleValue>("AverageValue", "The average of the value."));
104      Parameters.Add(new ValueParameter<BoolValue>("CollectAverageValueInResults", "Determines if the average of the value should also be stored in the results.", new BoolValue(true)));
105      Parameters.Add(new ValueLookupParameter<DoubleValue>("MaxValue", "The maximum of the value."));
106      Parameters.Add(new ValueParameter<BoolValue>("CollectMaxValueInResults", "Determines if the maximum of the value should also be stored in the results.", new BoolValue(true)));
107      Parameters.Add(new ValueLookupParameter<DataTable>("Values", "The data table to store the minimum, average and maximum of the value."));
108      Parameters.Add(new ValueLookupParameter<VariableCollection>("Results", "The results collection where the analysis values should be stored."));
109      #endregion
110
111      #region Create operators
112      MinAverageMaxValueCalculator minAverageMaxValueCalculator = new MinAverageMaxValueCalculator();
113      DataTableValuesCollector dataTableValuesCollector = new DataTableValuesCollector();
114      resultsCollector = new ResultsCollector();
115
116      minAverageMaxValueCalculator.AverageValueParameter.ActualName = AverageValueParameter.Name;
117      minAverageMaxValueCalculator.MaxValueParameter.ActualName = MaxValueParameter.Name;
118      minAverageMaxValueCalculator.MinValueParameter.ActualName = MinValueParameter.Name;
119      minAverageMaxValueCalculator.ValueParameter.ActualName = ValueParameter.Name;
120      minAverageMaxValueCalculator.ValueParameter.Depth = ValueParameter.Depth;
121
122      dataTableValuesCollector.CollectedValues.Add(new LookupParameter<DoubleValue>("MinValue", null, MinValueParameter.Name));
123      dataTableValuesCollector.CollectedValues.Add(new LookupParameter<DoubleValue>("AverageValue", null, AverageValueParameter.Name));
124      dataTableValuesCollector.CollectedValues.Add(new LookupParameter<DoubleValue>("MaxValue", null, MaxValueParameter.Name));
125      dataTableValuesCollector.DataTableParameter.ActualName = ValuesParameter.Name;
126
127      if (CollectMinValueInResults.Value)
128        resultsCollector.CollectedValues.Add(new LookupParameter<DoubleValue>("MinValue", null, MinValueParameter.Name));
129      if (CollectAverageValueInResults.Value)
130        resultsCollector.CollectedValues.Add(new LookupParameter<DoubleValue>("AverageValue", null, AverageValueParameter.Name));
131      if (CollectMaxValueInResults.Value)
132        resultsCollector.CollectedValues.Add(new LookupParameter<DoubleValue>("MaxValue", null, MaxValueParameter.Name));
133      resultsCollector.CollectedValues.Add(new LookupParameter<DataTable>(ValuesParameter.Name));
134      resultsCollector.ResultsParameter.ActualName = ResultsParameter.Name;
135      #endregion
136
137      #region Create operator graph
138      OperatorGraph.InitialOperator = minAverageMaxValueCalculator;
139      minAverageMaxValueCalculator.Successor = dataTableValuesCollector;
140      dataTableValuesCollector.Successor = resultsCollector;
141      resultsCollector.Successor = null;
142      #endregion
143
144      Initialize();
145    }
146
147    [StorableHook(HookType.AfterDeserialization)]
148    private void Initialize() {
149      ValueParameter.DepthChanged += new EventHandler(ValueParameter_DepthChanged);
150      CollectMinValueInResultsParameter.ValueChanged += new EventHandler(CollectMinValueInResultsParameter_ValueChanged);
151      CollectMinValueInResultsParameter.Value.ValueChanged += new EventHandler(CollectMinValueInResultsParameter_ValueChanged);
152      CollectMaxValueInResultsParameter.ValueChanged += new EventHandler(CollectMaxValueInResultsParameter_ValueChanged);
153      CollectMaxValueInResultsParameter.Value.ValueChanged += new EventHandler(CollectMaxValueInResultsParameter_ValueChanged);
154      CollectAverageValueInResultsParameter.ValueChanged += new EventHandler(CollectAverageValueInResultsParameter_ValueChanged);
155      CollectAverageValueInResultsParameter.Value.ValueChanged += new EventHandler(CollectAverageValueInResultsParameter_ValueChanged);
156    }
157
158    private void CollectAverageValueInResultsParameter_ValueChanged(object sender, EventArgs e) {
159      if (CollectAverageValueInResults.Value)
160        resultsCollector.CollectedValues.Add(new LookupParameter<DoubleValue>("AverageValue", null, AverageValueParameter.Name));
161      else {
162        IParameter avgValueParameter;
163        resultsCollector.CollectedValues.TryGetValue("AverageValue", out avgValueParameter);
164        resultsCollector.CollectedValues.Remove(avgValueParameter);
165      }
166    }
167
168    private void CollectMaxValueInResultsParameter_ValueChanged(object sender, EventArgs e) {
169      if (CollectMaxValueInResults.Value)
170        resultsCollector.CollectedValues.Add(new LookupParameter<DoubleValue>("MaxValue", null, MaxValueParameter.Name));
171      else {
172        IParameter maxValueParameter;
173        resultsCollector.CollectedValues.TryGetValue("MaxValue", out maxValueParameter);
174        resultsCollector.CollectedValues.Remove(maxValueParameter);
175      }
176    }
177
178    private void CollectMinValueInResultsParameter_ValueChanged(object sender, EventArgs e) {
179      if (CollectMinValueInResults.Value)
180        resultsCollector.CollectedValues.Add(new LookupParameter<DoubleValue>("MinValue", null, MinValueParameter.Name));
181      else {
182        IParameter minValueParameter;
183        resultsCollector.CollectedValues.TryGetValue("MinValue", out minValueParameter);
184        resultsCollector.CollectedValues.Remove(minValueParameter);
185      }
186    }
187
188    private void ValueParameter_DepthChanged(object sender, System.EventArgs e) {
189      MinAverageMaxValueCalculator.ValueParameter.Depth = ValueParameter.Depth;
190    }
191  }
192}
Note: See TracBrowser for help on using the repository browser.