Changeset 966 for trunk/yat/classifier


Ignore:
Timestamp:
Oct 11, 2007, 7:01:01 PM (14 years ago)
Author:
Peter
Message:

fixing some doxygen warnings

Location:
trunk/yat/classifier
Files:
6 edited

Legend:

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

    r882 r966  
    5050  public:
    5151
     52    /// 'Read Only' iterator
    5253    typedef utility::Iterator<const double, const classifier::DataLookup1D>
    5354    const_iterator;
     
    9899
    99100    /**
     101       \return 'Read Only' iterator to first element.
    100102     */
    101103    const_iterator begin() const;
    102104
    103105    /**
     106       \return 'Read Only' iterator to end of DataLookup1D.
    104107     */
    105108    const_iterator end() const;
  • trunk/yat/classifier/DataLookupWeighted1D.h

    r890 r966  
    4747  public:
    4848   
     49    /// 'Read Only' Iterator
    4950    typedef utility::IteratorWeighted<const double, const classifier::DataLookupWeighted1D>
    5051    const_iterator;
     
    7778
    7879    /**
     80       \return 'Read Only' iterator to beginning of DataLookupWeighted1D.
    7981     */
    8082    const_iterator begin() const;
     
    8688   
    8789    /**
     90       \return 'Read Only' iterator to end of DataLookupWeighted1D.
    8891     */
    8992    const_iterator end() const;
  • trunk/yat/classifier/MatrixLookup.h

    r916 r966  
    7575    ///
    7676    /// Constructor creating a lookup into the entire @a matrix.
     77    /// \param matrix underlying matrix
    7778    /// @param own if true MatrixLookup owns its underlying @a matrix
    7879    ///
  • trunk/yat/classifier/SVM.h

    r964 r966  
    8787    /// large C means the training will be focused on getting samples
    8888    /// correctly classified, with risk for overfitting and poor
    89     /// generalisation. A too small C will result in a training where
     89    /// generalisation. A too small C will result in a training in which
    9090    /// misclassifications are not penalized. C is weighted with
    9191    /// respect to the size, so \f$ n_+C_+ = n_-C_- \f$, meaning a
     
    106106    long int max_epochs(void) const;
    107107   
    108     /*
     108    /**
    109109      \brief set maximal number of epochs in training
    110110    */
  • trunk/yat/classifier/SVindex.h

    r865 r966  
    3737namespace classifier { 
    3838
    39 #ifndef DOXYGEN_SHOULD_SKIP_THIS
    40   /// @internal Class keeping track of which samples are support vectors and
     39  ///
     40  /// Internal Class keeping track of which samples are support vectors and
    4141  /// not. The first nof_sv elements in the vector are indices of the
    4242  /// support vectors
     
    4646
    4747  public:
    48     //Default Contructor
     48    ///Default Contructor
    4949    SVindex();
    5050
    51     //
     51    /// Constructor
    5252    SVindex(const size_t);
    5353
    54     // @return index_first
     54    /// @return index_first
    5555    size_t index_first(void) const;
    5656
    57     // @return index_second
     57    /// @return index_second
    5858    size_t index_second(void) const;
    5959
    60     // synch the object against alpha
     60    /// synch the object against alpha
    6161    void init(const utility::vector& alpha, const double);
    6262
    63     // @return nof support vectors
     63    /// @return nof support vectors
    6464    size_t nof_sv(void) const;
    6565
    66     // making first to an nsv. If already sv, nothing happens.
     66    /// making first to an nsv. If already sv, nothing happens.
    6767    void nsv_first(void);
    6868
    69     // making second to an nsv. If already sv, nothing happens.
     69    /// making second to an nsv. If already sv, nothing happens.
    7070    void nsv_second(void);   
    7171
    72     // randomizes the nsv part of vector and sets index_first to
    73     // nof_sv_ (the first nsv)
     72    /// randomizes the nsv part of vector and sets index_first to
     73    /// nof_sv_ (the first nsv)
    7474    void shuffle(void);
    7575
    76     // @return nof samples
     76    /// @return nof samples
    7777    size_t size(void) const;
    7878
    79     // making first to a sv. If already sv, nothing happens.
     79    /// making first to a sv. If already sv, nothing happens.
    8080    void sv_first(void);
    8181
    82     // making second to a sv. If already sv, nothing happens.
     82    /// making second to a sv. If already sv, nothing happens.
    8383    void sv_second(void);
    8484
    85     //
    86     void update_first(const size_t);
     85    /// set index_first to \a i
     86    void update_first(const size_t i);
    8787
    88     //
    89     void update_second(const size_t);
     88    /// set index_second to \a i
     89    void update_second(const size_t i);
    9090
    91     // @return value_first
     91    /// @return value_first
    9292    size_t value_first(void) const;
    9393
    94     // @return const ref value_second
     94    /// @return value_second
    9595    size_t value_second(void) const;
    9696
     97    /// \return index \a i (if i<nof_sv() index is sv)
    9798    size_t operator()(size_t i) const;
    9899
     
    106107   
    107108  };
    108 #endif /* DOXYGEN_SHOULD_SKIP_THIS */
    109109
    110110}}} // of namespace classifier, yat, and theplu
  • trunk/yat/classifier/Sampler.h

    r865 r966  
    4747    ///
    4848    /// @param target used to balance partitions
    49     /// @param Number of partitions
     49    /// @param N Number of partitions
    5050    ///
    5151    Sampler(const Target& target, size_t N);
Note: See TracChangeset for help on using the changeset viewer.