Various small fixes
authorPeter Kovacs <kpeter@inf.elte.hu>
Mon, 01 Mar 2010 02:28:44 +0100
changeset 5718404ec968ca
parent 56 11bd4cea8379
child 58 10b6a5b7d4c0
Various small fixes
adaptors.dox
algorithms.dox
getting_started.dox
intro.dox
lp.dox
maps.dox
tools.dox
undir_graphs.dox
     1.1 --- a/adaptors.dox	Mon Mar 01 02:28:05 2010 +0100
     1.2 +++ b/adaptors.dox	Mon Mar 01 02:28:44 2010 +0100
     1.3 @@ -25,7 +25,7 @@
     1.4  has to be considered.
     1.5  If some nodes or arcs have to be hidden (maybe temporarily) or the reverse
     1.6  oriented graph has to be used, then this is the case.
     1.7 -However, actually modifing physical storage of the graph or
     1.8 +However, actually modifying physical storage of the graph or
     1.9  making a copy of the graph structure along with the required maps
    1.10  could be rather expensive (in time or in memory usage) compared to the
    1.11  operations that should be performed on the altered graph.
    1.12 @@ -61,7 +61,7 @@
    1.13  code, and makes it possible to easily implement complex algorithms based on
    1.14  well tested standard components.
    1.15  
    1.16 -For solving the problem introduced above, we could use the follwing code.
    1.17 +For solving the problem introduced above, we could use the following code.
    1.18  
    1.19  \code
    1.20    ListDigraph g;
     2.1 --- a/algorithms.dox	Mon Mar 01 02:28:05 2010 +0100
     2.2 +++ b/algorithms.dox	Mon Mar 01 02:28:44 2010 +0100
     2.3 @@ -22,9 +22,14 @@
     2.4  
     2.5  \todo This page is under construction.
     2.6  
     2.7 +\todo The following contents are mainly ported from the LEMON 0.x tutorial,
     2.8 +thus they have to be thoroughly revised and reworked.
     2.9 +
    2.10 +\warning Currently, this section may contain old or faulty contents.
    2.11 +
    2.12  In addition to the graph structures, the most important parts of LEMON are
    2.13  the various algorithms related to graph theory and combinatorial optimization.
    2.14 -The library probvides quite flexible and efficient implementations
    2.15 +The library provides quite flexible and efficient implementations
    2.16  for well-known fundamental algorithms, such as breadth-first
    2.17  search (BFS), depth-first search (DFS), Dijkstra algorithm, Kruskal algorithm
    2.18  and methods for discovering graph properties like connectivity, bipartiteness
    2.19 @@ -37,9 +42,6 @@
    2.20  
    2.21  [SEC]sec_graph_search[SEC] Graph Search
    2.22  
    2.23 -\todo The following contents are ported from the LEMON 0.x tutorial,
    2.24 -thus they have to thouroughly revised, reorganized and reworked.
    2.25 -
    2.26  See \ref Bfs, \ref Dfs and \ref graph_properties.
    2.27  
    2.28  Both \ref lemon::Bfs "Bfs" and \ref lemon::Dfs "Dfs" are highly adaptable and efficient
    2.29 @@ -50,7 +52,7 @@
    2.30  The algorithm is implemented in the \ref lemon::Bfs "Bfs" template class - rather than as function.
    2.31  The class has two template parameters: \b GR and \b TR.<br>
    2.32  GR is the digraph the algorithm runs on. It has \ref lemon::ListDigraph "ListDigraph" as default type.
    2.33 -TR is a Traits class commonly used to easy the parametrization of templates. In most cases you
    2.34 +TR is a Traits class commonly used to easy the parameterization of templates. In most cases you
    2.35  wont need to modify the default type \ref lemon::BfsDefaultTraits "BfsDefaultTraits<GR>".
    2.36  
    2.37  To use the class, declare it!
     3.1 --- a/getting_started.dox	Mon Mar 01 02:28:05 2010 +0100
     3.2 +++ b/getting_started.dox	Mon Mar 01 02:28:44 2010 +0100
     3.3 @@ -49,7 +49,7 @@
     3.4  g++ -o hello_lemon hello_lemon.cc -lemon
     3.5  \endverbatim
     3.6  
     3.7 -As a result you will get the exacutable \c hello_lemon in the current
     3.8 +As a result you will get the executable \c hello_lemon in the current
     3.9  directory, which you can run by the following command.
    3.10  
    3.11  \verbatim
     4.1 --- a/intro.dox	Mon Mar 01 02:28:05 2010 +0100
     4.2 +++ b/intro.dox	Mon Mar 01 02:28:44 2010 +0100
     4.3 @@ -36,7 +36,7 @@
     4.4  which often arise when designing and testing certain networks,
     4.5  for example in telecommunication, computer networks, logistics, scheduling,
     4.6  and other areas.
     4.7 -A very natural way of modelling these networks is by means of a graph.
     4.8 +A very natural way of modeling these networks is by means of a graph.
     4.9  Generally, if you want to write any program that works with graphs,
    4.10  then you might find it useful and convenient to use LEMON.
    4.11  
     5.1 --- a/lp.dox	Mon Mar 01 02:28:05 2010 +0100
     5.2 +++ b/lp.dox	Mon Mar 01 02:28:44 2010 +0100
     5.3 @@ -194,9 +194,9 @@
     5.4    x2 = 9
     5.5  \endcode
     5.6  
     5.7 -The documnetation of the MIP solver interface can be found in the
     5.8 +The documentation of the MIP solver interface can be found in the
     5.9  reference manual at the class \ref MipSolver. The common parts of the
    5.10 -LP and MIP interfaces are docmented in their common ancestor class
    5.11 +LP and MIP interfaces are documented in their common ancestor class
    5.12  \ref LpBase.
    5.13  
    5.14  
     6.1 --- a/maps.dox	Mon Mar 01 02:28:05 2010 +0100
     6.2 +++ b/maps.dox	Mon Mar 01 02:28:44 2010 +0100
     6.3 @@ -23,7 +23,9 @@
     6.4  \todo This page is under construction.
     6.5  
     6.6  \todo The following contents are ported from the LEMON 0.x tutorial,
     6.7 -thus they have to thouroughly revised, reorganized and reworked.
     6.8 +thus they have to be thoroughly revised and reworked.
     6.9 +
    6.10 +\warning Currently, this section may contain old or faulty contents.
    6.11  
    6.12  The LEMON maps are not only just storage classes, but also
    6.13  they are %concepts of any key--value based data access.
     7.1 --- a/tools.dox	Mon Mar 01 02:28:05 2010 +0100
     7.2 +++ b/tools.dox	Mon Mar 01 02:28:44 2010 +0100
     7.3 @@ -43,8 +43,8 @@
     7.4  Another nice feature of the library is \ref graphToEps(), a highly
     7.5  configurable graph displaying tool (using EPS output format).
     7.6  Originally, it was developed to evaluate the flexibility and scalability
     7.7 -of LEMON's approach to implement named parameters. Later it
     7.8 -has been evolved into a versatile tool featuring above 35 named
     7.9 +of LEMON's approach to implement \ref named-param "named parameters".
    7.10 +Later it has been evolved into a versatile tool featuring above 35 named
    7.11  parameters. The following code demonstrates its typical use.
    7.12  
    7.13  \code
    7.14 @@ -67,6 +67,9 @@
    7.15  
    7.16  \image html graph_to_eps.png
    7.17  
    7.18 +For more examples, see \ref graph_to_eps_demo.cc in the demo directory
    7.19 +of the LEMON source.
    7.20 +
    7.21  
    7.22  [SEC]sec_time_count[SEC] Time Measuring and Counting
    7.23  
     8.1 --- a/undir_graphs.dox	Mon Mar 01 02:28:05 2010 +0100
     8.2 +++ b/undir_graphs.dox	Mon Mar 01 02:28:44 2010 +0100
     8.3 @@ -55,7 +55,7 @@
     8.4  
     8.5  Each edge has an inherent orientation, thus it can be defined whether
     8.6  an arc is forward or backward oriented in an undirected graph with respect
     8.7 -to this default oriantation of the represented edge.
     8.8 +to this default orientation of the represented edge.
     8.9  The direction of an arc can be obtained and set using the functions
    8.10  \ref concepts::Graph::direction() "direction()" and
    8.11  \ref concepts::Graph::direct() "direct()", respectively.
    8.12 @@ -129,7 +129,7 @@
    8.13  \endcode
    8.14  
    8.15  
    8.16 -[SEC]sec_undir_graph_algs[SEC] Undirected Graph Algorihtms
    8.17 +[SEC]sec_undir_graph_algs[SEC] Undirected Graph Algorithms
    8.18  
    8.19  \todo This subsection is under construction.
    8.20