COIN-OR::LEMON - Graph Library

Changeset 186:47cd1716870e in lemon-0.x for src/work/alpar/emptygraph.h


Ignore:
Timestamp:
03/15/04 17:30:20 (16 years ago)
Author:
Alpar Juttner
Branch:
default
Phase:
public
Convert:
svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@262
Message:

.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • src/work/alpar/emptygraph.h

    r183 r186  
    1313  /// An empty graph class.
    1414 
    15   /// This class provides all the common features of a grapf structure,
    16   /// however completely without implementations or real data structures
     15  /// This class provides all the common features of a graph structure,
     16  /// however completely without implementations and real data structures
    1717  /// behind the interface.
    1818  /// All graph algorithms should compile with this class, but it will not
     
    3232    /// The base type of the node iterators.
    3333
    34     /// This \c Node is the base type of each node iterators,
     34    /// This is the base type of each node iterators,
    3535    /// thus each kind of node iterator will convert to this.
    3636    class Node {
     
    5959   
    6060    /// This iterator goes through each node.
     61
     62    /// This iterator goes through each node.
     63    /// Its usage is quite simple, for example you can count the number
     64    /// of nodes in graph \c G of type \c Graph like this:
     65    /// \code
     66    ///int count=0;
     67    ///for(Graph::NodeIt n(G);G.valid(n);G.next(n)) count++;
     68    /// \endcode
    6169    class NodeIt : public Node {
    6270    public:
     
    92100    };
    93101   
    94     /// This iterator goes trought the outgoing edges of a certain graph.
     102    /// This iterator goes trought the outgoing edges of a node.
     103
     104    /// This iterator goes trought the \e outgoing edges of a certain node
     105    /// of a graph.
     106    /// Its usage is quite simple, for example you can count the number
     107    /// of outgoing edges of a node \c n
     108    /// in graph \c G of type \c Graph as follows.
     109    /// \code
     110    ///int count=0;
     111    ///for(Graph::OutEdgeIt e(G,n);G.valid(e);G.next(e)) count++;
     112    /// \endcode
    95113   
    96114    class OutEdgeIt : public Edge {
     
    110128    };
    111129
     130    /// This iterator goes trought the incoming edges of a node.
     131
     132    /// This iterator goes trought the \e incoming edges of a certain node
     133    /// of a graph.
     134    /// Its usage is quite simple, for example you can count the number
     135    /// of outgoing edges of a node \c n
     136    /// in graph \c G of type \c Graph as follows.
     137    /// \code
     138    ///int count=0;
     139    ///for(Graph::InEdgeIt e(G,n);G.valid(e);G.next(e)) count++;
     140    /// \endcode
     141
    112142    class InEdgeIt : public Edge {
    113143    public:
     
    120150    };
    121151    //  class SymEdgeIt : public Edge {};
     152
     153    /// This iterator goes through each edge.
     154
     155    /// This iterator goes through each edge of a graph.
     156    /// Its usage is quite simple, for example you can count the number
     157    /// of edges in a graph \c G of type \c Graph as follows:
     158    /// \code
     159    ///int count=0;
     160    ///for(Graph::EdgeIt e(G);G.valid(e);G.next(e)) count++;
     161    /// \endcode
    122162    class EdgeIt : public Edge {
    123163    public:
     
    174214
    175215    /// Checks if a node iterator is valid
     216
     217    ///\todo Maybe, it would be better if iterator converted to
     218    ///bool directly, as Jacint prefers.
    176219    bool valid(const Node) const { return true;}
    177220    /// Checks if an edge iterator is valid
     221
     222    ///\todo Maybe, it would be better if iterator converted to
     223    ///bool directly, as Jacint prefers.
    178224    bool valid(const Edge) const { return true;}
    179225
     
    195241
    196242    /// \return the new node.
     243    ///
    197244    Node addNode() { return INVALID;}
    198245    ///Add a new edge to the graph.
     
    228275 
    229276
    230     ///Read/write map of the nodes to type \c T.
    231 
     277    ///Read/write/reference map of the nodes to type \c T.
     278
     279    ///Read/write/reference map of the nodes to type \c T.
     280    /// \sa MemoryMapSkeleton
    232281    /// \todo We may need copy constructor
    233282    /// \todo We may need conversion from other nodetype
     
    263312    };
    264313
    265     ///Read/write map of the edges to type \c T.
    266 
    267     ///Read/write map of the edges to type \c T.
    268     ///It behaves exactly the same way as \ref NodeMap.
     314    ///Read/write/reference map of the edges to type \c T.
     315
     316    ///Read/write/reference map of the edges to type \c T.
     317    ///It behaves exactly in the same way as \ref NodeMap.
     318    /// \sa NodeMap
     319    /// \sa MemoryMapSkeleton
     320    /// \todo We may need copy constructor
     321    /// \todo We may need conversion from other edgetype
     322    /// \todo We may need operator=
    269323    template<class T> class EdgeMap
    270324    {
Note: See TracChangeset for help on using the changeset viewer.