COIN-OR::LEMON - Graph Library

Changeset 880:9d0bfd35b97c in lemon-0.x for src/hugo/skeletons/graph.h


Ignore:
Timestamp:
09/17/04 17:51:50 (16 years ago)
Author:
Alpar Juttner
Branch:
default
Phase:
public
Convert:
svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@1188
Message:
  • Name changing: XYZGraphSkeleton -> XYZGraph
  • Fix some bad \ref's in the doc.
File:
1 edited

Legend:

Unmodified
Added
Removed
  • src/hugo/skeletons/graph.h

    r873 r880  
    55///\ingroup skeletons
    66///\file
    7 ///\brief Declaration of GraphSkeleton.
     7///\brief Declaration of Graph.
    88
    99#include <hugo/invalid.h>
     
    3232    /// like @ref ListGraph or
    3333    /// @ref SmartGraph will just refer to this structure.
    34     class StaticGraphSkeleton
     34    class StaticGraph
    3535    {
    3636    public:
     
    3939      /// Defalult constructor.
    4040      ///
    41       StaticGraphSkeleton() { }
     41      StaticGraph() { }
    4242      ///Copy consructor.
    4343
    4444//       ///\todo It is not clear, what we expect from a copy constructor.
    4545//       ///E.g. How to assign the nodes/edges to each other? What about maps?
    46 //       StaticGraphSkeleton(const StaticGraphSkeleton& g) { }
     46//       StaticGraph(const StaticGraph& g) { }
    4747
    4848      /// The base type of node iterators,
     
    123123        /// Sets the iterator to the first node of \c g.
    124124        ///
    125         NodeIt(const StaticGraphSkeleton& g) { }
     125        NodeIt(const StaticGraph& g) { }
    126126        /// Node -> NodeIt conversion.
    127127
     
    130130        /// This feature necessitates that each time we
    131131        /// iterate the edge-set, the iteration order is the same.
    132         NodeIt(const StaticGraphSkeleton& g, const Node& n) { }
     132        NodeIt(const StaticGraph& g, const Node& n) { }
    133133        /// Next node.
    134134
     
    215215        ///@param n the node
    216216        ///@param g the graph
    217         OutEdgeIt(const StaticGraphSkeleton& g, const Node& n) { }
     217        OutEdgeIt(const StaticGraph& g, const Node& n) { }
    218218        /// Edge -> OutEdgeIt conversion
    219219
     
    221221        /// This feature necessitates that each time we
    222222        /// iterate the edge-set, the iteration order is the same.
    223         OutEdgeIt(const StaticGraphSkeleton& g, const Edge& e) { }
     223        OutEdgeIt(const StaticGraph& g, const Edge& e) { }
    224224        ///Next outgoing edge
    225225       
     
    264264        ///@param n the node
    265265        ///@param g the graph
    266         InEdgeIt(const StaticGraphSkeleton& g, const Node& n) { }
     266        InEdgeIt(const StaticGraph& g, const Node& n) { }
    267267        /// Edge -> InEdgeIt conversion
    268268
     
    270270        /// This feature necessitates that each time we
    271271        /// iterate the edge-set, the iteration order is the same.
    272         InEdgeIt(const StaticGraphSkeleton& g, const Edge& n) { }
     272        InEdgeIt(const StaticGraph& g, const Edge& n) { }
    273273        /// Next incoming edge
    274274
     
    308308        /// node
    309309        ///@param g the graph
    310         EdgeIt(const StaticGraphSkeleton& g) { }
     310        EdgeIt(const StaticGraph& g) { }
    311311        /// Edge -> EdgeIt conversion
    312312
     
    314314        /// This feature necessitates that each time we
    315315        /// iterate the edge-set, the iteration order is the same.
    316         EdgeIt(const StaticGraphSkeleton&, const Edge&) { }
     316        EdgeIt(const StaticGraph&, const Edge&) { }
    317317        ///Next edge
    318318       
     
    371371      /// .
    372372     
    373       ///\todo What is this?
     373      ///\todo Should it be in the concept?
    374374      ///
    375375      int nodeNum() const { return 0; }
    376376      /// .
    377       ///\todo What is this?
     377
     378      ///\todo Should it be in the concept?
    378379      ///
    379380      int edgeNum() const { return 0; }
     
    382383      ///Reference map of the nodes to type \c T.
    383384
     385      /// \ingroup skeletons
    384386      ///Reference map of the nodes to type \c T.
    385       /// \sa ReferenceSkeleton
     387      /// \sa Reference
    386388      /// \warning Making maps that can handle bool type (NodeMap<bool>)
    387389      /// needs some extra attention!
    388       template<class T> class NodeMap: public ReferenceMap< Node, T >
     390      template<class T> class NodeMap : public ReferenceMap< Node, T >
    389391      {
    390392      public:
    391393
    392394        /// .
    393         NodeMap(const StaticGraphSkeleton&) { }
     395        NodeMap(const StaticGraph&) { }
    394396        /// .
    395         NodeMap(const StaticGraphSkeleton&, T) { }
     397        NodeMap(const StaticGraph&, T) { }
    396398
    397399        ///Copy constructor
     
    404406      ///Reference map of the edges to type \c T.
    405407
     408      /// \ingroup skeletons
    406409      ///Reference map of the edges to type \c T.
    407       /// \sa ReferenceSkeleton
     410      /// \sa Reference
    408411      /// \warning Making maps that can handle bool type (EdgeMap<bool>)
    409412      /// needs some extra attention!
     
    414417
    415418        /// .
    416         EdgeMap(const StaticGraphSkeleton&) { }
     419        EdgeMap(const StaticGraph&) { }
    417420        /// .
    418         EdgeMap(const StaticGraphSkeleton&, T) { }
     421        EdgeMap(const StaticGraph&, T) { }
    419422   
    420423        ///Copy constructor
     
    430433    /// An empty non-static graph class.
    431434
    432     /// This class provides everything that \c StaticGraphSkeleton
     435    /// This class provides everything that \ref StaticGraph
    433436    /// with additional functionality which enables to build a
    434437    /// graph from scratch.
    435     class ExtendableGraphSkeleton : public StaticGraphSkeleton
     438    class ExtendableGraph : public StaticGraph
    436439    {
    437440    public:
     
    440443      /// Defalult constructor.
    441444      ///
    442       ExtendableGraphSkeleton() { }
     445      ExtendableGraph() { }
    443446      ///Add a new node to the graph.
    444447
     
    448451      ///Add a new edge to the graph.
    449452
    450       ///Add a new edge to the graph with tail node \c tail
    451       ///and head node \c head.
     453      ///Add a new edge to the graph with tail node \c t
     454      ///and head node \c h.
    452455      ///\return the new edge.
    453       Edge addEdge(Node, Node) { return INVALID; }
     456      Edge addEdge(Node h, Node t) { return INVALID; }
    454457   
    455458      /// Resets the graph.
     
    457460      /// This function deletes all edges and nodes of the graph.
    458461      /// It also frees the memory allocated to store them.
    459       /// \todo It might belong to \c ErasableGraphSkeleton.
     462      /// \todo It might belong to \ref ErasableGraph.
    460463      void clear() { }
    461464    };
     
    463466    /// An empty erasable graph class.
    464467 
    465     /// This class is an extension of \c GraphSkeleton. It also makes it
     468    /// This class is an extension of \ref ExtendableGraph. It also makes it
    466469    /// possible to erase edges or nodes.
    467     class ErasableGraphSkeleton : public ExtendableGraphSkeleton
     470    class ErasableGraph : public ExtendableGraph
    468471    {
    469472    public:
     
    472475      /// Defalult constructor.
    473476      ///
    474       ErasableGraphSkeleton() { }
     477      ErasableGraph() { }
    475478      /// Deletes a node.
    476479
Note: See TracChangeset for help on using the changeset viewer.