COIN-OR::LEMON - Graph Library

Changeset 47:3750b8ebc91e in lemon for lemon


Ignore:
Timestamp:
01/08/08 02:12:50 (12 years ago)
Author:
Peter Kovacs <kpeter@…>
Branch:
default
Phase:
public
Message:

Minor doc improvements in maps.h.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • lemon/maps.h

    r46 r47  
    8282  /// Constant map.
    8383
    84   /// This is a readable map which assigns a specified value to each key.
    85   /// In other aspects it is equivalent to the \c NullMap.
     84  /// This is a \ref concepts::ReadMap "readable" map which assigns a
     85  /// specified value to each key.
     86  /// In other aspects it is equivalent to \c NullMap.
    8687  template<typename K, typename T>
    8788  class ConstMap : public MapBase<K, T> {
     
    134135  /// Constant map with inlined constant value.
    135136
    136   /// This is a readable map which assigns a specified value to each key.
    137   /// In other aspects it is equivalent to the \c NullMap.
     137  /// This is a \ref concepts::ReadMap "readable" map which assigns a
     138  /// specified value to each key.
     139  /// In other aspects it is equivalent to \c NullMap.
    138140  template<typename K, typename V, V v>
    139141  class ConstMap<K, Const<V, v> > : public MapBase<K, V> {
     
    150152  };
    151153
    152   ///Returns a \c ConstMap class
     154  ///Returns a \c ConstMap class with inlined value
    153155
    154156  ///This function just returns a \c ConstMap class with inlined value.
     
    163165  ///This is essentially a wrapper for \c std::map with addition that
    164166  ///you can specify a default value different from \c Value().
     167  ///It meets the \ref concepts::ReferenceMap "ReferenceMap" concept.
    165168  template <typename K, typename T, typename Compare = std::less<K> >
    166169  class StdMap : public MapBase<K, T> {
     
    191194    /// Constructor with specified default value
    192195    StdMap(const T& value = T()) : _value(value) {}
    193     /// \brief Constructs the map from an appropriate std::map, and explicitly
    194     /// specifies a default value.
     196    /// \brief Constructs the map from an appropriate \c std::map, and
     197    /// explicitly specifies a default value.
    195198    template <typename T1, typename Comp1>
    196199    StdMap(const std::map<Key, T1, Comp1> &map, const T& value = T())
    197200      : _map(map.begin(), map.end()), _value(value) {}
    198201   
    199     /// \brief Constructs a map from an other StdMap.
     202    /// \brief Constructs a map from an other \ref StdMap.
    200203    template<typename T1, typename Comp1>
    201204    StdMap(const StdMap<Key, T1, Comp1> &c)
     
    266269  /// \brief Map for storing values for keys from the range <tt>[0..size-1]</tt>
    267270  ///
    268   /// The current map has the <tt>[0..size-1]</tt> keyset and the values
     271  /// This map has the <tt>[0..size-1]</tt> keyset and the values
    269272  /// are stored in a \c std::vector<T>  container. It can be used with
    270273  /// some data structures, for example \c UnionFind, \c BinHeap, when
    271   /// the used items are small integer numbers.
     274  /// the used items are small integer numbers.
     275  /// This map meets the \ref concepts::ReferenceMap "ReferenceMap" concept.
    272276  ///
    273277  /// \todo Revise its name
     
    302306    IntegerMap(int size = 0, const T& value = T()) : _vector(size, value) {}
    303307
    304     /// \brief Constructs the map from an appropriate std::vector.
     308    /// \brief Constructs the map from an appropriate \c std::vector.
    305309    template <typename T1>
    306310    IntegerMap(const std::vector<T1>& vector)
    307311      : _vector(vector.begin(), vector.end()) {}
    308312   
    309     /// \brief Constructs a map from an other IntegerMap.
     313    /// \brief Constructs a map from an other \ref IntegerMap.
    310314    template <typename T1>
    311315    IntegerMap(const IntegerMap<T1> &c)
     
    401405    ConvertMap(const M &_m) : m(_m) {};
    402406
    403     /// \brief The subscript operator.
    404     ///
    405     /// The subscript operator.
     407    ///\e
    406408    Value operator[](const Key& k) const {return m[k];}
    407409  };
     
    491493  ///given maps.
    492494  ///Its \c Key and \c Value are inherited from \c M1.
    493   ///The \c Key and \c Value of M2 must be convertible to those of \c M1.
     495  ///The \c Key and \c Value of \c M2 must be convertible to those of \c M1.
    494496  template<typename M1, typename M2>
    495497  class AddMap : public MapBase<typename M1::Key, typename M1::Value> {
     
    511513
    512514  ///This function just returns an \c AddMap class.
    513   ///\todo How to call these type of functions?
     515  ///\todo Extend the documentation: how to call these type of functions?
    514516  ///
    515517  ///\relates AddMap
     
    10081010  ///\c Key and \c Value.
    10091011  ///In most cases they have to be given explicitly because a
    1010   ///functor typically does not provide such typedefs.
     1012  ///functor typically does not provide \c argument_type and
     1013  ///\c result_type typedefs.
    10111014  ///
    10121015  ///Parameter \c F is the type of the used functor.
     
    10331036  ///This function just returns a \c FunctorMap class.
    10341037  ///
    1035   ///It is specialized for adaptable function classes and
    1036   ///C++ functions.
     1038  ///This function is specialized for adaptable binary function
     1039  ///classes and C++ functions.
     1040  ///
    10371041  ///\relates FunctorMap
    10381042  template<typename K, typename V, typename F> inline
     
    10571061
    10581062  ///This class Converts a map to an STL style (unary) functor.
    1059   ///that is it provides an <tt>operator()</tt> to read its values.
     1063  ///That is it provides an <tt>operator()</tt> to read its values.
    10601064  ///
    10611065  ///For the sake of convenience it also works as
     
    10921096  }
    10931097
    1094   ///Applies all map setting operations to two maps
     1098  ///Just readable version of \ref ForkWriteMap
    10951099
    10961100  ///This map has two \ref concepts::ReadMap "readable map"
    10971101  ///parameters and each read request will be passed just to the
    1098   ///first map. This class is the just readable map type of the \c ForkWriteMap.
     1102  ///first map. This class is the just readable map type of \c ForkWriteMap.
    10991103  ///
    11001104  ///The \c Key and \c Value are inherited from \c M1.
    1101   ///The \c Key and \c Value of M2 must be convertible from those of \c M1.
     1105  ///The \c Key and \c Value of \c M2 must be convertible from those of \c M1.
    11021106  ///
    11031107  ///\sa ForkWriteMap
     
    11291133  ///
    11301134  ///The \c Key and \c Value are inherited from \c M1.
    1131   ///The \c Key and \c Value of M2 must be convertible from those of \c M1.
     1135  ///The \c Key and \c Value of \c M2 must be convertible from those of \c M1.
    11321136  ///
    11331137  ///\sa ForkMap
     
    11751179  ///This bool \ref concepts::ReadMap "read only map" returns the
    11761180  ///logical negation of the value returned by the given map.
    1177   ///Its \c Key is inherited from \c M, its Value is \c bool.
     1181  ///Its \c Key is inherited from \c M, its \c Value is \c bool.
    11781182  ///
    11791183  ///\sa NotWriteMap
     
    11971201  ///logical negation of the value returned by the given map. When it is set,
    11981202  ///the opposite value is set to the original map.
    1199   ///Its \c Key is inherited from \c M, its Value is \c bool.
     1203  ///Its \c Key is inherited from \c M, its \c Value is \c bool.
    12001204  ///
    12011205  ///\sa NotMap
     
    12631267  ///
    12641268  /// A \ref concepts::ReadWriteMap "read-write" bool map for logging
    1265   /// each \c true assigned element, i.e it/ copies all the keys set
     1269  /// each \c true assigned element, i.e it copies all the keys set
    12661270  /// to \c true to the given iterator.
    12671271  ///
     
    12691273  /// for each element.
    12701274  ///
    1271   /// The following example shows how you can write the edges found by the Prim
    1272   /// algorithm directly
    1273   /// to the standard output.
     1275  /// The following example shows how you can write the edges found by
     1276  /// the \ref Prim algorithm directly to the standard output.
    12741277  ///\code
    12751278  /// typedef IdMap<Graph, Edge> EdgeIdMap;
Note: See TracChangeset for help on using the changeset viewer.