Warning added on the usage of InDegMap/OutDegMap
authoralpar
Thu, 01 Sep 2005 20:35:30 +0000
changeset 1674648aa2f33dc8
parent 1673 8919ca9e70f3
child 1675 fa89ffb27a6d
Warning added on the usage of InDegMap/OutDegMap
lemon/graph_utils.h
     1.1 --- a/lemon/graph_utils.h	Thu Sep 01 19:21:35 2005 +0000
     1.2 +++ b/lemon/graph_utils.h	Thu Sep 01 20:35:30 2005 +0000
     1.3 @@ -1070,6 +1070,14 @@
     1.4    /// in constant time. On the other hand, the values are updated automatically
     1.5    /// whenever the graph changes.
     1.6    ///
     1.7 +  /// \warning Besides addNode() and addEdge(), a graph structure may provide
     1.8 +  /// alternative ways to mogify the graph. The correct behavior of InDegMap
     1.9 +  /// is not guarantied if these additional featureas are used. For example
    1.10 +  /// the funstions \ref ListGraph::changeSource() "changeSource()",
    1.11 +  /// \ref ListGraph::changeTarget() "changeTarget()" and
    1.12 +  /// \ref ListGraph::reverseEdge() "reverseEdge()"
    1.13 +  /// of \ref ListGraph will \e not update the degree values correctly.
    1.14 +  ///
    1.15    /// \sa OutDegMap
    1.16  
    1.17    template <typename _Graph>
    1.18 @@ -1154,7 +1162,6 @@
    1.19      AutoNodeMap deg;
    1.20    };
    1.21  
    1.22 -
    1.23    /// \brief Map of the node out-degrees.
    1.24    ///
    1.25    /// This map returns the out-degree of a node. Once it is constructed,
    1.26 @@ -1162,6 +1169,14 @@
    1.27    /// in constant time. On the other hand, the values are updated automatically
    1.28    /// whenever the graph changes.
    1.29    ///
    1.30 +  /// \warning Besides addNode() and addEdge(), a graph structure may provide
    1.31 +  /// alternative ways to mogify the graph. The correct behavior of OutDegMap
    1.32 +  /// is not guarantied if these additional featureas are used. For example
    1.33 +  /// the funstions \ref ListGraph::changeSource() "changeSource()",
    1.34 +  /// \ref ListGraph::changeTarget() "changeTarget()" and
    1.35 +  /// \ref ListGraph::reverseEdge() "reverseEdge()"
    1.36 +  /// of \ref ListGraph will \e not update the degree values correctly.
    1.37 +  ///
    1.38    /// \sa InDegMap
    1.39  
    1.40    template <typename _Graph>