Changeset 322

Timestamp:

May 26, 2005, 10:50:05 PM (16 years ago)

Author:

Peter

Message:

made arguments const and added some doc

Location:

trunk/lib/svm

Files:

• Kernel_MEV.h (modified) (3 diffs)
• Kernel_SEV.h (modified) (3 diffs)

trunk/lib/svm/Kernel_MEV.h

@@ -12 +12 @@
 
   ///
+  ///   @brief Memory Efficient Kernel
   ///   Class taking care of the \f$NxN\f$ kernel matrix, where
   ///   \f$N\f$ is number of samples. Type of Kernel is defined by a
-  ///   KernelFunction. This Memory Efficient Versions (SEV) does not
+  ///   KernelFunction. This Memory Efficient Version (MEV) does not
   ///   store the kernel matrix in memory, but calculates each element
-  ///   when it is needed.
+  ///   when it is needed. When memory allows do always use Kernel_SEV
+  ///   instead.
   ///   
   ///   @see also Kernel_SEV
@@ -35 +37 @@
     
     ///
+    ///   @todo
     ///   Constructor taking the \a data matrix, the KernelFunction and a
     ///   \a weight matrix as input. Each column in the data matrix
     ///   corresponds to one sample.
-    ///   @todo
     Kernel_MEV(const gslapi::matrix& data, const KernelFunction&, 
                const gslapi::matrix& weight);
@@ -51 +53 @@
     /// matrix
     ///
-    virtual double operator()(size_t row,size_t column) const;
+    virtual double operator()(const size_t row,const size_t column) const;
 
     ///

trunk/lib/svm/Kernel_SEV.h

@@ -14 +14 @@
 
   ///
+  ///   @brief Speed Efficient Kernel
   ///   Class taking care of the \f$NxN\f$ kernel matrix, where
   ///   \f$N\f$ is number of samples. Type of Kernel is defined by a
-  ///   KernelFunction. This Speed Efficient Versions (SEV) calculated
-  ///   the kernel matrix once and the kernel is stored in memory.
+  ///   KernelFunction. This Speed Efficient Version (SEV) calculated
+  ///   the kernel matrix once and the kernel is stored in
+  ///   memory. When \f$N\f$ is large and the kernel matrix cannot be
+  ///   stored in memory, use Kernel_MEV instead.
   ///   
   ///   @see also Kernel_MEV
@@ -32 +35 @@
     Kernel_SEV(const gslapi::matrix&, const KernelFunction&);
     
+    ///
+    /// @todo
+    /// Copy constructor
+    ///
     Kernel_SEV(const Kernel_SEV&);
 
@@ -40 +47 @@
 
     ///
-    /// @return element at position (\a row, \a column) of the Kernel
+    /// @return element at position (\a row, \a column) in the Kernel
     /// matrix
     ///
-    inline double operator()(size_t row,size_t column) const
+    inline double operator()(const size_t row,const size_t column) const
     { return kernel_(row,column); }