Changeset 314:2cc60866a0c9 in lemon-1.2 for lemon/bits

Ignore:
Timestamp:
10/09/08 13:27:35 (16 years ago)
Branch:
default
Phase:
public
Message:

Doc reorganization + improvements

• Reorganize several tools (move them to other modules).
• Add new module for map concepts.
• Remove the doc of all tools in lemon/bits.
• Improvements in groups.dox.
• Fix some doxygen warnings.
Location:
lemon/bits
Files:
10 edited

Unmodified
Removed

• lemon/bits/base_extender.h

 r289 #include ///\ingroup digraphbits ///\file ///\brief Extenders for the digraph types //\ingroup digraphbits //\file //\brief Extenders for the digraph types namespace lemon { /// \ingroup digraphbits /// /// \brief BaseDigraph to BaseGraph extender // \ingroup digraphbits // // \brief BaseDigraph to BaseGraph extender template class UndirDigraphExtender : public Base { }; /// First node of the edge // First node of the edge Node u(const Edge &e) const { return Parent::source(e); } /// Source of the given arc // Source of the given arc Node source(const Arc &e) const { return e.forward ? Parent::source(e) : Parent::target(e); } /// Second node of the edge // Second node of the edge Node v(const Edge &e) const { return Parent::target(e); } /// Target of the given arc // Target of the given arc Node target(const Arc &e) const { return e.forward ? Parent::target(e) : Parent::source(e); } /// \brief Directed arc from an edge. /// /// Returns a directed arc corresponding to the specified edge. /// If the given bool is true, the first node of the given edge and /// the source node of the returned arc are the same. // \brief Directed arc from an edge. // // Returns a directed arc corresponding to the specified edge. // If the given bool is true, the first node of the given edge and // the source node of the returned arc are the same. static Arc direct(const Edge &e, bool d) { return Arc(e, d); } /// Returns whether the given directed arc has the same orientation /// as the corresponding edge. // Returns whether the given directed arc has the same orientation // as the corresponding edge. static bool direction(const Arc &a) { return a.forward; }
• lemon/bits/bezier.h

 r209 #define LEMON_BEZIER_H ///\ingroup misc ///\file ///\brief Classes to compute with Bezier curves. /// ///Up to now this file is used internally by \ref graph_to_eps.h //\ingroup misc //\file //\brief Classes to compute with Bezier curves. // //Up to now this file is used internally by \ref graph_to_eps.h #include
• lemon/bits/default_map.h

 r313 #define LEMON_BITS_DEFAULT_MAP_H #include #include //#include ///\ingroup graphbits ///\file ///\brief Graph maps that construct and destruct their elements dynamically. //\ingroup graphbits //\file //\brief Graph maps that construct and destruct their elements dynamically. namespace lemon { // #endif /// DefaultMap class // DefaultMap class template class DefaultMap
• lemon/bits/enable_if.h

 r220 #define LEMON_BITS_ENABLE_IF_H ///\file ///\brief Miscellaneous basic utilities //\file //\brief Miscellaneous basic utilities namespace lemon { /// Basic type for defining "tags". A "YES" condition for \c enable_if. // Basic type for defining "tags". A "YES" condition for \c enable_if. /// Basic type for defining "tags". A "YES" condition for \c enable_if. /// ///\sa False // Basic type for defining "tags". A "YES" condition for \c enable_if. // //\sa False struct True { ///\e //\e static const bool value = true; }; /// Basic type for defining "tags". A "NO" condition for \c enable_if. // Basic type for defining "tags". A "NO" condition for \c enable_if. /// Basic type for defining "tags". A "NO" condition for \c enable_if. /// ///\sa True // Basic type for defining "tags". A "NO" condition for \c enable_if. // //\sa True struct False { ///\e //\e static const bool value = false; };
• lemon/bits/graph_extender.h

 r263 #include ///\ingroup graphbits ///\file ///\brief Extenders for the digraph types //\ingroup graphbits //\file //\brief Extenders for the digraph types namespace lemon { /// \ingroup graphbits /// /// \brief Extender for the Digraphs // \ingroup graphbits // // \brief Extender for the Digraphs template class DigraphExtender : public Base { }; /// \brief Base node of the iterator /// /// Returns the base node (i.e. the source in this case) of the iterator // \brief Base node of the iterator // // Returns the base node (i.e. the source in this case) of the iterator Node baseNode(const OutArcIt &arc) const { return Parent::source(arc); } /// \brief Running node of the iterator /// /// Returns the running node (i.e. the target in this case) of the /// iterator // \brief Running node of the iterator // // Returns the running node (i.e. the target in this case) of the // iterator Node runningNode(const OutArcIt &arc) const { return Parent::target(arc); } /// \brief Base node of the iterator /// /// Returns the base node (i.e. the target in this case) of the iterator // \brief Base node of the iterator // // Returns the base node (i.e. the target in this case) of the iterator Node baseNode(const InArcIt &arc) const { return Parent::target(arc); } /// \brief Running node of the iterator /// /// Returns the running node (i.e. the source in this case) of the /// iterator // \brief Running node of the iterator // // Returns the running node (i.e. the source in this case) of the // iterator Node runningNode(const InArcIt &arc) const { return Parent::source(arc); }; /// \ingroup _graphbits /// /// \brief Extender for the Graphs // \ingroup _graphbits // // \brief Extender for the Graphs template class GraphExtender : public Base { }; /// \brief Base node of the iterator /// /// Returns the base node (ie. the source in this case) of the iterator // \brief Base node of the iterator // // Returns the base node (ie. the source in this case) of the iterator Node baseNode(const OutArcIt &arc) const { return Parent::source(static_cast(arc)); } /// \brief Running node of the iterator /// /// Returns the running node (ie. the target in this case) of the /// iterator // \brief Running node of the iterator // // Returns the running node (ie. the target in this case) of the // iterator Node runningNode(const OutArcIt &arc) const { return Parent::target(static_cast(arc)); } /// \brief Base node of the iterator /// /// Returns the base node (ie. the target in this case) of the iterator // \brief Base node of the iterator // // Returns the base node (ie. the target in this case) of the iterator Node baseNode(const InArcIt &arc) const { return Parent::target(static_cast(arc)); } /// \brief Running node of the iterator /// /// Returns the running node (ie. the source in this case) of the /// iterator // \brief Running node of the iterator // // Returns the running node (ie. the source in this case) of the // iterator Node runningNode(const InArcIt &arc) const { return Parent::source(static_cast(arc)); } /// Base node of the iterator /// /// Returns the base node of the iterator // Base node of the iterator // // Returns the base node of the iterator Node baseNode(const IncEdgeIt &edge) const { return edge._direction ? u(edge) : v(edge); } /// Running node of the iterator /// /// Returns the running node of the iterator // Running node of the iterator // // Returns the running node of the iterator Node runningNode(const IncEdgeIt &edge) const { return edge._direction ? v(edge) : u(edge);
• lemon/bits/map_extender.h

 r263 #include ///\file ///\brief Extenders for iterable maps. //\file //\brief Extenders for iterable maps. namespace lemon { /// \ingroup graphbits /// /// \brief Extender for maps // \ingroup graphbits // // \brief Extender for maps template class MapExtender : public _Map { }; /// \ingroup graphbits /// /// \brief Extender for maps which use a subset of the items. // \ingroup graphbits // // \brief Extender for maps which use a subset of the items. template class SubMapExtender : public _Map {
• lemon/bits/traits.h

 r220 #define LEMON_BITS_TRAITS_H ///\file ///\brief Traits for graphs and maps /// //\file //\brief Traits for graphs and maps // #include