Free cookie consent management tool by TermsFeed Policy Generator

source: trunk/sources/HeuristicLab.Data/IntMatrixData.cs @ 846

Last change on this file since 846 was 763, checked in by gkronber, 16 years ago

removed visitor interfaces and methods in HeuristicLab.Data and fixed classes in HeuristicLab.Random to work without visitor methods. #343 (Rethink about usefulness of visitors for ObjectData and Constraints)

File size: 6.5 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.Text;
25using System.Xml;
26using HeuristicLab.Core;
27using System.Globalization;
28
29namespace HeuristicLab.Data {
[737]30  /// <summary>
31  /// A two-dimensional matrix of integer values.
32  /// </summary>
[2]33  public class IntMatrixData : ArrayDataBase {
[737]34    /// <summary>
35    /// Gets or sets the int values of the matrix.
36    /// </summary>
37    /// <remarks>Uses property <see cref="ArrayDataBase.Data"/> of base class <see cref="ArrayDataBase"/>.
38    /// No own data storage present.</remarks>
[2]39    public new int[,] Data {
40      get { return (int[,])base.Data; }
41      set { base.Data = value; }
42    }
43
[737]44    /// <summary>
45    /// Initializes a new instance of <see cref="IntMatrixData"/>.
46    /// </summary>
[2]47    public IntMatrixData() {
48      Data = new int[1, 1];
49    }
[737]50    /// <summary>
51    /// Initializes a new instance of <see cref="IntMatrixData"/>.
52    /// <note type="caution"> No CopyConstructor! <paramref name="data"/> is not copied!</note>
53    /// </summary>
54    /// <param name="data">The two-dimensional int matrix the instance should represent.</param>
[2]55    public IntMatrixData(int[,] data) {
56      Data = data;
57    }
58
[737]59    /// <summary>
60    /// Creates a new instance of <see cref="IntMatrixDataView"/>.
61    /// </summary>
62    /// <returns>The created instance as <see cref="IntMatrixDataView"/>.</returns>
[2]63    public override IView CreateView() {
64      return new IntMatrixDataView(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
74    /// the 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">The dictionary of all already persisted objects.
78    /// (Needed to avoid cycles.)</param>
79    /// <returns>The saved <see cref="XmlNode"/>.</returns>
[2]80    public override XmlNode GetXmlNode(string name, XmlDocument document, IDictionary<Guid,IStorable> persistedObjects) {
81      XmlNode node = base.GetXmlNode(name, document, persistedObjects);
82      XmlAttribute dim1 = document.CreateAttribute("Dimension1");
83      dim1.Value = Data.GetLength(0).ToString(CultureInfo.InvariantCulture.NumberFormat);
84      node.Attributes.Append(dim1);
85      XmlAttribute dim2 = document.CreateAttribute("Dimension2");
86      dim2.Value = Data.GetLength(1).ToString(CultureInfo.InvariantCulture.NumberFormat);
87      node.Attributes.Append(dim2);
88      node.InnerText = ToString(CultureInfo.InvariantCulture.NumberFormat);
89      return node;
90    }
[737]91    /// <summary>
92    /// Loads the persisted int matrix from the specified <paramref name="node"/>.
93    /// </summary>
94    /// <remarks>The dimensions of the matrix must be saved as Attributes
95    /// (<c>Dimension1</c>, <c>Dimension2</c>), formatted in the local number format. <br/>
96    /// The elements of the matrix must be saved in the node's inner text as string,
97    /// each element separated by a semicolon, line by line, formatted according to
98    /// the local number format (see <see cref="GetXmlNode"/>).</remarks>
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      int[,] data = new int[dim1, dim2];
107      for (int i = 0; i < dim1; i++) {
108        for (int j = 0; j < dim2; j++) {
109          data[i, j] = int.Parse(tokens[i * dim2 + j], CultureInfo.InvariantCulture.NumberFormat);
110        }
111      }
112      Data = data;
113    }
114
[737]115    /// <summary>
116    /// The string representation of the matrix.
117    /// </summary>
118    /// <returns>The elements of the matrix as a string, line by line, each element separated by a
119    /// semicolon and formatted according to the local number format.</returns>
[2]120    public override string ToString() {
121      return ToString(CultureInfo.CurrentCulture.NumberFormat);
122    }
123
[737]124    /// <summary>
125    /// The string representation of the matrix, considering a specified <paramref name="format"/>.
126    /// </summary>
127    /// <param name="format">The <see cref="NumberFormatInfo"/> the int values are formatted accordingly.</param>
128    /// <returns>The elements of the matrix as a string, line by line, each element separated by a
129    /// semicolon and formatted according to the specified <paramref name="format"/>.</returns>
[2]130    private string ToString(NumberFormatInfo format) {
131      StringBuilder builder = new StringBuilder();
132      for (int i = 0; i < Data.GetLength(0); i++) {
133        for (int j = 0; j < Data.GetLength(1); j++) {
134          builder.Append(";");
135          builder.Append(Data[i, j].ToString(format));
136        }
137      }
138      if (builder.Length > 0) builder.Remove(0, 1);
139      return builder.ToString();
140    }
141  }
142}
Note: See TracBrowser for help on using the repository browser.