Changeset 1069

Timestamp:

Feb 11, 2008, 10:57:24 PM (15 years ago)

Author:

Markus Ringnér

Message:

First few steps on #323

Location:

trunk

Files:

• doc/concepts.doxygen (added)
• doc/doxygen.config.in (modified) (2 diffs)
• yat/statistics/EuclideanDistance.h (modified) (1 diff)
• yat/statistics/PearsonDistance.h (modified) (1 diff)

trunk/doc/doxygen.config.in

@@ -142 +142 @@
 
 FULL_PATH_NAMES        = YES
-
+b
 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 
 # can be used to strip a user defined part of the path. Stripping is 
@@ -350 +350 @@
 # with spaces.
 
-INPUT                  = first_page.doxygen namespaces.doxygen ../yat
+INPUT                  = first_page.doxygen namespaces.doxygen concepts.doxygen ../yat
 
 # If the value of the INPUT tag contains directories, you can use the 

trunk/yat/statistics/EuclideanDistance.h

@@ -35 +35 @@
 namespace yat {
 namespace statistics {
-
+  
+  ///
+  /// @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.
+    ///
     template <typename Iter1, typename Iter2>
     double operator()

trunk/yat/statistics/PearsonDistance.h

@@ -34 +34 @@
 namespace statistics {
 
+  ///
+  /// @brief Calculates the Pearson correlation distance between two points stored in 1-dimensional containers. Implements the concept \ref concept_distance.
+  ///
+  ///
   struct PearsonDistance
   {
+    ///
+    /// @brief Calculates the Pearson correlation distance between two ranges.
+    ///
     template <typename Iter1, typename Iter2>
     double operator()