source: branches/2971_named_intervals/HeuristicLab.Problems.DataAnalysis/3.4/Implementation/Regression/RegressionProblemData.cs @ 17506

Last change on this file since 17506 was 17506, checked in by mkommend, 3 months ago

#2971: Further minor refactorings and renaming of members.

File size: 9.8 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 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 HEAL.Attic;
26using HeuristicLab.Common;
27using HeuristicLab.Core;
28using HeuristicLab.Data;
29using HeuristicLab.Parameters;
30
31namespace HeuristicLab.Problems.DataAnalysis {
32  [StorableType("EE612297-B1AF-42D2-BF21-AF9A2D42791C")]
33  [Item("RegressionProblemData", "Represents an item containing all data defining a regression problem.")]
34  public class RegressionProblemData : DataAnalysisProblemData, IRegressionProblemData, IStorableContent {
35    protected const string TargetVariableParameterName = "TargetVariable";
36    protected const string VariableRangesParameterName = "VariableRanges";
37    protected const string IntervalConstraintsParameterName = "IntervalConstraints";
38    public string Filename { get; set; }
39
40    #region default data
41    private static double[,] kozaF1 = new double[,] {
42          {2.017885919, -1.449165046},
43          {1.30060506,  -1.344523885},
44          {1.147134798, -1.317989331},
45          {0.877182504, -1.266142284},
46          {0.852562452, -1.261020794},
47          {0.431095788, -1.158793317},
48          {0.112586002, -1.050908405},
49          {0.04594507,  -1.021989402},
50          {0.042572879, -1.020438113},
51          {-0.074027291,  -0.959859562},
52          {-0.109178553,  -0.938094706},
53          {-0.259721109,  -0.803635355},
54          {-0.272991057,  -0.387519561},
55          {-0.161978191,  -0.193611001},
56          {-0.102489983,  -0.114215349},
57          {-0.01469968, -0.014918985},
58          {-0.008863365,  -0.008942626},
59          {0.026751057, 0.026054094},
60          {0.166922436, 0.14309643},
61          {0.176953808, 0.1504144},
62          {0.190233418, 0.159916534},
63          {0.199800708, 0.166635331},
64          {0.261502822, 0.207600348},
65          {0.30182879,  0.232370249},
66          {0.83763905,  0.468046718}
67    };
68    private static readonly Dataset defaultDataset;
69    private static readonly IEnumerable<string> defaultAllowedInputVariables;
70    private static readonly string defaultTargetVariable;
71
72    private static readonly RegressionProblemData emptyProblemData;
73    public static RegressionProblemData EmptyProblemData {
74      get { return emptyProblemData; }
75    }
76
77    static RegressionProblemData() {
78      defaultDataset = new Dataset(new string[] { "y", "x" }, kozaF1);
79      defaultDataset.Name = "Fourth-order Polynomial Function Benchmark Dataset";
80      defaultDataset.Description = "f(x) = x^4 + x^3 + x^2 + x^1";
81      defaultAllowedInputVariables = new List<string>() { "x" };
82      defaultTargetVariable = "y";
83
84      var problemData = new RegressionProblemData();
85      problemData.Parameters.Clear();
86      problemData.Name = "Empty Regression ProblemData";
87      problemData.Description = "This ProblemData acts as place holder before the correct problem data is loaded.";
88      problemData.isEmpty = true;
89
90      problemData.Parameters.Add(new FixedValueParameter<Dataset>(DatasetParameterName, "", new Dataset()));
91      problemData.Parameters.Add(new FixedValueParameter<ReadOnlyCheckedItemList<StringValue>>(InputVariablesParameterName, ""));
92      problemData.Parameters.Add(new FixedValueParameter<IntRange>(TrainingPartitionParameterName, "", (IntRange)new IntRange(0, 0).AsReadOnly()));
93      problemData.Parameters.Add(new FixedValueParameter<IntRange>(TestPartitionParameterName, "", (IntRange)new IntRange(0, 0).AsReadOnly()));
94      problemData.Parameters.Add(new ConstrainedValueParameter<StringValue>(TargetVariableParameterName, new ItemSet<StringValue>()));
95      problemData.Parameters.Add(new FixedValueParameter<IntervalCollection>(VariableRangesParameterName, "", new IntervalCollection()));
96      problemData.Parameters.Add(new FixedValueParameter<ProblemDataConstraint>(IntervalConstraintsParameterName, "", new ProblemDataConstraint(problemData)));
97      emptyProblemData = problemData;
98    }
99    #endregion
100
101    public IConstrainedValueParameter<StringValue> TargetVariableParameter {
102      get { return (IConstrainedValueParameter<StringValue>)Parameters[TargetVariableParameterName]; }
103    }
104
105    public IFixedValueParameter<IntervalCollection> VariableRangesParameter => (IFixedValueParameter<IntervalCollection>)Parameters[VariableRangesParameterName];
106
107    public IntervalCollection VariableRanges {
108      get => VariableRangesParameter.Value;
109    }
110
111
112    public IFixedValueParameter<ProblemDataConstraint> IntervalConstraintsParameter => (IFixedValueParameter<ProblemDataConstraint>)Parameters[IntervalConstraintsParameterName];
113
114    public ProblemDataConstraint IntervalConstraints {
115      get => IntervalConstraintsParameter.Value;
116    }
117
118
119    public string TargetVariable {
120      get { return TargetVariableParameter.Value.Value; }
121      set {
122        if (value == null) throw new ArgumentNullException("targetVariable", "The provided value for the targetVariable is null.");
123        if (value == TargetVariable) return;
124
125        var matchingParameterValue = TargetVariableParameter.ValidValues.FirstOrDefault(v => v.Value == value);
126        if (matchingParameterValue == null) throw new ArgumentException("The provided value is not valid as the targetVariable.", "targetVariable");
127        TargetVariableParameter.Value = matchingParameterValue;
128      }
129    }
130
131    public IEnumerable<double> TargetVariableValues {
132      get { return Dataset.GetDoubleValues(TargetVariable); }
133    }
134    public IEnumerable<double> TargetVariableTrainingValues {
135      get { return Dataset.GetDoubleValues(TargetVariable, TrainingIndices); }
136    }
137    public IEnumerable<double> TargetVariableTestValues {
138      get { return Dataset.GetDoubleValues(TargetVariable, TestIndices); }
139    }
140
141
142    [StorableConstructor]
143    protected RegressionProblemData(StorableConstructorFlag _) : base(_) { }
144    [StorableHook(HookType.AfterDeserialization)]
145    private void AfterDeserialization() {
146      if (!Parameters.ContainsKey(VariableRangesParameterName)) {
147        var intervalCollection = CalculateDatasetIntervals(this.Dataset);
148        Parameters.Add(new FixedValueParameter<IntervalCollection>(VariableRangesParameterName, intervalCollection));
149      }
150      if (!Parameters.ContainsKey(IntervalConstraintsParameterName)) {
151        Parameters.Add(new FixedValueParameter<ProblemDataConstraint>(IntervalConstraintsParameterName, new ProblemDataConstraint(this)));
152      }
153      RegisterParameterEvents();
154    }
155
156    protected RegressionProblemData(RegressionProblemData original, Cloner cloner)
157      : base(original, cloner) {
158      RegisterParameterEvents();
159    }
160    public override IDeepCloneable Clone(Cloner cloner) {
161      if (this == emptyProblemData) return emptyProblemData;
162      return new RegressionProblemData(this, cloner);
163    }
164
165    public RegressionProblemData()
166      : this(defaultDataset, defaultAllowedInputVariables, defaultTargetVariable) {
167    }
168    public RegressionProblemData(IRegressionProblemData regressionProblemData)
169      : this(regressionProblemData.Dataset, regressionProblemData.AllowedInputVariables, regressionProblemData.TargetVariable) {
170      TrainingPartition.Start = regressionProblemData.TrainingPartition.Start;
171      TrainingPartition.End = regressionProblemData.TrainingPartition.End;
172      TestPartition.Start = regressionProblemData.TestPartition.Start;
173      TestPartition.End = regressionProblemData.TestPartition.End;
174    }
175
176    public RegressionProblemData(IDataset dataset, IEnumerable<string> allowedInputVariables, string targetVariable, IEnumerable<ITransformation> transformations = null)
177      : base(dataset, allowedInputVariables, transformations ?? Enumerable.Empty<ITransformation>()) {
178      var variables = InputVariables.Select(x => x.AsReadOnly()).ToList();
179      Parameters.Add(new ConstrainedValueParameter<StringValue>(TargetVariableParameterName, new ItemSet<StringValue>(variables), variables.Where(x => x.Value == targetVariable).First()));
180      var intervalCollection = CalculateDatasetIntervals(this.Dataset);
181      Parameters.Add(new FixedValueParameter<IntervalCollection>(VariableRangesParameterName, intervalCollection));
182      Parameters.Add(new FixedValueParameter<ProblemDataConstraint>(IntervalConstraintsParameterName, new ProblemDataConstraint(this)));
183      RegisterParameterEvents();
184    }
185
186    private static IntervalCollection CalculateDatasetIntervals(IDataset dataset) {
187      IntervalCollection intervalCollection = new IntervalCollection();
188      foreach (var variable in dataset.DoubleVariables) {// intervals are only possible for double variables
189        var variableInterval = Interval.GetInterval(dataset.GetDoubleValues(variable));
190        intervalCollection.AddInterval(variable, variableInterval);
191      }
192
193      return intervalCollection;
194    }
195
196    private void RegisterParameterEvents() {
197      TargetVariableParameter.ValueChanged += new EventHandler(TargetVariableParameter_ValueChanged);
198    }
199    private void TargetVariableParameter_ValueChanged(object sender, EventArgs e) {
200      OnChanged();
201    }
202  }
203}
Note: See TracBrowser for help on using the repository browser.