doc/migration.dox
author Alpar Juttner <alpar@cs.elte.hu>
Mon, 06 Oct 2008 13:02:13 +0100
changeset 305 069f27927ba9
child 306 2bf7c645d5a6
permissions -rw-r--r--
0.x -> 1.x migration script and guide (preliminary version) (#157)
alpar@305
     1
/* -*- mode: C++; indent-tabs-mode: nil; -*-
alpar@305
     2
 *
alpar@305
     3
 * This file is a part of LEMON, a generic C++ optimization library.
alpar@305
     4
 *
alpar@305
     5
 * Copyright (C) 2003-2008
alpar@305
     6
 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
alpar@305
     7
 * (Egervary Research Group on Combinatorial Optimization, EGRES).
alpar@305
     8
 *
alpar@305
     9
 * Permission to use, modify and distribute this software is granted
alpar@305
    10
 * provided that this copyright notice appears in all copies. For
alpar@305
    11
 * precise terms see the accompanying LICENSE file.
alpar@305
    12
 *
alpar@305
    13
 * This software is provided "AS IS" with no warranty of any kind,
alpar@305
    14
 * express or implied, and with no claim as to its suitability for any
alpar@305
    15
 * purpose.
alpar@305
    16
 *
alpar@305
    17
 */
alpar@305
    18
alpar@305
    19
/*!
alpar@305
    20
alpar@305
    21
\page migration Migration from the 0.x Series
alpar@305
    22
alpar@305
    23
This guide gives an in depth description on what has changed compared
alpar@305
    24
to the 0.x release series. 
alpar@305
    25
alpar@305
    26
Many of these changes adjusted automatically by the
alpar@305
    27
<tt>script/lemon-0.x-to-1.x.sh</tt> tool. Those requiring manual
alpar@305
    28
update are typeset <b>boldface</b>.
alpar@305
    29
alpar@305
    30
\section migration-graph Graph Related Name Changes
alpar@305
    31
alpar@305
    32
- Directed graphs are called \c Digraph and they have <tt>Arc</tt>s
alpar@305
    33
  instead of <tt>Edge</tt>s, while the undirected graph is called \c
alpar@305
    34
  Graph (instead of \c UGraph) and they have <tt>Edge</tt>s (instead
alpar@305
    35
  of <tt>UEdge</tt>s). This changes reflected thoroughly everywhere in
alpar@305
    36
  the library. Namely,
alpar@305
    37
  - \c Graph -> \c Digraph
alpar@305
    38
    - \c ListGraph -> \c ListDigraph, \c SmartGraph -> \c SmartDigraph etc.
alpar@305
    39
  - \c UGraph -> \c Graph
alpar@305
    40
    - \c ListUGraph -> \c ListGraph, \c SmartUGraph -> \c SmartGraph etc.
alpar@305
    41
  - \c Edge -> \c Arc
alpar@305
    42
  - \c UEdge -> \c Edge
alpar@305
    43
  - \c EdgeMap -> \c ArcMap
alpar@305
    44
  - \c UEdgeMap -> \c EdgeMap
alpar@305
    45
  - Class names and function names containing the words \e edge or \e arc
alpar@305
    46
    should also be updated.
alpar@305
    47
- <b>The two endpoints of an (\e undirected) \c Edge can be obtained by the
alpar@305
    48
  <tt>u()</tt> and <tt>v()</tt> member function of the graph class
alpar@305
    49
  (instead of <tt>source()</tt> and <tt>target()</tt>). This change
alpar@305
    50
  must be done by hand.</b>
alpar@305
    51
  \n Of course, you can still use <tt>source()</tt> and <tt>target()</tt>
alpar@305
    52
  for <tt>Arc</tt>s (directed edges).
alpar@305
    53
alpar@305
    54
\section migration-lgf LGF tools
alpar@305
    55
alpar@305
    56
\section migration-search BFS, DFS and Dijkstra
alpar@305
    57
alpar@305
    58
\section migration-error Exceptions and Debug tools
alpar@305
    59
alpar@305
    60
\section migration-other Others
alpar@305
    61
*/