doc/tutorial.dox
author kpeter
Mon, 18 Feb 2008 03:32:06 +0000
changeset 2575 e866e288cba6
parent 2391 14a343be7a5a
permissions -rw-r--r--
Major improvements in NetworkSimplex.

Main changes:
- Use -potenital[] instead of potential[] to conform to the usual
terminology.
- Use function parameter instead of #define commands to select pivot rule.
- Use much faster implementation for the candidate list pivot rule.
It is about 5-20 times faster now.
- Add a new pivot rule called "Limited Search" that is a modified
version of "Block Search". It is about 25 percent faster on rather
sparse graphs.
- By default "Limited Search" is used for sparse graphs and
"Block Search" is used otherwise. This combined method is the most
efficient on every input class.
- Change the name of private members to start with "_".
- Change the name of function parameters not to start with "_".
- Remove unnecessary documentation for private members.
- Many doc improvements.
     1 /* -*- C++ -*-
     2  *
     3  * This file is a part of LEMON, a generic C++ optimization library
     4  *
     5  * Copyright (C) 2003-2008
     6  * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
     7  * (Egervary Research Group on Combinatorial Optimization, EGRES).
     8  *
     9  * Permission to use, modify and distribute this software is granted
    10  * provided that this copyright notice appears in all copies. For
    11  * precise terms see the accompanying LICENSE file.
    12  *
    13  * This software is provided "AS IS" with no warranty of any kind,
    14  * express or implied, and with no claim as to its suitability for any
    15  * purpose.
    16  *
    17  */
    18 
    19 namespace lemon {
    20 /**
    21 \page Tutorial LEMON Tutorial
    22 
    23 <H2>Table of Contents</H2>
    24 
    25 <OL style="padding-bottom: 60px">
    26   <LI>\ref intro
    27   <LI>\ref getting_started
    28   <UL>
    29     <LI>\ref hello_world
    30     <LI>\ref compile_hw
    31   </UL>
    32   <LI>\ref basic_concepts
    33   <UL>
    34     <LI>\ref basic_ListGraph
    35     <LI>\ref maps1
    36   </UL>
    37   <LI>\ref lemon_file_format
    38   <UL>
    39     <LI>\ref read_write_bg
    40   </UL>
    41   <LI>\ref algorithms
    42   <UL>
    43     <LI>\ref algo_bfs_dfs
    44     <LI>\ref algo_dijkstra
    45     <LI>\ref algo_kruskal
    46   </UL>
    47   <LI>\ref maps2
    48   <UL>
    49     <LI>\ref custom_maps
    50     <LI>Map Adaptors
    51     <LI>Special Purpose Maps
    52   </UL>
    53   <LI>\ref show_a_graph
    54   <LI>Miscellaneous Tool
    55   <UL>
    56     <LI>LP solver
    57     <LI>Simulated Annealing
    58   </UL>
    59 </OL>
    60 
    61 \section intro Introduction
    62 In this tutorial we try to show you as many aspects of LEMON as possible. From
    63 the basics to the very advanced or highly optimized tools. The given examples
    64 are all available in \c demo directory, so feel free to look at them after the
    65 sections.
    66 */
    67 }