COIN-OR::LEMON - Graph Library

Changeset 641:bfd6c14e2975 in lemon-0.x


Ignore:
Timestamp:
05/14/04 20:08:29 (16 years ago)
Author:
marci
Branch:
default
Phase:
public
Convert:
svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@839
Message:

some documentation in stGraphWrapper<Gr> and BipartiteGraphWrapper?<Gr>

File:
1 edited

Legend:

Unmodified
Added
Removed
  • src/work/marci/bipartite_graph_wrapper.h

    r558 r641  
    1717namespace hugo {
    1818
     19  /// \brief A wrapper for composing a bipartite graph from a graph
     20  /// and from a node-map showing for any node which color class it belongs to.
     21  ///
    1922  /// A wrapper for composing a bipartite graph.
    2023  /// \c _graph have to be a reference to a graph of type \c Graph
     
    2427  /// graph or a directed graph with edges oriented from S to T.
    2528  ///
    26   ///\author Marton Makai
     29  /// \author Marton Makai
    2730  template<typename Graph>
    2831  class BipartiteGraphWrapper : public GraphWrapper<Graph> {
     
    177180    }
    178181
     182    /// Returns true iff \c n is in S.
    179183    bool inSClass(const Node& n) const {
    180184      return !(*(this->s_false_t_true_map))[n];
    181185    }
     186
     187    /// Returns true iff \c n is in T.
    182188    bool inTClass(const Node& n) const {
    183189      return (*(this->s_false_t_true_map))[n];
     
    191197  const bool BipartiteGraphWrapper<G>::T_CLASS=true;
    192198
    193 
    194 
    195 
    196 
    197 
    198 
    199 
    200 
    201 
    202 
    203 
    204   ///\bug Do not use this while the bipartitemap augmentation
     199  /// \brief A bipartite graph template class
     200  ///
     201  /// This class composes a bipartite graph over a directed or undirected
     202  /// graph structure of type \c Graph.
     203  /// \c _graph have to be a reference to a graph of type \c Graph
     204  /// and \c _s_false_t_true_map is an \c IterableBoolMap
     205  /// reference containing the elements for the
     206  /// color classes S and T. \c _graph is to be referred to an undirected
     207  /// graph or a directed graph with edges oriented from S to T.
     208  ///
     209  ///\bug experimental. Do not use this while the bipartitemap augmentation
    205210  /// does not work well.
    206211  template<typename Graph>
     
    271276//   }
    272277
    273   /// experimentral, do not try it.
    274   /// It eats a bipartite graph, oriented from S to T.
    275   /// Such one can be made e.g. by the above wrapper.
     278  /// \brief A wrapper for adding extra nodes s and t to a bipartite graph
     279  /// and edges from s to each node of S and form each node of T to t.
     280  ///
     281  /// A wrapper for adding extra nodes s and t to a bipartite graph
     282  /// and edges from s to each node of S and form each node of T to t.
     283  /// This class is very useful to reduce some matching or more
     284  /// generally, capacitataed b-matching problem to a flow problem.
     285  /// According to the bipartite graph concepts the bipartite
     286  /// graph have to be oriented from S to T.
    276287  ///
    277   ///\author Marton Makai
     288  /// \author Marton Makai
    278289  template<typename Graph>
    279290  class stGraphWrapper : public GraphWrapper<Graph> {
Note: See TracChangeset for help on using the changeset viewer.