1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/doc/migration.dox	Mon Oct 06 13:02:13 2008 +0100
     1.3 @@ -0,0 +1,61 @@
     1.4 +/* -*- mode: C++; indent-tabs-mode: nil; -*-
     1.5 + *
     1.6 + * This file is a part of LEMON, a generic C++ optimization library.
     1.7 + *
     1.8 + * Copyright (C) 2003-2008
     1.9 + * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
    1.10 + * (Egervary Research Group on Combinatorial Optimization, EGRES).
    1.11 + *
    1.12 + * Permission to use, modify and distribute this software is granted
    1.13 + * provided that this copyright notice appears in all copies. For
    1.14 + * precise terms see the accompanying LICENSE file.
    1.15 + *
    1.16 + * This software is provided "AS IS" with no warranty of any kind,
    1.17 + * express or implied, and with no claim as to its suitability for any
    1.18 + * purpose.
    1.19 + *
    1.20 + */
    1.21 +
    1.22 +/*!
    1.23 +
    1.24 +\page migration Migration from the 0.x Series
    1.25 +
    1.26 +This guide gives an in depth description on what has changed compared
    1.27 +to the 0.x release series. 
    1.28 +
    1.29 +Many of these changes adjusted automatically by the
    1.30 +<tt>script/lemon-0.x-to-1.x.sh</tt> tool. Those requiring manual
    1.31 +update are typeset <b>boldface</b>.
    1.32 +
    1.33 +\section migration-graph Graph Related Name Changes
    1.34 +
    1.35 +- Directed graphs are called \c Digraph and they have <tt>Arc</tt>s
    1.36 +  instead of <tt>Edge</tt>s, while the undirected graph is called \c
    1.37 +  Graph (instead of \c UGraph) and they have <tt>Edge</tt>s (instead
    1.38 +  of <tt>UEdge</tt>s). This changes reflected thoroughly everywhere in
    1.39 +  the library. Namely,
    1.40 +  - \c Graph -> \c Digraph
    1.41 +    - \c ListGraph -> \c ListDigraph, \c SmartGraph -> \c SmartDigraph etc.
    1.42 +  - \c UGraph -> \c Graph
    1.43 +    - \c ListUGraph -> \c ListGraph, \c SmartUGraph -> \c SmartGraph etc.
    1.44 +  - \c Edge -> \c Arc
    1.45 +  - \c UEdge -> \c Edge
    1.46 +  - \c EdgeMap -> \c ArcMap
    1.47 +  - \c UEdgeMap -> \c EdgeMap
    1.48 +  - Class names and function names containing the words \e edge or \e arc
    1.49 +    should also be updated.
    1.50 +- <b>The two endpoints of an (\e undirected) \c Edge can be obtained by the
    1.51 +  <tt>u()</tt> and <tt>v()</tt> member function of the graph class
    1.52 +  (instead of <tt>source()</tt> and <tt>target()</tt>). This change
    1.53 +  must be done by hand.</b>
    1.54 +  \n Of course, you can still use <tt>source()</tt> and <tt>target()</tt>
    1.55 +  for <tt>Arc</tt>s (directed edges).
    1.56 +
    1.57 +\section migration-lgf LGF tools
    1.58 +
    1.59 +\section migration-search BFS, DFS and Dijkstra
    1.60 +
    1.61 +\section migration-error Exceptions and Debug tools
    1.62 +
    1.63 +\section migration-other Others
    1.64 +*/