lemon-0.x: comparison lemon/graph

equal deleted inserted replaced

-:bb4caa63aa8c
+:c5cc9e634454
 ///\brief Base type for the Graph Adaptors
 ///\ingroup graph_adaptors
 ///
 ///Base type for the Graph Adaptors
 ///
-///\warning Graph adaptors are in even
-///more experimental state than the other
-///parts of the lib. Use them at you own risk.
-///
 ///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
 ///make easier implementing graph adaptors. E.g. if an adaptor is
 ///considered which differs from the wrapped graph only in some of its
 };
 ///\brief A graph adaptor which reverses the orientation of the edges.
 ///\ingroup graph_adaptors
-///
-///\warning Graph adaptors are in even more experimental
-///state than the other
-///parts of the lib. Use them at you own risk.
 ///
 /// If \c g is defined as
 ///\code
 /// ListGraph g;
 ///\endcode
 };
 /// \brief A graph adaptor for hiding nodes and edges from a graph.
 /// \ingroup graph_adaptors
-///
-/// \warning Graph adaptors are in even more experimental state than the
-/// other parts of the lib. Use them at you own risk.
 ///
 /// SubGraphAdaptor shows the graph with filtered node-set and
 /// edge-set. If the \c checked parameter is true then it filters the edgeset
 /// to do not get invalid edges without source or target.
 /// Let \f$ G=(V, A) \f$ be a directed graph
 ///\brief An adaptor for hiding nodes from a graph.
 ///\ingroup graph_adaptors
 ///
-///\warning Graph adaptors are in even more experimental state
-///than the other
-///parts of the lib. Use them at you own risk.
-///
 ///An adaptor for hiding nodes from a graph.
 ///This adaptor specializes SubGraphAdaptor in the way that only
 ///the node-set
 ///can be filtered. In usual case the checked parameter is true, we get the
 ///induced subgraph. But if the checked parameter is false then we can only
 nodeSubGraphAdaptor(const Graph& graph, const NodeFilterMap& nfm) {
 return NodeSubGraphAdaptor<const Graph, const NodeFilterMap>(graph, nfm);
 }
 ///\brief An adaptor for hiding edges from a graph.
-///
-///\warning Graph adaptors are in even more experimental state
-///than the other parts of the lib. Use them at you own risk.
 ///
 ///An adaptor for hiding edges from a graph.
 ///This adaptor specializes SubGraphAdaptor in the way that
 ///only the edge-set
 ///can be filtered. The usefulness of this adaptor is demonstrated in the
 ///\brief An adaptor for composing the residual
 ///graph for directed flow and circulation problems.
 ///
 ///\ingroup graph_adaptors
 ///
-///An adaptor for composing the residual graph for
+///An adaptor for composing the residual graph for directed flow and
-///directed flow and circulation problems.
+///circulation problems.  Let \f$ G=(V, A) \f$ be a directed graph
-//   ///Let \f$ G=(V, A) \f$ be a directed graph and let \f$ F \f$ be a
+///and let \f$ F \f$ be a number type. Let moreover \f$ f,c:A\to F \f$,
-//   ///number type. Let moreover
+///be functions on the edge-set.
-//   ///\f$ f,c:A\to F \f$, be functions on the edge-set.
+///
-//   ///In the appications of ResGraphAdaptor, \f$ f \f$ usually stands for a
+///In the appications of ResGraphAdaptor, \f$ f \f$ usually stands
-//   ///flow and \f$ c \f$ for a capacity function.
+///for a flow and \f$ c \f$ for a capacity function.  Suppose that a
-//   ///Suppose that a graph instange \c g of type
+///graph instange \c g of type \c ListGraph implements \f$ G \f$.
-//   ///\c ListGraph implements \f$ G \f$.
+///
-//   ///\code
+///\code
-//   /// ListGraph g;
+///  ListGraph g;
-//   ///\endcode
+///\endcode
-//   ///Then RevGraphAdaptor implements the graph structure with node-set
+///
-//   ///\f$ V \f$ and edge-set \f$ A_{forward}\cup A_{backward} \f$, where
+///Then RevGraphAdaptor implements the graph structure with node-set
-//   ///\f$ A_{forward}=\{uv : uv\in A, f(uv)<c(uv)\} \f$ and
+/// \f$ V \f$ and edge-set \f$ A_{forward}\cup A_{backward} \f$,
-//   ///\f$ A_{backward}=\{vu : uv\in A, f(uv)>0\} \f$,
+///where \f$ A_{forward}=\{uv : uv\in A, f(uv)<c(uv)\} \f$ and
-//   ///i.e. the so called residual graph.
+/// \f$ A_{backward}=\{vu : uv\in A, f(uv)>0\} \f$, i.e. the so called
-//   ///When we take the union \f$ A_{forward}\cup A_{backward} \f$,
+///residual graph.  When we take the union
-//   ///multilicities are counted, i.e. if an edge is in both
+/// \f$ A_{forward}\cup A_{backward} \f$, multilicities are counted, i.e.
-//   ///\f$ A_{forward} \f$ and \f$ A_{backward} \f$, then in the adaptor it
+///if an edge is in both \f$ A_{forward} \f$ and \f$ A_{backward} \f$,
-//   ///appears twice. The following code shows how such an instance can be
+///then in the adaptor it appears twice. The following code shows how
-//   ///constructed.
+///such an instance can be constructed.
-//   ///\code
+///
-//   /// typedef ListGraph Graph;
+///\code
-//   /// Graph::EdgeMap<int> f(g);
+///  typedef ListGraph Graph;
-//   /// Graph::EdgeMap<int> c(g);
+///  Graph::EdgeMap<int> f(g);
-//   /// ResGraphAdaptor<Graph, int, Graph::EdgeMap<int>, Graph::EdgeMap<int> > ga(g);
+///  Graph::EdgeMap<int> c(g);
-//   ///\endcode
+///  ResGraphAdaptor<Graph, int, Graph::EdgeMap<int>, Graph::EdgeMap<int> > ga(g);
-//   ///\author Marton Makai
+///\endcode
-//   ///
+///\author Marton Makai
+///
 template<typename Graph, typename Number,
 	   typename CapacityMap, typename FlowMap,
 typename Tolerance = Tolerance<Number> >
 class ResGraphAdaptor :
 public EdgeSubGraphAdaptor<
 ///\brief For blocking flows.
 ///\ingroup graph_adaptors
 ///
-///\warning Graph adaptors are in even more
-///experimental state than the other
-///parts of the lib. Use them at you own risk.
-///
 ///This graph adaptor is used for on-the-fly
 ///Dinits blocking flow computations.
 ///For each node, an out-edge is stored which is used when the
 ///\code
 ///OutEdgeIt& first(OutEdgeIt&, const Node&)

changeset 2042	bdc953f2a449
parent 2037	32e4bebee616
child 2079	7fe378247fea