source: branches/2974_Constants_Optimization/HeuristicLab.Problems.DataAnalysis.Symbolic.Regression/3.4/SymbolicRegressionModel.cs @ 16677

Last change on this file since 16677 was 16677, checked in by gkronber, 17 months ago

#2974: merged r16499:16658 from trunk:HeuristicLab.Problems.DataAnalysis.Symbolic.Regression to branch:HeuristicLab.Problems.DataAnalysis.Symbolic.Regression

File size: 4.4 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 HeuristicLab.Common;
25using HeuristicLab.Core;
26using HeuristicLab.Encodings.SymbolicExpressionTreeEncoding;
27using HEAL.Attic;
28
29namespace HeuristicLab.Problems.DataAnalysis.Symbolic.Regression {
30  /// <summary>
31  /// Represents a symbolic regression model
32  /// </summary>
33  [StorableType("2739C33E-4DDB-4285-9DFB-C056D900B2F2")]
34  [Item(Name = "Symbolic Regression Model", Description = "Represents a symbolic regression model.")]
35  public class SymbolicRegressionModel : SymbolicDataAnalysisModel, ISymbolicRegressionModel {
36    [Storable]
37    private string targetVariable;
38    public string TargetVariable {
39      get { return targetVariable; }
40      set {
41        if (string.IsNullOrEmpty(value) || targetVariable == value) return;
42        targetVariable = value;
43        OnTargetVariableChanged(this, EventArgs.Empty);
44      }
45    }
46
47    [StorableConstructor]
48    protected SymbolicRegressionModel(StorableConstructorFlag _) : base(_) {
49      targetVariable = string.Empty;
50    }
51
52    protected SymbolicRegressionModel(SymbolicRegressionModel original, Cloner cloner)
53      : base(original, cloner) {
54      this.targetVariable = original.targetVariable;
55    }
56
57    public SymbolicRegressionModel(string targetVariable, ISymbolicExpressionTree tree,
58      ISymbolicDataAnalysisExpressionTreeInterpreter interpreter,
59      double lowerEstimationLimit = double.MinValue, double upperEstimationLimit = double.MaxValue)
60      : base(tree, interpreter, lowerEstimationLimit, upperEstimationLimit) {
61      this.targetVariable = targetVariable;
62    }
63
64    public override IDeepCloneable Clone(Cloner cloner) {
65      return new SymbolicRegressionModel(this, cloner);
66    }
67
68    public IEnumerable<double> GetEstimatedValues(IDataset dataset, IEnumerable<int> rows) {
69      return Interpreter.GetSymbolicExpressionTreeValues(SymbolicExpressionTree, dataset, rows)
70        .LimitToRange(LowerEstimationLimit, UpperEstimationLimit);
71    }
72
73    public ISymbolicRegressionSolution CreateRegressionSolution(IRegressionProblemData problemData) {
74      return new SymbolicRegressionSolution(this, new RegressionProblemData(problemData));
75    }
76    IRegressionSolution IRegressionModel.CreateRegressionSolution(IRegressionProblemData problemData) {
77      return CreateRegressionSolution(problemData);
78    }
79
80    public void Scale(IRegressionProblemData problemData) {
81      Scale(problemData, problemData.TargetVariable);
82    }
83
84    public virtual bool IsProblemDataCompatible(IRegressionProblemData problemData, out string errorMessage) {
85      return RegressionModel.IsProblemDataCompatible(this, problemData, out errorMessage);
86    }
87
88    public override bool IsProblemDataCompatible(IDataAnalysisProblemData problemData, out string errorMessage) {
89      if (problemData == null) throw new ArgumentNullException("problemData", "The provided problemData is null.");
90      var regressionProblemData = problemData as IRegressionProblemData;
91      if (regressionProblemData == null)
92        throw new ArgumentException("The problem data is not a regression problem data. Instead a " + problemData.GetType().GetPrettyName() + " was provided.", "problemData");
93      return IsProblemDataCompatible(regressionProblemData, out errorMessage);
94    }
95
96    #region events
97    public event EventHandler TargetVariableChanged;
98    private void OnTargetVariableChanged(object sender, EventArgs args) {
99      var changed = TargetVariableChanged;
100      if (changed != null)
101        changed(sender, args);
102    }
103    #endregion
104  }
105}
Note: See TracBrowser for help on using the repository browser.