COIN-OR::LEMON - Graph Library

Changeset 2084:59769591eb60 in lemon-0.x for lemon/ugraph_adaptor.h


Ignore:
Timestamp:
05/15/06 11:49:51 (14 years ago)
Author:
Balazs Dezso
Branch:
default
Phase:
public
Convert:
svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@2749
Message:

Documentation improvements

Rearrangements:

IO modules
Algorithms

New documentation:

SwapBpUGraphAdaptor

Demos:

strongly_connected_orientation.cc

Benchmarks:

swap_bipartite_bench.cc

File:
1 edited

Legend:

Unmodified
Added
Removed
  • lemon/ugraph_adaptor.h

    r2069 r2084  
    3939namespace lemon {
    4040
    41   /// \ingroup graph_adaptors
    42   ///
    4341  /// \brief Base type for the Graph Adaptors
    4442  ///
     
    234232
    235233  /// \ingroup graph_adaptors
     234  ///
     235  /// \brief Trivial undirected graph adaptor
     236  ///
     237  /// This class is an adaptor which does not change the adapted undirected
     238  /// graph. It can be used only to test the undirected graph adaptors.
    236239  template <typename _UGraph>
    237240  class UGraphAdaptor
     
    349352    }
    350353
    351     ///\e
    352 
     354    /// \brief Hide the given node in the graph.
     355    ///
    353356    /// This function hides \c n in the graph, i.e. the iteration
    354357    /// jumps over it. This is done by simply setting the value of \c n 
     
    356359    void hide(const Node& n) const { node_filter_map->set(n, false); }
    357360
    358     ///\e
    359 
     361    /// \brief Hide the given undirected edge in the graph.
     362    ///
    360363    /// This function hides \c e in the graph, i.e. the iteration
    361364    /// jumps over it. This is done by simply setting the value of \c e 
    362     /// to be false in the corresponding edge-map.
     365    /// to be false in the corresponding uedge-map.
    363366    void hide(const UEdge& e) const { uedge_filter_map->set(e, false); }
    364367
    365     ///\e
    366 
     368    /// \brief Unhide the given node in the graph.
     369    ///
    367370    /// The value of \c n is set to be true in the node-map which stores
    368371    /// hide information. If \c n was hidden previuosly, then it is shown
     
    370373     void unHide(const Node& n) const { node_filter_map->set(n, true); }
    371374
    372     ///\e
    373 
    374     /// The value of \c e is set to be true in the edge-map which stores
     375    /// \brief Hide the given undirected edge in the graph.
     376    ///
     377    /// The value of \c e is set to be true in the uedge-map which stores
    375378    /// hide information. If \c e was hidden previuosly, then it is shown
    376379    /// again
    377380    void unHide(const UEdge& e) const { uedge_filter_map->set(e, true); }
    378381
     382    /// \brief Returns true if \c n is hidden.
     383    ///
    379384    /// Returns true if \c n is hidden.
    380    
    381     ///\e
    382     ///
    383385    bool hidden(const Node& n) const { return !(*node_filter_map)[n]; }
    384386
    385     /// Returns true if \c n is hidden.
    386    
    387     ///\e
    388     ///
     387    /// \brief Returns true if \c e is hidden.
     388    ///
     389    /// Returns true if \c e is hidden.
    389390    bool hidden(const UEdge& e) const { return !(*uedge_filter_map)[e]; }
    390391
     
    578579    }
    579580
    580     ///\e
    581 
     581    /// \brief Hide the given node in the graph.
     582    ///
    582583    /// This function hides \c n in the graph, i.e. the iteration
    583584    /// jumps over it. This is done by simply setting the value of \c n 
     
    585586    void hide(const Node& n) const { node_filter_map->set(n, false); }
    586587
    587     ///\e
    588 
     588    /// \brief Hide the given undirected edge in the graph.
     589    ///
    589590    /// This function hides \c e in the graph, i.e. the iteration
    590591    /// jumps over it. This is done by simply setting the value of \c e 
    591     /// to be false in the corresponding edge-map.
     592    /// to be false in the corresponding uedge-map.
    592593    void hide(const UEdge& e) const { uedge_filter_map->set(e, false); }
    593594
    594     ///\e
    595 
     595    /// \brief Unhide the given node in the graph.
     596    ///
    596597    /// The value of \c n is set to be true in the node-map which stores
    597598    /// hide information. If \c n was hidden previuosly, then it is shown
     
    599600     void unHide(const Node& n) const { node_filter_map->set(n, true); }
    600601
    601     ///\e
    602 
    603     /// The value of \c e is set to be true in the edge-map which stores
     602    /// \brief Hide the given undirected edge in the graph.
     603    ///
     604    /// The value of \c e is set to be true in the uedge-map which stores
    604605    /// hide information. If \c e was hidden previuosly, then it is shown
    605606    /// again
    606607    void unHide(const UEdge& e) const { uedge_filter_map->set(e, true); }
    607608
     609    /// \brief Returns true if \c n is hidden.
     610    ///
    608611    /// Returns true if \c n is hidden.
    609    
    610     ///\e
    611     ///
    612612    bool hidden(const Node& n) const { return !(*node_filter_map)[n]; }
    613613
    614     /// Returns true if \c n is hidden.
    615    
    616     ///\e
    617     ///
     614    /// \brief Returns true if \c e is hidden.
     615    ///
     616    /// Returns true if \c e is hidden.
    618617    bool hidden(const UEdge& e) const { return !(*uedge_filter_map)[e]; }
    619618
     
    734733  /// node-filter.
    735734  ///
    736   /// Note that \c n is of type \c SubGA::NodeIt, but it can be converted to
    737   /// \c Graph::Node that is why \c g.id(n) can be applied.
    738   ///
    739735  template<typename _UGraph, typename NodeFilterMap,
    740736           typename UEdgeFilterMap, bool checked = true>
Note: See TracChangeset for help on using the changeset viewer.