lemon-1.3: comparison lemon/grid

equal deleted inserted replaced

-:d50e532081a7
+:f1dda056d0ff
 /// \ingroup graphs
 ///
 /// \brief Grid graph class
 ///
-/// This class implements a special graph type. The nodes of the
+/// GridGraph implements a special graph type. The nodes of the
-/// graph can be indexed by two integer \c (i,j) value where \c i is
+/// graph can be indexed by two integer values \c (i,j) where \c i is
-/// in the \c [0..width()-1] range and j is in the \c
+/// in the range <tt>[0..width()-1]</tt> and j is in the range
-/// [0..height()-1] range.  Two nodes are connected in the graph if
+/// <tt>[0..height()-1]</tt>. Two nodes are connected in the graph if
-/// the indexes differ exactly on one position and exactly one is
+/// the indices differ exactly on one position and the difference is
-/// the difference. The nodes of the graph can be indexed by position
+/// also exactly one. The nodes of the graph can be obtained by position
-/// with the \c operator()() function. The positions of the nodes can be
+/// using the \c operator()() function and the indices of the nodes can
-/// get with \c pos(), \c col() and \c row() members. The outgoing
+/// be obtained using \c pos(), \c col() and \c row() members. The outgoing
 /// arcs can be retrieved with the \c right(), \c up(), \c left()
 /// and \c down() functions, where the bottom-left corner is the
 /// origin.
+///
+/// This class is completely static and it needs constant memory space.
+/// Thus you can neither add nor delete nodes or edges, however
+/// the structure can be resized using resize().
 ///
 /// \image html grid_graph.png
 /// \image latex grid_graph.eps "Grid graph" width=\textwidth
 ///
 /// A short example about the basic usage:
 ///     val[graph(i, j)] = i + j;
 ///   }
 /// }
 ///\endcode
 ///
-/// This graph type fully conforms to the \ref concepts::Graph
+/// This type fully conforms to the \ref concepts::Graph "Graph concept".
-/// "Graph concept".
+/// Most of its member functions and nested classes are documented
+/// only in the concept class.
 class GridGraph : public ExtendedGridGraphBase {
 typedef ExtendedGridGraphBase Parent;
 public:
-/// \brief Map to get the indices of the nodes as dim2::Point<int>.
+/// \brief Map to get the indices of the nodes as \ref dim2::Point
-///
+/// "dim2::Point<int>".
-/// Map to get the indices of the nodes as dim2::Point<int>.
+///
+/// Map to get the indices of the nodes as \ref dim2::Point
+/// "dim2::Point<int>".
 class IndexMap {
 public:
 /// \brief The key type of the map
 typedef GridGraph::Node Key;
 /// \brief The value type of the map
 typedef dim2::Point<int> Value;
 /// \brief Constructor
-///
-/// Constructor
 IndexMap(const GridGraph& graph) : _graph(graph) {}
 /// \brief The subscript operator
-///
-/// The subscript operator.
 Value operator[](Key key) const {
 return _graph.pos(key);
 }
 private:
 typedef GridGraph::Node Key;
 /// \brief The value type of the map
 typedef int Value;
 /// \brief Constructor
-///
-/// Constructor
 ColMap(const GridGraph& graph) : _graph(graph) {}
 /// \brief The subscript operator
-///
-/// The subscript operator.
 Value operator[](Key key) const {
 return _graph.col(key);
 }
 private:
 typedef GridGraph::Node Key;
 /// \brief The value type of the map
 typedef int Value;
 /// \brief Constructor
-///
-/// Constructor
 RowMap(const GridGraph& graph) : _graph(graph) {}
 /// \brief The subscript operator
-///
-/// The subscript operator.
 Value operator[](Key key) const {
 return _graph.row(key);
 }
 private:
 const GridGraph& _graph;
 };
 /// \brief Constructor
 ///
-/// Construct a grid graph with given size.
+/// Construct a grid graph with the given size.
 GridGraph(int width, int height) { construct(width, height); }
-/// \brief Resize the graph
+/// \brief Resizes the graph
 ///
-/// Resize the graph. The function will fully destroy and rebuild
+/// This function resizes the graph. It fully destroys and
-/// the graph.  This cause that the maps of the graph will
+/// rebuilds the structure, therefore the maps of the graph will be
-/// reallocated automatically and the previous values will be
+/// reallocated automatically and the previous values will be lost.
-/// lost.
 void resize(int width, int height) {
 Parent::notifier(Arc()).clear();
 Parent::notifier(Edge()).clear();
 Parent::notifier(Node()).clear();
 construct(width, height);
 /// Gives back the node on the given position.
 Node operator()(int i, int j) const {
 return Parent::operator()(i, j);
 }
-/// \brief Gives back the column index of the node.
+/// \brief The column index of the node.
 ///
 /// Gives back the column index of the node.
 int col(Node n) const {
 return Parent::col(n);
 }
-/// \brief Gives back the row index of the node.
+/// \brief The row index of the node.
 ///
 /// Gives back the row index of the node.
 int row(Node n) const {
 return Parent::row(n);
 }
-/// \brief Gives back the position of the node.
+/// \brief The position of the node.
 ///
 /// Gives back the position of the node, ie. the <tt>(col,row)</tt> pair.
 dim2::Point<int> pos(Node n) const {
 return Parent::pos(n);
 }
-/// \brief Gives back the number of the columns.
+/// \brief The number of the columns.
 ///
 /// Gives back the number of the columns.
 int width() const {
 return Parent::width();
 }
-/// \brief Gives back the number of the rows.
+/// \brief The number of the rows.
 ///
 /// Gives back the number of the rows.
 int height() const {
 return Parent::height();
 }
-/// \brief Gives back the arc goes right from the node.
+/// \brief The arc goes right from the node.
 ///
 /// Gives back the arc goes right from the node. If there is not
 /// outgoing arc then it gives back INVALID.
 Arc right(Node n) const {
 return Parent::right(n);
 }
-/// \brief Gives back the arc goes left from the node.
+/// \brief The arc goes left from the node.
 ///
 /// Gives back the arc goes left from the node. If there is not
 /// outgoing arc then it gives back INVALID.
 Arc left(Node n) const {
 return Parent::left(n);
 }
-/// \brief Gives back the arc goes up from the node.
+/// \brief The arc goes up from the node.
 ///
 /// Gives back the arc goes up from the node. If there is not
 /// outgoing arc then it gives back INVALID.
 Arc up(Node n) const {
 return Parent::up(n);
 }
-/// \brief Gives back the arc goes down from the node.
+/// \brief The arc goes down from the node.
 ///
 /// Gives back the arc goes down from the node. If there is not
 /// outgoing arc then it gives back INVALID.
 Arc down(Node n) const {
 return Parent::down(n);

changeset 741	10c9c3a35b83
parent 617	4137ef9aacc6
child 787	c2230649a493