Ignore:
Timestamp:
Sep 15, 2006, 5:12:44 PM (15 years ago)
Author:
Peter
Message:

corrected documentation to be in line with guidinglines

File:
1 edited

Legend:

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

    r648 r650  
    4747                 const utility::vector& value);
    4848   
    49     /// Function taking values, target, weight and a vector defining
    50     /// what samples to use. The area is defines as \f$ \frac{\sum
    51     /// w^+w^-}{\sum w^+w^-}\f$, where the sum in the numerator goes
    52     /// over all pairs where value+ is larger than value-. The
    53     /// denominator goes over all pairs. If target is equal to 1,
    54     /// sample belonges to class + otherwise sample belongs to class
    55     /// -. @return wheighted version of area under the ROC curve. If
    56     /// the area is less than 0.5 and absolute=true, 1-area is
    57     /// returned. Complexity is \f$ N^2 \f$ where \f$ N \f$ is number
    58     /// of samples.
    59     ///
     49    /**
     50        Function taking values, target, weight and a vector defining
     51        what samples to use. The area is defines as \f$ \frac{\sum
     52        w^+w^-}{\sum w^+w^-}\f$, where the sum in the numerator goes
     53        over all pairs where value+ is larger than value-. The
     54        denominator goes over all pairs. If target is equal to 1,
     55        sample belonges to class + otherwise sample belongs to class
     56        -. @return wheighted version of area under the ROC curve. If
     57        the area is less than 0.5 and absolute=true, 1-area is
     58        returned. Complexity is \f$ N^2 \f$ where \f$ N \f$ is number
     59        of samples.
     60    */
    6061    double score(const classifier::Target& target,
    6162                 const classifier::DataLookupWeighted1D& value);
    6263       
    6364
    64     /// Function taking values, target, weight and a vector defining
    65     /// what samples to use. The area is defines as \f$ \frac{\sum
    66     /// w^+w^-}{\sum w^+w^-}\f$, where the sum in the numerator goes
    67     /// over all pairs where value+ is larger than value-. The
    68     /// denominator goes over all pairs. If target is equal to 1,
    69     /// sample belonges to class + otherwise sample belongs to class
    70     /// -. @return wheighted version of area under the ROC curve. If
    71     /// the area is less than 0.5 and absolute=true, 1-area is
    72     /// returned. Complexity is \f$ N^2 \f$ where \f$ N \f$ is number
    73     /// of samples.
    74     ///
     65    /**
     66        Function taking values, target, weight and a vector defining
     67        what samples to use. The area is defines as \f$ \frac{\sum
     68        w^+w^-}{\sum w^+w^-}\f$, where the sum in the numerator goes
     69        over all pairs where value+ is larger than value-. The
     70        denominator goes over all pairs. If target is equal to 1,
     71        sample belonges to class + otherwise sample belongs to class
     72        -. @return wheighted version of area under the ROC curve. If
     73        the area is less than 0.5 and absolute=true, 1-area is
     74        returned. Complexity is \f$ N^2 \f$ where \f$ N \f$ is number
     75        of samples.
     76    */
    7577    double score(const classifier::Target& target,
    7678                 const utility::vector& value,
Note: See TracChangeset for help on using the changeset viewer.