Changeset 1192

Timestamp:

Feb 29, 2008, 8:09:32 PM (16 years ago)

Author:

Peter

Message:

some more docs

Location:

trunk/yat/classifier

Files:

• MatrixLookup.h (modified) (2 diffs)
• MatrixLookupWeighted.h (modified) (4 diffs)

trunk/yat/classifier/MatrixLookup.h

@@ -46 +46 @@
 
   ///
-  /// @brief General view into utility::matrix
+  /// @brief General view into utility::Matrix
   ///
   /// MatrixLookups can be used to create lookups/views into matrices
@@ -71 +71 @@
   /// constructors and assignments.
   ///
+  /// \see MatrixLookupWeighted
+  ///
   class MatrixLookup
   {

trunk/yat/classifier/MatrixLookupWeighted.h

@@ -54 +54 @@
   /// element is associated to a weight.
   ///
-  /// A MatrixLookupWeighted can be created directly from a matrix or
-  /// from an other MatrixLookupWeighted. In the latter case, the
+  /// A MatrixLookupWeighted can be created directly from a utility::Matrix or
+  /// from another MatrixLookupWeighted. In the latter case, the
   /// resulting MatrixLookupWeighted is looking directly into the
   /// underlying matrix to avoid multiple lookups.
@@ -109 +109 @@
     /// for nan's in @a matrix. 
     /// 
-    /// \see  bool utility::nan(const matrix&, matrix&);
+    /// \see  bool utility::nan(const Matrix&, Matrix&);
     ///
     /// @note If @a matrix goes out of scope or
@@ -124 +124 @@
        \note no check for nan is performed.
        
-       \see   bool utility::nan(const matrix&, matrix&);
-       
-       @note If @a matrix goes out of scope or
+       @note If underlying utility::Matrix goes out of scope or
        is deleted, the MatrixLookupWeighted becomes invalid and the
        result of further use is undefined.
@@ -141 +139 @@
     /// weights(row[i],column[j]). This also means that number of
     /// rows in created MatrixLookupWeighted is equal to size of
-    /// vector @a row, and number of columns is equal to size of
-    /// vector @a column.
+    /// @a row, and number of columns is equal to size of @a column.
     ///
     /// @note If @a matrix or @a weights goes out of scope or is deleted, the