Changeset 1115 for trunk/doc/concepts.doxygen

Timestamp:

Feb 21, 2008, 8:20:59 PM (14 years ago)

Author:

Markus Ringnér

Message:

Fixes #254 and #295

File:

• trunk/doc/concepts.doxygen (modified) (3 diffs)

trunk/doc/concepts.doxygen

@@ -36 +36 @@
 \section Description
 
-\ref concept_distance is a concept ..
+\ref concept_distance is a concept for classes implementing different
+alternatives to calculate the distance between two points.
 
 \section Requirements
 
-Classes modelling the concept \ref concept_distance should implement ...  
+Classes modelling the concept \ref concept_distance should implement
+the following public function:
+
+\verbatim
+template<typename Iter1, typename Iter2>
+double  operator() (Iter1 beg1, Iter1 end1, Iter2 beg2) const
+\endverbatim
+
+This function should calculate and return the distance between
+elements of two ranges. The first range is given by [\a beg1, \a end1)
+and the second range starts with \a beg2 and has the same length as
+the first range. The function should support iterators of the category
+std::forward_iterator. The function should provide both a fast
+calculation for unweighted iterators and a calculation for weighted
+iterators. The latter correspond to the case where elements in a range
+have both a value and a weight. The selection between unweighted and
+weighted implementations should utilize
+theplu::yat::utility::weighted_iterator_tag. Moreover
+theplu::yat::utility::weighted_if_any2 should be utilized to provide a
+weighted implementation if any of the two ranges is weighted, and an
+unweighted implementation when both ranges are unweighted.
+
+\section Implementations
 
 Examples of classes modelling the concept \ref concept_distance
@@ -60 +83 @@
 
 Classes modelling the concept \ref concept_neighbor_weighting should
-implement the following function:
+implement the following public function:
   
 \verbatim   
@@ -78 +101 @@
 class. The total vote for each class is stored in the vector \a prediction.
 
+\section Implementations
+
 Examples of classes modelling the concept \ref
 concept_neighbor_weighting include