doc/maps1.dox
changeset 2476 059dcdda37c5
parent 2408 467ca6d16556
child 2553 bfced05fa852
     1.1 --- a/doc/maps1.dox	Wed Sep 26 14:37:48 2007 +0000
     1.2 +++ b/doc/maps1.dox	Thu Sep 27 13:04:06 2007 +0000
     1.3 @@ -16,6 +16,8 @@
     1.4   *
     1.5   */
     1.6  
     1.7 +namespace lemon {
     1.8 +
     1.9  /**
    1.10  \page maps1 Maps I.
    1.11  
    1.12 @@ -34,22 +36,24 @@
    1.13  
    1.14  To make easy to use them - especially as template parameters - there are <i>map concepts</i> like by graph classes.
    1.15  <ul>
    1.16 -<li>\ref ReadMap - values can be read out with the \c operator[].
    1.17 +<li>\ref concepts::ReadMap "ReadMap" - values can be read out with the \c operator[].
    1.18  \code value_typed_variable = map_instance[key_value]; \endcode
    1.19  </li>
    1.20 -<li>\ref WriteMap - values can be set with the \c set() member function.
    1.21 +<li>\ref concepts::WriteMap "WriteMap" - values can be set with the \c set() member function.
    1.22  \code map_instance.set(key_value, value_typed_expression); \endcode
    1.23  </li>
    1.24 -<li>\ref ReadWriteMap - it's just a shortcut to indicate that the map is both
    1.25 +<li>\ref concepts::ReadWriteMap "ReadWriteMap" - it's just a shortcut to indicate that the map is both
    1.26  readable and writable. It is delivered from them.
    1.27  </li>
    1.28 -<li>\ref ReferenceMap - a subclass of ReadWriteMap. It has two additional typedefs
    1.29 +<li>\ref concepts::ReferenceMap "ReferenceMap" - a subclass of ReadWriteMap. It has two additional typedefs
    1.30  <i>Reference</i> and <i>ConstReference</i> and two overloads of \c operator[] to
    1.31  providing you constant or non-constant reference to the value belonging to a key,
    1.32  so you have a direct access to the memory address where it is stored.
    1.33  </li>
    1.34  <li>And there are the Matrix version of these maps, where the values are assigned to a pair of keys.
    1.35 -The keys can be different types. (\ref ReadMatrixMap, \ref WriteMatrixMap, \ref ReadWriteMatrixMap, \ref ReferenceMatrixMap)
    1.36 +The keys can be different types. (\ref concepts::ReadMatrixMap "ReadMatrixMap", 
    1.37 +\ref concepts::WriteMatrixMap "WriteMatrixMap", \ref concepts::ReadWriteMatrixMap "ReadWriteMatrixMap",
    1.38 +\ref concepts::ReferenceMatrixMap "ReferenceMatrixMap")
    1.39  </li>
    1.40  </ul>
    1.41  
    1.42 @@ -88,3 +92,5 @@
    1.43  (coming soon) and will use maps hardly.
    1.44  Or if you want to know more about maps read these \ref maps2 "advanced map techniques".
    1.45  */
    1.46 +
    1.47 +}