doc/mainpage.dox.in
author Peter Kovacs <kpeter@inf.elte.hu>
Tue, 15 Mar 2011 19:32:21 +0100
changeset 1047 ddd3c0d3d9bf
parent 956 141f9c0db4a3
parent 1037 d3b041452dd8
child 1219 4f9a45a6d6f0
permissions -rw-r--r--
Implement the scaling Price Refinement heuristic in CostScaling (#417)
instead of Early Termination.

These two heuristics are similar, but the newer one is faster
and not only makes it possible to skip some epsilon phases, but
it can improve the performance of the other phases, as well.
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@956
     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@1037
    20
\mainpage @PACKAGE_NAME@ @PACKAGE_VERSION@ Documentation
alpar@40
    21
alpar@40
    22
\section intro Introduction
alpar@40
    23
kpeter@802
    24
<b>LEMON</b> stands for <i><b>L</b>ibrary for <b>E</b>fficient <b>M</b>odeling
kpeter@802
    25
and <b>O</b>ptimization in <b>N</b>etworks</i>.
kpeter@921
    26
It is a C++ template library providing efficient implementations of common
kpeter@802
    27
data structures and algorithms with focus on combinatorial optimization
alpar@956
    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@956
    38
The project is maintained by the
kpeter@802
    39
<a href="http://www.cs.elte.hu/egres/">Egerv&aacute;ry Research Group on
kpeter@802
    40
Combinatorial Optimization</a> \ref egres
kpeter@802
    41
at the Operations Research Department of the
kpeter@921
    42
<a href="http://www.elte.hu/en/">E&ouml;tv&ouml;s Lor&aacute;nd University</a>,
kpeter@921
    43
Budapest, Hungary.
kpeter@802
    44
LEMON is also a member of the <a href="http://www.coin-or.org/">COIN-OR</a>
kpeter@802
    45
initiative \ref coinor.
kpeter@802
    46
kpeter@802
    47
\section howtoread How to Read the Documentation
alpar@40
    48
kpeter@698
    49
If you would like to get to know the library, see
kpeter@606
    50
<a class="el" href="http://lemon.cs.elte.hu/pub/tutorial/">LEMON Tutorial</a>.
alpar@40
    51
kpeter@921
    52
If you are interested in starting to use the library, see the <a class="el"
kpeter@921
    53
href="http://lemon.cs.elte.hu/trac/lemon/wiki/InstallGuide/">Installation
kpeter@921
    54
Guide</a>.
kpeter@921
    55
kpeter@698
    56
If you know what you are looking for, then try to find it under the
kpeter@606
    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
*/