Changeset 1093

Timestamp:

Feb 14, 2008, 11:08:10 PM (16 years ago)

Author:

Peter

Message:

some doc for EuclideanDistance? refs #254

File:

• trunk/yat/statistics/EuclideanDistance.h (modified) (1 diff)

trunk/yat/statistics/EuclideanDistance.h

@@ -37 +37 @@
   
   ///
-  /// @brief Calculates the Euclidean distance between two points stored in 1-dimensional containers. Implements the concept \ref concept_distance.
+  /// @brief Calculates the Euclidean distance between two points
+  /// stored in 1-dimensional containers. Implements the concept \ref
+  /// concept_distance.
   ///
   ///
   struct EuclideanDistance
   {   
-    ///
-    /// @brief Calculates the Euclidean distance between two ranges.
-    ///
+    /**
+       \brief Calculates the Euclidean distance between two ranges.
+    
+       If both ranges are unweighted the distance is calculated as \f$
+       \sqrt{\sum (x_i-y_i)^2 } \f$
+
+       Else distance is calculated as \f$ N \frac{\sum
+       w_xw_y(x-y)^2}{\sum w_xw_y} \f$
+    */
     template <typename Iter1, typename Iter2>
     double operator()