[6978] | 1 | #region License Information
|
---|
| 2 | /* HeuristicLab
|
---|
[14186] | 3 | * Copyright (C) 2002-2016 Heuristic and Evolutionary Algorithms Laboratory (HEAL)
|
---|
[6978] | 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 |
|
---|
[7227] | 22 | using System;
|
---|
[6978] | 23 | using System.Linq;
|
---|
| 24 | using HeuristicLab.Analysis;
|
---|
| 25 | using HeuristicLab.Common;
|
---|
| 26 | using HeuristicLab.Core;
|
---|
| 27 | using HeuristicLab.Data;
|
---|
| 28 | using HeuristicLab.Operators;
|
---|
| 29 | using HeuristicLab.Optimization;
|
---|
| 30 | using HeuristicLab.Parameters;
|
---|
| 31 | using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
|
---|
| 32 |
|
---|
| 33 | namespace 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]
|
---|
[7230] | 39 | public sealed class SymbolicExpressionTreeLengthAnalyzer : SingleSuccessorOperator, ISymbolicExpressionTreeAnalyzer {
|
---|
[6978] | 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 | }
|
---|
[12706] | 53 |
|
---|
| 54 | public ILookupParameter<IntValue> MaximumSymbolicExpressionTreeLengthParameter {
|
---|
| 55 | get { return (ILookupParameter<IntValue>)Parameters[MaximumSymbolicExpressionTreeLengthParameterName]; }
|
---|
| 56 | }
|
---|
[6978] | 57 | public ValueLookupParameter<DataTable> SymbolicExpressionTreeLengthsParameter {
|
---|
[7124] | 58 | get { return (ValueLookupParameter<DataTable>)Parameters[SymbolicExpressionTreeLengthsParameterName]; }
|
---|
[6978] | 59 | }
|
---|
| 60 | public ValueLookupParameter<DataTableHistory> SymbolicExpressionTreeLengthsHistoryParameter {
|
---|
[7124] | 61 | get { return (ValueLookupParameter<DataTableHistory>)Parameters[SymbolicExpressionTreeLengthsHistoryParameterName]; }
|
---|
[6978] | 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 | }
|
---|
[7143] | 73 | public ValueParameter<IntValue> UpdateCounterParameter {
|
---|
| 74 | get { return (ValueParameter<IntValue>)Parameters[UpdateCounterParameterName]; }
|
---|
[6978] | 75 | }
|
---|
| 76 | #endregion
|
---|
[7124] | 77 |
|
---|
[7143] | 78 | #region Properties
|
---|
[7172] | 79 | public bool EnabledByDefault {
|
---|
| 80 | get { return true; }
|
---|
| 81 | }
|
---|
[7143] | 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 |
|
---|
[6978] | 93 | [StorableConstructor]
|
---|
[8561] | 94 | private SymbolicExpressionTreeLengthAnalyzer(bool deserializing) : base(deserializing) { }
|
---|
[6978] | 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 LookupParameter<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)));
|
---|
[7143] | 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)));
|
---|
[6978] | 111 |
|
---|
[7227] | 112 | SymbolicExpressionTreeLengthsParameter.Hidden = true;
|
---|
| 113 | SymbolicExpressionTreeLengthsHistoryParameter.Hidden = true;
|
---|
| 114 | ResultsParameter.Hidden = true;
|
---|
| 115 | UpdateCounterParameter.Hidden = true;
|
---|
[6978] | 116 | }
|
---|
| 117 |
|
---|
| 118 | [StorableHook(HookType.AfterDeserialization)]
|
---|
| 119 | private void AfterDeserialization() {
|
---|
| 120 | // check if all the parameters are present and accounted for
|
---|
| 121 | if (!Parameters.ContainsKey(StoreHistoryParameterName)) {
|
---|
| 122 | Parameters.Add(new ValueParameter<BoolValue>(StoreHistoryParameterName, "True if the tree lengths history of the population should be stored.", new BoolValue(false)));
|
---|
| 123 | }
|
---|
| 124 | if (!Parameters.ContainsKey(UpdateIntervalParameterName)) {
|
---|
| 125 | Parameters.Add(new ValueParameter<IntValue>(UpdateIntervalParameterName, "The interval in which the tree length analysis should be applied.", new IntValue(1)));
|
---|
| 126 | }
|
---|
[7280] | 127 | //necessary code to correct UpdateCounterParameter - type was changed from LookupParameter to ValueParameter
|
---|
| 128 | if (Parameters.ContainsKey(UpdateCounterParameterName) && (Parameters[UpdateCounterParameterName] is LookupParameter<IntValue>))
|
---|
| 129 | Parameters.Remove(UpdateCounterParameterName);
|
---|
[7227] | 130 | if (!Parameters.ContainsKey(UpdateCounterParameterName)) {
|
---|
| 131 | Parameters.Add(new ValueParameter<IntValue>(UpdateCounterParameterName, "The value which counts how many times the operator was called since the last update", new IntValue(0)));
|
---|
| 132 | UpdateCounterParameter.Hidden = true;
|
---|
| 133 | }
|
---|
| 134 | }
|
---|
[7150] | 135 |
|
---|
[7227] | 136 | #region IStatefulItem members
|
---|
[7230] | 137 | public override void InitializeState() {
|
---|
| 138 | base.InitializeState();
|
---|
[7227] | 139 | UpdateCounter.Value = 0;
|
---|
[6978] | 140 | }
|
---|
[7230] | 141 | public override void ClearState() {
|
---|
| 142 | base.ClearState();
|
---|
[7227] | 143 | UpdateCounter.Value = 0;
|
---|
| 144 | }
|
---|
| 145 | #endregion
|
---|
[6978] | 146 |
|
---|
| 147 | public override IOperation Apply() {
|
---|
[7143] | 148 | UpdateCounter.Value++;
|
---|
[6978] | 149 | // the analyzer runs periodically, every 'updateInterval' times
|
---|
[7143] | 150 | if (UpdateCounter.Value == UpdateInterval.Value) {
|
---|
| 151 | UpdateCounter.Value = 0; // reset counter
|
---|
[6978] | 152 |
|
---|
| 153 | // compute all tree lengths and store them in the lengthsTable
|
---|
| 154 | var solutions = SymbolicExpressionTreeParameter.ActualValue;
|
---|
| 155 |
|
---|
| 156 | var treeLengthsTable = SymbolicExpressionTreeLengthsParameter.ActualValue;
|
---|
| 157 | // if the table was not created yet, we create it here
|
---|
| 158 | if (treeLengthsTable == null) {
|
---|
[7702] | 159 | treeLengthsTable = new DataTable("Tree Length Histogram");
|
---|
[6978] | 160 | SymbolicExpressionTreeLengthsParameter.ActualValue = treeLengthsTable;
|
---|
| 161 | }
|
---|
| 162 |
|
---|
| 163 | // data table which stores tree length values
|
---|
[7124] | 164 | DataRow treeLengthsTableRow;
|
---|
[6978] | 165 |
|
---|
[7124] | 166 | const string treeLengthsTableRowName = "Symbolic expression tree lengths";
|
---|
| 167 | const string treeLengthsTableRowDesc = "The distribution of symbolic expression tree lengths";
|
---|
| 168 | const string xAxisTitle = "Symbolic expression tree lengths";
|
---|
| 169 | const string yAxisTitle = "Frequency / Number of tree individuals";
|
---|
| 170 |
|
---|
[7147] | 171 | var treeLengths = solutions.Select(s => (int)s.Length).ToList();
|
---|
[6978] | 172 |
|
---|
[7147] | 173 | int maxLength = treeLengths.Max(t => t);
|
---|
| 174 | int minLength = treeLengths.Min(t => t);
|
---|
| 175 |
|
---|
[7124] | 176 | if (!treeLengthsTable.Rows.ContainsKey(treeLengthsTableRowName)) {
|
---|
[7147] | 177 | treeLengthsTableRow = new DataRow(treeLengthsTableRowName, treeLengthsTableRowDesc, treeLengths.Select(x => (double)x));
|
---|
[7124] | 178 | treeLengthsTable.Rows.Add(treeLengthsTableRow);
|
---|
[6978] | 179 | } else {
|
---|
[7124] | 180 | treeLengthsTableRow = treeLengthsTable.Rows[treeLengthsTableRowName];
|
---|
[7147] | 181 | treeLengthsTableRow.Values.Replace(treeLengths.Select(x => (double)x));
|
---|
[6978] | 182 | }
|
---|
| 183 |
|
---|
[12706] | 184 | double maximumAllowedTreeLength = MaximumSymbolicExpressionTreeLengthParameter.ActualValue.Value;
|
---|
[6978] | 185 |
|
---|
[7124] | 186 | treeLengthsTableRow.VisualProperties.ChartType = DataRowVisualProperties.DataRowChartType.Histogram;
|
---|
| 187 | treeLengthsTableRow.VisualProperties.ExactBins = false;
|
---|
[6978] | 188 |
|
---|
[7147] | 189 | int range = maxLength - minLength;
|
---|
| 190 | if (range == 0) range = 1;
|
---|
[7124] | 191 | // the following trick should result in an integer intervalWidth of 1,2,4,...
|
---|
[7147] | 192 | treeLengthsTableRow.VisualProperties.Bins = range;
|
---|
[6978] | 193 |
|
---|
[7124] | 194 | if (maxLength <= 25) // [0,25]
|
---|
| 195 | treeLengthsTableRow.VisualProperties.ScaleFactor = 1.0;
|
---|
[7147] | 196 | else if (maxLength <= 100) // [26,100]
|
---|
[7124] | 197 | treeLengthsTableRow.VisualProperties.ScaleFactor = 1.0 / 2.0;
|
---|
[7147] | 198 | else if (maxLength <= 250) // [101,250]
|
---|
[7124] | 199 | treeLengthsTableRow.VisualProperties.ScaleFactor = 1.0 / 5.0;
|
---|
[6978] | 200 | else if (maxLength <= 500) // [251,500]
|
---|
[7124] | 201 | treeLengthsTableRow.VisualProperties.ScaleFactor = 1.0 / 10.0;
|
---|
[6978] | 202 | else
|
---|
[7124] | 203 | treeLengthsTableRow.VisualProperties.ScaleFactor = 1.0 / 20.0; // [501,inf]
|
---|
[6978] | 204 |
|
---|
[7124] | 205 | treeLengthsTableRow.VisualProperties.IsVisibleInLegend = false;
|
---|
| 206 |
|
---|
[6978] | 207 | // visual properties for the X-axis
|
---|
| 208 | treeLengthsTable.VisualProperties.XAxisMinimumAuto = false;
|
---|
| 209 | treeLengthsTable.VisualProperties.XAxisMaximumAuto = false;
|
---|
| 210 | treeLengthsTable.VisualProperties.XAxisMinimumFixedValue = 0.0;
|
---|
| 211 | if (maxLength > maximumAllowedTreeLength + 1)
|
---|
[7124] | 212 | treeLengthsTable.VisualProperties.XAxisMaximumFixedValue = maxLength + 1; // +1 so the histogram column for the maximum length won't get trimmed
|
---|
[6978] | 213 | else
|
---|
| 214 | treeLengthsTable.VisualProperties.XAxisMaximumFixedValue = maximumAllowedTreeLength + 1;
|
---|
[7124] | 215 | treeLengthsTable.VisualProperties.XAxisTitle = xAxisTitle;
|
---|
[7147] | 216 | //visual properties for the Y-axis
|
---|
[6978] | 217 | treeLengthsTable.VisualProperties.YAxisMinimumAuto = false;
|
---|
| 218 | treeLengthsTable.VisualProperties.YAxisMaximumAuto = false;
|
---|
| 219 | treeLengthsTable.VisualProperties.YAxisMinimumFixedValue = 0.0;
|
---|
[7223] | 220 | int maxFreq = (int)Math.Round(solutions.GroupBy(s => s.Length).Max(g => g.Count()) / treeLengthsTableRow.VisualProperties.ScaleFactor);
|
---|
[7150] | 221 | if (maxFreq % 5 != 0)
|
---|
| 222 | maxFreq += (5 - maxFreq % 5);
|
---|
| 223 | double yAxisMaximumFixedValue = maxFreq;
|
---|
[7147] | 224 |
|
---|
| 225 | treeLengthsTable.VisualProperties.YAxisMaximumFixedValue = yAxisMaximumFixedValue;
|
---|
[7124] | 226 | treeLengthsTable.VisualProperties.YAxisTitle = yAxisTitle;
|
---|
[6978] | 227 |
|
---|
| 228 | var results = ResultsParameter.ActualValue;
|
---|
| 229 |
|
---|
[7124] | 230 | if (!results.ContainsKey(treeLengthsTableRowName)) {
|
---|
| 231 | results.Add(new Result(treeLengthsTableRowName, treeLengthsTable));
|
---|
[6978] | 232 | } else {
|
---|
[7124] | 233 | results[treeLengthsTableRowName].Value = treeLengthsTable;
|
---|
[6978] | 234 | }
|
---|
| 235 |
|
---|
| 236 | bool storeHistory = StoreHistoryParameter.Value.Value;
|
---|
[7124] | 237 | const string treeLengthHistoryTableName = "Tree lengths history";
|
---|
[6978] | 238 |
|
---|
| 239 | if (storeHistory) {
|
---|
| 240 | var treeLengthsHistory = SymbolicExpressionTreeLengthsHistoryParameter.ActualValue;
|
---|
| 241 | if (treeLengthsHistory == null) {
|
---|
| 242 | treeLengthsHistory = new DataTableHistory();
|
---|
| 243 | SymbolicExpressionTreeLengthsHistoryParameter.ActualValue = treeLengthsHistory;
|
---|
| 244 | }
|
---|
[7227] | 245 | treeLengthsHistory.Add((DataTable)treeLengthsTable.Clone());
|
---|
[6978] | 246 |
|
---|
[7124] | 247 | if (!results.ContainsKey(treeLengthHistoryTableName)) {
|
---|
| 248 | results.Add(new Result(treeLengthHistoryTableName, treeLengthsHistory));
|
---|
[6978] | 249 | } else {
|
---|
[7124] | 250 | results[treeLengthHistoryTableName].Value = treeLengthsHistory;
|
---|
[6978] | 251 | }
|
---|
| 252 | }
|
---|
| 253 | }
|
---|
| 254 | return base.Apply();
|
---|
| 255 | }
|
---|
| 256 | }
|
---|
| 257 | }
|
---|