source: branches/3139_ParameterChange_SymbolicExpressionTreeLengthAnalyzer/HeuristicLab.Encodings.SymbolicExpressionTreeEncoding/3.4/Analyzers/SymbolicExpressionTreeLengthAnalyzer.cs @ 18080

Last change on this file since 18080 was 18080, checked in by dpiringe, 8 months ago

#3139

  • changed the type of MaximumSymbolicExpressionTreeLengthParameter from ILookupParameter to IValueLookupParameter
  • added logic in AfterDeserialization to handle serialized data with old parameter type
File size: 13.6 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 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 System.Linq;
24using HeuristicLab.Analysis;
25using HeuristicLab.Common;
26using HeuristicLab.Core;
27using HeuristicLab.Data;
28using HeuristicLab.Operators;
29using HeuristicLab.Optimization;
30using HeuristicLab.Parameters;
31using HEAL.Attic;
32
33namespace HeuristicLab.Encodings.SymbolicExpressionTreeEncoding {
34  /// <summary>
35  /// An operator that tracks tree lengths of Symbolic Expression Trees
36  /// </summary>
37  [Item("SymbolicExpressionTreeLengthAnalyzer", "An operator that tracks tree lengths of Symbolic Expression Trees")]
38  [StorableType("8A9F09AC-40E4-4AA2-9270-9204C9460E66")]
39  public sealed class SymbolicExpressionTreeLengthAnalyzer : SingleSuccessorOperator, ISymbolicExpressionTreeAnalyzer {
40    private const string SymbolicExpressionTreeParameterName = "SymbolicExpressionTree";
41    private const string MaximumSymbolicExpressionTreeLengthParameterName = "MaximumSymbolicExpressionTreeLength";
42    private const string SymbolicExpressionTreeLengthsParameterName = "SymbolicExpressionTreeLengthsTable";
43    private const string SymbolicExpressionTreeLengthsHistoryParameterName = "SymbolicExpressionTreeLengthsHistoryTable";
44    private const string ResultsParameterName = "Results";
45    private const string StoreHistoryParameterName = "StoreHistory";
46    private const string UpdateIntervalParameterName = "UpdateInterval";
47    private const string UpdateCounterParameterName = "UpdateCounter";
48
49    #region Parameter properties
50    public IScopeTreeLookupParameter<ISymbolicExpressionTree> SymbolicExpressionTreeParameter {
51      get { return (IScopeTreeLookupParameter<ISymbolicExpressionTree>)Parameters[SymbolicExpressionTreeParameterName]; }
52    }
53
54    public IValueLookupParameter<IntValue> MaximumSymbolicExpressionTreeLengthParameter {
55      get { return (IValueLookupParameter<IntValue>)Parameters[MaximumSymbolicExpressionTreeLengthParameterName]; }
56    }
57    public ValueLookupParameter<DataTable> SymbolicExpressionTreeLengthsParameter {
58      get { return (ValueLookupParameter<DataTable>)Parameters[SymbolicExpressionTreeLengthsParameterName]; }
59    }
60    public ValueLookupParameter<DataTableHistory> SymbolicExpressionTreeLengthsHistoryParameter {
61      get { return (ValueLookupParameter<DataTableHistory>)Parameters[SymbolicExpressionTreeLengthsHistoryParameterName]; }
62    }
63    public ValueLookupParameter<ResultCollection> ResultsParameter {
64      get { return (ValueLookupParameter<ResultCollection>)Parameters[ResultsParameterName]; }
65    }
66    // history
67    public ValueParameter<BoolValue> StoreHistoryParameter {
68      get { return (ValueParameter<BoolValue>)Parameters[StoreHistoryParameterName]; }
69    }
70    public ValueParameter<IntValue> UpdateIntervalParameter {
71      get { return (ValueParameter<IntValue>)Parameters[UpdateIntervalParameterName]; }
72    }
73    public ValueParameter<IntValue> UpdateCounterParameter {
74      get { return (ValueParameter<IntValue>)Parameters[UpdateCounterParameterName]; }
75    }
76    #endregion
77
78    #region Properties
79    public bool EnabledByDefault {
80      get { return true; }
81    }
82    public IntValue UpdateInterval {
83      get { return UpdateIntervalParameter.Value; }
84    }
85    public IntValue UpdateCounter {
86      get { return UpdateCounterParameter.Value; }
87    }
88    public BoolValue StoreHistory {
89      get { return StoreHistoryParameter.Value; }
90    }
91    #endregion
92
93    [StorableConstructor]
94    private SymbolicExpressionTreeLengthAnalyzer(StorableConstructorFlag _) : base(_) { }
95    private SymbolicExpressionTreeLengthAnalyzer(SymbolicExpressionTreeLengthAnalyzer original, Cloner cloner)
96      : base(original, cloner) {
97    }
98    public override IDeepCloneable Clone(Cloner cloner) {
99      return new SymbolicExpressionTreeLengthAnalyzer(this, cloner);
100    }
101    public SymbolicExpressionTreeLengthAnalyzer()
102      : base() {
103      Parameters.Add(new ScopeTreeLookupParameter<ISymbolicExpressionTree>(SymbolicExpressionTreeParameterName, "The symbolic expression tree whose length should be calculated."));
104      Parameters.Add(new ValueLookupParameter<IntValue>(MaximumSymbolicExpressionTreeLengthParameterName, "The maximum allowed symbolic expression tree length"));
105      Parameters.Add(new ValueLookupParameter<DataTable>(SymbolicExpressionTreeLengthsParameterName, "The data table to store the symbolic expression tree lengths."));
106      Parameters.Add(new ValueLookupParameter<DataTableHistory>(SymbolicExpressionTreeLengthsHistoryParameterName, "The data table to store the symbolic expression tree lengths history."));
107      Parameters.Add(new ValueLookupParameter<ResultCollection>(ResultsParameterName, "The results collection where the analysis values should be stored."));
108      Parameters.Add(new ValueParameter<BoolValue>(StoreHistoryParameterName, "True if the tree lengths history of the population should be stored.", new BoolValue(false)));
109      Parameters.Add(new ValueParameter<IntValue>(UpdateIntervalParameterName, "The interval in which the tree length analysis should be applied.", new IntValue(1)));
110      Parameters.Add(new ValueParameter<IntValue>(UpdateCounterParameterName, "The value which counts how many times the operator was called since the last update", new IntValue(0)));
111
112      SymbolicExpressionTreeLengthsParameter.Hidden = true;
113      SymbolicExpressionTreeLengthsHistoryParameter.Hidden = true;
114      ResultsParameter.Hidden = true;
115      UpdateCounterParameter.Hidden = true;
116    }
117
118    [StorableHook(HookType.AfterDeserialization)]
119    private void AfterDeserialization() {
120      // reset MaximumSymbolicExpressionTreeLengthParameterName to ValueLookupParameter
121      if (Parameters.TryGetValue(MaximumSymbolicExpressionTreeLengthParameterName, out IParameter parameter) && !(parameter is ValueLookupParameter<IntValue>)) {
122        Parameters.Remove(MaximumSymbolicExpressionTreeLengthParameterName);
123        Parameters.Add(new ValueLookupParameter<IntValue>(MaximumSymbolicExpressionTreeLengthParameterName, "The maximum allowed symbolic expression tree length"));
124      }
125      // check if all the parameters are present and accounted for
126      if (!Parameters.ContainsKey(StoreHistoryParameterName)) {
127        Parameters.Add(new ValueParameter<BoolValue>(StoreHistoryParameterName, "True if the tree lengths history of the population should be stored.", new BoolValue(false)));
128      }
129      if (!Parameters.ContainsKey(UpdateIntervalParameterName)) {
130        Parameters.Add(new ValueParameter<IntValue>(UpdateIntervalParameterName, "The interval in which the tree length analysis should be applied.", new IntValue(1)));
131      }
132      //necessary code to correct UpdateCounterParameter - type was changed from LookupParameter to ValueParameter
133      if (Parameters.ContainsKey(UpdateCounterParameterName) && (Parameters[UpdateCounterParameterName] is LookupParameter<IntValue>))
134        Parameters.Remove(UpdateCounterParameterName);
135      if (!Parameters.ContainsKey(UpdateCounterParameterName)) {
136        Parameters.Add(new ValueParameter<IntValue>(UpdateCounterParameterName, "The value which counts how many times the operator was called since the last update", new IntValue(0)));
137        UpdateCounterParameter.Hidden = true;
138      }
139    }
140
141    #region IStatefulItem members
142    public override void InitializeState() {
143      base.InitializeState();
144      UpdateCounter.Value = 0;
145    }
146    public override void ClearState() {
147      base.ClearState();
148      UpdateCounter.Value = 0;
149    }
150    #endregion
151
152    public override IOperation Apply() {
153      UpdateCounter.Value++;
154      // the analyzer runs periodically, every 'updateInterval' times
155      if (UpdateCounter.Value == UpdateInterval.Value) {
156        UpdateCounter.Value = 0; // reset counter
157
158        // compute all tree lengths and store them in the lengthsTable
159        var solutions = SymbolicExpressionTreeParameter.ActualValue;
160
161        var treeLengthsTable = SymbolicExpressionTreeLengthsParameter.ActualValue;
162        // if the table was not created yet, we create it here
163        if (treeLengthsTable == null) {
164          treeLengthsTable = new DataTable("Tree Length Histogram");
165          SymbolicExpressionTreeLengthsParameter.ActualValue = treeLengthsTable;
166        }
167
168        // data table which stores tree length values
169        DataRow treeLengthsTableRow;
170
171        const string treeLengthsTableRowName = "Symbolic expression tree lengths";
172        const string treeLengthsTableRowDesc = "The distribution of symbolic expression tree lengths";
173        const string xAxisTitle = "Symbolic expression tree lengths";
174        const string yAxisTitle = "Frequency / Number of tree individuals";
175
176        var treeLengths = solutions.Select(s => (int)s.Length).ToList();
177
178        int maxLength = treeLengths.Max(t => t);
179        int minLength = treeLengths.Min(t => t);
180
181        if (!treeLengthsTable.Rows.ContainsKey(treeLengthsTableRowName)) {
182          treeLengthsTableRow = new DataRow(treeLengthsTableRowName, treeLengthsTableRowDesc, treeLengths.Select(x => (double)x));
183          treeLengthsTable.Rows.Add(treeLengthsTableRow);
184        } else {
185          treeLengthsTableRow = treeLengthsTable.Rows[treeLengthsTableRowName];
186          treeLengthsTableRow.Values.Replace(treeLengths.Select(x => (double)x));
187        }
188
189        double maximumAllowedTreeLength = MaximumSymbolicExpressionTreeLengthParameter.ActualValue.Value;
190
191        treeLengthsTableRow.VisualProperties.ChartType = DataRowVisualProperties.DataRowChartType.Histogram;
192        treeLengthsTable.VisualProperties.HistogramExactBins = false;
193
194        int range = maxLength - minLength;
195        if (range == 0) range = 1;
196        // the following trick should result in an integer intervalWidth of 1,2,4,...
197        treeLengthsTable.VisualProperties.HistogramBins = range;
198
199        if (maxLength <= 25) // [0,25]
200          treeLengthsTableRow.VisualProperties.ScaleFactor = 1.0;
201        else if (maxLength <= 100) // [26,100]
202          treeLengthsTableRow.VisualProperties.ScaleFactor = 1.0 / 2.0;
203        else if (maxLength <= 250) // [101,250]
204          treeLengthsTableRow.VisualProperties.ScaleFactor = 1.0 / 5.0;
205        else if (maxLength <= 500) // [251,500]
206          treeLengthsTableRow.VisualProperties.ScaleFactor = 1.0 / 10.0;
207        else
208          treeLengthsTableRow.VisualProperties.ScaleFactor = 1.0 / 20.0; // [501,inf]
209
210        treeLengthsTableRow.VisualProperties.IsVisibleInLegend = false;
211
212        // visual properties for the X-axis
213        treeLengthsTable.VisualProperties.XAxisMinimumAuto = false;
214        treeLengthsTable.VisualProperties.XAxisMaximumAuto = false;
215        treeLengthsTable.VisualProperties.XAxisMinimumFixedValue = 0.0;
216        if (maxLength > maximumAllowedTreeLength + 1)
217          treeLengthsTable.VisualProperties.XAxisMaximumFixedValue = maxLength + 1; // +1 so the histogram column for the maximum length won't get trimmed
218        else
219          treeLengthsTable.VisualProperties.XAxisMaximumFixedValue = maximumAllowedTreeLength + 1;
220        treeLengthsTable.VisualProperties.XAxisTitle = xAxisTitle;
221        //visual properties for the Y-axis
222        treeLengthsTable.VisualProperties.YAxisMinimumAuto = false;
223        treeLengthsTable.VisualProperties.YAxisMaximumAuto = false;
224        treeLengthsTable.VisualProperties.YAxisMinimumFixedValue = 0.0;
225        int maxFreq = (int)Math.Round(solutions.GroupBy(s => s.Length).Max(g => g.Count()) / treeLengthsTableRow.VisualProperties.ScaleFactor);
226        if (maxFreq % 5 != 0)
227          maxFreq += (5 - maxFreq % 5);
228        double yAxisMaximumFixedValue = maxFreq;
229
230        treeLengthsTable.VisualProperties.YAxisMaximumFixedValue = yAxisMaximumFixedValue;
231        treeLengthsTable.VisualProperties.YAxisTitle = yAxisTitle;
232
233        var results = ResultsParameter.ActualValue;
234
235        if (!results.ContainsKey(treeLengthsTableRowName)) {
236          results.Add(new Result(treeLengthsTableRowName, treeLengthsTable));
237        } else {
238          results[treeLengthsTableRowName].Value = treeLengthsTable;
239        }
240
241        bool storeHistory = StoreHistoryParameter.Value.Value;
242        const string treeLengthHistoryTableName = "Tree lengths history";
243
244        if (storeHistory) {
245          var treeLengthsHistory = SymbolicExpressionTreeLengthsHistoryParameter.ActualValue;
246          if (treeLengthsHistory == null) {
247            treeLengthsHistory = new DataTableHistory();
248            SymbolicExpressionTreeLengthsHistoryParameter.ActualValue = treeLengthsHistory;
249          }
250          treeLengthsHistory.Add((DataTable)treeLengthsTable.Clone());
251
252          if (!results.ContainsKey(treeLengthHistoryTableName)) {
253            results.Add(new Result(treeLengthHistoryTableName, treeLengthsHistory));
254          } else {
255            results[treeLengthHistoryTableName].Value = treeLengthsHistory;
256          }
257        }
258      }
259      return base.Apply();
260    }
261  }
262}
Note: See TracBrowser for help on using the repository browser.