Changeset 1187 for trunk/yat/statistics


Ignore:
Timestamp:
Feb 28, 2008, 10:06:54 PM (13 years ago)
Author:
Peter
Message:

minor docs issues fixed

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/yat/statistics/AveragerPair.h

    r1186 r1187  
    7171
    7272    /**
     73       \brief Concordence correlation coefficient.
     74
    7375       \f$ \frac{\sum_i (x_i-m_x)(y_i-m_y)}{\sum_i
    7476       (x_i-m_x)^2+\sum_i (y_i-m_y)^2 + n(m_x-m_y)^2} \f$
    7577       
    76        @return Concordence correlation coefficient.
    7778    */
    7879    double ccc(void) const;
    7980
    80     ///
    81     /// \f$ \frac{\sum_i (x_i-m_x)(y_i-m_y)}{\sqrt{\sum_i
    82     /// (x_i-m_x)^2\sum_i (y_i-m_y)^2}} \f$
    83     ///
    84     /// @return %Pearson correlation coefficient.
    85     ///
     81    /**
     82      \f$ \frac{\sum_i (x_i-m_x)(y_i-m_y)}{\sqrt{\sum_i
     83      (x_i-m_x)^2\sum_i (y_i-m_y)^2}} \f$
     84       
     85       \return %Pearson correlation coefficient.
     86    */
    8687    double correlation(void) const;
    8788 
     
    100101    double mean_xy(void) const;
    101102
    102     ///
    103     /// @return Average squared deviation between x and y \f$
    104     /// \frac{1}{N} \sum (x-y)^2 \f$
    105     ///
     103    /**
     104       \return Average squared deviation between x and y \f$
     105      \frac{1}{N} \sum (x-y)^2 \f$
     106    */
    106107    double msd(void) const;
    107108
     
    121122    double sum_xy(void) const;
    122123
    123     ///
    124     /// @return Sum of squared deviation between x and y \f$
    125     /// \sum (x-y)^2 \f$
    126     ///
     124    /**
     125       \return Sum of squared deviation between x and y \f$
     126      \sum (x-y)^2 \f$
     127    */
    127128    double sum_squared_deviation(void) const;
    128129
Note: See TracChangeset for help on using the changeset viewer.