1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/mainpage.dox Sat Oct 11 11:29:12 2008 +0200
1.3 @@ -0,0 +1,96 @@
1.4 +/* -*- mode: C++; indent-tabs-mode: nil; -*-
1.5 + *
1.6 + * This file is a part of LEMON, a generic C++ optimization library.
1.7 + *
1.8 + * Copyright (C) 2003-2008
1.9 + * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
1.10 + * (Egervary Research Group on Combinatorial Optimization, EGRES).
1.11 + *
1.12 + * Permission to use, modify and distribute this software is granted
1.13 + * provided that this copyright notice appears in all copies. For
1.14 + * precise terms see the accompanying LICENSE file.
1.15 + *
1.16 + * This software is provided "AS IS" with no warranty of any kind,
1.17 + * express or implied, and with no claim as to its suitability for any
1.18 + * purpose.
1.19 + *
1.20 + */
1.21 +
1.22 +namespace lemon {
1.23 +/**
1.24 +\mainpage LEMON Tutorial
1.25 +
1.26 +<h2>Table of Contents</h2>
1.27 +
1.28 +<ol>
1.29 + <li>\ref intro "Introduction"</li>
1.30 + <li>\ref getting_started "Getting Started"</li>
1.31 + <ul>
1.32 + <li>\ref hello_lemon "Compile Your First Code"</li>
1.33 + <ul>
1.34 + <li>\ref hello_lemon_system "If LEMON is Installed System-Wide"</li>
1.35 + <li>\ref hello_lemon_user "If LEMON is Installed User-Local"</li>
1.36 + <ul>
1.37 + <li>\ref hello_lemon_pkg_config "Use pkg-config"</li>
1.38 + </ul>
1.39 + </ul>
1.40 + </ul>
1.41 + <li>\ref basic_concepts "Basic Concepts"</li>
1.42 + <ul>
1.43 + <li>\ref digraph_build "Build and Modify a Digraph"</li>
1.44 + <li>\ref digraph_iterate "Iterate Over the Elements"</li>
1.45 + <li>\ref standard_maps "Maps - Assign Data to Graphs"</li>
1.46 + <li>\ref algorithms "Algorithms"</li>
1.47 + <ul>
1.48 + <li>\ref alg_bfs_dfs "BFS, DFS - Graph Search"</li>
1.49 + <li>\ref alg_dijkstra "Dijkstra - Shorthest Path"</li>
1.50 + <li>\ref alg_kruskal "Kruskal - Minimum Spanning Tree"</li>
1.51 + </ul>
1.52 + <li>\ref undir_graphs "Undirected Graphs"</li>
1.53 + </ul>
1.54 + <li>\ref tools "Some Important Auxiliary Tools"</li>
1.55 + <ul>
1.56 + <li>\ref lgf "LEMON Graph Format"</li>
1.57 + <ul>
1.58 + <li>\ref glemon "gLemon - A Graph Editor for LEMON"</li>
1.59 + </ul>
1.60 + <li>\ref graph_to_eps "GraphToEps - Postscript Exporting"</li>
1.61 + <li>\ref time_count "Time Measuring and Counting"</li>
1.62 + <li>\ref random "Random Numbers"</li>
1.63 + </ul>
1.64 + <li>\ref advanced "Advanced Topics"</li>
1.65 + <ul>
1.66 + <li>\ref maps "Maps"</li>
1.67 + <ul>
1.68 + <li>\ref map_concepts "Read/Write/Reference Maps"</li>
1.69 + <li>\ref custom_maps "Custom Maps"</li>
1.70 + <li>\ref map_adaptors "Map Adaptors"</li>
1.71 + <li>\ref special_maps "Other Special Purpose Maps"</li>
1.72 + </ul>
1.73 + <li>\ref graphs "Graphs"</li>
1.74 + <ul>
1.75 + <li>\ref graph_adaptors "Graph Adaptors"</li>
1.76 + <li>\ref special_graphs "Special Graph Structures"</li>
1.77 + </ul>
1.78 + <li>\ref named_params "Named Parameters"</li>
1.79 + <ul>
1.80 + <li>\ref alg_named_params "Customizing Algorithms"</li>
1.81 + </ul>
1.82 + </ul>
1.83 + <li>\ref lp "LP and MIP Solvers"</li>
1.84 + <li>\ref appendix "Appendix"</li>
1.85 + <ul>
1.86 + <li>\ref install "Install LEMON"</li>
1.87 + <ul>
1.88 + <li>\ref install_system "Install System Wide"</li>
1.89 + <ul>
1.90 + <li>\ref install_system_source "From Source"</li>
1.91 + <li>\ref install_system_rpm "From rpm"</li>
1.92 + </ul>
1.93 + <li>\ref install_user "Install Locally to the User"</li>
1.94 + </ul>
1.95 + </ul>
1.96 +</ol>
1.97 +
1.98 +*/
1.99 +}