source: trunk/HeuristicLab.Problems.DataAnalysis.Symbolic.Classification/3.4/SymbolicClassificationModel.cs @ 16243

Last change on this file since 16243 was 16243, checked in by mkommend, 2 years ago

#2955: Added IsProblemDataCompatible and IsDatasetCompatible to all DataAnalysisModels.

File size: 4.3 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 HeuristicLab.Common;
25using HeuristicLab.Core;
26using HeuristicLab.Encodings.SymbolicExpressionTreeEncoding;
27using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
28
29namespace HeuristicLab.Problems.DataAnalysis.Symbolic.Classification {
30  /// <summary>
31  /// Represents a symbolic classification model
32  /// </summary>
33  [StorableClass]
34  [Item(Name = "SymbolicClassificationModel", Description = "Represents a symbolic classification model.")]
35  public abstract class SymbolicClassificationModel : SymbolicDataAnalysisModel, ISymbolicClassificationModel {
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 SymbolicClassificationModel(bool deserializing)
49      : base(deserializing) {
50      targetVariable = string.Empty;
51    }
52
53    protected SymbolicClassificationModel(SymbolicClassificationModel original, Cloner cloner)
54      : base(original, cloner) {
55      targetVariable = original.targetVariable;
56    }
57
58    protected SymbolicClassificationModel(string targetVariable, ISymbolicExpressionTree tree, ISymbolicDataAnalysisExpressionTreeInterpreter interpreter, double lowerEstimationLimit = double.MinValue, double upperEstimationLimit = double.MaxValue)
59      : base(tree, interpreter, lowerEstimationLimit, upperEstimationLimit) {
60      this.targetVariable = targetVariable;
61    }
62
63    public abstract IEnumerable<double> GetEstimatedClassValues(IDataset dataset, IEnumerable<int> rows);
64    public abstract void RecalculateModelParameters(IClassificationProblemData problemData, IEnumerable<int> rows);
65
66    public abstract ISymbolicClassificationSolution CreateClassificationSolution(IClassificationProblemData problemData);
67
68    IClassificationSolution IClassificationModel.CreateClassificationSolution(IClassificationProblemData problemData) {
69      return CreateClassificationSolution(problemData);
70    }
71
72    public void Scale(IClassificationProblemData problemData) {
73      Scale(problemData, problemData.TargetVariable);
74    }
75
76    public virtual bool IsProblemDataCompatible(IClassificationProblemData problemData, out string errorMessage) {
77      return ClassificationModel.IsProblemDataCompatible(this, problemData, out errorMessage);
78    }
79
80    public override bool IsProblemDataCompatible(IDataAnalysisProblemData problemData, out string errorMessage) {
81      if (problemData == null) throw new ArgumentNullException("problemData", "The provided problemData is null.");
82      var classificationProblemData = problemData as IClassificationProblemData;
83      if (classificationProblemData == null)
84        throw new ArgumentException("The problem data is not a regression problem data. Instead a " + problemData.GetType().GetPrettyName() + " was provided.", "problemData");
85      return IsProblemDataCompatible(classificationProblemData, out errorMessage);
86    }
87
88    #region events
89    public event EventHandler TargetVariableChanged;
90    private void OnTargetVariableChanged(object sender, EventArgs args) {
91      var changed = TargetVariableChanged;
92      if (changed != null)
93        changed(sender, args);
94    }
95    #endregion
96  }
97}
Note: See TracBrowser for help on using the repository browser.