COIN-OR::LEMON - Graph Library

Changeset 823:eff1caf6d32e in lemon for lemon/static_graph.h


Ignore:
Timestamp:
09/29/09 10:39:20 (15 years ago)
Author:
Peter Kovacs <kpeter@…>
Branch:
default
Children:
824:5764dd9b6e18, 825:a143f19f465b
Phase:
public
Message:

Extend the interface of StaticDigraph? (#68)
with index(), arc() and node() functions similarly to
other static graph structures.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • lemon/static_graph.h

    r822 r823  
    240240  /// support any other modification of the digraph.
    241241  ///
     242  /// Since this digraph structure is completely static, its nodes and arcs
     243  /// can be indexed with integers from the ranges <tt>[0..nodeNum()-1]</tt>
     244  /// and <tt>[0..arcNum()-1]</tt>, respectively.
     245  /// The index of an item is the same as its ID, it can be obtained
     246  /// using the corresponding \ref index() or \ref concepts::Digraph::id()
     247  /// "id()" function. A node or arc with a certain index can be obtained
     248  /// using node() or arc().
     249  ///
    242250  /// This type fully conforms to the \ref concepts::Digraph "Digraph concept".
    243251  /// Most of its member functions and nested classes are documented
     
    252260  public:
    253261 
    254     /// \brief Clear the digraph.
    255     ///
    256     /// This function erases all nodes and arcs from the digraph.
    257     void clear() {
    258       Parent::clear();
    259     }
    260    
     262    /// \brief Constructor
     263    ///
     264    /// Default constructor.
     265    StaticDigraph() : Parent() {}
     266
     267    /// \brief The node with the given index.
     268    ///
     269    /// This function returns the node with the given index.
     270    /// \sa index()
     271    Node node(int ix) const { return Parent::nodeFromId(ix); }
     272
     273    /// \brief The arc with the given index.
     274    ///
     275    /// This function returns the arc with the given index.
     276    /// \sa index()
     277    Arc arc(int ix) const { return Parent::arcFromId(ix); }
     278
     279    /// \brief The index of the given node.
     280    ///
     281    /// This function returns the index of the the given node.
     282    /// \sa node()
     283    int index(Node node) const { return Parent::id(node); }
     284
     285    /// \brief The index of the given arc.
     286    ///
     287    /// This function returns the index of the the given arc.
     288    /// \sa arc()
     289    int index(Arc arc) const { return Parent::id(arc); }
     290
     291    /// \brief Number of nodes.
     292    ///
     293    /// This function returns the number of nodes.
     294    int nodeNum() const { return node_num; }
     295
     296    /// \brief Number of arcs.
     297    ///
     298    /// This function returns the number of arcs.
     299    int arcNum() const { return arc_num; }
     300
    261301    /// \brief Build the digraph copying another digraph.
    262302    ///
     
    289329    }
    290330 
     331    /// \brief Clear the digraph.
     332    ///
     333    /// This function erases all nodes and arcs from the digraph.
     334    void clear() {
     335      Parent::clear();
     336    }
    291337
    292338  protected:
Note: See TracChangeset for help on using the changeset viewer.