source: trunk/sources/HeuristicLab.Problems.DataAnalysis/3.4/Dataset.cs @ 10406

Last change on this file since 10406 was 10406, checked in by mkommend, 6 years ago

#2145: Adapted type checks in the Dataset ctors.

File size: 10.6 KB
Line 
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
22using System;
23using System.Collections;
24using System.Collections.Generic;
25using System.Collections.ObjectModel;
26using System.Linq;
27using HeuristicLab.Common;
28using HeuristicLab.Core;
29using HeuristicLab.Data;
30using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
31
32namespace HeuristicLab.Problems.DataAnalysis {
33  [Item("Dataset", "Represents a dataset containing data that should be analyzed.")]
34  [StorableClass]
35  public sealed class Dataset : NamedItem, IStringConvertibleMatrix {
36    [StorableConstructor]
37    private Dataset(bool deserializing) : base(deserializing) { }
38    private Dataset(Dataset original, Cloner cloner)
39      : base(original, cloner) {
40      variableValues = new Dictionary<string, IList>(original.variableValues);
41      variableNames = new List<string>(original.variableNames);
42      rows = original.rows;
43    }
44    public override IDeepCloneable Clone(Cloner cloner) { return new Dataset(this, cloner); }
45
46    public Dataset()
47      : base() {
48      Name = "-";
49      VariableNames = Enumerable.Empty<string>();
50      variableValues = new Dictionary<string, IList>();
51      rows = 0;
52    }
53
54    public Dataset(IEnumerable<string> variableNames, IEnumerable<IList> variableValues)
55      : base() {
56      Name = "-";
57      if (!variableNames.Any()) {
58        this.variableNames = Enumerable.Range(0, variableValues.Count()).Select(x => "Column " + x).ToList();
59      } else if (variableNames.Count() != variableValues.Count()) {
60        throw new ArgumentException("Number of variable names doesn't match the number of columns of variableValues");
61      } else if (!variableValues.All(list => list.Count == variableValues.First().Count)) {
62        throw new ArgumentException("The number of values must be equal for every variable");
63      } else if (variableNames.Distinct().Count() != variableNames.Count()) {
64        var duplicateVariableNames =
65          variableNames.GroupBy(v => v).Where(g => g.Count() > 1).Select(g => g.Key).ToList();
66        string message = "The dataset cannot contain duplicate variables names: " + Environment.NewLine;
67        foreach (var duplicateVariableName in duplicateVariableNames)
68          message += duplicateVariableName + Environment.NewLine;
69        throw new ArgumentException(message);
70      }
71
72      rows = variableValues.First().Count;
73      this.variableNames = new List<string>(variableNames);
74      this.variableValues = new Dictionary<string, IList>(this.variableNames.Count);
75      for (int i = 0; i < this.variableNames.Count; i++) {
76        var values = variableValues.ElementAt(i);
77        IList clonedValues = null;
78        if (values is IList<double>)
79          clonedValues = new List<double>(values.Cast<double>());
80        else if (values is IList<string>)
81          clonedValues = new List<string>(values.Cast<string>());
82        else if (values is IList<DateTime>)
83          clonedValues = new List<DateTime>(values.Cast<DateTime>());
84        else {
85          this.variableNames = new List<string>();
86          this.variableValues = new Dictionary<string, IList>();
87          throw new ArgumentException("The variable values must be of type IList<double>, IList<string> or IList<DateTime>");
88        }
89        this.variableValues.Add(this.variableNames[i], clonedValues);
90      }
91    }
92
93    public Dataset(IEnumerable<string> variableNames, double[,] variableValues) {
94      Name = "-";
95      if (variableNames.Count() != variableValues.GetLength(1)) {
96        throw new ArgumentException("Number of variable names doesn't match the number of columns of variableValues");
97      }
98      if (variableNames.Distinct().Count() != variableNames.Count()) {
99        var duplicateVariableNames = variableNames.GroupBy(v => v).Where(g => g.Count() > 1).Select(g => g.Key).ToList();
100        string message = "The dataset cannot contain duplicate variables names: " + Environment.NewLine;
101        foreach (var duplicateVariableName in duplicateVariableNames)
102          message += duplicateVariableName + Environment.NewLine;
103        throw new ArgumentException(message);
104      }
105
106      rows = variableValues.GetLength(0);
107      this.variableNames = new List<string>(variableNames);
108
109      this.variableValues = new Dictionary<string, IList>(variableValues.GetLength(1));
110      for (int col = 0; col < variableValues.GetLength(1); col++) {
111        string columName = this.variableNames[col];
112        var values = new List<double>(variableValues.GetLength(0));
113        for (int row = 0; row < variableValues.GetLength(0); row++) {
114          values.Add(variableValues[row, col]);
115        }
116        this.variableValues.Add(columName, values);
117      }
118    }
119
120    #region Backwards compatible code, remove with 3.5
121    private double[,] storableData;
122    //name alias used to suppport backwards compatibility
123    [Storable(Name = "data", AllowOneWay = true)]
124    private double[,] StorableData { set { storableData = value; } }
125
126    [StorableHook(HookType.AfterDeserialization)]
127    private void AfterDeserialization() {
128      if (variableValues == null) {
129        rows = storableData.GetLength(0);
130        variableValues = new Dictionary<string, IList>();
131        for (int col = 0; col < storableData.GetLength(1); col++) {
132          string columName = variableNames[col];
133          var values = new List<double>(rows);
134          for (int row = 0; row < rows; row++) {
135            values.Add(storableData[row, col]);
136          }
137          variableValues.Add(columName, values);
138        }
139        storableData = null;
140      }
141    }
142    #endregion
143
144    [Storable(Name = "VariableValues")]
145    private Dictionary<string, IList> variableValues;
146
147    private List<string> variableNames;
148    [Storable]
149    public IEnumerable<string> VariableNames {
150      get { return variableNames; }
151      private set {
152        if (variableNames != null) throw new InvalidOperationException();
153        variableNames = new List<string>(value);
154      }
155    }
156
157    public IEnumerable<string> DoubleVariables {
158      get { return variableValues.Where(p => p.Value is List<double>).Select(p => p.Key); }
159    }
160
161    public IEnumerable<double> GetDoubleValues(string variableName) {
162      IList list;
163      if (!variableValues.TryGetValue(variableName, out list))
164        throw new ArgumentException("The variable " + variableName + " does not exist in the dataset.");
165      List<double> values = list as List<double>;
166      if (values == null) throw new ArgumentException("The variable " + variableName + " is not a double variable.");
167
168      //mkommend yield return used to enable lazy evaluation
169      foreach (double value in values)
170        yield return value;
171    }
172    public ReadOnlyCollection<double> GetReadOnlyDoubleValues(string variableName) {
173      IList list;
174      if (!variableValues.TryGetValue(variableName, out list))
175        throw new ArgumentException("The variable " + variableName + " does not exist in the dataset.");
176      List<double> values = list as List<double>;
177      if (values == null) throw new ArgumentException("The variable " + variableName + " is not a double variable.");
178      return values.AsReadOnly();
179    }
180    public double GetDoubleValue(string variableName, int row) {
181      IList list;
182      if (!variableValues.TryGetValue(variableName, out list))
183        throw new ArgumentException("The variable " + variableName + " does not exist in the dataset.");
184      List<double> values = list as List<double>;
185      if (values == null) throw new ArgumentException("The variable " + variableName + " is not a double variable.");
186      return values[row];
187    }
188    public IEnumerable<double> GetDoubleValues(string variableName, IEnumerable<int> rows) {
189      IList list;
190      if (!variableValues.TryGetValue(variableName, out list))
191        throw new ArgumentException("The variable " + variableName + " does not exist in the dataset.");
192      List<double> values = list as List<double>;
193      if (values == null) throw new ArgumentException("The variable " + variableName + " is not a double variable.");
194
195      return rows.Select(index => values[index]);
196    }
197
198    #region IStringConvertibleMatrix Members
199    [Storable]
200    private int rows;
201    public int Rows {
202      get { return rows; }
203      set { throw new NotSupportedException(); }
204    }
205    public int Columns {
206      get { return variableNames.Count; }
207      set { throw new NotSupportedException(); }
208    }
209
210    public bool SortableView {
211      get { return false; }
212      set { throw new NotSupportedException(); }
213    }
214    public bool ReadOnly {
215      get { return true; }
216    }
217
218    IEnumerable<string> IStringConvertibleMatrix.ColumnNames {
219      get { return this.VariableNames; }
220      set { throw new NotSupportedException(); }
221    }
222    IEnumerable<string> IStringConvertibleMatrix.RowNames {
223      get { return Enumerable.Empty<string>(); }
224      set { throw new NotSupportedException(); }
225    }
226
227    public string GetValue(int rowIndex, int columnIndex) {
228      return variableValues[variableNames[columnIndex]][rowIndex].ToString();
229    }
230    public bool SetValue(string value, int rowIndex, int columnIndex) {
231      throw new NotSupportedException();
232    }
233    public bool Validate(string value, out string errorMessage) {
234      throw new NotSupportedException();
235    }
236
237    public event EventHandler ColumnsChanged { add { } remove { } }
238    public event EventHandler RowsChanged { add { } remove { } }
239    public event EventHandler ColumnNamesChanged { add { } remove { } }
240    public event EventHandler RowNamesChanged { add { } remove { } }
241    public event EventHandler SortableViewChanged { add { } remove { } }
242    public event EventHandler<EventArgs<int, int>> ItemChanged { add { } remove { } }
243    public event EventHandler Reset { add { } remove { } }
244    #endregion
245  }
246}
Note: See TracBrowser for help on using the repository browser.