doc/tutorial.dox
changeset 2192 d6e4efb477d8
parent 2165 947d36fb3b49
child 2195 f47faf6913ab
equal deleted inserted replaced
0:0914a8fe7ec4 1:3df55a5342c4
     1 /**
     1 /**
     2 \page Tutorial LEMON Tutorial
     2 \page Tutorial LEMON Tutorial
     3 
     3 
     4 <H2>Table of Contents</H2>
     4 \section toc Table of Contents
     5 
     5 
     6 <OL>
     6 -# \ref intro
     7   <LI><A href="#intro">Introduction</A>
     7 -# \ref get_start
     8   <LI><A href="#get_start">Getting Started</A>
     8   - \ref hello_world
     9   <UL>
     9   - \ref compile
    10     <LI><A href="#hello_world">Hello World in LEMON</A>
    10 -# \ref basic
    11     <LI><A href="#compile">Compiling Hello World</A>
    11   - \ref list_graph
    12   </UL>
    12   - \ref maps1
    13   <LI><A href="#basic">Basic concepts</A>
    13 -# \ref file
    14   <UL>
    14 -# \ref algos
    15     <LI><A href="#list_graph">ListGraph - a versatile directed graph</A>
    15   - \ref bfs_dfs
    16     <LI><A href="#maps1">Maps I.</A>
    16   - \ref dijkstra
    17   </UL>
    17   - \ref kruskal
    18   <LI><A href="#file">Lemon Graph File Format</A>
    18 -# \ref maps2
    19   <LI><A href="#algos">Algorithms</A>
    19   - \ref custom_maps
    20   <UL>
    20   - \ref map_adaptors
    21     <LI><A href="#bfs_dfs">Bfs/Dfs</A>
    21   - \ref spec_maps
    22     <LI><A href="#dijkstra">Dijkstra</A>
    22 -# \ref show
    23     <LI><A href="#kruskal">Kruskal</A>
    23 -# \ref misc
    24   </UL>
    24   - \ref lp
    25   <LI><A href="#maps2">Maps II.</A>
    25   - \ref simann
    26   <UL>
       
    27     <LI><A href="#custom_maps">Writing Custom ReadMap</A>
       
    28     <LI><A href="#map_adaptors">Map Adaptors</A>
       
    29     <LI><A href="#spec_maps">Special Purpose Maps</A>
       
    30   </UL>
       
    31   <LI><A href="#show">Show a graph</A>
       
    32   <LI><A href="#misc">Miscellaneous Tool</A>
       
    33   <UL>
       
    34     <LI><A href="#lp">LP solver</A>
       
    35     <LI><A href="#simann">Simulated Annealing</A>
       
    36   </UL>
       
    37 </OL>
       
    38 
    26 
    39 <H2 id="intro">Introduction</H2>
    27 \section intro Introduction
    40 
    28 
    41 <H2 id="get_start">Getting Started</H2>
    29 \section get_start Getting Started
    42 
    30 
    43   <H3 id="hello_world">Hello World in LEMON</H3>
    31   \subsection hello_world Hello World in LEMON
    44 
    32 
    45   <H3 id="compile">Compiling Hello World</H3>
    33   \subsection compile Compiling Hello World
    46 
    34 
    47 <H2 id="basic">Basic concepts</H2>
    35 \section basic Basic concepts
    48 
    36 
    49   <H3 id="list_graph">ListGraph - a versatile directed graph</H3>
    37   \subsection list_graph ListGraph - a versatile directed graph
    50 
    38 
    51   <H3 id="maps1">Maps I.</H3>
    39   \subsection maps1 Maps I.
    52 
    40 
    53 <H2 id="file">Lemon Graph File Format</H2>
    41 \section file Lemon Graph File Format
    54 
    42 
    55 <H2 id="algos">Algorithms</H2>
    43 \section algos Algorithms
    56 
    44 
    57   <H3 id="bfs_dfs">Bfs/Dfs</H3>
    45   \subsection bfs_dfs Bfs/Dfs
    58 
    46 
    59   <H3 id="dijkstra">Dijkstra</H3>
    47   \subsection dijkstra Dijkstra
    60 
    48 
    61   <H3 id="kruskal">Kruskal</H3>
    49   \subsection kruskal Kruskal
    62 
    50 
    63 <H2 id="maps2">Maps II.</H2>
    51 \section maps2 Maps II.
    64 
    52 
    65   <H3 id="custom_maps">Writing Custom ReadMap</H3>
    53   \subsection custom_maps Writing Custom ReadMap
    66 
    54 
    67   <H3 id="map_adaptors">Map Adaptors</H3>
    55   \subsection map_adaptors Map Adaptors
    68 
    56 
    69   <H3 id="spec_maps">Special Purpose Maps</H3>
    57   \subsection spec_maps Special Purpose Maps
    70 
    58 
    71 <H2 id="show">Show a graph</H2>
    59 \section show Show a graph
    72 
    60 
    73 <H2 id="misc">Miscellaneous Tool</H2>
    61 \section misc Miscellaneous Tool
    74 
    62 
    75   <H3 id="lp">LP solver</H3>
    63   \subsection lp LP solver
    76 
    64 
    77   <H3 id="simann">Simulated Annealing</H3>
    65   \subsection simann Simulated Annealing
    78 
    66 
    79 */
    67 */