lemon/min_cut.h
changeset 2261 c52b572c294f
parent 2225 bb3d5e6f9fcb
child 2263 9273fe7d850c
equal deleted inserted replaced
11:738ef776f89c 12:48bc04a4588d
    65     typedef _Graph Graph;
    65     typedef _Graph Graph;
    66 
    66 
    67     /// \brief The type of the map that stores the edge capacities.
    67     /// \brief The type of the map that stores the edge capacities.
    68     ///
    68     ///
    69     /// The type of the map that stores the edge capacities.
    69     /// The type of the map that stores the edge capacities.
    70     /// It must meet the \ref concept::ReadMap "ReadMap" concept.
    70     /// It must meet the \ref concepts::ReadMap "ReadMap" concept.
    71     typedef _CapacityMap CapacityMap;
    71     typedef _CapacityMap CapacityMap;
    72 
    72 
    73     /// \brief The type of the capacity of the edges.
    73     /// \brief The type of the capacity of the edges.
    74     typedef typename CapacityMap::Value Value;
    74     typedef typename CapacityMap::Value Value;
    75 
    75 
   111     }
   111     }
   112 
   112 
   113     /// \brief The type of the map that stores whether a nodes is processed.
   113     /// \brief The type of the map that stores whether a nodes is processed.
   114     ///
   114     ///
   115     /// The type of the map that stores whether a nodes is processed.
   115     /// The type of the map that stores whether a nodes is processed.
   116     /// It must meet the \ref concept::WriteMap "WriteMap" concept.
   116     /// It must meet the \ref concepts::WriteMap "WriteMap" concept.
   117     /// By default it is a NullMap.
   117     /// By default it is a NullMap.
   118     typedef NullMap<typename Graph::Node, bool> ProcessedMap;
   118     typedef NullMap<typename Graph::Node, bool> ProcessedMap;
   119 
   119 
   120     /// \brief Instantiates a ProcessedMap.
   120     /// \brief Instantiates a ProcessedMap.
   121     ///
   121     ///
   132     }
   132     }
   133 
   133 
   134     /// \brief The type of the map that stores the cardinalties of the nodes.
   134     /// \brief The type of the map that stores the cardinalties of the nodes.
   135     /// 
   135     /// 
   136     /// The type of the map that stores the cardinalities of the nodes.
   136     /// The type of the map that stores the cardinalities of the nodes.
   137     /// It must meet the \ref concept::WriteMap "WriteMap" concept.
   137     /// It must meet the \ref concepts::WriteMap "WriteMap" concept.
   138     typedef typename Graph::template NodeMap<Value> CardinalityMap;
   138     typedef typename Graph::template NodeMap<Value> CardinalityMap;
   139 
   139 
   140     /// \brief Instantiates a CardinalityMap.
   140     /// \brief Instantiates a CardinalityMap.
   141     ///
   141     ///
   142     /// This function instantiates a \ref CardinalityMap. 
   142     /// This function instantiates a \ref CardinalityMap. 
   160   /// again any unprocessed node of the graph. Each node cardinality is
   160   /// again any unprocessed node of the graph. Each node cardinality is
   161   /// the sum of capacities on the out edges to the nodes which are processed
   161   /// the sum of capacities on the out edges to the nodes which are processed
   162   /// before the given node.
   162   /// before the given node.
   163   ///
   163   ///
   164   /// The edge capacities are passed to the algorithm using a
   164   /// The edge capacities are passed to the algorithm using a
   165   /// \ref concept::ReadMap "ReadMap", so it is easy to change it to any 
   165   /// \ref concepts::ReadMap "ReadMap", so it is easy to change it to any 
   166   /// kind of capacity.
   166   /// kind of capacity.
   167   ///
   167   ///
   168   /// The type of the capacity is determined by the \ref 
   168   /// The type of the capacity is determined by the \ref 
   169   /// concept::ReadMap::Value "Value" of the capacity map.
   169   /// concepts::ReadMap::Value "Value" of the capacity map.
   170   ///
   170   ///
   171   /// It is also possible to change the underlying priority heap.
   171   /// It is also possible to change the underlying priority heap.
   172   ///
   172   ///
   173   ///
   173   ///
   174   /// \param _Graph The graph type the algorithm runs on. The default value
   174   /// \param _Graph The graph type the algorithm runs on. The default value
   177   /// \ref MaxCardinalitySearchDefaultTraits.
   177   /// \ref MaxCardinalitySearchDefaultTraits.
   178   /// \param _CapacityMap This read-only EdgeMap determines the capacities of 
   178   /// \param _CapacityMap This read-only EdgeMap determines the capacities of 
   179   /// the edges. It is read once for each edge, so the map may involve in
   179   /// the edges. It is read once for each edge, so the map may involve in
   180   /// relatively time consuming process to compute the edge capacity if
   180   /// relatively time consuming process to compute the edge capacity if
   181   /// it is necessary. The default map type is \ref
   181   /// it is necessary. The default map type is \ref
   182   /// concept::Graph::EdgeMap "Graph::EdgeMap<int>".  The value
   182   /// concepts::Graph::EdgeMap "Graph::EdgeMap<int>".  The value
   183   /// of CapacityMap is not used directly by search algorithm, it is only 
   183   /// of CapacityMap is not used directly by search algorithm, it is only 
   184   /// passed to \ref MaxCardinalitySearchDefaultTraits.  
   184   /// passed to \ref MaxCardinalitySearchDefaultTraits.  
   185   /// \param _Traits Traits class to set various data types used by the 
   185   /// \param _Traits Traits class to set various data types used by the 
   186   /// algorithm.  The default traits class is 
   186   /// algorithm.  The default traits class is 
   187   /// \ref MaxCardinalitySearchDefaultTraits 
   187   /// \ref MaxCardinalitySearchDefaultTraits 
   712     }
   712     }
   713 
   713 
   714     /// \brief The type of the map that stores the edge capacities.
   714     /// \brief The type of the map that stores the edge capacities.
   715     ///
   715     ///
   716     /// The type of the map that stores the edge capacities.
   716     /// The type of the map that stores the edge capacities.
   717     /// It must meet the \ref concept::ReadMap "ReadMap" concept.
   717     /// It must meet the \ref concepts::ReadMap "ReadMap" concept.
   718     typedef _CapacityMap CapacityMap;
   718     typedef _CapacityMap CapacityMap;
   719 
   719 
   720     /// \brief Instantiates a CapacityMap.
   720     /// \brief Instantiates a CapacityMap.
   721     ///
   721     ///
   722     /// This function instantiates a \ref CapacityMap.
   722     /// This function instantiates a \ref CapacityMap.