Changeset 1065

Timestamp:

Feb 10, 2008, 11:24:55 PM (16 years ago)

Author:

Peter

Message:

some documentation on matrix

File:

• trunk/yat/utility/matrix.h (modified) (4 diffs)

trunk/yat/utility/matrix.h

@@ -158 +158 @@
 
     /**
+       Iterator iterates along a row. When end of row is reached it
+       jumps to beginning of next row.
+
+       \return iterator pointing to upper-left element.
      */
     iterator begin(void);
 
     /**
+       Iterator iterates along a row. When end of row is reached it
+       jumps to beginning of next row.
+
+       \return const_iterator pointing to upper-left element.
      */
     const_iterator begin(void) const;
 
     /**
-     */
-    iterator begin_column(size_t);
-
-    /**
-     */
-    const_iterator begin_column(size_t) const;
-
-    /**
-     */
-    iterator begin_row(size_t);
-
-    /**
-     */
-    const_iterator begin_row(size_t) const;
+       Iterator iterates along a column.
+
+       \return iterator pointing to first element of column \a i.
+     */
+    iterator begin_column(size_t i);
+
+    /**
+       Iterator iterates along a column.
+
+       \return const_iterator pointing to first element of column \a i.
+     */
+    const_iterator begin_column(size_t i) const;
+
+    /**
+       Iterator iterates along a row.
+
+       \return iterator pointing to first element of row \a i.
+     */
+    iterator begin_row(size_t i);
+
+    /**
+       Iterator iterates along a row.
+
+       \return const_iterator pointing to first element of row \a i.
+     */
+    const_iterator begin_row(size_t i) const;
 
     /**
@@ -190 +210 @@
 
     /**
-     */
-    VectorView column_view(size_t);
-
-    /**
+       \return Vector view of column \a i
+     */
+    VectorView column_view(size_t i);
+
+    /**
+       \return const vector view of column \a i
      */
     const VectorConstView column_const_view(size_t) const;
@@ -212 +234 @@
 
     /**
+       \return iterator pointing to end of matrix
      */
     iterator end(void);
 
     /**
+       \return iterator pointing to end of matrix
      */
     const_iterator end(void) const;
 
     /**
-     */
-    iterator end_column(size_t);
-
-    /**
-     */
-    const_iterator end_column(size_t) const;
-
-    /**
-     */
-    iterator end_row(size_t);
-
-    /**
-     */
-    const_iterator end_row(size_t) const;
+       \return iterator pointing to end of column \a i
+     */
+    iterator end_column(size_t i);
+
+    /**
+       \return const_iterator pointing to end of column \a i
+     */
+    const_iterator end_column(size_t i) const;
+
+    /**
+       \return iterator pointing to end of row \a i
+     */
+    iterator end_row(size_t i);
+
+    /**
+       \return const_iterator pointing to end of row \a i
+     */
+    const_iterator end_row(size_t i) const;
 
     /**
@@ -289 +317 @@
 
     /**
+       \return Vector view of \a i
      */
     VectorView row_view(size_t);
 
     /**
+       \return const vector view of \a i
      */
     const VectorConstView row_const_view(size_t) const;