1.1 --- a/lemon/ugraph_adaptor.h Mon May 15 09:46:33 2006 +0000
1.2 +++ b/lemon/ugraph_adaptor.h Mon May 15 09:49:51 2006 +0000
1.3 @@ -38,8 +38,6 @@
1.4
1.5 namespace lemon {
1.6
1.7 - /// \ingroup graph_adaptors
1.8 - ///
1.9 /// \brief Base type for the Graph Adaptors
1.10 ///
1.11 /// This is the base type for most of LEMON graph adaptors.
1.12 @@ -233,6 +231,11 @@
1.13 };
1.14
1.15 /// \ingroup graph_adaptors
1.16 + ///
1.17 + /// \brief Trivial undirected graph adaptor
1.18 + ///
1.19 + /// This class is an adaptor which does not change the adapted undirected
1.20 + /// graph. It can be used only to test the undirected graph adaptors.
1.21 template <typename _UGraph>
1.22 class UGraphAdaptor
1.23 : public UGraphAdaptorExtender< UGraphAdaptorBase<_UGraph> > {
1.24 @@ -348,44 +351,42 @@
1.25 || !(*node_filter_map)[Parent::source(i)])) Parent::nextInc(i, d);
1.26 }
1.27
1.28 - ///\e
1.29 -
1.30 + /// \brief Hide the given node in the graph.
1.31 + ///
1.32 /// This function hides \c n in the graph, i.e. the iteration
1.33 /// jumps over it. This is done by simply setting the value of \c n
1.34 /// to be false in the corresponding node-map.
1.35 void hide(const Node& n) const { node_filter_map->set(n, false); }
1.36
1.37 - ///\e
1.38 -
1.39 + /// \brief Hide the given undirected edge in the graph.
1.40 + ///
1.41 /// This function hides \c e in the graph, i.e. the iteration
1.42 /// jumps over it. This is done by simply setting the value of \c e
1.43 - /// to be false in the corresponding edge-map.
1.44 + /// to be false in the corresponding uedge-map.
1.45 void hide(const UEdge& e) const { uedge_filter_map->set(e, false); }
1.46
1.47 - ///\e
1.48 -
1.49 + /// \brief Unhide the given node in the graph.
1.50 + ///
1.51 /// The value of \c n is set to be true in the node-map which stores
1.52 /// hide information. If \c n was hidden previuosly, then it is shown
1.53 /// again
1.54 void unHide(const Node& n) const { node_filter_map->set(n, true); }
1.55
1.56 - ///\e
1.57 -
1.58 - /// The value of \c e is set to be true in the edge-map which stores
1.59 + /// \brief Hide the given undirected edge in the graph.
1.60 + ///
1.61 + /// The value of \c e is set to be true in the uedge-map which stores
1.62 /// hide information. If \c e was hidden previuosly, then it is shown
1.63 /// again
1.64 void unHide(const UEdge& e) const { uedge_filter_map->set(e, true); }
1.65
1.66 + /// \brief Returns true if \c n is hidden.
1.67 + ///
1.68 /// Returns true if \c n is hidden.
1.69 -
1.70 - ///\e
1.71 - ///
1.72 bool hidden(const Node& n) const { return !(*node_filter_map)[n]; }
1.73
1.74 - /// Returns true if \c n is hidden.
1.75 -
1.76 - ///\e
1.77 + /// \brief Returns true if \c e is hidden.
1.78 ///
1.79 + /// Returns true if \c e is hidden.
1.80 bool hidden(const UEdge& e) const { return !(*uedge_filter_map)[e]; }
1.81
1.82 typedef False NodeNumTag;
1.83 @@ -577,44 +578,42 @@
1.84 while (i!=INVALID && !(*uedge_filter_map)[i]) Parent::nextInc(i, d);
1.85 }
1.86
1.87 - ///\e
1.88 -
1.89 + /// \brief Hide the given node in the graph.
1.90 + ///
1.91 /// This function hides \c n in the graph, i.e. the iteration
1.92 /// jumps over it. This is done by simply setting the value of \c n
1.93 /// to be false in the corresponding node-map.
1.94 void hide(const Node& n) const { node_filter_map->set(n, false); }
1.95
1.96 - ///\e
1.97 -
1.98 + /// \brief Hide the given undirected edge in the graph.
1.99 + ///
1.100 /// This function hides \c e in the graph, i.e. the iteration
1.101 /// jumps over it. This is done by simply setting the value of \c e
1.102 - /// to be false in the corresponding edge-map.
1.103 + /// to be false in the corresponding uedge-map.
1.104 void hide(const UEdge& e) const { uedge_filter_map->set(e, false); }
1.105
1.106 - ///\e
1.107 -
1.108 + /// \brief Unhide the given node in the graph.
1.109 + ///
1.110 /// The value of \c n is set to be true in the node-map which stores
1.111 /// hide information. If \c n was hidden previuosly, then it is shown
1.112 /// again
1.113 void unHide(const Node& n) const { node_filter_map->set(n, true); }
1.114
1.115 - ///\e
1.116 -
1.117 - /// The value of \c e is set to be true in the edge-map which stores
1.118 + /// \brief Hide the given undirected edge in the graph.
1.119 + ///
1.120 + /// The value of \c e is set to be true in the uedge-map which stores
1.121 /// hide information. If \c e was hidden previuosly, then it is shown
1.122 /// again
1.123 void unHide(const UEdge& e) const { uedge_filter_map->set(e, true); }
1.124
1.125 + /// \brief Returns true if \c n is hidden.
1.126 + ///
1.127 /// Returns true if \c n is hidden.
1.128 -
1.129 - ///\e
1.130 - ///
1.131 bool hidden(const Node& n) const { return !(*node_filter_map)[n]; }
1.132
1.133 - /// Returns true if \c n is hidden.
1.134 -
1.135 - ///\e
1.136 + /// \brief Returns true if \c e is hidden.
1.137 ///
1.138 + /// Returns true if \c e is hidden.
1.139 bool hidden(const UEdge& e) const { return !(*uedge_filter_map)[e]; }
1.140
1.141 typedef False NodeNumTag;
1.142 @@ -733,9 +732,6 @@
1.143 /// should filter all edges which's source or target is filtered by the
1.144 /// node-filter.
1.145 ///
1.146 - /// Note that \c n is of type \c SubGA::NodeIt, but it can be converted to
1.147 - /// \c Graph::Node that is why \c g.id(n) can be applied.
1.148 - ///
1.149 template<typename _UGraph, typename NodeFilterMap,
1.150 typename UEdgeFilterMap, bool checked = true>
1.151 class SubUGraphAdaptor :