1 | #region License Information
|
---|
2 | /* HeuristicLab
|
---|
3 | * Copyright (C) 2002-2013 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 | public IFixedValueParameter<Dataset> DatasetParameter {
|
---|
44 | get { return (IFixedValueParameter<Dataset>)Parameters[DatasetParameterName]; }
|
---|
45 | }
|
---|
46 | public IFixedValueParameter<ReadOnlyCheckedItemList<StringValue>> InputVariablesParameter {
|
---|
47 | get { return (IFixedValueParameter<ReadOnlyCheckedItemList<StringValue>>)Parameters[InputVariablesParameterName]; }
|
---|
48 | }
|
---|
49 | public IFixedValueParameter<IntRange> TrainingPartitionParameter {
|
---|
50 | get { return (IFixedValueParameter<IntRange>)Parameters[TrainingPartitionParameterName]; }
|
---|
51 | }
|
---|
52 | public IFixedValueParameter<IntRange> TestPartitionParameter {
|
---|
53 | get { return (IFixedValueParameter<IntRange>)Parameters[TestPartitionParameterName]; }
|
---|
54 | }
|
---|
55 | public IFixedValueParameter<ReadOnlyItemList<ITransformation>> TransformationsParameter {
|
---|
56 | get { return (IFixedValueParameter<ReadOnlyItemList<ITransformation>>)Parameters[TransformationsParameterName]; }
|
---|
57 | }
|
---|
58 | #endregion
|
---|
59 |
|
---|
60 | #region properties
|
---|
61 | protected bool isEmpty = false;
|
---|
62 | public bool IsEmpty {
|
---|
63 | get { return isEmpty; }
|
---|
64 | }
|
---|
65 | public Dataset Dataset {
|
---|
66 | get { return DatasetParameter.Value; }
|
---|
67 | }
|
---|
68 | public ICheckedItemList<StringValue> InputVariables {
|
---|
69 | get { return InputVariablesParameter.Value; }
|
---|
70 | }
|
---|
71 | public IEnumerable<string> AllowedInputVariables {
|
---|
72 | get { return InputVariables.CheckedItems.Select(x => x.Value.Value); }
|
---|
73 | }
|
---|
74 |
|
---|
75 | public IntRange TrainingPartition {
|
---|
76 | get { return TrainingPartitionParameter.Value; }
|
---|
77 | }
|
---|
78 | public IntRange TestPartition {
|
---|
79 | get { return TestPartitionParameter.Value; }
|
---|
80 | }
|
---|
81 |
|
---|
82 | public virtual IEnumerable<int> TrainingIndices {
|
---|
83 | get {
|
---|
84 | return Enumerable.Range(TrainingPartition.Start, Math.Max(0, TrainingPartition.End - TrainingPartition.Start))
|
---|
85 | .Where(IsTrainingSample);
|
---|
86 | }
|
---|
87 | }
|
---|
88 | public virtual IEnumerable<int> TestIndices {
|
---|
89 | get {
|
---|
90 | return Enumerable.Range(TestPartition.Start, Math.Max(0, TestPartition.End - TestPartition.Start))
|
---|
91 | .Where(IsTestSample);
|
---|
92 | }
|
---|
93 | }
|
---|
94 |
|
---|
95 | public IEnumerable<ITransformation> Transformations {
|
---|
96 | get { return TransformationsParameter.Value; }
|
---|
97 | }
|
---|
98 |
|
---|
99 | public virtual bool IsTrainingSample(int index) {
|
---|
100 | return index >= 0 && index < Dataset.Rows &&
|
---|
101 | TrainingPartition.Start <= index && index < TrainingPartition.End &&
|
---|
102 | (index < TestPartition.Start || TestPartition.End <= index);
|
---|
103 | }
|
---|
104 |
|
---|
105 | public virtual bool IsTestSample(int index) {
|
---|
106 | return index >= 0 && index < Dataset.Rows &&
|
---|
107 | TestPartition.Start <= index && index < TestPartition.End;
|
---|
108 | }
|
---|
109 | #endregion
|
---|
110 |
|
---|
111 | protected DataAnalysisProblemData(DataAnalysisProblemData original, Cloner cloner)
|
---|
112 | : base(original, cloner) {
|
---|
113 | isEmpty = original.isEmpty;
|
---|
114 | RegisterEventHandlers();
|
---|
115 | }
|
---|
116 | [StorableConstructor]
|
---|
117 | protected DataAnalysisProblemData(bool deserializing) : base(deserializing) { }
|
---|
118 |
|
---|
119 | [StorableHook(HookType.AfterDeserialization)]
|
---|
120 | private void AfterDeserialization() {
|
---|
121 | if (!Parameters.ContainsKey(TransformationsParameterName)) {
|
---|
122 | Parameters.Add(new FixedValueParameter<ReadOnlyItemList<ITransformation>>(TransformationsParameterName, "", new ItemList<ITransformation>().AsReadOnly()));
|
---|
123 | TransformationsParameter.Hidden = true;
|
---|
124 | }
|
---|
125 | RegisterEventHandlers();
|
---|
126 | }
|
---|
127 |
|
---|
128 | protected DataAnalysisProblemData(Dataset dataset, IEnumerable<string> allowedInputVariables, IEnumerable<ITransformation> transformations) {
|
---|
129 | if (dataset == null) throw new ArgumentNullException("The dataset must not be null.");
|
---|
130 | if (allowedInputVariables == null) throw new ArgumentNullException("The allowedInputVariables must not be null.");
|
---|
131 |
|
---|
132 | if (allowedInputVariables.Except(dataset.DoubleVariables).Any())
|
---|
133 | throw new ArgumentException("All allowed input variables must be present in the dataset and of type double.");
|
---|
134 |
|
---|
135 | if (transformations == null) throw new ArgumentNullException("The transformations must not be null.");
|
---|
136 |
|
---|
137 | var inputVariables = new CheckedItemList<StringValue>(dataset.DoubleVariables.Select(x => new StringValue(x)));
|
---|
138 | foreach (StringValue x in inputVariables)
|
---|
139 | inputVariables.SetItemCheckedState(x, allowedInputVariables.Contains(x.Value));
|
---|
140 |
|
---|
141 | int trainingPartitionStart = 0;
|
---|
142 | int trainingPartitionEnd = dataset.Rows / 2;
|
---|
143 | int testPartitionStart = dataset.Rows / 2;
|
---|
144 | int testPartitionEnd = dataset.Rows;
|
---|
145 |
|
---|
146 | var transformationsList = new ItemList<ITransformation>(transformations);
|
---|
147 |
|
---|
148 | Parameters.Add(new FixedValueParameter<Dataset>(DatasetParameterName, "", dataset));
|
---|
149 | Parameters.Add(new FixedValueParameter<ReadOnlyCheckedItemList<StringValue>>(InputVariablesParameterName, "", inputVariables.AsReadOnly()));
|
---|
150 | Parameters.Add(new FixedValueParameter<IntRange>(TrainingPartitionParameterName, "", new IntRange(trainingPartitionStart, trainingPartitionEnd)));
|
---|
151 | Parameters.Add(new FixedValueParameter<IntRange>(TestPartitionParameterName, "", new IntRange(testPartitionStart, testPartitionEnd)));
|
---|
152 | Parameters.Add(new FixedValueParameter<ReadOnlyItemList<ITransformation>>(TransformationsParameterName, "", transformationsList.AsReadOnly()));
|
---|
153 |
|
---|
154 | TransformationsParameter.Hidden = true;
|
---|
155 |
|
---|
156 | ((ValueParameter<Dataset>)DatasetParameter).ReactOnValueToStringChangedAndValueItemImageChanged = false;
|
---|
157 | RegisterEventHandlers();
|
---|
158 | }
|
---|
159 |
|
---|
160 | private void RegisterEventHandlers() {
|
---|
161 | DatasetParameter.ValueChanged += new EventHandler(Parameter_ValueChanged);
|
---|
162 | InputVariables.CheckedItemsChanged += new CollectionItemsChangedEventHandler<IndexedItem<StringValue>>(InputVariables_CheckedItemsChanged);
|
---|
163 | TrainingPartition.ValueChanged += new EventHandler(Parameter_ValueChanged);
|
---|
164 | TestPartition.ValueChanged += new EventHandler(Parameter_ValueChanged);
|
---|
165 | TransformationsParameter.ValueChanged += new EventHandler(Parameter_ValueChanged);
|
---|
166 | }
|
---|
167 |
|
---|
168 | private void InputVariables_CheckedItemsChanged(object sender, CollectionItemsChangedEventArgs<IndexedItem<StringValue>> e) {
|
---|
169 | OnChanged();
|
---|
170 | }
|
---|
171 |
|
---|
172 | private void Parameter_ValueChanged(object sender, EventArgs e) {
|
---|
173 | OnChanged();
|
---|
174 | }
|
---|
175 |
|
---|
176 | public event EventHandler Changed;
|
---|
177 | protected virtual void OnChanged() {
|
---|
178 | var listeners = Changed;
|
---|
179 | if (listeners != null) listeners(this, EventArgs.Empty);
|
---|
180 | }
|
---|
181 |
|
---|
182 | protected virtual bool IsProblemDataCompatible(IDataAnalysisProblemData problemData, out string errorMessage) {
|
---|
183 | errorMessage = string.Empty;
|
---|
184 | if (problemData == null) throw new ArgumentNullException("problemData", "The provided problemData is null.");
|
---|
185 |
|
---|
186 | //check allowed input variables
|
---|
187 | StringBuilder message = new StringBuilder();
|
---|
188 | var variables = new HashSet<string>(problemData.InputVariables.Select(x => x.Value));
|
---|
189 | foreach (var item in AllowedInputVariables) {
|
---|
190 | if (!variables.Contains(item))
|
---|
191 | message.AppendLine("Input variable '" + item + "' is not present in the new problem data.");
|
---|
192 | }
|
---|
193 |
|
---|
194 | if (message.Length != 0) {
|
---|
195 | errorMessage = message.ToString();
|
---|
196 | return false;
|
---|
197 | }
|
---|
198 | return true;
|
---|
199 |
|
---|
200 | }
|
---|
201 |
|
---|
202 | public virtual void AdjustProblemDataProperties(IDataAnalysisProblemData problemData) {
|
---|
203 | DataAnalysisProblemData data = problemData as DataAnalysisProblemData;
|
---|
204 | if (data == null) throw new ArgumentException("The problem data is not a data analysis problem data. Instead a " + problemData.GetType().GetPrettyName() + " was provided.", "problemData");
|
---|
205 |
|
---|
206 | string errorMessage;
|
---|
207 | if (!data.IsProblemDataCompatible(this, out errorMessage)) {
|
---|
208 | throw new InvalidOperationException(errorMessage);
|
---|
209 | }
|
---|
210 |
|
---|
211 | foreach (var inputVariable in InputVariables) {
|
---|
212 | var variable = data.InputVariables.FirstOrDefault(i => i.Value == inputVariable.Value);
|
---|
213 | InputVariables.SetItemCheckedState(inputVariable, variable != null && data.InputVariables.ItemChecked(variable));
|
---|
214 | }
|
---|
215 |
|
---|
216 | TrainingPartition.Start = TrainingPartition.End = 0;
|
---|
217 | TestPartition.Start = 0;
|
---|
218 | TestPartition.End = Dataset.Rows;
|
---|
219 | }
|
---|
220 | }
|
---|
221 | }
|
---|