Changeset 3261 for branches/0.12-stable/doc/concepts.doxygen

Timestamp:

Jun 21, 2014, 11:20:04 AM (9 years ago)

Author:

Peter

Message:

newer versions of doxygen (1.8.7) complain when using same label in multiple places. Avoid these warnings.

File:

• branches/0.12-stable/doc/concepts.doxygen (modified) (25 diffs)

branches/0.12-stable/doc/concepts.doxygen

@@ -37 +37 @@
 \page concept_container_2d Container2D
 
-\section Description
+\section concept_container_2d_description Description
 
 \ref concept_container_2d is a <a
@@ -46 +46 @@
 row.
 
-\section Requirements
+\section concept_container_2d_requirments Requirements
 
 A \ref concept_container_2d provides the following:
 
-\subsection Types
+\subsection concept_container_2d_types Types
 
 <table cellspacing=0 border=1>
@@ -62 +62 @@
 <tr>
 <td>Const iterator type</td>
-<td><tt>X::const_iterator</tt></td> 
+<td><tt>X::const_iterator</tt></td>
 <td>
 A read-only iterator that can be used to iterate over the entire \ref
@@ -72 +72 @@
 <tr>
 <td>Const column iterator type</td>
-<td><tt>X::const_column_iterator</tt></td> 
+<td><tt>X::const_column_iterator</tt></td>
 <td>
 A read-only iterator that can be used to examine the elements in one
@@ -80 +80 @@
 <tr>
 <td>Const row iterator type</td>
-<td><tt>X::const_row_iterator</tt></td> 
+<td><tt>X::const_row_iterator</tt></td>
 <td>
 A read-only iterator that can be used to examine the elements in one
@@ -88 +88 @@
 </table>
 
-\subsection public_functions Public Functions
+\subsection concept_container_2d_public_functions Public Functions
 
 <table cellspacing=0 border=1>
@@ -154 +154 @@
 <td>Element Access</td>
 <td><tt>a(size_t row, size_t column)</tt></td>
-<td><tt>0 &lt;= row &lt; a.rows()</tt> and 
+<td><tt>0 &lt;= row &lt; a.rows()</tt> and
 <tt>0 &lt;= column &lt; a.columns()</tt></td>
 <td><tt>const_reference</tt></td>
@@ -161 +161 @@
 </table>
 
-\section Implementations
+\section concept_container_2d_implementations Implementations
 
 Examples of concept \ref concept_container_2d include:
@@ -173 +173 @@
 \page concept_mutable_container_2d Mutable Container2D
 
-\section Description
+\section concept_mutable_container_2d_description Description
 
 \ref concept_mutable_container_2d is a \ref concept_container_2d that
 also provides non-const access to its elements.
 
-\section Requirements
+\section concept_mutable_container_2d_requirments Requirements
 
 In addition to the requirements defined in \ref concept_container_2d,
 a \ref concept_mutable_container_2d also provides the following:
 
-\subsection Types
+\subsection concept_mutable_container_2d_types Types
 
 <table cellspacing=0 border=1>
@@ -192 +192 @@
 <tr>
 <td>Iterator type</td>
-<td><tt>X::iterator</tt></td> 
+<td><tt>X::iterator</tt></td>
 <td>
 
@@ -204 +204 @@
 <tr>
 <td>Column iterator type</td>
-<td><tt>X::column_iterator</tt></td> 
+<td><tt>X::column_iterator</tt></td>
 <td>
 A mutable iterator that can be used to modify the elements in one
@@ -212 +212 @@
 <tr>
 <td>Row iterator type</td>
-<td><tt>X::row_iterator</tt></td> 
+<td><tt>X::row_iterator</tt></td>
 <td>
 A mutable iterator that can be used to modify the elements in one
@@ -220 +220 @@
 </table>
 
-\subsection public_functions Public Functions
+\subsection concept_mutable_container_2d_public_functions Public Functions
 
 <table cellspacing=0 border=1>
@@ -272 +272 @@
 <td>Element Access</td>
 <td><tt>a(size_t row, size_t column)</tt></td>
-<td><tt>0 &lt;= row &lt; a.rows()</tt> and 
+<td><tt>0 &lt;= row &lt; a.rows()</tt> and
 <tt>0 &lt;= column &lt; a.columns()</tt></td>
 <td><tt>reference</tt></td>
@@ -279 +279 @@
 </table>
 
-\section Implementations
+\section concept_mutable_container_2d_implementations Implementations
 
 Examples of concept \ref concept_mutable_container_2d include:
@@ -290 +290 @@
 \page concept_distance Distance
 
-\section Description
+\section concept_distance_description Description
 
 \ref concept_distance is a concept for classes implementing different
 alternatives to calculate the distance between two points.
 
-\section Requirements
+\section concept_distance_requirments Requirements
 
 Classes modelling the concept \ref concept_distance should have a copy
-constructor 
+constructor
 
 \verbatim
@@ -320 +320 @@
 have both a value and a weight. The selection between unweighted and
 weighted implementations should utilize
-theplu::yat::utility::unweighted_iterator_tag and 
+theplu::yat::utility::unweighted_iterator_tag and
 theplu::yat::utility::weighted_iterator_tag. Moreover
 theplu::yat::utility::weighted_if_any2 should be utilized to provide a
@@ -326 +326 @@
 unweighted implementation when both ranges are unweighted.
 
-\section Implementations
+\section concept_distance_implementations Implementations
 
 Examples of classes modelling the concept \ref concept_distance
@@ -339 +339 @@
 \page concept_neighbor_weighting Neighbor Weighting Method
 
-\section Description
+\section concept_neighbor_weighting_description Description
 
 \ref concept_neighbor_weighting is a concept used in connection with
@@ -345 +345 @@
 NeighborWeighting should implement this concept.
 
-\section Requirements
+\section concept_neighbor_weighting_requirements Requirements
 
 Classes modelling the concept \ref concept_neighbor_weighting should
-be DefaultConstructible and Assignable as well as 
+be DefaultConstructible and Assignable as well as
 implement the following public function:
-  
-\verbatim   
-void operator()(const utility::VectorBase& distance, 
+
+\verbatim
+void operator()(const utility::VectorBase& distance,
                 const std::vector<size_t>& k_sorted,
-                const Target& target, 
+                const Target& target,
                 utility::VectorMutable& prediction) const
 \endverbatim
@@ -371 +371 @@
 neighbors with distance infinity do not vote.
 
-\section Implementations
+\section concept_neighbor_weighting_implementations Implementations
 
 Examples of classes modelling the concept \ref
@@ -384 +384 @@
 \page concept_weighted_iterator Weighted Iterator
 
-\section Description
+\section concept_weighted_iterator_description Description
 
 Most functionality in yat come in two versions: one optimized for
@@ -396 +396 @@
 Access Iterator.
 
-\section Requirements
+\section concept_weighted_iterator_requirements Requirements
 
 When implementing a new iterator that may be a \ref
@@ -443 +443 @@
 \page concept_data_iterator Data Iterator
 
-\section Description
-
-\ref concept_data_iterator is an iterator that is either: 
+\section concept_data_iterator_description Description
+
+\ref concept_data_iterator is an iterator that is either:
 
   - a \ref concept_weighted_iterator with value type convertible to
@@ -451 +451 @@
   - an unweighted iterator with value type convertible to \c double.
 
-\section Implementations
+\section concept_data_iterator_implementations Implementations
 
 Examples of concept \ref concept_data_iterator include: