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.
alpar@2391
     1
/* -*- C++ -*-
alpar@2391
     2
 *
alpar@2391
     3
 * This file is a part of LEMON, a generic C++ optimization library
alpar@2391
     4
 *
alpar@2553
     5
 * Copyright (C) 2003-2008
alpar@2391
     6
 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
alpar@2391
     7
 * (Egervary Research Group on Combinatorial Optimization, EGRES).
alpar@2391
     8
 *
alpar@2391
     9
 * Permission to use, modify and distribute this software is granted
alpar@2391
    10
 * provided that this copyright notice appears in all copies. For
alpar@2391
    11
 * precise terms see the accompanying LICENSE file.
alpar@2391
    12
 *
alpar@2391
    13
 * This software is provided "AS IS" with no warranty of any kind,
alpar@2391
    14
 * express or implied, and with no claim as to its suitability for any
alpar@2391
    15
 * purpose.
alpar@2391
    16
 *
alpar@2391
    17
 */
alpar@2391
    18
alpar@2216
    19
namespace lemon {
ladanyi@2165
    20
/**
ladanyi@2165
    21
\page Tutorial LEMON Tutorial
ladanyi@2165
    22
alpar@2195
    23
<H2>Table of Contents</H2>
ladanyi@2165
    24
alpar@2195
    25
<OL style="padding-bottom: 60px">
alpar@2195
    26
  <LI>\ref intro
alpar@2195
    27
  <LI>\ref getting_started
alpar@2195
    28
  <UL>
alpar@2195
    29
    <LI>\ref hello_world
alpar@2195
    30
    <LI>\ref compile_hw
alpar@2195
    31
  </UL>
alpar@2195
    32
  <LI>\ref basic_concepts
alpar@2195
    33
  <UL>
alpar@2195
    34
    <LI>\ref basic_ListGraph
alpar@2195
    35
    <LI>\ref maps1
alpar@2195
    36
  </UL>
alpar@2216
    37
  <LI>\ref lemon_file_format
alpar@2216
    38
  <UL>
alpar@2216
    39
    <LI>\ref read_write_bg
alpar@2216
    40
  </UL>
alpar@2195
    41
  <LI>\ref algorithms
alpar@2195
    42
  <UL>
alpar@2216
    43
    <LI>\ref algo_bfs_dfs
mqrelly@2281
    44
    <LI>\ref algo_dijkstra
mqrelly@2281
    45
    <LI>\ref algo_kruskal
alpar@2195
    46
  </UL>
alpar@2195
    47
  <LI>\ref maps2
alpar@2195
    48
  <UL>
alpar@2195
    49
    <LI>\ref custom_maps
alpar@2216
    50
    <LI>Map Adaptors
alpar@2216
    51
    <LI>Special Purpose Maps
alpar@2195
    52
  </UL>
mqrelly@2281
    53
  <LI>\ref show_a_graph
alpar@2216
    54
  <LI>Miscellaneous Tool
alpar@2195
    55
  <UL>
alpar@2216
    56
    <LI>LP solver
alpar@2216
    57
    <LI>Simulated Annealing
alpar@2195
    58
  </UL>
alpar@2195
    59
</OL>
ladanyi@2165
    60
ladanyi@2166
    61
\section intro Introduction
alpar@2195
    62
In this tutorial we try to show you as many aspects of LEMON as possible. From
alpar@2195
    63
the basics to the very advanced or highly optimized tools. The given examples
alpar@2195
    64
are all available in \c demo directory, so feel free to look at them after the
alpar@2195
    65
sections.
ladanyi@2165
    66
*/
alpar@2216
    67
}