Changeset 1115 for trunk/doc


Ignore:
Timestamp:
Feb 21, 2008, 8:20:59 PM (13 years ago)
Author:
Markus Ringnér
Message:

Fixes #254 and #295

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/doc/concepts.doxygen

    r1113 r1115  
    3636\section Description
    3737
    38 \ref concept_distance is a concept ..
     38\ref concept_distance is a concept for classes implementing different
     39alternatives to calculate the distance between two points.
    3940
    4041\section Requirements
    4142
    42 Classes modelling the concept \ref concept_distance should implement ... 
     43Classes modelling the concept \ref concept_distance should implement
     44the following public function:
     45
     46\verbatim
     47template<typename Iter1, typename Iter2>
     48double  operator() (Iter1 beg1, Iter1 end1, Iter2 beg2) const
     49\endverbatim
     50
     51This function should calculate and return the distance between
     52elements of two ranges. The first range is given by [\a beg1, \a end1)
     53and the second range starts with \a beg2 and has the same length as
     54the first range. The function should support iterators of the category
     55std::forward_iterator. The function should provide both a fast
     56calculation for unweighted iterators and a calculation for weighted
     57iterators. The latter correspond to the case where elements in a range
     58have both a value and a weight. The selection between unweighted and
     59weighted implementations should utilize
     60theplu::yat::utility::weighted_iterator_tag. Moreover
     61theplu::yat::utility::weighted_if_any2 should be utilized to provide a
     62weighted implementation if any of the two ranges is weighted, and an
     63unweighted implementation when both ranges are unweighted.
     64
     65\section Implementations
    4366
    4467Examples of classes modelling the concept \ref concept_distance
     
    6083
    6184Classes modelling the concept \ref concept_neighbor_weighting should
    62 implement the following function:
     85implement the following public function:
    6386 
    6487\verbatim   
     
    78101class. The total vote for each class is stored in the vector \a prediction.
    79102
     103\section Implementations
     104
    80105Examples of classes modelling the concept \ref
    81106concept_neighbor_weighting include
Note: See TracChangeset for help on using the changeset viewer.