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