Free cookie consent management tool by TermsFeed Policy Generator

source: trunk/sources/HeuristicLab.Data/3.2/DoubleMatrixData.cs @ 3155

Last change on this file since 3155 was 1529, checked in by gkronber, 16 years ago

Moved source files of plugins AdvancedOptimizationFrontEnd ... Grid into version-specific sub-folders. #576

File size: 6.9 KB
RevLine 
[2]1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2008 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.Generic;
24using System.Globalization;
25using System.Text;
26using System.Xml;
27using HeuristicLab.Core;
28
29namespace HeuristicLab.Data {
[737]30  /// <summary>
31  /// A two-dimensional matrix consisting of double values.
32  /// </summary>
[2]33  public class DoubleMatrixData : ArrayDataBase {
[737]34    /// <summary>
35    /// Gets or sets the double elements of the matrix.
36    /// </summary>
37    /// <remarks>Uses property <see cref="ArrayDataBase.Data"/> of base
38    /// class <see cref="ArrayDataBase"/>. No own data storage present.</remarks>
[2]39    public new double[,] Data {
40      get { return (double[,])base.Data; }
41      set { base.Data = value; }
42    }
43
[737]44    /// <summary>
45    /// Initializes a new instance of the <see cref="DoubleMatrixData"/> class.
46    /// </summary>
[2]47    public DoubleMatrixData() {
48      Data = new double[1, 1];
49    }
[737]50    /// <summary>
51    /// Initializes a new instance of the <see cref="DoubleMatrixData"/> class.
52    /// <note type="caution"> No CopyConstructor! <paramref name="data"/> is not copied!</note>
53    /// </summary>
54    /// <param name="data">The two-dimensional double matrix the instance should represent.</param>
[2]55    public DoubleMatrixData(double[,] data) {
56      Data = data;
57    }
58
[737]59    /// <summary>
60    /// Creates a new instance of the <see cref="DoubleMatrixDataView"/> class.
61    /// </summary>
62    /// <returns>The created instance as <see cref="DoubleMatrixDataView"/>.</returns>
[2]63    public override IView CreateView() {
64      return new DoubleMatrixDataView(this);
65    }
66
[737]67    /// <summary>
68    /// Saves the current instance as <see cref="XmlNode"/> in the specified <paramref name="document"/>.
69    /// </summary>
70    /// <remarks>The dimensions of the matrix are saved as attributes (<c>Dimension1</c>,<c>Dimension2</c>),
71    /// formatted according to the local culture info and its number format.<br/>
72    /// The elements of the matrix are saved as string in the node's inner text,
73    /// each element separated by a semicolon, all line by line, formatted according to the
74    /// local number format.</remarks>
75    /// <param name="name">The (tag)name of the <see cref="XmlNode"/>.</param>
76    /// <param name="document">The <see cref="XmlDocument"/> where the data is saved.</param>
77    /// <param name="persistedObjects">A dictionary of all already persisted objects. (Needed to avoid cycles.)</param>
78    /// <returns>The saved <see cref="XmlNode"/>.</returns>
[2]79    public override XmlNode GetXmlNode(string name, XmlDocument document, IDictionary<Guid,IStorable> persistedObjects) {
80      XmlNode node = base.GetXmlNode(name, document, persistedObjects);
81      XmlAttribute dim1 = document.CreateAttribute("Dimension1");
82      dim1.Value = Data.GetLength(0).ToString(CultureInfo.InvariantCulture.NumberFormat);
83      node.Attributes.Append(dim1);
84      XmlAttribute dim2 = document.CreateAttribute("Dimension2");
85      dim2.Value = Data.GetLength(1).ToString(CultureInfo.InvariantCulture.NumberFormat);
86      node.Attributes.Append(dim2);
87      node.InnerText = ToString(CultureInfo.InvariantCulture.NumberFormat);
88      return node;
89    }
[737]90    /// <summary>
91    /// Loads the persisted matrix from the specified <paramref name="node"/>.
92    /// </summary>
93    /// <remarks>The dimensions of the matrix must be saved as Attributes (<c>Dimension1</c>, <c>Dimension2</c>),
94    /// formatted in the local number format. <br/>
95    /// The elements of the matrix must be saved in the node's inner text as string,
96    /// each element separated by a semicolon, line by line, formatted according to the local
97    /// culture info and its number format (see <see cref="GetXmlNode"/>).</remarks>
98    /// <exception cref="System.FormatException">Thrown when a saved element cannot be parsed as a double value.</exception>
99    /// <param name="node">The <see cref="XmlNode"/> where the instance is saved.</param>
100    /// <param name="restoredObjects">The dictionary of all already restored objects. (Needed to avoid cycles.)</param>
[2]101    public override void Populate(XmlNode node, IDictionary<Guid,IStorable> restoredObjects) {
102      base.Populate(node, restoredObjects);
103      int dim1 = int.Parse(node.Attributes["Dimension1"].Value, CultureInfo.InvariantCulture.NumberFormat);
104      int dim2 = int.Parse(node.Attributes["Dimension2"].Value, CultureInfo.InvariantCulture.NumberFormat);
105      string[] tokens = node.InnerText.Split(';');
106      double[,] data = new double[dim1, dim2];
107      for (int i = 0; i < dim1; i++) {
108        for (int j = 0; j < dim2; j++) {
109          if(double.TryParse(tokens[i * dim2 + j], NumberStyles.Float, CultureInfo.InvariantCulture.NumberFormat, out data[i, j])==false) {
110            throw new FormatException("Can't parse " + tokens[i * dim2 + j] + " as double value.");
111          }
112        }
113      }
114      Data = data;
115    }
116
[737]117    /// <summary>
118    /// The string representation of the matrix.
119    /// </summary>
120    /// <returns>The elements of the matrix as a string, line by line, each element separated by a
121    /// semicolon and formatted according to local number format.</returns>
[2]122    public override string ToString() {
123      return ToString(CultureInfo.CurrentCulture.NumberFormat);
124    }
[737]125   
126    /// <summary>
127    /// The string representation of the matrix, considering a specified <paramref name="format"/>.
128    /// </summary>
129    /// <param name="format">The <see cref="NumberFormatInfo"/> the double values are formatted accordingly.</param>
130    /// <returns>The elements of the matrix as a string, line by line, each element separated by a
131    /// semicolon and formatted according to the specified <paramref name="format"/>.</returns>
[2]132    private string ToString(NumberFormatInfo format) {
133      StringBuilder builder = new StringBuilder();
134      for (int i = 0; i < Data.GetLength(0); i++) {
135        for (int j = 0; j < Data.GetLength(1); j++) {
136          builder.Append(";");
[344]137          builder.Append(Data[i, j].ToString("r", format));
[2]138        }
139      }
140      if (builder.Length > 0) builder.Remove(0, 1);
141      return builder.ToString();
142    }
143  }
144}
Note: See TracBrowser for help on using the repository browser.