Changeset 1588 for trunk/yat/classifier

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:

• MatrixLookup.h (modified) (1 diff)
• MatrixLookupWeighted.h (modified) (4 diffs)

trunk/yat/classifier/MatrixLookup.h

@@ -63 +63 @@
   /// underlying utility::Matrix. This implies that underlying data is deleted
   /// in destructor of MatrixLookup, but only if there is no other
-  /// owner of the underlying data. A reference counter is used to
-  /// keep track of number of owners. Ownership is copied in copy
-  /// constructors and assignments.
+  /// owner of the underlying data. 
   ///
   /// \see MatrixLookupWeighted

trunk/yat/classifier/MatrixLookupWeighted.h

@@ -24 +24 @@
   along with yat. If not, see <http://www.gnu.org/licenses/>.
 */
-
-#include "yat/utility/deprecate.h"
 
 #include "yat/utility/Container2DIterator.h"
@@ -41 +39 @@
 
 namespace utility {
-  class Matrix;
   class MatrixWeighted;
 }
@@ -50 +47 @@
 
   ///
-  /// @brief Class viewing into data and weight matrix.
-  ///
-  /// A MatrixLookupWeighted is very similar to a MatrixLookup, but
-  /// contains a pointer to a weight matrix as well meaning each data
-  /// element is associated to a weight.
-  ///
-  /// 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.
+  /// @brief General view into utility::MatrixWeighted
+  ///
+  /// A MatrixLookupWeighted can be created directly from a
+  /// utility::MatrixWeighted or from another MatrixLookupWeighted. In
+  /// the latter case, the resulting MatrixLookupWeighted is looking
+  /// directly into the underlying matrix to avoid multiple lookups.
   ///
   /// There is a possibility to set the MatrixLookupWeighted as owner
-  /// of the underlying matrices (data and weight). 
-  /// This implies that underlying data is deleted
-  /// in destructor of MatrixLookupWeighted, but only if there is no other
-  /// owner of the underlying data. A reference counter is used to
-  /// keep track of number of owners. Ownership is copied in copy
-  /// constructors and assignments.
+  /// of the underlying utility::MatrixWeighted.  This implies that
+  /// underlying data is deleted in destructor of
+  /// MatrixLookupWeighted, but only if there is no other owner of the
+  /// underlying data.
+  ///
+  /// \see MatrixLookup
   ///
   class MatrixLookupWeighted
@@ -84 +77 @@
        \since New in yat 0.5
      */
-    typedef const utility::DataWeight const_reference;
+    typedef const utility::DataWeight& const_reference;
 
     /// 'Read Only' iterator