doc/mainpage.dox.in
author Alpar Juttner <alpar@cs.elte.hu>
Tue, 26 May 2015 16:54:15 +0200
branch1.2
changeset 1000 d94bb1e50557
parent 877 141f9c0db4a3
parent 907 d3b041452dd8
permissions -rw-r--r--
Merge bugfix #598 to branch 1.2
alpar@209
     1
/* -*- mode: C++; indent-tabs-mode: nil; -*-
alpar@40
     2
 *
alpar@209
     3
 * This file is a part of LEMON, a generic C++ optimization library.
alpar@40
     4
 *
alpar@877
     5
 * Copyright (C) 2003-2010
alpar@40
     6
 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
alpar@40
     7
 * (Egervary Research Group on Combinatorial Optimization, EGRES).
alpar@40
     8
 *
alpar@40
     9
 * Permission to use, modify and distribute this software is granted
alpar@40
    10
 * provided that this copyright notice appears in all copies. For
alpar@40
    11
 * precise terms see the accompanying LICENSE file.
alpar@40
    12
 *
alpar@40
    13
 * This software is provided "AS IS" with no warranty of any kind,
alpar@40
    14
 * express or implied, and with no claim as to its suitability for any
alpar@40
    15
 * purpose.
alpar@40
    16
 *
alpar@40
    17
 */
alpar@40
    18
alpar@40
    19
/**
alpar@907
    20
\mainpage @PACKAGE_NAME@ @PACKAGE_VERSION@ Documentation
alpar@40
    21
alpar@40
    22
\section intro Introduction
alpar@40
    23
kpeter@755
    24
<b>LEMON</b> stands for <i><b>L</b>ibrary for <b>E</b>fficient <b>M</b>odeling
kpeter@755
    25
and <b>O</b>ptimization in <b>N</b>etworks</i>.
kpeter@848
    26
It is a C++ template library providing efficient implementations of common
kpeter@755
    27
data structures and algorithms with focus on combinatorial optimization
alpar@877
    28
tasks connected mainly with graphs and networks.
alpar@40
    29
alpar@40
    30
<b>
alpar@40
    31
LEMON is an <a class="el" href="http://opensource.org/">open&nbsp;source</a>
alpar@40
    32
project.
alpar@40
    33
You are free to use it in your commercial or
alpar@40
    34
non-commercial applications under very permissive
alpar@40
    35
\ref license "license terms".
alpar@40
    36
</b>
alpar@40
    37
alpar@877
    38
The project is maintained by the
kpeter@755
    39
<a href="http://www.cs.elte.hu/egres/">Egerv&aacute;ry Research Group on
kpeter@755
    40
Combinatorial Optimization</a> \ref egres
kpeter@755
    41
at the Operations Research Department of the
kpeter@848
    42
<a href="http://www.elte.hu/en/">E&ouml;tv&ouml;s Lor&aacute;nd University</a>,
kpeter@848
    43
Budapest, Hungary.
kpeter@755
    44
LEMON is also a member of the <a href="http://www.coin-or.org/">COIN-OR</a>
kpeter@755
    45
initiative \ref coinor.
kpeter@755
    46
kpeter@755
    47
\section howtoread How to Read the Documentation
alpar@40
    48
kpeter@651
    49
If you would like to get to know the library, see
kpeter@559
    50
<a class="el" href="http://lemon.cs.elte.hu/pub/tutorial/">LEMON Tutorial</a>.
alpar@40
    51
kpeter@848
    52
If you are interested in starting to use the library, see the <a class="el"
kpeter@848
    53
href="http://lemon.cs.elte.hu/trac/lemon/wiki/InstallGuide/">Installation
kpeter@848
    54
Guide</a>.
kpeter@848
    55
kpeter@651
    56
If you know what you are looking for, then try to find it under the
kpeter@559
    57
<a class="el" href="modules.html">Modules</a> section.
alpar@40
    58
kpeter@314
    59
If you are a user of the old (0.x) series of LEMON, please check out the
kpeter@314
    60
\ref migration "Migration Guide" for the backward incompatibilities.
alpar@40
    61
*/