Changeset 673


Ignore:
Timestamp:
Oct 7, 2006, 11:00:05 AM (15 years ago)
Author:
Peter
Message:

fixed dox in SNR

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/c++_tools/statistics/SNR.h

    r623 r673  
    1717namespace statistics { 
    1818
    19   ///
    20   /// @brief Class for score based on signal-to-noise ratio (SNR). 
    21   ///
    22   /// Also
    23   /// sometimes referred to as Golub score. The score is the ratio
    24   /// between difference in mean and the sum of standard deviations
    25   /// for two groups.  \f$ \frac{ \frac{1}{n_x}\sum x_i -
    26   /// \frac{1}{n_y}\sum y_i }{ \sigma_x + \sigma_y} \f$ where \f$
    27   /// \sigma \f$ is standard deviation.
    28   ///   
     19  /**
     20    @brief Class for score based on signal-to-noise ratio (SNR). 
     21     
     22    Also
     23    sometimes referred to as Golub score. The score is the ratio
     24    between difference in mean and the sum of standard deviations
     25    for two groups.  \f$ \frac{ \frac{1}{n_x}\sum x_i -
     26    \frac{1}{n_y}\sum y_i }{ \sigma_x + \sigma_y} \f$ where \f$
     27    \sigma \f$ is standard deviation.
     28  */
    2929  class SNR : public Score
    3030  {
Note: See TracChangeset for help on using the changeset viewer.