Free cookie consent management tool by TermsFeed Policy Generator

source: branches/2931_OR-Tools_LP_MIP/HeuristicLab.Problems.DataAnalysis.Symbolic/3.4/Formatters/SymbolicDataAnalysisExpressionExcelFormatter.cs @ 16803

Last change on this file since 16803 was 16803, checked in by ddorfmei, 5 years ago

#2931: Merged revision(s) 16720-16802 from trunk
File size: 14.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 System.Collections.Generic;
24using System.Globalization;
25using System.Linq;
26using System.Text;
27using HEAL.Attic;
28using HeuristicLab.Common;
29using HeuristicLab.Core;
30using HeuristicLab.Encodings.SymbolicExpressionTreeEncoding;
31
32namespace HeuristicLab.Problems.DataAnalysis.Symbolic {
33  [Item("Excel String Formatter", "String formatter for string representations of symbolic data analysis expressions in Excel syntax.")]
34  [StorableType("46C46897-9C92-4CF1-81C9-700732700DD3")]
35  public sealed class SymbolicDataAnalysisExpressionExcelFormatter : NamedItem, ISymbolicExpressionTreeStringFormatter {
36    [StorableConstructor]
37    private SymbolicDataAnalysisExpressionExcelFormatter(StorableConstructorFlag _) : base(_) { }
38    private SymbolicDataAnalysisExpressionExcelFormatter(SymbolicDataAnalysisExpressionExcelFormatter original, Cloner cloner) : base(original, cloner) { }
39    public SymbolicDataAnalysisExpressionExcelFormatter()
40      : base() {
41      Name = ItemName;
42      Description = ItemDescription;
43    }
44    public override IDeepCloneable Clone(Cloner cloner) {
45      return new SymbolicDataAnalysisExpressionExcelFormatter(this, cloner);
46    }
47    private string GetExcelColumnName(int columnNumber) {
48      int dividend = columnNumber;
49      string columnName = String.Empty;
50
51      while (dividend > 0) {
52        int modulo = (dividend - 1) % 26;
53        columnName = System.Convert.ToChar(65 + modulo) + columnName;
54        dividend = (int)((dividend - modulo) / 26);
55      }
56
57      return columnName;
58    }
59
60    private readonly Dictionary<string, string> variableNameMapping = new Dictionary<string, string>();
61    private int currentVariableIndex = 0;
62    private string GetColumnToVariableName(string varName) {
63      if (!variableNameMapping.ContainsKey(varName)) {
64        currentVariableIndex++;
65        variableNameMapping.Add(varName, GetExcelColumnName(currentVariableIndex));
66      }
67      return string.Format("${0}1", variableNameMapping[varName]);
68    }
69    public string Format(ISymbolicExpressionTree symbolicExpressionTree) {
70      return Format(symbolicExpressionTree, null);
71    }
72
73
74    public string Format(ISymbolicExpressionTree symbolicExpressionTree, IDataset dataset) {
75      if (dataset != null)
76        return FormatWithMapping(symbolicExpressionTree, CalculateVariableMapping(symbolicExpressionTree, dataset));
77      else return FormatWithMapping(symbolicExpressionTree, new Dictionary<string, string>());
78    }
79
80    public string FormatWithMapping(ISymbolicExpressionTree symbolicExpressionTree, Dictionary<string, string> variableNameMapping) {
81      foreach (var kvp in variableNameMapping) this.variableNameMapping.Add(kvp.Key, kvp.Value);
82      var stringBuilder = new StringBuilder();
83
84      stringBuilder.Append("=");
85      stringBuilder.Append(FormatRecursively(symbolicExpressionTree.Root));
86
87      foreach (var variable in this.variableNameMapping) {
88        stringBuilder.AppendLine();
89        stringBuilder.Append(variable.Key + " = " + variable.Value);
90      }
91      return stringBuilder.ToString();
92    }
93
94    private Dictionary<string, string> CalculateVariableMapping(ISymbolicExpressionTree tree, IDataset dataset) {
95      var mapping = new Dictionary<string, string>();
96      int inputIndex = 0;
97      var usedVariables = tree.IterateNodesPrefix().OfType<IVariableTreeNode>().Select(v => v.VariableName).Distinct().ToArray();
98      foreach (var variable in dataset.VariableNames) {
99        if (!usedVariables.Contains(variable)) continue;
100        inputIndex++;
101        mapping[variable] = GetExcelColumnName(inputIndex);
102      }
103      return mapping;
104    }
105
106    private string FormatRecursively(ISymbolicExpressionTreeNode node) {
107      ISymbol symbol = node.Symbol;
108      StringBuilder stringBuilder = new StringBuilder();
109
110      if (symbol is ProgramRootSymbol) {
111        stringBuilder.AppendLine(FormatRecursively(node.GetSubtree(0)));
112      } else if (symbol is StartSymbol)
113        return FormatRecursively(node.GetSubtree(0));
114      else if (symbol is Addition) {
115        stringBuilder.Append("(");
116        for (int i = 0; i < node.SubtreeCount; i++) {
117          if (i > 0) stringBuilder.Append("+");
118          stringBuilder.Append(FormatRecursively(node.GetSubtree(i)));
119        }
120        stringBuilder.Append(")");
121      } else if (symbol is Absolute) {
122        stringBuilder.Append($"ABS({FormatRecursively(node.GetSubtree(0))})");
123      } else if (symbol is AnalyticQuotient) {
124        stringBuilder.Append($"({FormatRecursively(node.GetSubtree(0))}) / SQRT(1 + POWER({FormatRecursively(node.GetSubtree(1))}, 2))");
125      } else if (symbol is Average) {
126        stringBuilder.Append("(1/(");
127        stringBuilder.Append(node.SubtreeCount);
128        stringBuilder.Append(")*(");
129        for (int i = 0; i < node.SubtreeCount; i++) {
130          if (i > 0) stringBuilder.Append("+");
131          stringBuilder.Append("(");
132          stringBuilder.Append(FormatRecursively(node.GetSubtree(i)));
133          stringBuilder.Append(")");
134        }
135        stringBuilder.Append(")");
136      } else if (symbol is Constant) {
137        ConstantTreeNode constantTreeNode = node as ConstantTreeNode;
138        stringBuilder.Append(constantTreeNode.Value.ToString(CultureInfo.InvariantCulture));
139      } else if (symbol is Cosine) {
140        stringBuilder.Append("COS(");
141        stringBuilder.Append(FormatRecursively(node.GetSubtree(0)));
142        stringBuilder.Append(")");
143      } else if (symbol is Cube) {
144        stringBuilder.Append($"POWER({FormatRecursively(node.GetSubtree(0))}, 3)");
145      } else if (symbol is CubeRoot) {
146        stringBuilder.Append($"POWER({FormatRecursively(node.GetSubtree(0))}, 1/3)");
147      } else if (symbol is Division) {
148        if (node.SubtreeCount == 1) {
149          stringBuilder.Append("1/(");
150          stringBuilder.Append(FormatRecursively(node.GetSubtree(0)));
151          stringBuilder.Append(")");
152        } else {
153          stringBuilder.Append(FormatRecursively(node.GetSubtree(0)));
154          stringBuilder.Append("/(");
155          for (int i = 1; i < node.SubtreeCount; i++) {
156            if (i > 1) stringBuilder.Append("*");
157            stringBuilder.Append(FormatRecursively(node.GetSubtree(i)));
158          }
159          stringBuilder.Append(")");
160        }
161      } else if (symbol is Exponential) {
162        stringBuilder.Append("EXP(");
163        stringBuilder.Append(FormatRecursively(node.GetSubtree(0)));
164        stringBuilder.Append(")");
165      } else if (symbol is Square) {
166        stringBuilder.Append("POWER(");
167        stringBuilder.Append(FormatRecursively(node.GetSubtree(0)));
168        stringBuilder.Append(",2)");
169      } else if (symbol is SquareRoot) {
170        stringBuilder.Append("SQRT(");
171        stringBuilder.Append(FormatRecursively(node.GetSubtree(0)));
172        stringBuilder.Append(")");
173      } else if (symbol is Logarithm) {
174        stringBuilder.Append("LN(");
175        stringBuilder.Append(FormatRecursively(node.GetSubtree(0)));
176        stringBuilder.Append(")");
177      } else if (symbol is Multiplication) {
178        for (int i = 0; i < node.SubtreeCount; i++) {
179          if (i > 0) stringBuilder.Append("*");
180          stringBuilder.Append(FormatRecursively(node.GetSubtree(i)));
181        }
182      } else if (symbol is Sine) {
183        stringBuilder.Append("SIN(");
184        stringBuilder.Append(FormatRecursively(node.GetSubtree(0)));
185        stringBuilder.Append(")");
186      } else if (symbol is Subtraction) {
187        stringBuilder.Append("(");
188        if (node.SubtreeCount == 1) {
189          stringBuilder.Append("-");
190          stringBuilder.Append(FormatRecursively(node.GetSubtree(0)));
191        } else {
192          stringBuilder.Append(FormatRecursively(node.GetSubtree(0)));
193          for (int i = 1; i < node.SubtreeCount; i++) {
194            stringBuilder.Append("-");
195            stringBuilder.Append(FormatRecursively(node.GetSubtree(i)));
196          }
197        }
198        stringBuilder.Append(")");
199      } else if (symbol is Tangent) {
200        stringBuilder.Append("TAN(");
201        stringBuilder.Append(FormatRecursively(node.GetSubtree(0)));
202        stringBuilder.Append(")");
203      } else if (symbol is HyperbolicTangent) {
204        stringBuilder.Append("TANH(");
205        stringBuilder.Append(FormatRecursively(node.GetSubtree(0)));
206        stringBuilder.Append(")");
207      } else if (symbol is Variable) {
208        VariableTreeNode variableTreeNode = node as VariableTreeNode;
209        stringBuilder.Append(variableTreeNode.Weight.ToString(CultureInfo.InvariantCulture));
210        stringBuilder.Append("*");
211        stringBuilder.Append(GetColumnToVariableName(variableTreeNode.VariableName));
212      } else if (symbol is BinaryFactorVariable) {
213        var binFactorNode = node as BinaryFactorVariableTreeNode;
214        stringBuilder.AppendFormat("IF({0}=\"{1}\", {2}, 0)",
215          GetColumnToVariableName(binFactorNode.VariableName),
216          binFactorNode.VariableValue,
217          binFactorNode.Weight.ToString(CultureInfo.InvariantCulture)
218          );
219      } else if (symbol is FactorVariable) {
220        var factorNode = node as FactorVariableTreeNode;
221        var values = factorNode.Symbol.GetVariableValues(factorNode.VariableName).ToArray();
222        var w = factorNode.Weights;
223        // create nested if
224        for (int i = 0; i < values.Length; i++) {
225          stringBuilder.AppendFormat("IF({0}=\"{1}\", {2}, ",
226            GetColumnToVariableName(factorNode.VariableName),
227            values[i],
228            w[i].ToString(CultureInfo.InvariantCulture));
229        }
230        stringBuilder.Append("\"\""); // return empty string on unknown value
231        stringBuilder.Append(')', values.Length); // add closing parenthesis
232      } else if (symbol is Power) {
233        stringBuilder.Append("POWER(");
234        stringBuilder.Append(FormatRecursively(node.GetSubtree(0)));
235        stringBuilder.Append(",ROUND(");
236        stringBuilder.Append(FormatRecursively(node.GetSubtree(1)));
237        stringBuilder.Append(",0))");
238      } else if (symbol is Root) {
239        stringBuilder.Append("(");
240        stringBuilder.Append(FormatRecursively(node.GetSubtree(0)));
241        stringBuilder.Append(")^(1 / ROUND(");
242        stringBuilder.Append(FormatRecursively(node.GetSubtree(1)));
243        stringBuilder.Append(",0))");
244      } else if (symbol is IfThenElse) {
245        stringBuilder.Append("IF(");
246        stringBuilder.Append("(" + FormatRecursively(node.GetSubtree(0)) + " ) > 0");
247        stringBuilder.Append(",");
248        stringBuilder.Append(FormatRecursively(node.GetSubtree(1)));
249        stringBuilder.Append(",");
250        stringBuilder.Append(FormatRecursively(node.GetSubtree(2)));
251        stringBuilder.Append(")");
252      } else if (symbol is VariableCondition) {
253        VariableConditionTreeNode variableConditionTreeNode = node as VariableConditionTreeNode;
254        if (!variableConditionTreeNode.Symbol.IgnoreSlope) {
255          double threshold = variableConditionTreeNode.Threshold;
256          double slope = variableConditionTreeNode.Slope;
257          string p = "(1 / (1 + EXP(-" + slope.ToString(CultureInfo.InvariantCulture) + " * (" +
258                     GetColumnToVariableName(variableConditionTreeNode.VariableName) + "-" +
259                     threshold.ToString(CultureInfo.InvariantCulture) + "))))";
260          stringBuilder.Append("((");
261          stringBuilder.Append(FormatRecursively(node.GetSubtree(0)));
262          stringBuilder.Append("*");
263          stringBuilder.Append(p);
264          stringBuilder.Append(") + (");
265          stringBuilder.Append(FormatRecursively(node.GetSubtree(1)));
266          stringBuilder.Append("*(");
267          stringBuilder.Append("1 - " + p + ")");
268          stringBuilder.Append("))");
269        } else {
270          stringBuilder.AppendFormat(CultureInfo.InvariantCulture, "(IF({0} <= {1}, {2}, {3}))",
271            GetColumnToVariableName(variableConditionTreeNode.VariableName),
272            variableConditionTreeNode.Threshold,
273            FormatRecursively(node.GetSubtree(0)),
274            FormatRecursively(node.GetSubtree(1))
275            );
276        }
277      } else if (symbol is Xor) {
278        stringBuilder.Append("IF(");
279        stringBuilder.Append("XOR(");
280        stringBuilder.Append("(" + FormatRecursively(node.GetSubtree(0)) + ") > 0,");
281        stringBuilder.Append("(" + FormatRecursively(node.GetSubtree(1)) + ") > 0");
282        stringBuilder.Append("), 1.0, -1.0)");
283      } else if (symbol is Or) {
284        stringBuilder.Append("IF(");
285        stringBuilder.Append("OR(");
286        stringBuilder.Append("(" + FormatRecursively(node.GetSubtree(0)) + ") > 0,");
287        stringBuilder.Append("(" + FormatRecursively(node.GetSubtree(1)) + ") > 0");
288        stringBuilder.Append("), 1.0, -1.0)");
289      } else if (symbol is And) {
290        stringBuilder.Append("IF(");
291        stringBuilder.Append("AND(");
292        stringBuilder.Append("(" + FormatRecursively(node.GetSubtree(0)) + ") > 0,");
293        stringBuilder.Append("(" + FormatRecursively(node.GetSubtree(1)) + ") > 0");
294        stringBuilder.Append("), 1.0, -1.0)");
295      } else if (symbol is Not) {
296        stringBuilder.Append("IF(");
297        stringBuilder.Append(FormatRecursively(node.GetSubtree(0)));
298        stringBuilder.Append(" > 0, -1.0, 1.0)");
299      } else if (symbol is GreaterThan) {
300        stringBuilder.Append("IF((");
301        stringBuilder.Append(FormatRecursively(node.GetSubtree(0)));
302        stringBuilder.Append(") > (");
303        stringBuilder.Append(FormatRecursively(node.GetSubtree(1)));
304        stringBuilder.Append("), 1.0, -1.0)");
305      } else if (symbol is LessThan) {
306        stringBuilder.Append("IF((");
307        stringBuilder.Append(FormatRecursively(node.GetSubtree(0)));
308        stringBuilder.Append(") < (");
309        stringBuilder.Append(FormatRecursively(node.GetSubtree(1)));
310        stringBuilder.Append("), 1.0, -1.0)");
311      } else {
312        throw new NotImplementedException("Excel export of " + node.Symbol + " is not implemented.");
313      }
314      return stringBuilder.ToString();
315    }
316  }
317}
Note: See TracBrowser for help on using the repository browser.