Changeset 3295 for trunk/doc


Ignore:
Timestamp:
Jul 25, 2014, 6:24:39 AM (7 years ago)
Author:
Peter
Message:

merge release 0.12 into trunk

Location:
trunk
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • trunk

  • trunk/doc/concepts.doxygen

    r2504 r3295  
    22//
    33// Copyright (C) 2008 Jari Häkkinen, Peter Johansson, Markus Ringnér
    4 // Copyright (C) 2009, 2010, 2011 Peter Johansson
     4// Copyright (C) 2009, 2010, 2011, 2014 Peter Johansson
    55//
    66// This file is part of the yat library, http://dev.thep.lu.se/yat
     
    3737\page concept_container_2d Container2D
    3838
    39 \section Description
     39\section concept_container_2d_description Description
    4040
    4141\ref concept_container_2d is a <a
     
    4646row.
    4747
    48 \section Requirements
     48\section concept_container_2d_requirments Requirements
    4949
    5050A \ref concept_container_2d provides the following:
    5151
    52 \subsection Types
     52\subsection concept_container_2d_types Types
    5353
    5454<table cellspacing=0 border=1>
     
    6262<tr>
    6363<td>Const iterator type</td>
    64 <td><tt>X::const_iterator</tt></td> 
     64<td><tt>X::const_iterator</tt></td>
    6565<td>
    6666A read-only iterator that can be used to iterate over the entire \ref
     
    7272<tr>
    7373<td>Const column iterator type</td>
    74 <td><tt>X::const_column_iterator</tt></td> 
     74<td><tt>X::const_column_iterator</tt></td>
    7575<td>
    7676A read-only iterator that can be used to examine the elements in one
     
    8080<tr>
    8181<td>Const row iterator type</td>
    82 <td><tt>X::const_row_iterator</tt></td> 
     82<td><tt>X::const_row_iterator</tt></td>
    8383<td>
    8484A read-only iterator that can be used to examine the elements in one
     
    8888</table>
    8989
    90 \subsection public_functions Public Functions
     90\subsection concept_container_2d_public_functions Public Functions
    9191
    9292<table cellspacing=0 border=1>
     
    154154<td>Element Access</td>
    155155<td><tt>a(size_t row, size_t column)</tt></td>
    156 <td><tt>0 &lt;= row &lt; a.rows()</tt> and 
     156<td><tt>0 &lt;= row &lt; a.rows()</tt> and
    157157<tt>0 &lt;= column &lt; a.columns()</tt></td>
    158158<td><tt>const_reference</tt></td>
     
    161161</table>
    162162
    163 \section Implementations
     163\section concept_container_2d_implementations Implementations
    164164
    165165Examples of concept \ref concept_container_2d include:
     
    173173\page concept_mutable_container_2d Mutable Container2D
    174174
    175 \section Description
     175\section concept_mutable_container_2d_description Description
    176176
    177177\ref concept_mutable_container_2d is a \ref concept_container_2d that
    178178also provides non-const access to its elements.
    179179
    180 \section Requirements
     180\section concept_mutable_container_2d_requirments Requirements
    181181
    182182In addition to the requirements defined in \ref concept_container_2d,
    183183a \ref concept_mutable_container_2d also provides the following:
    184184
    185 \subsection Types
     185\subsection concept_mutable_container_2d_types Types
    186186
    187187<table cellspacing=0 border=1>
     
    192192<tr>
    193193<td>Iterator type</td>
    194 <td><tt>X::iterator</tt></td> 
     194<td><tt>X::iterator</tt></td>
    195195<td>
    196196
     
    204204<tr>
    205205<td>Column iterator type</td>
    206 <td><tt>X::column_iterator</tt></td> 
     206<td><tt>X::column_iterator</tt></td>
    207207<td>
    208208A mutable iterator that can be used to modify the elements in one
     
    212212<tr>
    213213<td>Row iterator type</td>
    214 <td><tt>X::row_iterator</tt></td> 
     214<td><tt>X::row_iterator</tt></td>
    215215<td>
    216216A mutable iterator that can be used to modify the elements in one
     
    220220</table>
    221221
    222 \subsection public_functions Public Functions
     222\subsection concept_mutable_container_2d_public_functions Public Functions
    223223
    224224<table cellspacing=0 border=1>
     
    272272<td>Element Access</td>
    273273<td><tt>a(size_t row, size_t column)</tt></td>
    274 <td><tt>0 &lt;= row &lt; a.rows()</tt> and 
     274<td><tt>0 &lt;= row &lt; a.rows()</tt> and
    275275<tt>0 &lt;= column &lt; a.columns()</tt></td>
    276276<td><tt>reference</tt></td>
     
    279279</table>
    280280
    281 \section Implementations
     281\section concept_mutable_container_2d_implementations Implementations
    282282
    283283Examples of concept \ref concept_mutable_container_2d include:
     
    290290\page concept_distance Distance
    291291
    292 \section Description
     292\section concept_distance_description Description
    293293
    294294\ref concept_distance is a concept for classes implementing different
    295295alternatives to calculate the distance between two points.
    296296
    297 \section Requirements
     297\section concept_distance_requirments Requirements
    298298
    299299Classes modelling the concept \ref concept_distance should have a copy
    300 constructor 
     300constructor
    301301
    302302\verbatim
     
    320320have both a value and a weight. The selection between unweighted and
    321321weighted implementations should utilize
    322 theplu::yat::utility::unweighted_iterator_tag and 
     322theplu::yat::utility::unweighted_iterator_tag and
    323323theplu::yat::utility::weighted_iterator_tag. Moreover
    324324theplu::yat::utility::weighted_if_any2 should be utilized to provide a
     
    326326unweighted implementation when both ranges are unweighted.
    327327
    328 \section Implementations
     328\section concept_distance_implementations Implementations
    329329
    330330Examples of classes modelling the concept \ref concept_distance
     
    339339\page concept_neighbor_weighting Neighbor Weighting Method
    340340
    341 \section Description
     341\section concept_neighbor_weighting_description Description
    342342
    343343\ref concept_neighbor_weighting is a concept used in connection with
     
    345345NeighborWeighting should implement this concept.
    346346
    347 \section Requirements
     347\section concept_neighbor_weighting_requirements Requirements
    348348
    349349Classes modelling the concept \ref concept_neighbor_weighting should
    350 be DefaultConstructible and Assignable as well as 
     350be DefaultConstructible and Assignable as well as
    351351implement the following public function:
    352  
    353 \verbatim   
    354 void operator()(const utility::VectorBase& distance, 
     352
     353\verbatim
     354void operator()(const utility::VectorBase& distance,
    355355                const std::vector<size_t>& k_sorted,
    356                 const Target& target, 
     356                const Target& target,
    357357                utility::VectorMutable& prediction) const
    358358\endverbatim
     
    371371neighbors with distance infinity do not vote.
    372372
    373 \section Implementations
     373\section concept_neighbor_weighting_implementations Implementations
    374374
    375375Examples of classes modelling the concept \ref
     
    384384\page concept_weighted_iterator Weighted Iterator
    385385
    386 \section Description
     386\section concept_weighted_iterator_description Description
    387387
    388388Most functionality in yat come in two versions: one optimized for
     
    396396Access Iterator.
    397397
    398 \section Requirements
     398\section concept_weighted_iterator_requirements Requirements
    399399
    400400When implementing a new iterator that may be a \ref
     
    443443\page concept_data_iterator Data Iterator
    444444
    445 \section Description
    446 
    447 \ref concept_data_iterator is an iterator that is either: 
     445\section concept_data_iterator_description Description
     446
     447\ref concept_data_iterator is an iterator that is either:
    448448
    449449  - a \ref concept_weighted_iterator with value type convertible to
     
    451451  - an unweighted iterator with value type convertible to \c double.
    452452
    453 \section Implementations
     453\section concept_data_iterator_implementations Implementations
    454454
    455455Examples of concept \ref concept_data_iterator include:
Note: See TracChangeset for help on using the changeset viewer.