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