Free cookie consent management tool by TermsFeed Policy Generator

source: branches/HeuristicLab.Hive_Milestone3/sources/HeuristicLab.Data/3.3/DoubleMatrixData.cs @ 3155

Last change on this file since 3155 was 1853, checked in by epitzer, 16 years ago

Fix EmptyStorableClass attributes. (#603)

File size: 3.7 KB
Line 
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;
28using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
29
30namespace HeuristicLab.Data {
31  /// <summary>
32  /// A two-dimensional matrix consisting of double values.
33  /// </summary>
34  [EmptyStorableClass]
35  public class DoubleMatrixData : ArrayDataBase {
36    /// <summary>
37    /// Gets or sets the double elements of the matrix.
38    /// </summary>
39    /// <remarks>Uses property <see cref="ArrayDataBase.Data"/> of base
40    /// class <see cref="ArrayDataBase"/>. No own data storage present.</remarks>
41    public new double[,] Data {
42      get { return (double[,])base.Data; }
43      set { base.Data = value; }
44    }
45
46    /// <summary>
47    /// Initializes a new instance of the <see cref="DoubleMatrixData"/> class.
48    /// </summary>
49    public DoubleMatrixData() {
50      Data = new double[1, 1];
51    }
52    /// <summary>
53    /// Initializes a new instance of the <see cref="DoubleMatrixData"/> class.
54    /// <note type="caution"> No CopyConstructor! <paramref name="data"/> is not copied!</note>
55    /// </summary>
56    /// <param name="data">The two-dimensional double matrix the instance should represent.</param>
57    public DoubleMatrixData(double[,] data) {
58      Data = data;
59    }
60
61    /// <summary>
62    /// Creates a new instance of the <see cref="DoubleMatrixDataView"/> class.
63    /// </summary>
64    /// <returns>The created instance as <see cref="DoubleMatrixDataView"/>.</returns>
65    public override IView CreateView() {
66      return new DoubleMatrixDataView(this);
67    }
68
69    /// <summary>
70    /// The string representation of the matrix.
71    /// </summary>
72    /// <returns>The elements of the matrix as a string, line by line, each element separated by a
73    /// semicolon and formatted according to local number format.</returns>
74    public override string ToString() {
75      return ToString(CultureInfo.CurrentCulture.NumberFormat);
76    }
77   
78    /// <summary>
79    /// The string representation of the matrix, considering a specified <paramref name="format"/>.
80    /// </summary>
81    /// <param name="format">The <see cref="NumberFormatInfo"/> the double values are formatted accordingly.</param>
82    /// <returns>The elements of the matrix as a string, line by line, each element separated by a
83    /// semicolon and formatted according to the specified <paramref name="format"/>.</returns>
84    private string ToString(NumberFormatInfo format) {
85      StringBuilder builder = new StringBuilder();
86      for (int i = 0; i < Data.GetLength(0); i++) {
87        for (int j = 0; j < Data.GetLength(1); j++) {
88          builder.Append(";");
89          builder.Append(Data[i, j].ToString("r", format));
90        }
91      }
92      if (builder.Length > 0) builder.Remove(0, 1);
93      return builder.ToString();
94    }
95  }
96}
Note: See TracBrowser for help on using the repository browser.