Ignore:
Timestamp:
Feb 14, 2008, 11:08:10 PM (14 years ago)
Author:
Peter
Message:

some doc for EuclideanDistance? refs #254

File:
1 edited

Legend:

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

    r1092 r1093  
    3737 
    3838  ///
    39   /// @brief Calculates the Euclidean distance between two points stored in 1-dimensional containers. Implements the concept \ref concept_distance.
     39  /// @brief Calculates the Euclidean distance between two points
     40  /// stored in 1-dimensional containers. Implements the concept \ref
     41  /// concept_distance.
    4042  ///
    4143  ///
    4244  struct EuclideanDistance
    4345  {   
    44     ///
    45     /// @brief Calculates the Euclidean distance between two ranges.
    46     ///
     46    /**
     47       \brief Calculates the Euclidean distance between two ranges.
     48   
     49       If both ranges are unweighted the distance is calculated as \f$
     50       \sqrt{\sum (x_i-y_i)^2 } \f$
     51
     52       Else distance is calculated as \f$ N \frac{\sum
     53       w_xw_y(x-y)^2}{\sum w_xw_y} \f$
     54    */
    4755    template <typename Iter1, typename Iter2>
    4856    double operator()
Note: See TracChangeset for help on using the changeset viewer.