Changeset 811 for trunk/yat/utility

Timestamp:

Mar 16, 2007, 2:00:31 AM (15 years ago)

Author:

Peter

Message:

dox

Location:

trunk/yat/utility

Files:

• matrix.h (modified) (1 diff)
• vector.h (modified) (1 diff)

trunk/yat/utility/matrix.h

@@ -202 +202 @@
     void mul(const matrix& b);
 
-    ///
-    /// @brief Resize matrix
-    ///
-    /// All elements are set to @a init_value.
-    ///
+    /**
+       \brief Resize matrix
+       
+       All elements are set to @a init_value.
+
+       \note underlying GSL matrix is destroyed and a view into this
+       matrix becomes invalid.
+    */
     void resize(size_t, size_t, double init_value=0);
 

trunk/yat/utility/vector.h

@@ -267 +267 @@
     void mul(const vector& other);
 
-    ///
-    /// @brief Resize vector
-    ///
-    /// All elements are set to @a init_value.
-    ///
+    /**
+       @brief Resize vector
+       
+       All elements are set to @a init_value.
+
+       \note Underlying GSL vector is destroyed and a view into this
+       vector becomes invalid.
+    */
     void resize(size_t, double init_value=0);