alpar@309: /* -*- mode: C++; indent-tabs-mode: nil; -*-
alpar@309: *
alpar@309: * This file is a part of LEMON, a generic C++ optimization library.
alpar@309: *
alpar@309: * Copyright (C) 2003-2008
alpar@309: * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
alpar@309: * (Egervary Research Group on Combinatorial Optimization, EGRES).
alpar@309: *
alpar@309: * Permission to use, modify and distribute this software is granted
alpar@309: * provided that this copyright notice appears in all copies. For
alpar@309: * precise terms see the accompanying LICENSE file.
alpar@309: *
alpar@309: * This software is provided "AS IS" with no warranty of any kind,
alpar@309: * express or implied, and with no claim as to its suitability for any
alpar@309: * purpose.
alpar@309: *
alpar@309: */
alpar@309:
kpeter@310: namespace lemon {
alpar@309: /*!
alpar@309:
alpar@309: \page migration Migration from the 0.x Series
alpar@309:
alpar@309: This guide gives an in depth description on what has changed compared
kpeter@310: to the 0.x release series.
alpar@309:
alpar@309: Many of these changes adjusted automatically by the
alpar@309: script/lemon-0.x-to-1.x.sh tool. Those requiring manual
alpar@309: update are typeset boldface.
alpar@309:
alpar@309: \section migration-graph Graph Related Name Changes
alpar@309:
kpeter@310: - \ref concepts::Digraph "Directed graphs" are called \c Digraph and
kpeter@310: they have Arcs (instead of Edges), while
kpeter@310: \ref concepts::Graph "undirected graphs" are called \c Graph
kpeter@310: (instead of \c UGraph) and they have Edges (instead of
kpeter@310: UEdges). These changes reflected thoroughly everywhere in
alpar@309: the library. Namely,
alpar@309: - \c Graph -> \c Digraph
kpeter@310: - \c %ListGraph -> \c ListDigraph, \c %SmartGraph -> \c SmartDigraph etc.
alpar@309: - \c UGraph -> \c Graph
alpar@309: - \c ListUGraph -> \c ListGraph, \c SmartUGraph -> \c SmartGraph etc.
kpeter@310: - \c Edge -> \c Arc, \c UEdge -> \c Edge
kpeter@310: - \c EdgeMap -> \c ArcMap, \c UEdgeMap -> \c EdgeMap
kpeter@310: - \c EdgeIt -> \c ArcIt, \c UEdgeIt -> \c EdgeIt
kpeter@310: - Class names and function names containing the words \c graph,
kpeter@310: \c ugraph, \e edge or \e arc should also be updated.
alpar@309: - The two endpoints of an (\e undirected) \c Edge can be obtained by the
kpeter@310: u() and v() member function of the graph
alpar@309: (instead of source() and target()). This change
alpar@309: must be done by hand.
alpar@309: \n Of course, you can still use source() and target()
alpar@309: for Arcs (directed edges).
alpar@309:
kpeter@310: \warning
kpeter@310: The script/lemon-0.x-to-1.x.sh tool replaces all instances of
kpeter@310: the words \c graph, \c digraph, \c edge and \c arc, so it replaces them
kpeter@310: in strings, comments etc. as well as in all identifiers.
kpeter@310:
kpeter@318: \section migration-lgf LGF tools
deba@312: - The \ref lgf-format "LGF file format" has changed,
deba@312: \@nodeset has changed to \@nodes,
deba@312: \@edgeset and \@uedgeset to \@arcs or
deba@312: \@edges, which become completely equivalents. The
deba@312: \@nodes, \@edges and \@uedges sections are
deba@312: removed from the format, the content of them should be
deba@312: the part of \@attributes section. The data fields in
deba@312: the sections must follow a strict format, they must be either character
deba@312: sequences without whitespaces or quoted strings.
deba@312: - The LemonReader and LemonWriter core interfaces
deba@312: are no longer available.
deba@312: - The implementation of the general section readers and writers has changed
deba@312: they are simple functors now. Beside the old
deba@312: stream based section handling, currently line oriented section
deba@312: reading and writing are also supported. In the
deba@312: section readers the lines must be counted manually. The sections
deba@312: should be read and written with the SectionWriter and SectionReader
deba@312: classes.
deba@312: - Instead of the item readers and writers, item converters should be
deba@312: used. The converters are functors, which map the type to
deba@312: std::string or std::string to the type. The converters for standard
deba@312: containers hasn't yet been implemented in the new LEMON. The converters
deba@312: can return strings in any format, because if it is necessary, the LGF
deba@312: writer and reader will quote and unquote the given value.
deba@312: - The DigraphReader and DigraphWriter can used similarly to the
deba@312: 0.x series, however the read or write prefix of
deba@312: the member functions are removed.
deba@312: - The new LEMON supports the function like interface, the \c
deba@312: digraphReader and \c digraphWriter functions are more convenient than
deba@312: using the classes directly.
alpar@309:
alpar@309: \section migration-search BFS, DFS and Dijkstra
kpeter@310: - Using the function interface of BFS, DFS and %Dijkstra both source and
kpeter@310: target nodes can be given as parameters of the run() function
kpeter@310: (instead of \c bfs(), \c dfs() or \c dijkstra() itself).
kpeter@310: - \ref named-templ-param "Named class template parameters" of \c Bfs,
kpeter@310: \c Dfs, \c Dijkstra, \c BfsVisit, \c DfsVisit are renamed to start
kpeter@310: with "Set" instead of "Def". Namely,
kpeter@310: - \c DefPredMap -> \c SetPredMap
kpeter@310: - \c DefDistMap -> \c SetDistMap
kpeter@310: - \c DefReachedMap -> \c SetReachedMap
kpeter@310: - \c DefProcessedMap -> \c SetProcessedMap
kpeter@310: - \c DefHeap -> \c SetHeap
kpeter@310: - \c DefStandardHeap -> \c SetStandardHeap
kpeter@310: - \c DefOperationTraits -> \c SetOperationTraits
kpeter@310: - \c DefProcessedMapToBeDefaultMap -> \c SetStandardProcessedMap
alpar@309:
alpar@309: \section migration-error Exceptions and Debug tools
alpar@309:
alpar@311: The class hierarchy of exceptions has largely been simplified. Now,
alpar@311: only the i/o related tools may throw exceptions. All other exceptions
alpar@311: have been replaced with either the \c LEMON_ASSERT or the \c LEMON_DEBUG
alpar@311: macros.
alpar@311:
alpar@311: On the other hand, the parameter order of constructors of the
alpar@311: exceptions has been changed. See \ref IoError and \ref FormatError for
alpar@311: more details.
alpar@311:
alpar@309: \section migration-other Others
kpeter@310: - The contents of graph_utils.h are moved to core.h
kpeter@310: and maps.h. core.h is included by all graph types,
kpeter@310: therefore it usually do not have to be included directly.
kpeter@310: - path_utils.h is merged to \c path.h.
alpar@311: - The semantic of the assignment operations and copy constructors of maps
alpar@311: are still under discussion. So, you must copy them by hand (i.e. copy
alpar@311: each entry one-by-one)
kpeter@310: - The parameters of the graph copying tools (i.e. \c GraphCopy,
kpeter@310: \c DigraphCopy) have to be given in the from-to order.
kpeter@310: - \c copyDigraph() and \c copyGraph() are renamed to \c digraphCopy()
kpeter@310: and \c graphCopy(), respectively.
alpar@311: - The interface of \ref DynArcLookUp has changed. It is now the same as
alpar@311: of \ref ArcLookUp and \ref AllArcLookUp
kpeter@310: - Some map types should also been renamed. Namely,
kpeter@310: - \c IntegerMap -> \c RangeMap
kpeter@310: - \c StdMap -> \c SparseMap
kpeter@310: - \c FunctorMap -> \c FunctorToMap
kpeter@310: - \c MapFunctor -> \c MapToFunctor
kpeter@310: - \c ForkWriteMap -> \c ForkMap
kpeter@310: - \c StoreBoolMap -> \c LoggerBoolMap
kpeter@310: - \c dim2::BoundingBox -> \c dim2::Box
kpeter@310:
alpar@309: */
kpeter@310: }