source: branches/2435-alglib_3_15/HeuristicLab.Problems.DataAnalysis/3.4/Dataset.cs @ 17034

Last change on this file since 17034 was 17034, checked in by mkommend, 4 months ago

#2435: Updated branch with most recent trunk changes.

File size: 17.3 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2019 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;
24using System.Collections.Generic;
25using System.Collections.ObjectModel;
26using System.Linq;
27using HEAL.Attic;
28using HeuristicLab.Common;
29using HeuristicLab.Core;
30using HeuristicLab.Data;
31
32namespace HeuristicLab.Problems.DataAnalysis {
33  [Item("Dataset", "Represents a dataset containing data that should be analyzed.")]
34  [StorableType("49F4D145-50D7-4497-8D8A-D190CD556CC8")]
35  public class Dataset : NamedItem, IDataset {
36    [StorableConstructor]
37    protected Dataset(StorableConstructorFlag _) : base(_) { }
38    protected Dataset(Dataset original, Cloner cloner)
39      : base(original, cloner) {
40      // no need to clone the variable values because these can't be modified
41      variableValues = new Dictionary<string, IList>(original.variableValues);
42      variableNames = new List<string>(original.variableNames);
43      rows = original.rows;
44    }
45
46    public override IDeepCloneable Clone(Cloner cloner) { return new Dataset(this, cloner); }
47
48    public Dataset()
49      : base() {
50      Name = "-";
51      VariableNames = Enumerable.Empty<string>();
52      variableValues = new Dictionary<string, IList>();
53      rows = 0;
54    }
55
56    /// <summary>
57    /// Creates a new dataset. The variableValues are not cloned.
58    /// </summary>
59    /// <param name="variableNames">The names of the variables in the dataset</param>
60    /// <param name="variableValues">The values for the variables (column-oriented storage). Values are not cloned!</param>
61    public Dataset(IEnumerable<string> variableNames, IEnumerable<IList> variableValues)
62      : this(variableNames, variableValues, cloneValues: true) {
63    }
64
65    protected Dataset(IEnumerable<string> variableNames, IEnumerable<IList> variableValues, bool cloneValues = false) {
66      Name = "-";
67
68      if (variableNames.Any()) {
69        this.variableNames = new List<string>(variableNames);
70      } else {
71        this.variableNames = Enumerable.Range(0, variableValues.Count()).Select(x => "Column " + x).ToList();
72      }
73      // check if the arguments are consistent (no duplicate variables, same number of rows, correct data types, ...)
74      CheckArguments(this.variableNames, variableValues);
75
76      rows = variableValues.First().Count;
77
78      if (cloneValues) {
79        this.variableValues = CloneValues(this.variableNames, variableValues);
80      } else {
81        this.variableValues = new Dictionary<string, IList>(this.variableNames.Count);
82        for (int i = 0; i < this.variableNames.Count; i++) {
83          var variableName = this.variableNames[i];
84          var values = variableValues.ElementAt(i);
85          this.variableValues.Add(variableName, values);
86        }
87      }
88    }
89
90    public Dataset(IEnumerable<string> variableNames, double[,] variableValues) {
91      Name = "-";
92      if (variableNames.Count() != variableValues.GetLength(1)) {
93        throw new ArgumentException("Number of variable names doesn't match the number of columns of variableValues");
94      }
95      if (variableNames.Distinct().Count() != variableNames.Count()) {
96        var duplicateVariableNames = variableNames.GroupBy(v => v).Where(g => g.Count() > 1).Select(g => g.Key).ToList();
97        string message = "The dataset cannot contain duplicate variables names: " + Environment.NewLine;
98        foreach (var duplicateVariableName in duplicateVariableNames)
99          message += duplicateVariableName + Environment.NewLine;
100        throw new ArgumentException(message);
101      }
102
103      rows = variableValues.GetLength(0);
104      this.variableNames = new List<string>(variableNames);
105
106      this.variableValues = new Dictionary<string, IList>(variableValues.GetLength(1));
107      for (int col = 0; col < variableValues.GetLength(1); col++) {
108        string columName = this.variableNames[col];
109        var values = new List<double>(variableValues.GetLength(0));
110        for (int row = 0; row < variableValues.GetLength(0); row++) {
111          values.Add(variableValues[row, col]);
112        }
113        this.variableValues.Add(columName, values);
114      }
115    }
116
117    public static Dataset FromRowData(IEnumerable<string> variableNames, double[,] data) {
118      var colWise = new List<IList>(data.GetLength(1));
119      for (var col = 0; col < data.GetLength(1); col++) {
120        var column = new List<double>(data.GetLength(0));
121        for (var row = 0; row < data.GetLength(0); row++) {
122          column.Add(data[row, col]);
123        }
124        colWise.Add(column);
125      }
126      return new Dataset(variableNames, colWise);
127    }
128
129    public static Dataset FromRowData(IEnumerable<string> variableNames, IEnumerable<IList> data) {
130      var vnames = variableNames.ToList();
131      var transposed = new List<IList>();
132      var iter = data.GetEnumerator();
133      if (!iter.MoveNext()) throw new ArgumentException("Data does not contain any rows", nameof(data));
134      for (var i = 0; i < iter.Current.Count; i++) {
135        if (i >= vnames.Count) throw new ArgumentException("There are more variables in data, than variable names.", nameof(variableNames));
136        if (iter.Current[i] == null) throw new ArgumentException("Null values are not supported.", nameof(data));
137        if (!IsAllowedType(iter.Current[i].GetType())) throw new ArgumentException("Data contains types that are not allowed.", nameof(data));
138        if (iter.Current[i] is double d)
139          transposed.Add(new List<double>() { d });
140        else if (iter.Current[i] is DateTime dt)
141          transposed.Add(new List<DateTime>() { dt });
142        else if (iter.Current[i] is string s)
143          transposed.Add(new List<string>() { s });
144        else throw new NotSupportedException(string.Format("Variable {0} has type {1}. This is not supported when converting from row-wise data.", vnames[i], iter.Current[i].GetType()));
145      }
146      if (transposed.Count < vnames.Count) throw new ArgumentException("There are less variables in data, than variable names.", nameof(variableNames));
147      while (iter.MoveNext()) {
148        for (var i = 0; i < iter.Current.Count; i++)
149          if (transposed[i].Add(iter.Current[i]) < 0)
150            throw new ArgumentException(string.Format("Variable {0} has invalid value ({1})", vnames[i], iter.Current[i]), nameof(data));
151      }
152      return new Dataset(vnames, transposed);
153    }
154
155    public ModifiableDataset ToModifiable() {
156      return new ModifiableDataset(variableNames, variableNames.Select(v => variableValues[v]), true);
157    }
158
159    /// <summary>
160    /// Shuffle a dataset's rows
161    /// </summary>
162    /// <param name="random">Random number generator used for shuffling.</param>
163    /// <returns>A shuffled copy of the current dataset.</returns>
164    public Dataset Shuffle(IRandom random) {
165      var values = variableNames.Select(x => variableValues[x]).ToList();
166      return new Dataset(variableNames, values.ShuffleLists(random));
167    }
168
169
170
171    #region Backwards compatible code, remove with 3.5
172    private double[,] storableData;
173    //name alias used to support backwards compatibility
174    [Storable(OldName = "data")]
175    private double[,] StorableData { set { storableData = value; } }
176
177    [StorableHook(HookType.AfterDeserialization)]
178    private void AfterDeserialization() {
179      if (variableValues == null) {
180        rows = storableData.GetLength(0);
181        variableValues = new Dictionary<string, IList>();
182        for (int col = 0; col < storableData.GetLength(1); col++) {
183          string columName = variableNames[col];
184          var values = new List<double>(rows);
185          for (int row = 0; row < rows; row++) {
186            values.Add(storableData[row, col]);
187          }
188          variableValues.Add(columName, values);
189        }
190        storableData = null;
191      }
192    }
193    #endregion
194
195    [Storable(Name = "VariableValues")]
196    protected Dictionary<string, IList> variableValues;
197
198    protected List<string> variableNames;
199    [Storable]
200    public IEnumerable<string> VariableNames {
201      get { return variableNames; }
202      protected set {
203        if (variableNames != null) throw new InvalidOperationException();
204        variableNames = new List<string>(value);
205      }
206    }
207
208    public bool ContainsVariable(string variableName) {
209      return variableValues.ContainsKey(variableName);
210    }
211    public IEnumerable<string> DoubleVariables {
212      get { return variableValues.Where(p => p.Value is IList<double>).Select(p => p.Key); }
213    }
214
215    public IEnumerable<string> StringVariables {
216      get { return variableValues.Where(p => p.Value is IList<string>).Select(p => p.Key); }
217    }
218
219    public IEnumerable<string> DateTimeVariables {
220      get { return variableValues.Where(p => p.Value is IList<DateTime>).Select(p => p.Key); }
221    }
222
223    public IEnumerable<double> GetDoubleValues(string variableName) {
224      return GetValues<double>(variableName);
225    }
226    public IEnumerable<string> GetStringValues(string variableName) {
227      return GetValues<string>(variableName);
228    }
229    public IEnumerable<DateTime> GetDateTimeValues(string variableName) {
230      return GetValues<DateTime>(variableName);
231    }
232
233    public ReadOnlyCollection<double> GetReadOnlyDoubleValues(string variableName) {
234      var values = GetValues<double>(variableName);
235      return new ReadOnlyCollection<double>(values);
236    }
237    public double GetDoubleValue(string variableName, int row) {
238      var values = GetValues<double>(variableName);
239      return values[row];
240    }
241    public IEnumerable<double> GetDoubleValues(string variableName, IEnumerable<int> rows) {
242      return GetValues<double>(variableName, rows);
243    }
244
245    public string GetStringValue(string variableName, int row) {
246      var values = GetValues<string>(variableName);
247      return values[row];
248    }
249
250    public IEnumerable<string> GetStringValues(string variableName, IEnumerable<int> rows) {
251      return GetValues<string>(variableName, rows);
252    }
253    public ReadOnlyCollection<string> GetReadOnlyStringValues(string variableName) {
254      var values = GetValues<string>(variableName);
255      return new ReadOnlyCollection<string>(values);
256    }
257
258    public DateTime GetDateTimeValue(string variableName, int row) {
259      var values = GetValues<DateTime>(variableName);
260      return values[row];
261    }
262    public IEnumerable<DateTime> GetDateTimeValues(string variableName, IEnumerable<int> rows) {
263      return GetValues<DateTime>(variableName, rows);
264    }
265    public ReadOnlyCollection<DateTime> GetReadOnlyDateTimeValues(string variableName) {
266      var values = GetValues<DateTime>(variableName);
267      return new ReadOnlyCollection<DateTime>(values);
268    }
269    private IEnumerable<T> GetValues<T>(string variableName, IEnumerable<int> rows) {
270      var values = GetValues<T>(variableName);
271      return rows.Select(x => values[x]);
272    }
273    private IList<T> GetValues<T>(string variableName) {
274      IList list;
275      if (!variableValues.TryGetValue(variableName, out list))
276        throw new ArgumentException("The variable " + variableName + " does not exist in the dataset.");
277      IList<T> values = list as IList<T>;
278      if (values == null) throw new ArgumentException("The variable " + variableName + " is not a " + typeof(T) + " variable.");
279      return values;
280    }
281    public bool VariableHasType<T>(string variableName) {
282      return variableValues[variableName] is IList<T>;
283    }
284    protected Type GetVariableType(string variableName) {
285      IList list;
286      variableValues.TryGetValue(variableName, out list);
287      if (list == null)
288        throw new ArgumentException("The variable " + variableName + " does not exist in the dataset.");
289      return GetElementType(list);
290    }
291    protected static Type GetElementType(IList list) {
292      var type = list.GetType();
293      return type.IsGenericType ? type.GetGenericArguments()[0] : type.GetElementType();
294    }
295    protected static bool IsAllowedType(IList list) {
296      var type = GetElementType(list);
297      return IsAllowedType(type);
298    }
299    protected static bool IsAllowedType(Type type) {
300      return type == typeof(double) || type == typeof(string) || type == typeof(DateTime);
301    }
302
303    protected static void CheckArguments(IEnumerable<string> variableNames, IEnumerable<IList> variableValues) {
304      if (variableNames.Count() != variableValues.Count()) {
305        throw new ArgumentException("Number of variable names doesn't match the number of columns of variableValues");
306      } else if (!variableValues.All(list => list.Count == variableValues.First().Count)) {
307        throw new ArgumentException("The number of values must be equal for every variable");
308      } else if (variableNames.Distinct().Count() != variableNames.Count()) {
309        var duplicateVariableNames =
310          variableNames.GroupBy(v => v).Where(g => g.Count() > 1).Select(g => g.Key).ToList();
311        string message = "The dataset cannot contain duplicate variables names: " + Environment.NewLine;
312        foreach (var duplicateVariableName in duplicateVariableNames)
313          message += duplicateVariableName + Environment.NewLine;
314        throw new ArgumentException(message);
315      }
316      // check if all the variables are supported
317      foreach (var t in variableNames.Zip(variableValues, Tuple.Create)) {
318        var variableName = t.Item1;
319        var values = t.Item2;
320
321        if (!IsAllowedType(values)) {
322          throw new ArgumentException(string.Format("Unsupported type {0} for variable {1}.", GetElementType(values), variableName));
323        }
324      }
325    }
326
327    protected static Dictionary<string, IList> CloneValues(Dictionary<string, IList> variableValues) {
328      return variableValues.ToDictionary(x => x.Key, x => CloneValues(x.Value));
329    }
330
331    protected static Dictionary<string, IList> CloneValues(IEnumerable<string> variableNames, IEnumerable<IList> variableValues) {
332      return variableNames.Zip(variableValues, Tuple.Create).ToDictionary(x => x.Item1, x => CloneValues(x.Item2));
333    }
334
335    protected static IList CloneValues(IList values) {
336      var doubleValues = values as IList<double>;
337      if (doubleValues != null) return new List<double>(doubleValues);
338
339      var stringValues = values as IList<string>;
340      if (stringValues != null) return new List<string>(stringValues);
341
342      var dateTimeValues = values as IList<DateTime>;
343      if (dateTimeValues != null) return new List<DateTime>(dateTimeValues);
344
345      throw new ArgumentException(string.Format("Unsupported variable type {0}.", GetElementType(values)));
346    }
347
348    #region IStringConvertibleMatrix Members
349    [Storable]
350    private int rows;
351    public int Rows {
352      get { return rows; }
353      protected set { rows = value; }
354    }
355    int IStringConvertibleMatrix.Rows {
356      get { return Rows; }
357      set { throw new NotSupportedException(); }
358    }
359
360    public int Columns {
361      get { return variableNames.Count; }
362    }
363    int IStringConvertibleMatrix.Columns {
364      get { return Columns; }
365      set { throw new NotSupportedException(); }
366    }
367    bool IStringConvertibleMatrix.SortableView {
368      get { return false; }
369      set { throw new NotSupportedException(); }
370    }
371    bool IStringConvertibleMatrix.ReadOnly {
372      get { return true; }
373    }
374    IEnumerable<string> IStringConvertibleMatrix.ColumnNames {
375      get { return this.VariableNames; }
376      set { throw new NotSupportedException(); }
377    }
378    IEnumerable<string> IStringConvertibleMatrix.RowNames {
379      get { return Enumerable.Empty<string>(); }
380      set { throw new NotSupportedException(); }
381    }
382    string IStringConvertibleMatrix.GetValue(int rowIndex, int columnIndex) {
383      return variableValues[variableNames[columnIndex]][rowIndex].ToString();
384    }
385    bool IStringConvertibleMatrix.SetValue(string value, int rowIndex, int columnIndex) {
386      throw new NotSupportedException();
387    }
388    bool IStringConvertibleMatrix.Validate(string value, out string errorMessage) {
389      throw new NotSupportedException();
390    }
391
392    public virtual event EventHandler ColumnsChanged { add { } remove { } }
393    public virtual event EventHandler RowsChanged { add { } remove { } }
394    public virtual event EventHandler ColumnNamesChanged { add { } remove { } }
395    public virtual event EventHandler RowNamesChanged { add { } remove { } }
396    public virtual event EventHandler SortableViewChanged { add { } remove { } }
397    public virtual event EventHandler<EventArgs<int, int>> ItemChanged { add { } remove { } }
398    public virtual event EventHandler Reset { add { } remove { } }
399    #endregion
400  }
401}
Note: See TracBrowser for help on using the repository browser.