Free cookie consent management tool by TermsFeed Policy Generator

source: trunk/sources/HeuristicLab.Optimization.Operators/3.3/ExpressionCalculator.cs @ 14783

Last change on this file since 14783 was 14185, checked in by swagner, 8 years ago

#2526: Updated year of copyrights in license headers

File size: 3.8 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2016 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.Collections.Generic;
23using HeuristicLab.Common;
24using HeuristicLab.Core;
25using HeuristicLab.Data;
26using HeuristicLab.Operators;
27using HeuristicLab.Parameters;
28using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
29
30namespace HeuristicLab.Optimization.Operators {
31  /// <summary>
32  /// An operator that evaluates an expression.
33  /// </summary>
34  [Item("ExpressionCalculator", "An operator that evaluates an expression.")]
35  [StorableClass]
36  public class ExpressionCalculator : ValuesCollector {
37    [Storable]
38    public Calculator Calculator { get; set; }
39
40    #region Parameter Properties
41    public IValueLookupParameter<StringValue> ExpressionParameter {
42      get { return (IValueLookupParameter<StringValue>)Parameters["Expression"]; }
43    }
44    public IValueLookupParameter<IItem> ExpressionResultParameter {
45      get { return (IValueLookupParameter<IItem>)Parameters["ExpressionResult"]; }
46    }
47    #endregion
48
49    #region Properties
50    private string Formula {
51      get { return ExpressionParameter.Value.Value; }
52    }
53    private IItem ExpressionResult {
54      set { ExpressionResultParameter.ActualValue = value; }
55    }
56    #endregion
57
58    [StorableConstructor]
59    protected ExpressionCalculator(bool deserializing) : base(deserializing) { }
60    protected ExpressionCalculator(ExpressionCalculator original, Cloner cloner)
61      : base(original, cloner) {
62      this.Calculator = cloner.Clone(original.Calculator);
63    }
64    public ExpressionCalculator()
65      : base() {
66      Parameters.Add(new ValueLookupParameter<IItem>("ExpressionResult", "The result of the evaluated expression."));
67      Parameters.Add(new ValueLookupParameter<StringValue>("Expression",
68@"RPN formula for new value in postfix notation.
69
70This can contain the following elements:
71
72literals:
73  numbers, true, false, null and strings in single quotes
74variables (run parameters or results):
75  unquoted or in double quotes if they contain special characters or whitespace
76mathematical functions (resulting in double values):
77  +, -, *, /, ^ (power), log
78predicates:
79  ==, <, >, isnull, not
80conversions:
81  toint, todouble
82array indexing:
83  []
84stack manipulation:
85  drop swap dup
86string matching:
87  <string> <pattern> ismatch
88string replacing:
89  <string> <pattern> <replacement> rename
90conditionals:
91  <then> <else> <condition> if
92
93If the final value is null, the result variable is removed if it exists."));
94
95      Calculator = new Calculator();
96    }
97
98    public override IDeepCloneable Clone(Cloner cloner) {
99      return new ExpressionCalculator(this, cloner);
100    }
101
102    public override IOperation Apply() {
103      Calculator.Formula = Formula;
104      var variables = new Dictionary<string, IItem>();
105      foreach (var collectedValue in CollectedValues)
106        variables[collectedValue.Name] = collectedValue.ActualValue;
107      ExpressionResult = Calculator.GetValue(variables);
108      return base.Apply();
109    }
110  }
111}
Note: See TracBrowser for help on using the repository browser.