Changeset 737 for trunk/sources/HeuristicLab.Data/DoubleMatrixData.cs

Timestamp:

11/12/08 13:10:09 (15 years ago)

Author:

vdorfer

Message:

Created API documentation for HeuristLab.Data namespace (#331)

File:

• trunk/sources/HeuristicLab.Data/DoubleMatrixData.cs (modified) (4 diffs)

trunk/sources/HeuristicLab.Data/DoubleMatrixData.cs

@@ -28 +28 @@
 
 namespace HeuristicLab.Data {
+  /// <summary>
+  /// A two-dimensional matrix consisting of double values.
+  /// </summary>
   public class DoubleMatrixData : ArrayDataBase {
+    /// <summary>
+    /// Gets or sets the double elements of the matrix.
+    /// </summary>
+    /// <remarks>Uses property <see cref="ArrayDataBase.Data"/> of base 
+    /// class <see cref="ArrayDataBase"/>. No own data storage present.</remarks>
     public new double[,] Data {
       get { return (double[,])base.Data; }
@@ -34 +42 @@
     }
 
+    /// <summary>
+    /// Initializes a new instance of the <see cref="DoubleMatrixData"/> class.
+    /// </summary>
     public DoubleMatrixData() {
       Data = new double[1, 1];
     }
+    /// <summary>
+    /// Initializes a new instance of the <see cref="DoubleMatrixData"/> class.
+    /// <note type="caution"> No CopyConstructor! <paramref name="data"/> is not copied!</note>
+    /// </summary>
+    /// <param name="data">The two-dimensional double matrix the instance should represent.</param>
     public DoubleMatrixData(double[,] data) {
       Data = data;
     }
 
+    /// <summary>
+    /// Creates a new instance of the <see cref="DoubleMatrixDataView"/> class.
+    /// </summary>
+    /// <returns>The created instance as <see cref="DoubleMatrixDataView"/>.</returns>
     public override IView CreateView() {
       return new DoubleMatrixDataView(this);
     }
 
+    /// <summary>
+    /// Saves the current instance as <see cref="XmlNode"/> in the specified <paramref name="document"/>.
+    /// </summary>
+    /// <remarks>The dimensions of the matrix are saved as attributes (<c>Dimension1</c>,<c>Dimension2</c>), 
+    /// formatted according to the local culture info and its number format.<br/>
+    /// The elements of the matrix are saved as string in the node's inner text, 
+    /// each element separated by a semicolon, all line by line, formatted according to the 
+    /// local number format.</remarks>
+    /// <param name="name">The (tag)name of the <see cref="XmlNode"/>.</param>
+    /// <param name="document">The <see cref="XmlDocument"/> where the data is saved.</param>
+    /// <param name="persistedObjects">A dictionary of all already persisted objects. (Needed to avoid cycles.)</param>
+    /// <returns>The saved <see cref="XmlNode"/>.</returns>
     public override XmlNode GetXmlNode(string name, XmlDocument document, IDictionary<Guid,IStorable> persistedObjects) {
       XmlNode node = base.GetXmlNode(name, document, persistedObjects);
@@ -56 +88 @@
       return node;
     }
+    /// <summary>
+    /// Loads the persisted matrix from the specified <paramref name="node"/>.
+    /// </summary>
+    /// <remarks>The dimensions of the matrix must be saved as Attributes (<c>Dimension1</c>, <c>Dimension2</c>),
+    /// formatted in the local number format. <br/>
+    /// The elements of the matrix must be saved in the node's inner text as string, 
+    /// each element separated by a semicolon, line by line, formatted according to the local 
+    /// culture info and its number format (see <see cref="GetXmlNode"/>).</remarks>
+    /// <exception cref="System.FormatException">Thrown when a saved element cannot be parsed as a double value.</exception>
+    /// <param name="node">The <see cref="XmlNode"/> where the instance is saved.</param>
+    /// <param name="restoredObjects">The dictionary of all already restored objects. (Needed to avoid cycles.)</param>
     public override void Populate(XmlNode node, IDictionary<Guid,IStorable> restoredObjects) {
       base.Populate(node, restoredObjects);
@@ -72 +115 @@
     }
 
+    /// <summary>
+    /// The string representation of the matrix.
+    /// </summary>
+    /// <returns>The elements of the matrix as a string, line by line, each element separated by a 
+    /// semicolon and formatted according to local number format.</returns>
     public override string ToString() {
       return ToString(CultureInfo.CurrentCulture.NumberFormat);
     }
-
+    
+    /// <summary>
+    /// The string representation of the matrix, considering a specified <paramref name="format"/>.
+    /// </summary>
+    /// <param name="format">The <see cref="NumberFormatInfo"/> the double values are formatted accordingly.</param>
+    /// <returns>The elements of the matrix as a string, line by line, each element separated by a 
+    /// semicolon and formatted according to the specified <paramref name="format"/>.</returns>
     private string ToString(NumberFormatInfo format) {
       StringBuilder builder = new StringBuilder();