diff --git a/doc/migration.dox b/doc/migration.dox new file mode 100644 --- /dev/null +++ b/doc/migration.dox @@ -0,0 +1,61 @@ +/* -*- mode: C++; indent-tabs-mode: nil; -*- + * + * This file is a part of LEMON, a generic C++ optimization library. + * + * Copyright (C) 2003-2008 + * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport + * (Egervary Research Group on Combinatorial Optimization, EGRES). + * + * Permission to use, modify and distribute this software is granted + * provided that this copyright notice appears in all copies. For + * precise terms see the accompanying LICENSE file. + * + * This software is provided "AS IS" with no warranty of any kind, + * express or implied, and with no claim as to its suitability for any + * purpose. + * + */ + +/*! + +\page migration Migration from the 0.x Series + +This guide gives an in depth description on what has changed compared +to the 0.x release series. + +Many of these changes adjusted automatically by the +script/lemon-0.x-to-1.x.sh tool. Those requiring manual +update are typeset boldface. + +\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 + the library. Namely, + - \c Graph -> \c Digraph + - \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. +- The two endpoints of an (\e undirected) \c Edge can be obtained by the + u() and v() member function of the graph class + (instead of source() and target()). This change + must be done by hand. + \n Of course, you can still use source() and target() + for Arcs (directed edges). + +\section migration-lgf LGF tools + +\section migration-search BFS, DFS and Dijkstra + +\section migration-error Exceptions and Debug tools + +\section migration-other Others +*/