COIN-OR::LEMON - Graph Library

Changeset 612:0856a9a87eb9 in lemon-0.x


Ignore:
Timestamp:
05/11/04 19:02:32 (16 years ago)
Author:
marci
Branch:
default
Phase:
public
Convert:
svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@795
Message:

BidirGraph?, UndirGraph? some docs, in group graphs

File:
1 edited

Legend:

Unmodified
Added
Removed
  • src/hugo/graph_wrapper.h

    r594 r612  
    8383  ///\todo Some more docs...
    8484  ///
    85   ///\author Marton Makai
    86  
     85  ///\author Marton Makai
    8786  template<typename Graph>
    8887  class GraphWrapper {
     
    224223
    225224  /// A graph wrapper which reverses the orientation of the edges.
     225  /// Thus \c Graph have to be a directed graph type.
    226226  ///
    227227  ///\author Marton Makai
     
    229229  class RevGraphWrapper : public GraphWrapper<Graph> {
    230230  protected:
    231     RevGraphWrapper() : GraphWrapper<Graph>(0) { }
     231    RevGraphWrapper() : GraphWrapper<Graph>() { }
    232232  public:
    233233    RevGraphWrapper(Graph& _graph) : GraphWrapper<Graph>(_graph) { } 
     
    297297
    298298
    299   /// Wrapper for hiding nodes and edges from a graph.
     299  /// A graph wrapper for hiding nodes and edges from a graph.
    300300 
    301301  /// This wrapper shows a graph with filtered node-set and
     
    312312    EdgeFilterMap* edge_filter_map;
    313313
    314     SubGraphWrapper() : GraphWrapper<Graph>(0),
     314    SubGraphWrapper() : GraphWrapper<Graph>(),
    315315                        node_filter_map(0), edge_filter_map(0) { }
    316316    void setNodeFilterMap(NodeFilterMap& _node_filter_map) {
     
    489489
    490490
    491   /// A wrapper for forgetting the orientation of a graph.
    492 
     491  /// \brief A wrapper for forgetting the orientation of a graph.
     492  ///
    493493  /// A wrapper for getting an undirected graph by forgetting
    494494  /// the orientation of a directed one.
    495495  ///
    496   ///\author Marton Makai
     496  /// \author Marton Makai
    497497  template<typename Graph>
    498498  class UndirGraphWrapper : public GraphWrapper<Graph> {
     
    574574  };
    575575 
    576 
    577 
    578   /// An undirected graph template
     576  /// \brief An undirected graph template.
     577  ///
     578  /// An undirected graph template.
     579  /// This class works as an undirected graph and a directed graph of
     580  /// class \c Graph is used for the physical storage.
     581  /// \ingroup graphs
    579582  template<typename Graph>
    580583  class UndirGraph : public UndirGraphWrapper<Graph> {
     
    589592
    590593
     594  ///\brief A wrapper for composing bidirected graph from a directed one.
     595  /// experimental, for fezso's sake.
     596  ///
    591597  /// A wrapper for composing bidirected graph from a directed one.
    592598  /// experimental, for fezso's sake.
    593 
    594   /// A wrapper for composing bidirected graph from a directed one.
    595   /// experimental, for fezso's sake.
     599  /// A bidirected graph is composed over the directed one without physical
     600  /// storage. As the oppositely directed edges are logically different ones
     601  /// the maps are able to attach different values for them.
    596602  template<typename Graph>
    597603  class BidirGraphWrapper : public GraphWrapper<Graph> {
     
    911917  };
    912918
     919  /// \brief A bidirected graph template.
     920  ///
     921  /// A bidirected graph template.
     922  /// Such a bidirected graph stores each pair of oppositely directed edges
     923  /// ones in the memory, i.e. a directed graph of type
     924  /// \c Graph is used for that.
     925  /// As the oppositely directed edges are logically different ones
     926  /// the maps are able to attach different values for them.
     927  /// \ingroup graphs
     928  template<typename Graph>
     929  class BidirGraph : public BidirGraphWrapper<Graph> {
     930    typedef UndirGraphWrapper<Graph> Parent;
     931  protected:
     932    Graph gr;
     933  public:
     934    BidirGraph() : BidirGraphWrapper<Graph>() {
     935      Parent::setGraph(gr);
     936    }
     937  };
    913938
    914939
     
    12271252
    12281253
    1229   /// ErasingFirstGraphWrapper for blocking flows.
    1230 
    1231   /// ErasingFirstGraphWrapper for blocking flows.
     1254  /// For blocking flows.
     1255
     1256  /// This graph wrapper is used for Dinits blocking flow computations.
     1257  /// For each node, an out-edge is stored which is used when the
     1258  /// \code
     1259  /// OutEdgeIt& first(OutEdgeIt&, const Node&)
     1260  /// \endcode
     1261  /// is called.
    12321262  ///
    12331263  ///\author Marton Makai
Note: See TracChangeset for help on using the changeset viewer.