Changeset 966 for trunk/yat/statistics


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

fixing some doxygen warnings

Location:
trunk/yat/statistics
Files:
8 edited

Legend:

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

    r865 r966  
    5151  public:
    5252    ///
    53     ///
    54     ///
     53    /// \brief Defaul Constructor
     54    /// \param absolute if true max(AUC, 1-AUC) is used
     55    ///
    5556    AUC(bool absolute=true);
    5657
  • trunk/yat/statistics/SAMScore.h

    r865 r966  
    5757    ///
    5858    /// @param s0 \f$ s_0 \f$ is a fudge factor
     59    /// @param absolute if true max(score, -score) is used
    5960    ///
    6061    SAMScore(const double s0, bool absolute=true);
  • trunk/yat/statistics/Score.h

    r865 r966  
    118118    /// is wanted.
    119119    ///
    120     /// @a value and @weight are copied to utility::vector and the
     120    /// \a value and \a weight are copied to utility::vector and the
    121121    /// corresponding operator is called. If speed is important this
    122122    /// operator should be implemented in inherited class to avoid
  • trunk/yat/statistics/VectorFunction.h

    r865 r966  
    3636  struct VectorFunction
    3737  {
     38    /**
     39       \brief Destructor
     40     */
    3841    virtual ~VectorFunction();
     42
     43    /**
     44       \brief abstract interface
     45     */
    3946    virtual double operator()(const std::vector<double>&) const=0;
    4047  };
     
    8996  };
    9097
    91 
     98  /**
     99     Functor that picks Nth smalles element in a vector.
     100   */
    92101  class Nth_Element : public VectorFunction
    93102  {
  • trunk/yat/statistics/euclidean_vector_distance.h

    r937 r966  
    2323    : public vector_distance_tag
    2424  {
     25    /// \brief tag for euclidean distance
    2526    typedef euclidean_vector_distance_tag distance;
    2627  };
  • trunk/yat/statistics/pearson_vector_distance.h

    r937 r966  
    2222    : public vector_distance_tag
    2323  {
     24    /// \brief tag for pearson distance
    2425    typedef pearson_vector_distance_tag distance;
    2526  };
  • trunk/yat/statistics/tScore.h

    r865 r966  
    8080       2 } \f$
    8181       
     82       \param target Target defining the two groups
     83       \param value Vector with data points on which calculation is based
    8284       @param dof double pointer in which approximation of degrees of
    8385       freedom is returned: pos.n()+neg.n()-2. See AveragerWeighted.
     
    100102       } \f$. See AveragerWeighted for details.
    101103       
     104       \param target Target defining the two groups
     105       \param value Vector with values/weights on which calculation is based
    102106       @param dof double pointer in which approximation of degrees of
    103107       freedom is returned: pos.n()+neg.n()-2. See AveragerWeighted.
     
    154158       + n_y - 2 } \f$. See AveragerWeighted for details.
    155159     
     160       \param target Target defining the two groups
     161       \param value Vector with data values on which calculation is based
     162       \param weight Vector with weight associated to \a value
    156163       @param dof double pointer in which approximation of degrees of
    157164       freedom is returned: pos.n()+neg.n()-2. See AveragerWeighted.
  • trunk/yat/statistics/vector_distance.h

    r958 r966  
    1818  /// For each measure to calculate distances between containers
    1919  /// with random access iterators one should provide a struct
    20   /// which inherits from vector_distance_tag and provides a "label" for
     20  /// that inherits from vector_distance_tag and provides a "label" for
    2121  /// the distance measure.
    2222  ///
    2323  struct vector_distance_tag {
     24    /// tag defining distance measure
    2425    typedef vector_distance_tag distance;
    2526  };
     
    3637  template <class T>
    3738  struct vector_distance_traits {
     39    /// \return distance type
    3840    typedef typename T::distance distance;
    3941  };
Note: See TracChangeset for help on using the changeset viewer.