Changeset 648 for trunk/c++_tools/utility

Timestamp:

Sep 14, 2006, 5:04:17 AM (17 years ago)

Author:

Peter

Message:

fixes #133 removed all errors reported from Doxygen. Only one error left which says Index is not documented but I don't want it to be documented actually we use the Doxygens preprocessor to skip documenting that class, yet Doxygen complains that class is not documented huh. Only solution would be to move that class to its own file and not keep it together with SVM.

Location:

trunk/c++_tools/utility

Files:

• Exception.h (modified) (1 diff)
• NNI.h (modified) (1 diff)
• Option.h (modified) (1 diff)

trunk/c++_tools/utility/Exception.h

@@ -34 +34 @@
 
   ///
-  /// @brief Class
+  /// @brief Class for IO errors
   ///
   class IO_error : public std::runtime_error
   {
   public:
+    /// 
+    /// Default constructor
+    ///
     IO_error(void) throw() : std::runtime_error("IO_error:") {}
+
+    ///
+    /// Constructor for exception with message
+    ///
     IO_error(std::string message) throw()
       : std::runtime_error("IO_error: " + message) {}

trunk/c++_tools/utility/NNI.h

@@ -111 +111 @@
 
   protected:
+    /** \f$ d_{ij}^2=\frac {\sum_{k=1}^C w_{ik} w_{jk} (x_{ik}-x_{jk})^2
+       }{\sum_{k=l}^C w_{ik} w_{jk} } \f$ where C is the number of
+    */ columns
     std::vector<std::pair<u_int,double> > calculate_distances(const u_int) const;
+    /// Contributing nearest neighbours are added up to the user set
+    /// number, and neighbours are disqualified if their element
+    /// (column) weight is zero
     std::vector<u_int> nearest_neighbours(const u_int,
                              const std::vector<std::pair<u_int,double> >&) const;
+    ///
+    /// original data matrix
+    ///
+    const utility::matrix& data_;
 
-    const utility::matrix& data_;
+    ///
+    /// data after imputation
+    ///
     utility::matrix imputed_data_;
+
+    ///
+    /// number of neighbor to use
+    ///
     u_int neighbours_;
+
+    ///
+    /// which rows are not imputed due to lack of data
+    ///
     std::vector<size_t> not_imputed_;
+
+    ///
+    /// weight matrix
+    ///
     const utility::matrix& weight_;
   };

trunk/c++_tools/utility/Option.h

@@ -50 +50 @@
     /// @param short_name one character key such as 'h' for -h flag
     /// @param long_name string key such as "help" for --help flag
-    /// @param telling what kind argument this option expects
+    /// @param arg telling what kind argument this option expects
     /// @param desc string used in help display
     ///