doc/mainpage.dox
author alpar
Tue, 05 Jun 2007 14:48:20 +0000
changeset 2448 ab899ae3505f
parent 2141 9bb0bfea2f0b
child 2553 bfced05fa852
permissions -rw-r--r--
Bugfix and improvement in -tsp2 algorithm
alpar@2391
     1
/* -*- C++ -*-
alpar@2391
     2
 *
alpar@2391
     3
 * This file is a part of LEMON, a generic C++ optimization library
alpar@2391
     4
 *
alpar@2391
     5
 * Copyright (C) 2003-2007
alpar@2391
     6
 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
alpar@2391
     7
 * (Egervary Research Group on Combinatorial Optimization, EGRES).
alpar@2391
     8
 *
alpar@2391
     9
 * Permission to use, modify and distribute this software is granted
alpar@2391
    10
 * provided that this copyright notice appears in all copies. For
alpar@2391
    11
 * precise terms see the accompanying LICENSE file.
alpar@2391
    12
 *
alpar@2391
    13
 * This software is provided "AS IS" with no warranty of any kind,
alpar@2391
    14
 * express or implied, and with no claim as to its suitability for any
alpar@2391
    15
 * purpose.
alpar@2391
    16
 *
alpar@2391
    17
 */
alpar@2391
    18
alpar@479
    19
/**
alpar@995
    20
\mainpage LEMON Documentation
alpar@479
    21
ladanyi@666
    22
\section intro Introduction
alpar@479
    23
alpar@921
    24
\subsection whatis What is LEMON
ladanyi@666
    25
alpar@921
    26
LEMON stands for
alpar@926
    27
<b>L</b>ibrary of <b>E</b>fficient <b>M</b>odels
alpar@926
    28
and <b>O</b>ptimization in <b>N</b>etworks.
alpar@670
    29
It is a C++ template
alpar@670
    30
library aimed at combinatorial optimization tasks which
alpar@1170
    31
often involve in working
alpar@991
    32
with graphs.
alpar@991
    33
alpar@991
    34
<b>
alpar@995
    35
LEMON is an <a class="el" href="http://opensource.org/">open&nbsp;source</a>
alpar@995
    36
project.
marci@1003
    37
You are free to use it in your commercial or
marci@1003
    38
non-commercial applications under very permissive
alpar@991
    39
\ref license "license terms".
alpar@991
    40
</b>
ladanyi@666
    41
athos@1169
    42
\subsection howtoread How to read the documentation
ladanyi@666
    43
athos@1169
    44
If you want to get a quick start and see the most important features then 
athos@1169
    45
take a look at our \ref quicktour
athos@1169
    46
"Quick Tour to LEMON" which will guide you along.
ladanyi@666
    47
athos@1173
    48
If you already feel like using our library, see the page that tells you 
athos@1173
    49
\ref getstart "How to start using LEMON".
athos@1173
    50
athos@1169
    51
If you 
athos@1169
    52
want to see how LEMON works, see 
alpar@1170
    53
some \ref demoprograms "demo programs"!
athos@1169
    54
alpar@2141
    55
If you know what you are looking for then try to find it under the
alpar@2141
    56
<a class="el" href="modules.html">Modules</a>
alpar@2141
    57
section.
athos@1169
    58
ladanyi@666
    59
ladanyi@666
    60
*/