mainpage.dox
author Peter Kovacs <kpeter@inf.elte.hu>
Tue, 28 Oct 2008 18:54:30 +0100
changeset 9 a48bf0d3a790
parent 7 934258c64b6b
child 10 55e2f7712e87
permissions -rw-r--r--
Extend installation guide + reorganize the toc
kpeter@2
     1
/* -*- mode: C++; indent-tabs-mode: nil; -*-
kpeter@2
     2
 *
kpeter@2
     3
 * This file is a part of LEMON, a generic C++ optimization library.
kpeter@2
     4
 *
kpeter@2
     5
 * Copyright (C) 2003-2008
kpeter@2
     6
 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
kpeter@2
     7
 * (Egervary Research Group on Combinatorial Optimization, EGRES).
kpeter@2
     8
 *
kpeter@2
     9
 * Permission to use, modify and distribute this software is granted
kpeter@2
    10
 * provided that this copyright notice appears in all copies. For
kpeter@2
    11
 * precise terms see the accompanying LICENSE file.
kpeter@2
    12
 *
kpeter@2
    13
 * This software is provided "AS IS" with no warranty of any kind,
kpeter@2
    14
 * express or implied, and with no claim as to its suitability for any
kpeter@2
    15
 * purpose.
kpeter@2
    16
 *
kpeter@2
    17
 */
kpeter@2
    18
kpeter@2
    19
namespace lemon {
kpeter@2
    20
/**
kpeter@2
    21
\mainpage LEMON Tutorial
kpeter@2
    22
kpeter@3
    23
\section toc Table of Contents
kpeter@2
    24
kpeter@4
    25
 - \ref intro
kpeter@9
    26
 - \ref basic_concepts "Basic Concepts"
kpeter@4
    27
   - \ref hello_lemon
kpeter@4
    28
   - \ref digraph_build "Build and Modify a Digraph"
kpeter@4
    29
   - \ref digraph_iterate "Iterate Over the Elements"
kpeter@4
    30
   - \ref standard_maps "Maps - Assign Data to Graphs"
kpeter@4
    31
   - \ref algorithms "Algorithms"
kpeter@4
    32
     - \ref alg_bfs_dfs "BFS, DFS - Graph Search"
kpeter@4
    33
     - \ref alg_dijkstra "Dijkstra - Shorthest Path"
kpeter@4
    34
     - \ref alg_kruskal "Kruskal - Minimum Spanning Tree"
kpeter@4
    35
   - \ref undir_graphs "Undirected Graphs"
kpeter@4
    36
 - \ref tools "Some Important Auxiliary Tools"
kpeter@4
    37
   - \ref lgf "LEMON Graph Format"
kpeter@4
    38
     - \ref glemon "gLemon - A Graph Editor for LEMON"
kpeter@4
    39
   - \ref graph_to_eps "GraphToEps - Postscript Exporting"
kpeter@4
    40
   - \ref time_count "Time Measuring and Counting"
kpeter@4
    41
   - \ref random "Random Numbers"
kpeter@4
    42
 - \ref advanced "Advanced Topics"
kpeter@4
    43
   - \ref maps "Maps"
kpeter@4
    44
     - \ref map_concepts "Read/Write/Reference Maps"
kpeter@4
    45
     - \ref custom_maps "Custom Maps"
kpeter@4
    46
     - \ref map_adaptors "Map Adaptors"
kpeter@4
    47
     - \ref special_maps "Other Special Purpose Maps"
kpeter@4
    48
   - \ref graphs "Graphs"
kpeter@4
    49
     - \ref graph_adaptors "Graph Adaptors"
kpeter@4
    50
     - \ref special_graphs "Special Graph Structures"
kpeter@4
    51
   - \ref named_params "Named Parameters"
kpeter@4
    52
     - \ref alg_named_params "Customizing Algorithms"
kpeter@4
    53
 - \ref lp "LP and MIP Solvers"
kpeter@4
    54
   - \ref lp_examples "Simple Examples"
kpeter@4
    55
   - \ref lp_maxflow "Maximum Flow as LP Problem"
kpeter@4
    56
 - \ref appendix "Appendix"
alpar@7
    57
   - \ref install
alpar@7
    58
     - \ref requirements_lemon
alpar@7
    59
       - \ref requirements_lp
alpar@7
    60
     - \ref install_from_source
kpeter@9
    61
       - \ref install_hg
kpeter@9
    62
     - \ref install_rpm
kpeter@9
    63
     - \ref install_user
kpeter@9
    64
     - \ref compile_codes
kpeter@9
    65
       - \ref compile_system_wide
kpeter@9
    66
       - \ref compile_user_local
kpeter@2
    67
kpeter@2
    68
*/
kpeter@2
    69
}