An alert added to doc.
authoralpar
Fri, 17 Sep 2004 15:11:39 +0000
changeset 8795e284075b193
parent 878 86b42ec55f3e
child 880 9d0bfd35b97c
An alert added to doc.
src/hugo/graph_wrapper.h
     1.1 --- a/src/hugo/graph_wrapper.h	Fri Sep 17 12:23:09 2004 +0000
     1.2 +++ b/src/hugo/graph_wrapper.h	Fri Sep 17 15:11:39 2004 +0000
     1.3 @@ -80,6 +80,9 @@
     1.4  
     1.5    ///Base type for the Graph Wrappers
     1.6  
     1.7 +  ///\warning Graph wrappers are in even more experimental state than the other
     1.8 +  ///parts of the lib. Use them at you own risk.
     1.9 +  ///
    1.10    ///This is the base type for the Graph Wrappers.
    1.11    ///\todo Some more docs... 
    1.12    ///
    1.13 @@ -214,6 +217,9 @@
    1.14  
    1.15    /// A graph wrapper which reverses the orientation of the edges.
    1.16  
    1.17 +  ///\warning Graph wrappers are in even more experimental state than the other
    1.18 +  ///parts of the lib. Use them at you own risk.
    1.19 +  ///
    1.20    /// A graph wrapper which reverses the orientation of the edges.
    1.21    /// Thus \c Graph have to be a directed graph type.
    1.22    ///
    1.23 @@ -288,6 +294,9 @@
    1.24  
    1.25    /// A graph wrapper for hiding nodes and edges from a graph.
    1.26    
    1.27 +  ///\warning Graph wrappers are in even more experimental state than the other
    1.28 +  ///parts of the lib. Use them at you own risk.
    1.29 +  ///
    1.30    /// This wrapper shows a graph with filtered node-set and 
    1.31    /// edge-set. Given a bool-valued map on the node-set and one on 
    1.32    /// the edge-set of the graphs, the iterators shows only the objects 
    1.33 @@ -555,6 +564,9 @@
    1.34    
    1.35    /// \brief An undirected graph template.
    1.36    ///
    1.37 +  ///\warning Graph wrappers are in even more experimental state than the other
    1.38 +  ///parts of the lib. Use them at you own risk.
    1.39 +  ///
    1.40    /// An undirected graph template.
    1.41    /// This class works as an undirected graph and a directed graph of 
    1.42    /// class \c Graph is used for the physical storage.
    1.43 @@ -577,6 +589,9 @@
    1.44    ///\brief A wrapper for composing a subgraph of a 
    1.45    /// bidirected graph made from a directed one. 
    1.46    ///
    1.47 +  ///\warning Graph wrappers are in even more experimental state than the other
    1.48 +  ///parts of the lib. Use them at you own risk.
    1.49 +  ///
    1.50    /// Suppose that for a directed graph $G=(V, A)$, 
    1.51    /// two predicates on the edge-set, $forward_filter$, and $backward_filter$ 
    1.52    /// is given, and we are dealing with the directed graph
    1.53 @@ -915,6 +930,9 @@
    1.54  
    1.55    ///\brief A wrapper for composing bidirected graph from a directed one. 
    1.56    ///
    1.57 +  ///\warning Graph wrappers are in even more experimental state than the other
    1.58 +  ///parts of the lib. Use them at you own risk.
    1.59 +  ///
    1.60    /// A wrapper for composing bidirected graph from a directed one. 
    1.61    /// A bidirected graph is composed over the directed one without physical 
    1.62    /// storage. As the oppositely directed edges are logically different ones 
    1.63 @@ -953,6 +971,9 @@
    1.64  
    1.65    /// \brief A bidirected graph template.
    1.66    ///
    1.67 +  ///\warning Graph wrappers are in even more experimental state than the other
    1.68 +  ///parts of the lib. Use them at you own risk.
    1.69 +  ///
    1.70    /// A bidirected graph template.
    1.71    /// Such a bidirected graph stores each pair of oppositely directed edges 
    1.72    /// ones in the memory, i.e. a directed graph of type 
    1.73 @@ -1013,6 +1034,9 @@
    1.74    
    1.75    /// A wrapper for composing the residual graph for directed flow and circulation problems.
    1.76  
    1.77 +  ///\warning Graph wrappers are in even more experimental state than the other
    1.78 +  ///parts of the lib. Use them at you own risk.
    1.79 +  ///
    1.80    /// A wrapper for composing the residual graph for directed flow and circulation problems.
    1.81    template<typename Graph, typename Number, 
    1.82  	   typename CapacityMap, typename FlowMap>
    1.83 @@ -1088,6 +1112,9 @@
    1.84  
    1.85    /// For blocking flows.
    1.86  
    1.87 +  ///\warning Graph wrappers are in even more experimental state than the other
    1.88 +  ///parts of the lib. Use them at you own risk.
    1.89 +  ///
    1.90    /// This graph wrapper is used for on-the-fly 
    1.91    /// Dinits blocking flow computations.
    1.92    /// For each node, an out-edge is stored which is used when the