source: branches/2974_Constants_Optimization/HeuristicLab.Problems.DataAnalysis.Symbolic/3.4/Converters/TreeToAutoDiffTermConverter.cs @ 16508

Last change on this file since 16508 was 16508, checked in by mkommend, 14 months ago

#2974: Reverted changes in TreeToAutoDiffTermConverter.

File size: 13.6 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2018 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.Linq;
25using System.Runtime.Serialization;
26using AutoDiff;
27using HeuristicLab.Encodings.SymbolicExpressionTreeEncoding;
28
29namespace HeuristicLab.Problems.DataAnalysis.Symbolic {
30  public class TreeToAutoDiffTermConverter {
31    public delegate double ParametricFunction(double[] vars, double[] @params);
32
33    public delegate Tuple<double[], double> ParametricFunctionGradient(double[] vars, double[] @params);
34
35    #region helper class
36    public class DataForVariable {
37      public readonly string variableName;
38      public readonly string variableValue; // for factor vars
39      public readonly int lag;
40
41      public DataForVariable(string varName, string varValue, int lag) {
42        this.variableName = varName;
43        this.variableValue = varValue;
44        this.lag = lag;
45      }
46
47      public override bool Equals(object obj) {
48        var other = obj as DataForVariable;
49        if (other == null) return false;
50        return other.variableName.Equals(this.variableName) &&
51               other.variableValue.Equals(this.variableValue) &&
52               other.lag == this.lag;
53      }
54
55      public override int GetHashCode() {
56        return variableName.GetHashCode() ^ variableValue.GetHashCode() ^ lag;
57      }
58    }
59    #endregion
60
61    #region derivations of functions
62    // create function factory for arctangent
63    private static readonly Func<Term, UnaryFunc> arctan = UnaryFunc.Factory(
64      eval: Math.Atan,
65      diff: x => 1 / (1 + x * x));
66
67    private static readonly Func<Term, UnaryFunc> sin = UnaryFunc.Factory(
68      eval: Math.Sin,
69      diff: Math.Cos);
70
71    private static readonly Func<Term, UnaryFunc> cos = UnaryFunc.Factory(
72      eval: Math.Cos,
73      diff: x => -Math.Sin(x));
74
75    private static readonly Func<Term, UnaryFunc> tan = UnaryFunc.Factory(
76      eval: Math.Tan,
77      diff: x => 1 + Math.Tan(x) * Math.Tan(x));
78
79    private static readonly Func<Term, UnaryFunc> erf = UnaryFunc.Factory(
80      eval: alglib.errorfunction,
81      diff: x => 2.0 * Math.Exp(-(x * x)) / Math.Sqrt(Math.PI));
82
83    private static readonly Func<Term, UnaryFunc> norm = UnaryFunc.Factory(
84      eval: alglib.normaldistribution,
85      diff: x => -(Math.Exp(-(x * x)) * Math.Sqrt(Math.Exp(x * x)) * x) / Math.Sqrt(2 * Math.PI));
86
87    private static readonly Func<Term, UnaryFunc> abs = UnaryFunc.Factory(
88      eval: Math.Abs,
89      diff: x => Math.Sign(x)
90      );
91
92    #endregion
93
94    public static bool TryConvertToAutoDiff(ISymbolicExpressionTree tree, bool makeVariableWeightsVariable, bool addLinearScalingTerms,
95      out List<DataForVariable> parameters, out double[] initialConstants,
96      out ParametricFunction func,
97      out ParametricFunctionGradient func_grad) {
98
99      // use a transformator object which holds the state (variable list, parameter list, ...) for recursive transformation of the tree
100      var transformator = new TreeToAutoDiffTermConverter(makeVariableWeightsVariable, addLinearScalingTerms);
101      AutoDiff.Term term;
102      try {
103        term = transformator.ConvertToAutoDiff(tree.Root.GetSubtree(0));
104        var parameterEntries = transformator.parameters.ToArray(); // guarantee same order for keys and values
105        var compiledTerm = term.Compile(transformator.variables.ToArray(),
106          parameterEntries.Select(kvp => kvp.Value).ToArray());
107        parameters = new List<DataForVariable>(parameterEntries.Select(kvp => kvp.Key));
108        initialConstants = transformator.initialConstants.ToArray();
109        func = (vars, @params) => compiledTerm.Evaluate(vars, @params);
110        func_grad = (vars, @params) => compiledTerm.Differentiate(vars, @params);
111        return true;
112      } catch (ConversionException) {
113        func = null;
114        func_grad = null;
115        parameters = null;
116        initialConstants = null;
117      }
118      return false;
119    }
120
121    // state for recursive transformation of trees
122    private readonly List<double> initialConstants;
123    private readonly Dictionary<DataForVariable, AutoDiff.Variable> parameters;
124    private readonly List<AutoDiff.Variable> variables;
125    private readonly bool makeVariableWeightsVariable;
126    private readonly bool addLinearScalingTerms;
127
128    private TreeToAutoDiffTermConverter(bool makeVariableWeightsVariable, bool addLinearScalingTerms) {
129      this.makeVariableWeightsVariable = makeVariableWeightsVariable;
130      this.addLinearScalingTerms = addLinearScalingTerms;
131      this.initialConstants = new List<double>();
132      this.parameters = new Dictionary<DataForVariable, AutoDiff.Variable>();
133      this.variables = new List<AutoDiff.Variable>();
134    }
135
136    private AutoDiff.Term ConvertToAutoDiff(ISymbolicExpressionTreeNode node) {
137      if (node.Symbol is Constant) {
138        initialConstants.Add(((ConstantTreeNode)node).Value);
139        var var = new AutoDiff.Variable();
140        variables.Add(var);
141        return var;
142      }
143      if (node.Symbol is Variable || node.Symbol is BinaryFactorVariable) {
144        var varNode = node as VariableTreeNodeBase;
145        var factorVarNode = node as BinaryFactorVariableTreeNode;
146        // factor variable values are only 0 or 1 and set in x accordingly
147        var varValue = factorVarNode != null ? factorVarNode.VariableValue : string.Empty;
148        var par = FindOrCreateParameter(parameters, varNode.VariableName, varValue);
149
150        if (makeVariableWeightsVariable) {
151          initialConstants.Add(varNode.Weight);
152          var w = new AutoDiff.Variable();
153          variables.Add(w);
154          return AutoDiff.TermBuilder.Product(w, par);
155        } else {
156          return varNode.Weight * par;
157        }
158      }
159      if (node.Symbol is FactorVariable) {
160        var factorVarNode = node as FactorVariableTreeNode;
161        var products = new List<Term>();
162        foreach (var variableValue in factorVarNode.Symbol.GetVariableValues(factorVarNode.VariableName)) {
163          var par = FindOrCreateParameter(parameters, factorVarNode.VariableName, variableValue);
164
165          initialConstants.Add(factorVarNode.GetValue(variableValue));
166          var wVar = new AutoDiff.Variable();
167          variables.Add(wVar);
168
169          products.Add(AutoDiff.TermBuilder.Product(wVar, par));
170        }
171        return AutoDiff.TermBuilder.Sum(products);
172      }
173      if (node.Symbol is LaggedVariable) {
174        var varNode = node as LaggedVariableTreeNode;
175        var par = FindOrCreateParameter(parameters, varNode.VariableName, string.Empty, varNode.Lag);
176
177        if (makeVariableWeightsVariable) {
178          initialConstants.Add(varNode.Weight);
179          var w = new AutoDiff.Variable();
180          variables.Add(w);
181          return AutoDiff.TermBuilder.Product(w, par);
182        } else {
183          return varNode.Weight * par;
184        }
185      }
186      if (node.Symbol is Addition) {
187        List<AutoDiff.Term> terms = new List<Term>();
188        foreach (var subTree in node.Subtrees) {
189          terms.Add(ConvertToAutoDiff(subTree));
190        }
191        return AutoDiff.TermBuilder.Sum(terms);
192      }
193      if (node.Symbol is Subtraction) {
194        List<AutoDiff.Term> terms = new List<Term>();
195        for (int i = 0; i < node.SubtreeCount; i++) {
196          AutoDiff.Term t = ConvertToAutoDiff(node.GetSubtree(i));
197          if (i > 0) t = -t;
198          terms.Add(t);
199        }
200        if (terms.Count == 1) return -terms[0];
201        else return AutoDiff.TermBuilder.Sum(terms);
202      }
203      if (node.Symbol is Multiplication) {
204        List<AutoDiff.Term> terms = new List<Term>();
205        foreach (var subTree in node.Subtrees) {
206          terms.Add(ConvertToAutoDiff(subTree));
207        }
208        if (terms.Count == 1) return terms[0];
209        else return terms.Aggregate((a, b) => new AutoDiff.Product(a, b));
210      }
211      if (node.Symbol is Division) {
212        List<AutoDiff.Term> terms = new List<Term>();
213        foreach (var subTree in node.Subtrees) {
214          terms.Add(ConvertToAutoDiff(subTree));
215        }
216        if (terms.Count == 1) return 1.0 / terms[0];
217        else return terms.Aggregate((a, b) => new AutoDiff.Product(a, 1.0 / b));
218      }
219      if (node.Symbol is Absolute) {
220        var x1 = ConvertToAutoDiff(node.GetSubtree(0));
221        return abs(x1);
222      }
223      if (node.Symbol is AnalyticQuotient) {
224        var x1 = ConvertToAutoDiff(node.GetSubtree(0));
225        var x2 = ConvertToAutoDiff(node.GetSubtree(1));
226        return x1 / (TermBuilder.Power(1 + x2 * x2, 0.5));
227      }
228      if (node.Symbol is Logarithm) {
229        return AutoDiff.TermBuilder.Log(
230          ConvertToAutoDiff(node.GetSubtree(0)));
231      }
232      if (node.Symbol is Exponential) {
233        return AutoDiff.TermBuilder.Exp(
234          ConvertToAutoDiff(node.GetSubtree(0)));
235      }
236      if (node.Symbol is Square) {
237        return AutoDiff.TermBuilder.Power(
238          ConvertToAutoDiff(node.GetSubtree(0)), 2.0);
239      }
240      if (node.Symbol is SquareRoot) {
241        return AutoDiff.TermBuilder.Power(
242          ConvertToAutoDiff(node.GetSubtree(0)), 0.5);
243      }
244      if (node.Symbol is Cube) {
245        return AutoDiff.TermBuilder.Power(
246          ConvertToAutoDiff(node.GetSubtree(0)), 3.0);
247      }
248      if (node.Symbol is CubeRoot) {
249        return AutoDiff.TermBuilder.Power(
250          ConvertToAutoDiff(node.GetSubtree(0)), 1.0 / 3.0);
251      }
252      if (node.Symbol is Sine) {
253        return sin(
254          ConvertToAutoDiff(node.GetSubtree(0)));
255      }
256      if (node.Symbol is Cosine) {
257        return cos(
258          ConvertToAutoDiff(node.GetSubtree(0)));
259      }
260      if (node.Symbol is Tangent) {
261        return tan(
262          ConvertToAutoDiff(node.GetSubtree(0)));
263      }
264      if (node.Symbol is Erf) {
265        return erf(
266          ConvertToAutoDiff(node.GetSubtree(0)));
267      }
268      if (node.Symbol is Norm) {
269        return norm(
270          ConvertToAutoDiff(node.GetSubtree(0)));
271      }
272      if (node.Symbol is StartSymbol) {
273        if (addLinearScalingTerms) {
274          // scaling variables α, β are given at the beginning of the parameter vector
275          var alpha = new AutoDiff.Variable();
276          var beta = new AutoDiff.Variable();
277          variables.Add(beta);
278          variables.Add(alpha);
279          var t = ConvertToAutoDiff(node.GetSubtree(0));
280          return t * alpha + beta;
281        } else return ConvertToAutoDiff(node.GetSubtree(0));
282      }
283      throw new ConversionException();
284    }
285
286
287    // for each factor variable value we need a parameter which represents a binary indicator for that variable & value combination
288    // each binary indicator is only necessary once. So we only create a parameter if this combination is not yet available
289    private static Term FindOrCreateParameter(Dictionary<DataForVariable, AutoDiff.Variable> parameters,
290      string varName, string varValue = "", int lag = 0) {
291      var data = new DataForVariable(varName, varValue, lag);
292
293      AutoDiff.Variable par = null;
294      if (!parameters.TryGetValue(data, out par)) {
295        // not found -> create new parameter and entries in names and values lists
296        par = new AutoDiff.Variable();
297        parameters.Add(data, par);
298      }
299      return par;
300    }
301
302    public static bool IsCompatible(ISymbolicExpressionTree tree) {
303      var containsUnknownSymbol = (
304        from n in tree.Root.GetSubtree(0).IterateNodesPrefix()
305        where
306          !(n.Symbol is Variable) &&
307          !(n.Symbol is BinaryFactorVariable) &&
308          !(n.Symbol is FactorVariable) &&
309          !(n.Symbol is LaggedVariable) &&
310          !(n.Symbol is Constant) &&
311          !(n.Symbol is Addition) &&
312          !(n.Symbol is Subtraction) &&
313          !(n.Symbol is Multiplication) &&
314          !(n.Symbol is Division) &&
315          !(n.Symbol is Logarithm) &&
316          !(n.Symbol is Exponential) &&
317          !(n.Symbol is SquareRoot) &&
318          !(n.Symbol is Square) &&
319          !(n.Symbol is Sine) &&
320          !(n.Symbol is Cosine) &&
321          !(n.Symbol is Tangent) &&
322          !(n.Symbol is Erf) &&
323          !(n.Symbol is Norm) &&
324          !(n.Symbol is StartSymbol) &&
325          !(n.Symbol is Absolute) &&
326          !(n.Symbol is AnalyticQuotient) &&
327          !(n.Symbol is Cube) &&
328          !(n.Symbol is CubeRoot)
329        select n).Any();
330      return !containsUnknownSymbol;
331    }
332    #region exception class
333    [Serializable]
334    public class ConversionException : Exception {
335
336      public ConversionException() {
337      }
338
339      public ConversionException(string message) : base(message) {
340      }
341
342      public ConversionException(string message, Exception inner) : base(message, inner) {
343      }
344
345      protected ConversionException(
346        SerializationInfo info,
347        StreamingContext context) : base(info, context) {
348      }
349    }
350    #endregion
351  }
352}
Note: See TracBrowser for help on using the repository browser.