lemon-0.x: comparison lemon/ugraph

equal deleted inserted replaced

-:7c788c95658d
+:989676e541fe
 #include <iostream>
 namespace lemon {
-/// \ingroup graph_adaptors
-///
 /// \brief Base type for the Graph Adaptors
 ///
 /// This is the base type for most of LEMON graph adaptors.
 /// This class implements a trivial graph adaptor i.e. it only wraps the
 /// functions and types of the graph. The purpose of this class is to
 };
 };
 /// \ingroup graph_adaptors
+///
+/// \brief Trivial undirected graph adaptor
+///
+/// This class is an adaptor which does not change the adapted undirected
+/// graph. It can be used only to test the undirected graph adaptors.
 template <typename _UGraph>
 class UGraphAdaptor
 : public UGraphAdaptorExtender< UGraphAdaptorBase<_UGraph> > {
 public:
 typedef _UGraph Graph;
 Parent::nextInc(i, d);
 while (i!=INVALID && (!(*uedge_filter_map)[i]
 || !(*node_filter_map)[Parent::source(i)])) Parent::nextInc(i, d);
 }
-///\e
+/// \brief Hide the given node in the graph.
+///
 /// This function hides \c n in the graph, i.e. the iteration
 /// jumps over it. This is done by simply setting the value of \c n
 /// to be false in the corresponding node-map.
 void hide(const Node& n) const { node_filter_map->set(n, false); }
-///\e
+/// \brief Hide the given undirected edge in the graph.
+///
 /// This function hides \c e in the graph, i.e. the iteration
 /// jumps over it. This is done by simply setting the value of \c e
-/// to be false in the corresponding edge-map.
+/// to be false in the corresponding uedge-map.
 void hide(const UEdge& e) const { uedge_filter_map->set(e, false); }
-///\e
+/// \brief Unhide the given node in the graph.
+///
 /// The value of \c n is set to be true in the node-map which stores
 /// hide information. If \c n was hidden previuosly, then it is shown
 /// again
 void unHide(const Node& n) const { node_filter_map->set(n, true); }
-///\e
+/// \brief Hide the given undirected edge in the graph.
+///
-/// The value of \c e is set to be true in the edge-map which stores
+/// The value of \c e is set to be true in the uedge-map which stores
 /// hide information. If \c e was hidden previuosly, then it is shown
 /// again
 void unHide(const UEdge& e) const { uedge_filter_map->set(e, true); }
+/// \brief Returns true if \c n is hidden.
+///
 /// Returns true if \c n is hidden.
-///\e
-///
 bool hidden(const Node& n) const { return !(*node_filter_map)[n]; }
-/// Returns true if \c n is hidden.
+/// \brief Returns true if \c e is hidden.
+///
-///\e
+/// Returns true if \c e is hidden.
-///
 bool hidden(const UEdge& e) const { return !(*uedge_filter_map)[e]; }
 typedef False NodeNumTag;
 typedef False EdgeNumTag;
 void nextInc(UEdge& i, bool& d) const {
 Parent::nextInc(i, d);
 while (i!=INVALID && !(*uedge_filter_map)[i]) Parent::nextInc(i, d);
 }
-///\e
+/// \brief Hide the given node in the graph.
+///
 /// This function hides \c n in the graph, i.e. the iteration
 /// jumps over it. This is done by simply setting the value of \c n
 /// to be false in the corresponding node-map.
 void hide(const Node& n) const { node_filter_map->set(n, false); }
-///\e
+/// \brief Hide the given undirected edge in the graph.
+///
 /// This function hides \c e in the graph, i.e. the iteration
 /// jumps over it. This is done by simply setting the value of \c e
-/// to be false in the corresponding edge-map.
+/// to be false in the corresponding uedge-map.
 void hide(const UEdge& e) const { uedge_filter_map->set(e, false); }
-///\e
+/// \brief Unhide the given node in the graph.
+///
 /// The value of \c n is set to be true in the node-map which stores
 /// hide information. If \c n was hidden previuosly, then it is shown
 /// again
 void unHide(const Node& n) const { node_filter_map->set(n, true); }
-///\e
+/// \brief Hide the given undirected edge in the graph.
+///
-/// The value of \c e is set to be true in the edge-map which stores
+/// The value of \c e is set to be true in the uedge-map which stores
 /// hide information. If \c e was hidden previuosly, then it is shown
 /// again
 void unHide(const UEdge& e) const { uedge_filter_map->set(e, true); }
+/// \brief Returns true if \c n is hidden.
+///
 /// Returns true if \c n is hidden.
-///\e
-///
 bool hidden(const Node& n) const { return !(*node_filter_map)[n]; }
-/// Returns true if \c n is hidden.
+/// \brief Returns true if \c e is hidden.
+///
-///\e
+/// Returns true if \c e is hidden.
-///
 bool hidden(const UEdge& e) const { return !(*uedge_filter_map)[e]; }
 typedef False NodeNumTag;
 typedef False EdgeNumTag;
 /// edge-iterator cares only the filter on the edge-set.
 /// This way the edge-map
 /// should filter all edges which's source or target is filtered by the
 /// node-filter.
 ///
-/// Note that \c n is of type \c SubGA::NodeIt, but it can be converted to
-/// \c Graph::Node that is why \c g.id(n) can be applied.
-///
 template<typename _UGraph, typename NodeFilterMap,
 	   typename UEdgeFilterMap, bool checked = true>
 class SubUGraphAdaptor :
 public UGraphAdaptorExtender<
 SubUGraphAdaptorBase<_UGraph, NodeFilterMap, UEdgeFilterMap, checked> > {

changeset 2085	1970a93dfaa8
parent 2069	d55adbe1fc78
child 2087	67258b5a057b