Ignore:
Timestamp:
Sep 14, 2006, 5:04:17 AM (16 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:
3 edited

Legend:

Unmodified
Added
Removed
  • trunk/c++_tools/utility/Exception.h

    r570 r648  
    3434
    3535  ///
    36   /// @brief Class
     36  /// @brief Class for IO errors
    3737  ///
    3838  class IO_error : public std::runtime_error
    3939  {
    4040  public:
     41    ///
     42    /// Default constructor
     43    ///
    4144    IO_error(void) throw() : std::runtime_error("IO_error:") {}
     45
     46    ///
     47    /// Constructor for exception with message
     48    ///
    4249    IO_error(std::string message) throw()
    4350      : std::runtime_error("IO_error: " + message) {}
  • trunk/c++_tools/utility/NNI.h

    r616 r648  
    111111
    112112  protected:
     113    /** \f$ d_{ij}^2=\frac {\sum_{k=1}^C w_{ik} w_{jk} (x_{ik}-x_{jk})^2
     114       }{\sum_{k=l}^C w_{ik} w_{jk} } \f$ where C is the number of
     115    */ columns
    113116    std::vector<std::pair<u_int,double> > calculate_distances(const u_int) const;
     117    /// Contributing nearest neighbours are added up to the user set
     118    /// number, and neighbours are disqualified if their element
     119    /// (column) weight is zero
    114120    std::vector<u_int> nearest_neighbours(const u_int,
    115121                             const std::vector<std::pair<u_int,double> >&) const;
     122    ///
     123    /// original data matrix
     124    ///
     125    const utility::matrix& data_;
    116126
    117     const utility::matrix& data_;
     127    ///
     128    /// data after imputation
     129    ///
    118130    utility::matrix imputed_data_;
     131
     132    ///
     133    /// number of neighbor to use
     134    ///
    119135    u_int neighbours_;
     136
     137    ///
     138    /// which rows are not imputed due to lack of data
     139    ///
    120140    std::vector<size_t> not_imputed_;
     141
     142    ///
     143    /// weight matrix
     144    ///
    121145    const utility::matrix& weight_;
    122146  };
  • trunk/c++_tools/utility/Option.h

    r601 r648  
    5050    /// @param short_name one character key such as 'h' for -h flag
    5151    /// @param long_name string key such as "help" for --help flag
    52     /// @param telling what kind argument this option expects
     52    /// @param arg telling what kind argument this option expects
    5353    /// @param desc string used in help display
    5454    ///
Note: See TracChangeset for help on using the changeset viewer.