Index: doc/migration.dox
===================================================================
--- doc/migration.dox (revision 309)
+++ doc/migration.dox (revision 310)
@@ -17,4 +17,5 @@
*/
+namespace lemon {
/*!
@@ -22,5 +23,5 @@
This guide gives an in depth description on what has changed compared
-to the 0.x release series.
+to the 0.x release series.
Many of these changes adjusted automatically by the
@@ -30,21 +31,21 @@
\section migration-graph Graph Related Name Changes
-- Directed graphs are called \c Digraph and they have Arcs
- instead of Edges, while the undirected graph is called \c
- Graph (instead of \c UGraph) and they have Edges (instead
- of UEdges). This changes reflected thoroughly everywhere in
+- \ref concepts::Digraph "Directed graphs" are called \c Digraph and
+ they have Arcs (instead of Edges), while
+ \ref concepts::Graph "undirected graphs" are called \c Graph
+ (instead of \c UGraph) and they have Edges (instead of
+ UEdges). These changes reflected thoroughly everywhere in
the library. Namely,
- \c Graph -> \c Digraph
- - \c ListGraph -> \c ListDigraph, \c SmartGraph -> \c SmartDigraph etc.
+ - \c %ListGraph -> \c ListDigraph, \c %SmartGraph -> \c SmartDigraph etc.
- \c UGraph -> \c Graph
- \c ListUGraph -> \c ListGraph, \c SmartUGraph -> \c SmartGraph etc.
- - \c Edge -> \c Arc
- - \c UEdge -> \c Edge
- - \c EdgeMap -> \c ArcMap
- - \c UEdgeMap -> \c EdgeMap
- - Class names and function names containing the words \e edge or \e arc
- should also be updated.
+ - \c Edge -> \c Arc, \c UEdge -> \c Edge
+ - \c EdgeMap -> \c ArcMap, \c UEdgeMap -> \c EdgeMap
+ - \c EdgeIt -> \c ArcIt, \c UEdgeIt -> \c EdgeIt
+ - Class names and function names containing the words \c graph,
+ \c ugraph, \e edge or \e arc should also be updated.
- The two endpoints of an (\e undirected) \c Edge can be obtained by the
- u() and v() member function of the graph class
+ u() and v() member function of the graph
(instead of source() and target()). This change
must be done by hand.
@@ -52,10 +53,53 @@
for Arcs (directed edges).
+\warning
+The script/lemon-0.x-to-1.x.sh tool replaces all instances of
+the words \c graph, \c digraph, \c edge and \c arc, so it replaces them
+in strings, comments etc. as well as in all identifiers.
+
\section migration-lgf LGF tools
\section migration-search BFS, DFS and Dijkstra
+- Using the function interface of BFS, DFS and %Dijkstra both source and
+ target nodes can be given as parameters of the run() function
+ (instead of \c bfs(), \c dfs() or \c dijkstra() itself).
+- \ref named-templ-param "Named class template parameters" of \c Bfs,
+ \c Dfs, \c Dijkstra, \c BfsVisit, \c DfsVisit are renamed to start
+ with "Set" instead of "Def". Namely,
+ - \c DefPredMap -> \c SetPredMap
+ - \c DefDistMap -> \c SetDistMap
+ - \c DefReachedMap -> \c SetReachedMap
+ - \c DefProcessedMap -> \c SetProcessedMap
+ - \c DefHeap -> \c SetHeap
+ - \c DefStandardHeap -> \c SetStandardHeap
+ - \c DefOperationTraits -> \c SetOperationTraits
+ - \c DefProcessedMapToBeDefaultMap -> \c SetStandardProcessedMap
\section migration-error Exceptions and Debug tools
\section migration-other Others
+- The contents of graph_utils.h are moved to core.h
+ and maps.h. core.h is included by all graph types,
+ therefore it usually do not have to be included directly.
+- path_utils.h is merged to \c path.h.
+- The parameters of the graph copying tools (i.e. \c GraphCopy,
+ \c DigraphCopy) have to be given in the from-to order.
+- \c copyDigraph() and \c copyGraph() are renamed to \c digraphCopy()
+ and \c graphCopy(), respectively.
+- The of
+ - DefXyzMap --> SetXyzMap
+ - DefHeap --> SetHeap
+ - DefStandardHeap --> SetStandardHeap
+ - DefOperationTraits --> SetOperationTraits
+ - DefProcessedMapToBeDefaultMap --> SetStandardProcessedMap
+- Some map types should also been renamed. Namely,
+ - \c IntegerMap -> \c RangeMap
+ - \c StdMap -> \c SparseMap
+ - \c FunctorMap -> \c FunctorToMap
+ - \c MapFunctor -> \c MapToFunctor
+ - \c ForkWriteMap -> \c ForkMap
+ - \c StoreBoolMap -> \c LoggerBoolMap
+- \c dim2::BoundingBox -> \c dim2::Box
+
*/
+}