mainpage.dox
author Peter Kovacs <kpeter@inf.elte.hu>
Sat, 11 Oct 2008 13:13:09 +0200
changeset 3 0cf8882c7e7c
parent 2 9388ccf86294
child 4 89f6fff82e93
permissions -rw-r--r--
Add Intro and Getting Started pages
     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 <ol>
    26   <li>\ref intro "Introduction"</li>
    27   <li>\ref getting_started "Getting Started"</li>
    28   <ul>
    29     <li>\ref hello_lemon "Compile Your First Code"</li>
    30     <ul>
    31       <li>\ref hello_lemon_system "If LEMON is Installed System-Wide"</li>
    32       <li>\ref hello_lemon_user "If LEMON is Installed User-Local"</li>
    33       <ul>
    34         <li>\ref hello_lemon_pkg_config "Use pkg-config"</li>
    35       </ul>
    36     </ul>
    37   </ul>
    38   <li>\ref basic_concepts "Basic Concepts"</li>
    39   <ul>
    40     <li>\ref digraph_build "Build and Modify a Digraph"</li>
    41     <li>\ref digraph_iterate "Iterate Over the Elements"</li>
    42     <li>\ref standard_maps "Maps - Assign Data to Graphs"</li>
    43     <li>\ref algorithms "Algorithms"</li>
    44     <ul>
    45       <li>\ref alg_bfs_dfs "BFS, DFS - Graph Search"</li>
    46       <li>\ref alg_dijkstra "Dijkstra - Shorthest Path"</li>
    47       <li>\ref alg_kruskal "Kruskal - Minimum Spanning Tree"</li>
    48     </ul>
    49     <li>\ref undir_graphs "Undirected Graphs"</li>
    50   </ul>
    51   <li>\ref tools "Some Important Auxiliary Tools"</li>
    52   <ul>
    53     <li>\ref lgf "LEMON Graph Format"</li>
    54     <ul>
    55       <li>\ref glemon "gLemon - A Graph Editor for LEMON"</li>
    56     </ul>
    57     <li>\ref graph_to_eps "GraphToEps - Postscript Exporting"</li>
    58     <li>\ref time_count "Time Measuring and Counting"</li>
    59     <li>\ref random "Random Numbers"</li>
    60   </ul>
    61   <li>\ref advanced "Advanced Topics"</li>
    62   <ul>
    63     <li>\ref maps "Maps"</li>
    64     <ul>
    65       <li>\ref map_concepts "Read/Write/Reference Maps"</li>
    66       <li>\ref custom_maps "Custom Maps"</li>
    67       <li>\ref map_adaptors "Map Adaptors"</li>
    68       <li>\ref special_maps "Other Special Purpose Maps"</li>
    69     </ul>
    70     <li>\ref graphs "Graphs"</li>
    71     <ul>
    72       <li>\ref graph_adaptors "Graph Adaptors"</li>
    73       <li>\ref special_graphs "Special Graph Structures"</li>
    74     </ul>
    75     <li>\ref named_params "Named Parameters"</li>
    76     <ul>
    77       <li>\ref alg_named_params "Customizing Algorithms"</li>
    78     </ul>
    79   </ul>
    80   <li>\ref lp "LP and MIP Solvers"</li>
    81   <li>\ref appendix "Appendix"</li>
    82   <ul>
    83     <li>\ref install "Install LEMON"</li>
    84     <ul>
    85       <li>\ref install_system "Install System Wide"</li>
    86       <ul>
    87         <li>\ref install_system_source "From Source"</li>
    88         <li>\ref install_system_rpm "From rpm"</li>
    89       </ul>
    90       <li>\ref install_user "Install Locally to the User"</li>
    91     </ul>
    92   </ul>
    93 </ol>
    94 
    95 */
    96 }