Changeset 1588 for trunk/yat


Ignore:
Timestamp:
Oct 17, 2008, 5:43:15 PM (13 years ago)
Author:
Peter
Message:

cleaning up some docs and includes

Location:
trunk/yat/classifier
Files:
2 edited

Legend:

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

    r1565 r1588  
    6363  /// underlying utility::Matrix. This implies that underlying data is deleted
    6464  /// in destructor of MatrixLookup, but only if there is no other
    65   /// owner of the underlying data. A reference counter is used to
    66   /// keep track of number of owners. Ownership is copied in copy
    67   /// constructors and assignments.
     65  /// owner of the underlying data.
    6866  ///
    6967  /// \see MatrixLookupWeighted
  • trunk/yat/classifier/MatrixLookupWeighted.h

    r1587 r1588  
    2424  along with yat. If not, see <http://www.gnu.org/licenses/>.
    2525*/
    26 
    27 #include "yat/utility/deprecate.h"
    2826
    2927#include "yat/utility/Container2DIterator.h"
     
    4139
    4240namespace utility {
    43   class Matrix;
    4441  class MatrixWeighted;
    4542}
     
    5047
    5148  ///
    52   /// @brief Class viewing into data and weight matrix.
    53   ///
    54   /// A MatrixLookupWeighted is very similar to a MatrixLookup, but
    55   /// contains a pointer to a weight matrix as well meaning each data
    56   /// element is associated to a weight.
    57   ///
    58   /// A MatrixLookupWeighted can be created directly from a utility::Matrix or
    59   /// from another MatrixLookupWeighted. In the latter case, the
    60   /// resulting MatrixLookupWeighted is looking directly into the
    61   /// underlying matrix to avoid multiple lookups.
     49  /// @brief General view into utility::MatrixWeighted
     50  ///
     51  /// A MatrixLookupWeighted can be created directly from a
     52  /// utility::MatrixWeighted or from another MatrixLookupWeighted. In
     53  /// the latter case, the resulting MatrixLookupWeighted is looking
     54  /// directly into the underlying matrix to avoid multiple lookups.
    6255  ///
    6356  /// There is a possibility to set the MatrixLookupWeighted as owner
    64   /// of the underlying matrices (data and weight).
    65   /// This implies that underlying data is deleted
    66   /// in destructor of MatrixLookupWeighted, but only if there is no other
    67   /// owner of the underlying data. A reference counter is used to
    68   /// keep track of number of owners. Ownership is copied in copy
    69   /// constructors and assignments.
     57  /// of the underlying utility::MatrixWeighted.  This implies that
     58  /// underlying data is deleted in destructor of
     59  /// MatrixLookupWeighted, but only if there is no other owner of the
     60  /// underlying data.
     61  ///
     62  /// \see MatrixLookup
    7063  ///
    7164  class MatrixLookupWeighted
     
    8477       \since New in yat 0.5
    8578     */
    86     typedef const utility::DataWeight const_reference;
     79    typedef const utility::DataWeight& const_reference;
    8780
    8881    /// 'Read Only' iterator
Note: See TracChangeset for help on using the changeset viewer.