doc/mainpage.dox
author Peter Kovacs <kpeter@inf.elte.hu>
Thu, 12 Nov 2009 23:26:13 +0100
changeset 872 fa6f37d7a25b
parent 705 ebdcc68fe79e
child 921 e05b2b48515a
permissions -rw-r--r--
Entirely rework CapacityScaling (#180)

- Use the new interface similarly to NetworkSimplex.
- Rework the implementation using an efficient internal structure
for handling the residual network. This improvement made the
code much faster (up to 2-5 times faster on large graphs).
- Handle GEQ supply type (LEQ is not supported).
- Handle negative costs for arcs of finite capacity.
(Note that this algorithm cannot handle arcs of negative cost
and infinite upper bound, thus it returns UNBOUNDED if such
an arc exists.)
- Extend the documentation.
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@463
     5
 * Copyright (C) 2003-2009
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@40
    20
\mainpage LEMON 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@802
    26
It is a C++ template library providing efficient implementation of common
kpeter@802
    27
data structures and algorithms with focus on combinatorial optimization
kpeter@802
    28
problems in 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
kpeter@802
    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@802
    42
<a href="http://www.elte.hu/">E&ouml;tv&ouml;s Lor&aacute;nd University,
kpeter@802
    43
Budapest</a>, 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@698
    52
If you know what you are looking for, then try to find it under the
kpeter@606
    53
<a class="el" href="modules.html">Modules</a> section.
alpar@40
    54
kpeter@314
    55
If you are a user of the old (0.x) series of LEMON, please check out the
kpeter@314
    56
\ref migration "Migration Guide" for the backward incompatibilities.
alpar@40
    57
*/