source: trunk/sources/HeuristicLab.Encodings.SymbolicExpressionTreeEncoding/3.4/Analyzers/SymbolicExpressionTreeLengthAnalyzer.cs @ 12012

Last change on this file since 12012 was 12012, checked in by ascheibe, 5 years ago

#2212 merged r12008, r12009, r12010 back into trunk

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