Changeset 1192 for trunk/yat


Ignore:
Timestamp:
Feb 29, 2008, 8:09:32 PM (13 years ago)
Author:
Peter
Message:

some more docs

Location:
trunk/yat/classifier
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • trunk/yat/classifier/MatrixLookup.h

    r1191 r1192  
    4646
    4747  ///
    48   /// @brief General view into utility::matrix
     48  /// @brief General view into utility::Matrix
    4949  ///
    5050  /// MatrixLookups can be used to create lookups/views into matrices
     
    7171  /// constructors and assignments.
    7272  ///
     73  /// \see MatrixLookupWeighted
     74  ///
    7375  class MatrixLookup
    7476  {
  • trunk/yat/classifier/MatrixLookupWeighted.h

    r1170 r1192  
    5454  /// element is associated to a weight.
    5555  ///
    56   /// A MatrixLookupWeighted can be created directly from a matrix or
    57   /// from an other MatrixLookupWeighted. In the latter case, the
     56  /// A MatrixLookupWeighted can be created directly from a utility::Matrix or
     57  /// from another MatrixLookupWeighted. In the latter case, the
    5858  /// resulting MatrixLookupWeighted is looking directly into the
    5959  /// underlying matrix to avoid multiple lookups.
     
    109109    /// for nan's in @a matrix.
    110110    ///
    111     /// \see  bool utility::nan(const matrix&, matrix&);
     111    /// \see  bool utility::nan(const Matrix&, Matrix&);
    112112    ///
    113113    /// @note If @a matrix goes out of scope or
     
    124124       \note no check for nan is performed.
    125125       
    126        \see   bool utility::nan(const matrix&, matrix&);
    127        
    128        @note If @a matrix goes out of scope or
     126       @note If underlying utility::Matrix goes out of scope or
    129127       is deleted, the MatrixLookupWeighted becomes invalid and the
    130128       result of further use is undefined.
     
    141139    /// weights(row[i],column[j]). This also means that number of
    142140    /// rows in created MatrixLookupWeighted is equal to size of
    143     /// vector @a row, and number of columns is equal to size of
    144     /// vector @a column.
     141    /// @a row, and number of columns is equal to size of @a column.
    145142    ///
    146143    /// @note If @a matrix or @a weights goes out of scope or is deleted, the
Note: See TracChangeset for help on using the changeset viewer.