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 |
|
---|
22 | using System;
|
---|
23 | using System.Collections.Generic;
|
---|
24 | using System.Linq;
|
---|
25 | using System.Text;
|
---|
26 | using HeuristicLab.Collections;
|
---|
27 | using HeuristicLab.Common;
|
---|
28 | using HeuristicLab.Core;
|
---|
29 | using HeuristicLab.Data;
|
---|
30 | using HeuristicLab.Parameters;
|
---|
31 | using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
|
---|
32 |
|
---|
33 | namespace HeuristicLab.Problems.DataAnalysis {
|
---|
34 | [StorableClass]
|
---|
35 | public abstract class DataAnalysisProblemData : ParameterizedNamedItem, IDataAnalysisProblemData {
|
---|
36 | protected const string DatasetParameterName = "Dataset";
|
---|
37 | protected const string InputVariablesParameterName = "InputVariables";
|
---|
38 | protected const string TrainingPartitionParameterName = "TrainingPartition";
|
---|
39 | protected const string TestPartitionParameterName = "TestPartition";
|
---|
40 | protected const string TransformationsParameterName = "Transformations";
|
---|
41 |
|
---|
42 | #region parameter properites
|
---|
43 | //mkommend: inserted parameter caching due to performance reasons
|
---|
44 | private IFixedValueParameter<Dataset> datasetParameter;
|
---|
45 | public IFixedValueParameter<Dataset> DatasetParameter {
|
---|
46 | get {
|
---|
47 | if (datasetParameter == null) datasetParameter = (IFixedValueParameter<Dataset>)Parameters[DatasetParameterName];
|
---|
48 | return datasetParameter;
|
---|
49 | }
|
---|
50 | }
|
---|
51 |
|
---|
52 | private IFixedValueParameter<ReadOnlyCheckedItemList<StringValue>> inputVariablesParameter;
|
---|
53 | public IFixedValueParameter<ReadOnlyCheckedItemList<StringValue>> InputVariablesParameter {
|
---|
54 | get {
|
---|
55 | if (inputVariablesParameter == null) inputVariablesParameter = (IFixedValueParameter<ReadOnlyCheckedItemList<StringValue>>)Parameters[InputVariablesParameterName];
|
---|
56 | return inputVariablesParameter;
|
---|
57 | }
|
---|
58 | }
|
---|
59 |
|
---|
60 | private IFixedValueParameter<IntRange> trainingPartitionParameter;
|
---|
61 | public IFixedValueParameter<IntRange> TrainingPartitionParameter {
|
---|
62 | get {
|
---|
63 | if (trainingPartitionParameter == null) trainingPartitionParameter = (IFixedValueParameter<IntRange>)Parameters[TrainingPartitionParameterName];
|
---|
64 | return trainingPartitionParameter;
|
---|
65 | }
|
---|
66 | }
|
---|
67 |
|
---|
68 | private IFixedValueParameter<IntRange> testPartitionParameter;
|
---|
69 | public IFixedValueParameter<IntRange> TestPartitionParameter {
|
---|
70 | get {
|
---|
71 | if (testPartitionParameter == null) testPartitionParameter = (IFixedValueParameter<IntRange>)Parameters[TestPartitionParameterName];
|
---|
72 | return testPartitionParameter;
|
---|
73 | }
|
---|
74 | }
|
---|
75 |
|
---|
76 | public IFixedValueParameter<ReadOnlyItemList<IDataAnalysisTransformation>> TransformationsParameter {
|
---|
77 | get { return (IFixedValueParameter<ReadOnlyItemList<IDataAnalysisTransformation>>)Parameters[TransformationsParameterName]; }
|
---|
78 | }
|
---|
79 | #endregion
|
---|
80 |
|
---|
81 | #region properties
|
---|
82 | protected bool isEmpty = false;
|
---|
83 | public bool IsEmpty {
|
---|
84 | get { return isEmpty; }
|
---|
85 | }
|
---|
86 | public IDataset Dataset {
|
---|
87 | get { return DatasetParameter.Value; }
|
---|
88 | }
|
---|
89 | public ICheckedItemList<StringValue> InputVariables {
|
---|
90 | get { return InputVariablesParameter.Value; }
|
---|
91 | }
|
---|
92 | public IEnumerable<string> AllowedInputVariables {
|
---|
93 | get { return InputVariables.CheckedItems.Select(x => x.Value.Value); }
|
---|
94 | }
|
---|
95 |
|
---|
96 | public double[,] AllowedInputsTrainingValues {
|
---|
97 | get { return Dataset.ToArray(AllowedInputVariables, TrainingIndices); }
|
---|
98 | }
|
---|
99 |
|
---|
100 | public double[,] AllowedInputsTestValues { get { return Dataset.ToArray(AllowedInputVariables, TestIndices); } }
|
---|
101 | public IntRange TrainingPartition {
|
---|
102 | get { return TrainingPartitionParameter.Value; }
|
---|
103 | }
|
---|
104 | public IntRange TestPartition {
|
---|
105 | get { return TestPartitionParameter.Value; }
|
---|
106 | }
|
---|
107 |
|
---|
108 | public virtual IEnumerable<int> AllIndices {
|
---|
109 | get { return Enumerable.Range(0, Dataset.Rows); }
|
---|
110 | }
|
---|
111 | public virtual IEnumerable<int> TrainingIndices {
|
---|
112 | get {
|
---|
113 | return Enumerable.Range(TrainingPartition.Start, Math.Max(0, TrainingPartition.End - TrainingPartition.Start))
|
---|
114 | .Where(IsTrainingSample);
|
---|
115 | }
|
---|
116 | }
|
---|
117 | public virtual IEnumerable<int> TestIndices {
|
---|
118 | get {
|
---|
119 | return Enumerable.Range(TestPartition.Start, Math.Max(0, TestPartition.End - TestPartition.Start))
|
---|
120 | .Where(IsTestSample);
|
---|
121 | }
|
---|
122 | }
|
---|
123 |
|
---|
124 | public IEnumerable<IDataAnalysisTransformation> Transformations {
|
---|
125 | get { return TransformationsParameter.Value; }
|
---|
126 | }
|
---|
127 |
|
---|
128 | public virtual bool IsTrainingSample(int index) {
|
---|
129 | return index >= 0 && index < Dataset.Rows &&
|
---|
130 | TrainingPartition.Start <= index && index < TrainingPartition.End &&
|
---|
131 | (index < TestPartition.Start || TestPartition.End <= index);
|
---|
132 | }
|
---|
133 |
|
---|
134 | public virtual bool IsTestSample(int index) {
|
---|
135 | return index >= 0 && index < Dataset.Rows &&
|
---|
136 | TestPartition.Start <= index && index < TestPartition.End;
|
---|
137 | }
|
---|
138 | #endregion
|
---|
139 |
|
---|
140 | protected DataAnalysisProblemData(DataAnalysisProblemData original, Cloner cloner)
|
---|
141 | : base(original, cloner) {
|
---|
142 | isEmpty = original.isEmpty;
|
---|
143 | RegisterEventHandlers();
|
---|
144 | }
|
---|
145 | [StorableConstructor]
|
---|
146 | protected DataAnalysisProblemData(bool deserializing) : base(deserializing) { }
|
---|
147 |
|
---|
148 | [StorableHook(HookType.AfterDeserialization)]
|
---|
149 | private void AfterDeserialization() {
|
---|
150 | if (Parameters[TransformationsParameterName] is FixedValueParameter<ReadOnlyItemList<ITransformation>>)
|
---|
151 | Parameters.Remove(TransformationsParameterName);
|
---|
152 | if (!Parameters.ContainsKey(TransformationsParameterName))
|
---|
153 | Parameters.Add(new FixedValueParameter<ReadOnlyItemList<IDataAnalysisTransformation>>(TransformationsParameterName, new ItemList<IDataAnalysisTransformation>().AsReadOnly()) { Hidden = true });
|
---|
154 |
|
---|
155 | RegisterEventHandlers();
|
---|
156 | }
|
---|
157 |
|
---|
158 | protected DataAnalysisProblemData(IDataset dataset, IEnumerable<string> allowedInputVariables, IEnumerable<IDataAnalysisTransformation> transformations = null) {
|
---|
159 | if (dataset == null) throw new ArgumentNullException("The dataset must not be null.");
|
---|
160 | if (allowedInputVariables == null) throw new ArgumentNullException("The allowed input variables must not be null.");
|
---|
161 |
|
---|
162 | if (allowedInputVariables.Except(dataset.DoubleVariables).Except(dataset.StringVariables).Any())
|
---|
163 | throw new ArgumentException("All allowed input variables must be present in the dataset and of type double or string.");
|
---|
164 |
|
---|
165 | var variables = dataset.VariableNames.Where(variable => dataset.VariableHasType<double>(variable) || dataset.VariableHasType<string>(variable));
|
---|
166 | var inputVariables = new CheckedItemList<StringValue>(variables.Select(x => new StringValue(x)));
|
---|
167 | foreach (StringValue x in inputVariables)
|
---|
168 | inputVariables.SetItemCheckedState(x, allowedInputVariables.Contains(x.Value));
|
---|
169 |
|
---|
170 | int trainingPartitionStart = 0;
|
---|
171 | int trainingPartitionEnd = dataset.Rows / 2;
|
---|
172 | int testPartitionStart = dataset.Rows / 2;
|
---|
173 | int testPartitionEnd = dataset.Rows;
|
---|
174 |
|
---|
175 | var transformationsList = new ItemList<IDataAnalysisTransformation>(transformations ?? Enumerable.Empty<IDataAnalysisTransformation>());
|
---|
176 |
|
---|
177 | Parameters.Add(new FixedValueParameter<Dataset>(DatasetParameterName, "", (Dataset)dataset));
|
---|
178 | Parameters.Add(new FixedValueParameter<ReadOnlyCheckedItemList<StringValue>>(InputVariablesParameterName, "", inputVariables.AsReadOnly()));
|
---|
179 | Parameters.Add(new FixedValueParameter<IntRange>(TrainingPartitionParameterName, "", new IntRange(trainingPartitionStart, trainingPartitionEnd)));
|
---|
180 | Parameters.Add(new FixedValueParameter<IntRange>(TestPartitionParameterName, "", new IntRange(testPartitionStart, testPartitionEnd)));
|
---|
181 | Parameters.Add(new FixedValueParameter<ReadOnlyItemList<IDataAnalysisTransformation>>(TransformationsParameterName, "", transformationsList.AsReadOnly()) { Hidden = transformationsList.Count == 0 });
|
---|
182 |
|
---|
183 | ((ValueParameter<Dataset>)DatasetParameter).ReactOnValueToStringChangedAndValueItemImageChanged = false;
|
---|
184 | RegisterEventHandlers();
|
---|
185 | }
|
---|
186 |
|
---|
187 | private void RegisterEventHandlers() {
|
---|
188 | DatasetParameter.ValueChanged += new EventHandler(Parameter_ValueChanged);
|
---|
189 | InputVariables.CheckedItemsChanged += new CollectionItemsChangedEventHandler<IndexedItem<StringValue>>(InputVariables_CheckedItemsChanged);
|
---|
190 | TrainingPartition.ValueChanged += new EventHandler(Parameter_ValueChanged);
|
---|
191 | TestPartition.ValueChanged += new EventHandler(Parameter_ValueChanged);
|
---|
192 | TransformationsParameter.ValueChanged += new EventHandler(Parameter_ValueChanged);
|
---|
193 | }
|
---|
194 |
|
---|
195 | private void InputVariables_CheckedItemsChanged(object sender, CollectionItemsChangedEventArgs<IndexedItem<StringValue>> e) {
|
---|
196 | OnChanged();
|
---|
197 | }
|
---|
198 |
|
---|
199 | private void Parameter_ValueChanged(object sender, EventArgs e) {
|
---|
200 | OnChanged();
|
---|
201 | }
|
---|
202 |
|
---|
203 | public event EventHandler Changed;
|
---|
204 | protected virtual void OnChanged() {
|
---|
205 | var listeners = Changed;
|
---|
206 | if (listeners != null) listeners(this, EventArgs.Empty);
|
---|
207 | }
|
---|
208 |
|
---|
209 | protected virtual bool IsProblemDataCompatible(IDataAnalysisProblemData problemData, out string errorMessage) {
|
---|
210 | errorMessage = string.Empty;
|
---|
211 | if (problemData == null) throw new ArgumentNullException("problemData", "The provided problemData is null.");
|
---|
212 |
|
---|
213 | //check allowed input variables
|
---|
214 | StringBuilder message = new StringBuilder();
|
---|
215 | var variables = new HashSet<string>(problemData.InputVariables.Select(x => x.Value));
|
---|
216 | foreach (var item in AllowedInputVariables) {
|
---|
217 | if (!variables.Contains(item))
|
---|
218 | message.AppendLine("Input variable '" + item + "' is not present in the new problem data.");
|
---|
219 | }
|
---|
220 |
|
---|
221 | if (message.Length != 0) {
|
---|
222 | errorMessage = message.ToString();
|
---|
223 | return false;
|
---|
224 | }
|
---|
225 | return true;
|
---|
226 |
|
---|
227 | }
|
---|
228 |
|
---|
229 | public virtual void AdjustProblemDataProperties(IDataAnalysisProblemData problemData) {
|
---|
230 | DataAnalysisProblemData data = problemData as DataAnalysisProblemData;
|
---|
231 | if (data == null) throw new ArgumentException("The problem data is not a data analysis problem data. Instead a " + problemData.GetType().GetPrettyName() + " was provided.", "problemData");
|
---|
232 |
|
---|
233 | string errorMessage;
|
---|
234 | if (!data.IsProblemDataCompatible(this, out errorMessage)) {
|
---|
235 | throw new InvalidOperationException(errorMessage);
|
---|
236 | }
|
---|
237 |
|
---|
238 | foreach (var inputVariable in InputVariables) {
|
---|
239 | var variable = data.InputVariables.FirstOrDefault(i => i.Value == inputVariable.Value);
|
---|
240 | InputVariables.SetItemCheckedState(inputVariable, variable != null && data.InputVariables.ItemChecked(variable));
|
---|
241 | }
|
---|
242 | }
|
---|
243 |
|
---|
244 | public virtual IDataAnalysisProblemData Transform() {
|
---|
245 | var newDataset = Transform(Dataset, Transformations);
|
---|
246 |
|
---|
247 | var extendedInputs = ExtendInputVariables(AllowedInputVariables, Transformations);
|
---|
248 | var checkedInputs = new CheckedItemList<StringValue>(newDataset.VariableNames.Select(x => new StringValue(x)));
|
---|
249 | foreach (var input in checkedInputs) checkedInputs.SetItemCheckedState(input, extendedInputs.Contains(input.Value));
|
---|
250 |
|
---|
251 | // TODO: Cannot create concrete instance here (maybe derived Create-method?)
|
---|
252 | var cloner = new Cloner();
|
---|
253 | cloner.RegisterClonedObject(Dataset, newDataset);
|
---|
254 | cloner.RegisterClonedObject(InputVariables, checkedInputs.AsReadOnly());
|
---|
255 | //cloner.RegisterClonedObject(TransformationsParameter.Value, new ItemList<IDataAnalysisTransformation>(transformations).AsReadOnly());
|
---|
256 |
|
---|
257 | return cloner.Clone(this);
|
---|
258 | }
|
---|
259 |
|
---|
260 | public virtual IDataAnalysisProblemData InverseTransform() {
|
---|
261 | var newDataset = InverseTransform(Dataset, Transformations);
|
---|
262 |
|
---|
263 | var checkedInputs = new CheckedItemList<StringValue>(newDataset.VariableNames.Select(x => new StringValue(x)));
|
---|
264 | foreach (var input in checkedInputs) checkedInputs.SetItemCheckedState(input, AllowedInputVariables.Contains(input.Value));
|
---|
265 |
|
---|
266 | // TODO: Cannot create concrete instance here (maybe derived Create-method?)
|
---|
267 | var cloner = new Cloner();
|
---|
268 | cloner.RegisterClonedObject(Dataset, newDataset);
|
---|
269 | cloner.RegisterClonedObject(InputVariables, checkedInputs.AsReadOnly());
|
---|
270 | //cloner.RegisterClonedObject(TransformationsParameter.Value, new ItemList<IDataAnalysisTransformation>().AsReadOnly());
|
---|
271 |
|
---|
272 | return cloner.Clone(this);
|
---|
273 | }
|
---|
274 |
|
---|
275 | public static IDataset Transform(IDataset dataset, IEnumerable<IDataAnalysisTransformation> transformations) {
|
---|
276 | var modifiableDataset = ((Dataset)dataset).ToModifiable();
|
---|
277 |
|
---|
278 | foreach (var transformation in transformations) {
|
---|
279 | var trans = (ITransformation<double>)transformation.Transformation;
|
---|
280 |
|
---|
281 | var originalData = modifiableDataset.GetDoubleValues(transformation.OriginalVariable);
|
---|
282 | if (!trans.Check(originalData, out string errorMessage))
|
---|
283 | throw new InvalidOperationException($"Cannot estimate Values, Transformation is invalid: {errorMessage}");
|
---|
284 |
|
---|
285 | var transformedData = trans.Apply(originalData).ToList();
|
---|
286 | if (modifiableDataset.VariableNames.Contains(transformation.TransformedVariable))
|
---|
287 | modifiableDataset.ReplaceVariable(transformation.TransformedVariable, transformedData);
|
---|
288 | else
|
---|
289 | modifiableDataset.AddVariable(transformation.TransformedVariable, transformedData);
|
---|
290 | }
|
---|
291 |
|
---|
292 | return modifiableDataset;
|
---|
293 | }
|
---|
294 |
|
---|
295 | public static IDataset InverseTransform(IDataset dataset, IEnumerable<IDataAnalysisTransformation> transformations, bool removeVirtualVariables = true) {
|
---|
296 | var modifiableDataset = ((Dataset)dataset).ToModifiable();
|
---|
297 |
|
---|
298 | var transformationsStack = new Stack<IDataAnalysisTransformation>(transformations);
|
---|
299 | while (transformationsStack.Any()) {
|
---|
300 | var transformation = transformationsStack.Pop();
|
---|
301 | var trans = (ITransformation<double>)transformation.Transformation;
|
---|
302 |
|
---|
303 | var prevTransformations = transformations.Except(transformationsStack);
|
---|
304 | bool originalWasChanged = prevTransformations.Any(x => x.TransformedVariable == transformation.OriginalVariable);
|
---|
305 | if (originalWasChanged) {
|
---|
306 | var transformedData = modifiableDataset.GetDoubleValues(transformation.TransformedVariable);
|
---|
307 |
|
---|
308 | var originalData = trans.InverseApply(transformedData).ToList();
|
---|
309 | modifiableDataset.ReplaceVariable(transformation.OriginalVariable, originalData);
|
---|
310 | }
|
---|
311 |
|
---|
312 | bool transformedVariablePending = transformationsStack.Any(x => x.OriginalVariable == transformation.TransformedVariable || x.TransformedVariable == transformation.TransformedVariable);
|
---|
313 | if (removeVirtualVariables && !transformedVariablePending)
|
---|
314 | modifiableDataset.RemoveVariable(transformation.TransformedVariable);
|
---|
315 | }
|
---|
316 |
|
---|
317 | return modifiableDataset;
|
---|
318 | }
|
---|
319 |
|
---|
320 | public static IEnumerable<string> ExtendInputVariables(IEnumerable<string> oldInputVariables, IEnumerable<IDataAnalysisTransformation> transformations) {
|
---|
321 | var inputs = new HashSet<string>(oldInputVariables);
|
---|
322 |
|
---|
323 | foreach (var transformation in transformations) {
|
---|
324 | if (inputs.Contains(transformation.OriginalVariable))
|
---|
325 | inputs.Add(transformation.TransformedVariable);
|
---|
326 | }
|
---|
327 |
|
---|
328 | return inputs;
|
---|
329 | }
|
---|
330 |
|
---|
331 | public static IEnumerable<string> RemoveVirtualVariables(IEnumerable<string> variables, IEnumerable<IDataAnalysisTransformation> transformations) {
|
---|
332 | var remainingVariables = new HashSet<string>(variables);
|
---|
333 |
|
---|
334 | var transformationsStack = new Stack<IDataAnalysisTransformation>(transformations);
|
---|
335 |
|
---|
336 | while (transformationsStack.Any()) {
|
---|
337 | var transformation = transformationsStack.Pop();
|
---|
338 |
|
---|
339 |
|
---|
340 | bool transformedVariablePending = transformationsStack.Any(x => x.OriginalVariable == transformation.TransformedVariable);
|
---|
341 | if (!transformedVariablePending)
|
---|
342 | remainingVariables.Remove(transformation.TransformedVariable);
|
---|
343 | }
|
---|
344 |
|
---|
345 | return remainingVariables;
|
---|
346 | }
|
---|
347 | }
|
---|
348 | }
|
---|