source: lemon-tutorial/mainpage.dox @ 3:0cf8882c7e7c

/* -*- mode: C++; indent-tabs-mode: nil; -*-
 *
 * This file is a part of LEMON, a generic C++ optimization library.
 *
 * Copyright (C) 2003-2008
 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
 * (Egervary Research Group on Combinatorial Optimization, EGRES).
 *
 * Permission to use, modify and distribute this software is granted
 * provided that this copyright notice appears in all copies. For
 * precise terms see the accompanying LICENSE file.
 *
 * This software is provided "AS IS" with no warranty of any kind,
 * express or implied, and with no claim as to its suitability for any
 * purpose.
 *
 */

namespace lemon {
/**
\mainpage LEMON Tutorial

\section toc Table of Contents

<ol>
  <li>\ref intro "Introduction"</li>
  <li>\ref getting_started "Getting Started"</li>
  <ul>
    <li>\ref hello_lemon "Compile Your First Code"</li>
    <ul>
      <li>\ref hello_lemon_system "If LEMON is Installed System-Wide"</li>
      <li>\ref hello_lemon_user "If LEMON is Installed User-Local"</li>
      <ul>
        <li>\ref hello_lemon_pkg_config "Use pkg-config"</li>
      </ul>
    </ul>
  </ul>
  <li>\ref basic_concepts "Basic Concepts"</li>
  <ul>
    <li>\ref digraph_build "Build and Modify a Digraph"</li>
    <li>\ref digraph_iterate "Iterate Over the Elements"</li>
    <li>\ref standard_maps "Maps - Assign Data to Graphs"</li>
    <li>\ref algorithms "Algorithms"</li>
    <ul>
      <li>\ref alg_bfs_dfs "BFS, DFS - Graph Search"</li>
      <li>\ref alg_dijkstra "Dijkstra - Shorthest Path"</li>
      <li>\ref alg_kruskal "Kruskal - Minimum Spanning Tree"</li>
    </ul>
    <li>\ref undir_graphs "Undirected Graphs"</li>
  </ul>
  <li>\ref tools "Some Important Auxiliary Tools"</li>
  <ul>
    <li>\ref lgf "LEMON Graph Format"</li>
    <ul>
      <li>\ref glemon "gLemon - A Graph Editor for LEMON"</li>
    </ul>
    <li>\ref graph_to_eps "GraphToEps - Postscript Exporting"</li>
    <li>\ref time_count "Time Measuring and Counting"</li>
    <li>\ref random "Random Numbers"</li>
  </ul>
  <li>\ref advanced "Advanced Topics"</li>
  <ul>
    <li>\ref maps "Maps"</li>
    <ul>
      <li>\ref map_concepts "Read/Write/Reference Maps"</li>
      <li>\ref custom_maps "Custom Maps"</li>
      <li>\ref map_adaptors "Map Adaptors"</li>
      <li>\ref special_maps "Other Special Purpose Maps"</li>
    </ul>
    <li>\ref graphs "Graphs"</li>
    <ul>
      <li>\ref graph_adaptors "Graph Adaptors"</li>
      <li>\ref special_graphs "Special Graph Structures"</li>
    </ul>
    <li>\ref named_params "Named Parameters"</li>
    <ul>
      <li>\ref alg_named_params "Customizing Algorithms"</li>
    </ul>
  </ul>
  <li>\ref lp "LP and MIP Solvers"</li>
  <li>\ref appendix "Appendix"</li>
  <ul>
    <li>\ref install "Install LEMON"</li>
    <ul>
      <li>\ref install_system "Install System Wide"</li>
      <ul>
        <li>\ref install_system_source "From Source"</li>
        <li>\ref install_system_rpm "From rpm"</li>
      </ul>
      <li>\ref install_user "Install Locally to the User"</li>
    </ul>
  </ul>
</ol>

*/
}