COIN-OR::LEMON - Graph Library

Changeset 2476:059dcdda37c5 in lemon-0.x for doc/maps1.dox


Ignore:
Timestamp:
09/27/07 15:04:06 (12 years ago)
Author:
Peter Kovacs
Branch:
default
Phase:
public
Convert:
svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@3315
Message:

Bug fixes in the documentation (mainly bad references).

File:
1 edited

Legend:

Unmodified
Added
Removed
  • doc/maps1.dox

    r2408 r2476  
    1616 *
    1717 */
     18
     19namespace lemon {
    1820
    1921/**
     
    3537To make easy to use them - especially as template parameters - there are <i>map concepts</i> like by graph classes.
    3638<ul>
    37 <li>\ref ReadMap - values can be read out with the \c operator[].
     39<li>\ref concepts::ReadMap "ReadMap" - values can be read out with the \c operator[].
    3840\code value_typed_variable = map_instance[key_value]; \endcode
    3941</li>
    40 <li>\ref WriteMap - values can be set with the \c set() member function.
     42<li>\ref concepts::WriteMap "WriteMap" - values can be set with the \c set() member function.
    4143\code map_instance.set(key_value, value_typed_expression); \endcode
    4244</li>
    43 <li>\ref ReadWriteMap - it's just a shortcut to indicate that the map is both
     45<li>\ref concepts::ReadWriteMap "ReadWriteMap" - it's just a shortcut to indicate that the map is both
    4446readable and writable. It is delivered from them.
    4547</li>
    46 <li>\ref ReferenceMap - a subclass of ReadWriteMap. It has two additional typedefs
     48<li>\ref concepts::ReferenceMap "ReferenceMap" - a subclass of ReadWriteMap. It has two additional typedefs
    4749<i>Reference</i> and <i>ConstReference</i> and two overloads of \c operator[] to
    4850providing you constant or non-constant reference to the value belonging to a key,
     
    5052</li>
    5153<li>And there are the Matrix version of these maps, where the values are assigned to a pair of keys.
    52 The keys can be different types. (\ref ReadMatrixMap, \ref WriteMatrixMap, \ref ReadWriteMatrixMap, \ref ReferenceMatrixMap)
     54The keys can be different types. (\ref concepts::ReadMatrixMap "ReadMatrixMap",
     55\ref concepts::WriteMatrixMap "WriteMatrixMap", \ref concepts::ReadWriteMatrixMap "ReadWriteMatrixMap",
     56\ref concepts::ReferenceMatrixMap "ReferenceMatrixMap")
    5357</li>
    5458</ul>
     
    8993Or if you want to know more about maps read these \ref maps2 "advanced map techniques".
    9094*/
     95
     96}
Note: See TracChangeset for help on using the changeset viewer.