Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

GraphItem Class Reference
[Graph Structure Concepts]

#include <lemon/concept/graph_component.h>

Inheritance diagram for GraphItem:

Inheritance graph
[legend]
List of all members.

Detailed Description

This class describes the interface of Node and Edge (and UndirEdge in undirected graphs) subtypes of graph types.

Note:
This class is a template class so that we can use it to create graph skeleton classes. The reason for this is than Node and Edge types should not derive from the same base class. For Node you should instantiate it with character 'n' and for Edge with 'e'.

Definition at line 52 of file graph_component.h.

Public Member Functions

 GraphItem ()
 Default constructor.
 GraphItem (GraphItem const &)
 Copy constructor.
 GraphItem (Invalid)
 Invalid constructor & conversion.
GraphItemoperator= (GraphItem const &)
 Assign operator for nodes.
bool operator== (GraphItem) const
 Equality operator.
bool operator!= (GraphItem) const
 Inequality operator.
bool operator< (GraphItem) const
 Artificial ordering operator.


Constructor & Destructor Documentation

GraphItem  )  [inline]
 

Warning:
The default constructor is not required to set the item to some well-defined value. So you should consider it as uninitialized.

Definition at line 59 of file graph_component.h.

GraphItem GraphItem const &   )  [inline]
 

Copy constructor.

Definition at line 64 of file graph_component.h.

GraphItem Invalid   )  [inline]
 

This constructor initializes the item to be invalid.

See also:
Invalid for more details.

Definition at line 69 of file graph_component.h.


Member Function Documentation

GraphItem& operator= GraphItem const &   )  [inline]
 

The nodes are assignable.

Definition at line 74 of file graph_component.h.

bool operator== GraphItem   )  const [inline]
 

Two iterators are equal if and only if they represents the same node in the graph or both are invalid.

Definition at line 79 of file graph_component.h.

bool operator!= GraphItem   )  const [inline]
 

See also:
operator==(const Node& n)

Definition at line 84 of file graph_component.h.

bool operator< GraphItem   )  const [inline]
 

To allow the use of graph descriptors as key type in std::map or similar associative container we require this.

Note:
This operator only have to define some strict ordering of the items; this order has nothing to do with the iteration ordering of the items.
Bug:
This is a technical requirement. Do we really need this?

Definition at line 96 of file graph_component.h.


The documentation for this class was generated from the following file:
Generated on Sat Mar 19 10:58:57 2005 for LEMON by  doxygen 1.4.1