Free cookie consent management tool by TermsFeed Policy Generator

source: stable/HeuristicLab.Problems.DataAnalysis/3.4/ModifiableDataset.cs @ 15982

Last change on this file since 15982 was 15584, checked in by swagner, 7 years ago

#2640: Updated year of copyrights in license headers on stable

File size: 8.6 KB
Line 
1#region License Information
2
3/* HeuristicLab
4 * Copyright (C) 2002-2018 Heuristic and Evolutionary Algorithms Laboratory (HEAL)
5 *
6 * This file is part of HeuristicLab.
7 *
8 * HeuristicLab is free software: you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation, either version 3 of the License, or
11 * (at your option) any later version.
12 *
13 * HeuristicLab is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with HeuristicLab. If not, see <http://www.gnu.org/licenses/>.
20 */
21
22#endregion
23
24using System;
25using System.Collections;
26using System.Collections.Generic;
27using System.Linq;
28using HeuristicLab.Common;
29using HeuristicLab.Core;
30using HeuristicLab.Data;
31using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
32
33namespace HeuristicLab.Problems.DataAnalysis {
34  [Item("ModifiableDataset", "Represents a dataset containing data that should be analyzed, which can be modified by adding or replacing variables and values.")]
35  [StorableClass]
36  public sealed class ModifiableDataset : Dataset, IStringConvertibleMatrix {
37    [StorableConstructor]
38    private ModifiableDataset(bool deserializing) : base(deserializing) { }
39
40    private ModifiableDataset(ModifiableDataset original, Cloner cloner) : base(original, cloner) {
41      var variables = variableValues.Keys.ToList();
42      foreach (var v in variables) {
43        var type = GetVariableType(v);
44        if (type == typeof(DateTime)) {
45          variableValues[v] = GetDateTimeValues(v).ToList();
46        } else if (type == typeof(double)) {
47          variableValues[v] = GetDoubleValues(v).ToList();
48        } else if (type == typeof(string)) {
49          variableValues[v] = GetStringValues(v).ToList();
50        } else {
51          throw new ArgumentException("Unsupported type " + type + " for variable " + v);
52        }
53      }
54    }
55    public override IDeepCloneable Clone(Cloner cloner) { return new ModifiableDataset(this, cloner); }
56    public ModifiableDataset() : base() { }
57
58    public ModifiableDataset(IEnumerable<string> variableNames, IEnumerable<IList> variableValues) : base(variableNames, variableValues) { }
59
60    public void ReplaceRow(int row, IEnumerable<object> values) {
61      var list = values.ToList();
62      if (list.Count != variableNames.Count)
63        throw new ArgumentException("The number of values must be equal to the number of variable names.");
64      // check if all the values are of the correct type
65      for (int i = 0; i < list.Count; ++i) {
66        if (list[i].GetType() != GetVariableType(variableNames[i])) {
67          throw new ArgumentException("The type of the provided value does not match the variable type.");
68        }
69      }
70      // replace values
71      for (int i = 0; i < list.Count; ++i) {
72        variableValues[variableNames[i]][row] = list[i];
73      }
74      OnReset();
75    }
76
77    public void ReplaceVariable(string variableName, IList values) {
78      if (!variableValues.ContainsKey(variableName))
79        throw new ArgumentException(string.Format("Variable {0} is not present in the dataset.", variableName));
80      if (values.Count != variableValues[variableName].Count)
81        throw new ArgumentException("The number of values must coincide with the number of dataset rows.");
82      if (GetVariableType(variableName) != values[0].GetType())
83        throw new ArgumentException("The type of the provided value does not match the variable type.");
84      variableValues[variableName] = values;
85    }
86
87    public void AddRow(IEnumerable<object> values) {
88      var list = values.ToList();
89      if (list.Count != variableNames.Count)
90        throw new ArgumentException("The number of values must be equal to the number of variable names.");
91      // check if all the values are of the correct type
92      for (int i = 0; i < list.Count; ++i) {
93        if (list[i].GetType() != GetVariableType(variableNames[i])) {
94          throw new ArgumentException("The type of the provided value does not match the variable type.");
95        }
96      }
97      // add values
98      for (int i = 0; i < list.Count; ++i) {
99        variableValues[variableNames[i]].Add(list[i]);
100      }
101      rows++;
102      OnRowsChanged();
103      OnReset();
104    }
105
106    // adds a new variable to the dataset
107    public void AddVariable<T>(string variableName, IEnumerable<T> values) {
108      if (variableValues.ContainsKey(variableName))
109        throw new ArgumentException("Variable " + variableName + " is already present in the dataset.");
110      int count = values.Count();
111      if (count != rows)
112        throw new ArgumentException("The number of values must exactly match the number of rows in the dataset.");
113      variableValues[variableName] = new List<T>(values);
114      variableNames.Add(variableName);
115      OnColumnsChanged();
116      OnColumnNamesChanged();
117      OnReset();
118    }
119
120    public void RemoveVariable(string variableName) {
121      if (!variableValues.ContainsKey(variableName))
122        throw new ArgumentException("The variable " + variableName + " does not exist in the dataset.");
123      variableValues.Remove(variableName);
124      variableNames.Remove(variableName);
125      OnColumnsChanged();
126      OnColumnNamesChanged();
127      OnReset();
128    }
129
130    // slow, avoid to use this
131    public void RemoveRow(int row) {
132      foreach (var list in variableValues.Values)
133        list.RemoveAt(row);
134      rows--;
135      OnRowsChanged();
136      OnReset();
137    }
138
139    public void SetVariableValue(object value, string variableName, int row) {
140      IList list;
141      variableValues.TryGetValue(variableName, out list);
142      if (list == null)
143        throw new ArgumentException("The variable " + variableName + " does not exist in the dataset.");
144      if (row < 0 || list.Count < row)
145        throw new ArgumentOutOfRangeException("Invalid row value");
146      if (GetVariableType(variableName) != value.GetType())
147        throw new ArgumentException("The type of the provided value does not match the variable type.");
148
149      list[row] = value;
150      OnItemChanged(row, variableNames.IndexOf(variableName));
151    }
152
153    private Type GetVariableType(string variableName) {
154      IList list;
155      variableValues.TryGetValue(variableName, out list);
156      if (list == null)
157        throw new ArgumentException("The variable " + variableName + " does not exist in the dataset.");
158      return list.GetType().GetGenericArguments()[0];
159    }
160
161    bool IStringConvertibleMatrix.SetValue(string value, int rowIndex, int columnIndex) {
162      var variableName = variableNames[columnIndex];
163      // if value represents a double
164      double dv;
165      if (double.TryParse(value, out dv)) {
166        SetVariableValue(dv, variableName, rowIndex);
167        return true;
168      }
169      // if value represents a DateTime object
170      DateTime dt;
171      if (DateTime.TryParse(value, out dt)) {
172        SetVariableValue(dt, variableName, rowIndex);
173        return true;
174      }
175      // if value is simply a string
176      SetVariableValue(value, variableName, rowIndex);
177      return true;
178    }
179
180    bool IStringConvertibleMatrix.Validate(string value, out string errorMessage) {
181      errorMessage = string.Empty;
182      return true;
183    }
184
185    #region event handlers
186    public override event EventHandler RowsChanged;
187    private void OnRowsChanged() {
188      var handler = RowsChanged;
189      if (handler != null)
190        handler(this, EventArgs.Empty);
191    }
192
193    public override event EventHandler ColumnsChanged;
194    private void OnColumnsChanged() {
195      var handler = ColumnsChanged;
196      if (handler != null)
197        handler(this, EventArgs.Empty);
198    }
199
200    public override event EventHandler ColumnNamesChanged;
201    private void OnColumnNamesChanged() {
202      var handler = ColumnNamesChanged;
203      if (handler != null)
204        handler(this, EventArgs.Empty);
205    }
206
207    public override event EventHandler Reset;
208    private void OnReset() {
209      var handler = Reset;
210      if (handler != null)
211        handler(this, EventArgs.Empty);
212    }
213
214    public override event EventHandler<EventArgs<int, int>> ItemChanged;
215    private void OnItemChanged(int rowIndex, int columnIndex) {
216      var handler = ItemChanged;
217      if (handler != null) {
218        handler(this, new EventArgs<int, int>(rowIndex, columnIndex));
219      }
220    }
221    #endregion
222  }
223}
Note: See TracBrowser for help on using the repository browser.