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
     1 /* -*- mode: C++; indent-tabs-mode: nil; -*-
     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 \mainpage LEMON Tutorial
    22 
    23 \section toc Table of Contents
    24 
    25  - \ref intro
    26  - \ref basic_concepts "Basic Concepts"
    27    - \ref hello_lemon
    28    - \ref digraph_build "Build and Modify a Digraph"
    29    - \ref digraph_iterate "Iterate Over the Elements"
    30    - \ref standard_maps "Maps - Assign Data to Graphs"
    31    - \ref algorithms "Algorithms"
    32      - \ref alg_bfs_dfs "BFS, DFS - Graph Search"
    33      - \ref alg_dijkstra "Dijkstra - Shorthest Path"
    34      - \ref alg_kruskal "Kruskal - Minimum Spanning Tree"
    35    - \ref undir_graphs "Undirected Graphs"
    36  - \ref tools "Some Important Auxiliary Tools"
    37    - \ref lgf "LEMON Graph Format"
    38      - \ref glemon "gLemon - A Graph Editor for LEMON"
    39    - \ref graph_to_eps "GraphToEps - Postscript Exporting"
    40    - \ref time_count "Time Measuring and Counting"
    41    - \ref random "Random Numbers"
    42  - \ref advanced "Advanced Topics"
    43    - \ref maps "Maps"
    44      - \ref map_concepts "Read/Write/Reference Maps"
    45      - \ref custom_maps "Custom Maps"
    46      - \ref map_adaptors "Map Adaptors"
    47      - \ref special_maps "Other Special Purpose Maps"
    48    - \ref graphs "Graphs"
    49      - \ref graph_adaptors "Graph Adaptors"
    50      - \ref special_graphs "Special Graph Structures"
    51    - \ref named_params "Named Parameters"
    52      - \ref alg_named_params "Customizing Algorithms"
    53  - \ref lp "LP and MIP Solvers"
    54    - \ref lp_examples "Simple Examples"
    55    - \ref lp_maxflow "Maximum Flow as LP Problem"
    56  - \ref appendix "Appendix"
    57    - \ref install
    58      - \ref requirements_lemon
    59        - \ref requirements_lp
    60      - \ref install_from_source
    61        - \ref install_hg
    62      - \ref install_rpm
    63      - \ref install_user
    64      - \ref compile_codes
    65        - \ref compile_system_wide
    66        - \ref compile_user_local
    67 
    68 */
    69 }