Mercuriallemon-1.3 / file revision
summary | shortlog | changelog | graph | tags | bookmarks | branches | files | changeset | file | latest | revisions | annotate | diff | comparison | raw | help
doc/mainpage.dox
author Peter Kovacs <kpeter@inf.elte.hu>
Sat, 13 Mar 2010 22:01:38 +0100
changeset 864 d3ea191c3412
parent 755 134852d7fb0a
child 877 141f9c0db4a3
permissions -rw-r--r--
Rename min mean cycle classes and their members (#179)
with respect to the possible introduction of min ratio
cycle algorithms in the future.

The renamed classes:
- Karp --> KarpMmc
- HartmannOrlin --> HartmannOrlinMmc
- Howard --> HowardMmc

The renamed members:
- cycleLength() --> cycleCost()
- cycleArcNum() --> cycleSize()
- findMinMean() --> findCycleMean()
- Value --> Cost
- LargeValue --> LargeCost
- SetLargeValue --> SetLargeCost 
     1 /* -*- mode: C++; indent-tabs-mode: nil; -*-

     2  *

     3  * This file is a part of LEMON, a generic C++ optimization library.

     4  *

     5  * Copyright (C) 2003-2009

     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 <b>LEMON</b> stands for <i><b>L</b>ibrary for <b>E</b>fficient <b>M</b>odeling

    25 and <b>O</b>ptimization in <b>N</b>etworks</i>.

    26 It is a C++ template library providing efficient implementations of common

    27 data structures and algorithms with focus on combinatorial optimization

    28 tasks connected mainly with graphs and networks. 

    29 

    30 <b>

    31 LEMON is an <a class="el" href="http://opensource.org/">open&nbsp;source</a>

    32 project.

    33 You are free to use it in your commercial or

    34 non-commercial applications under very permissive

    35 \ref license "license terms".

    36 </b>

    37 

    38 The project is maintained by the 

    39 <a href="http://www.cs.elte.hu/egres/">Egerv&aacute;ry Research Group on

    40 Combinatorial Optimization</a> \ref egres

    41 at the Operations Research Department of the

    42 <a href="http://www.elte.hu/en/">E&ouml;tv&ouml;s Lor&aacute;nd University</a>,

    43 Budapest, Hungary.

    44 LEMON is also a member of the <a href="http://www.coin-or.org/">COIN-OR</a>

    45 initiative \ref coinor.

    46 

    47 \section howtoread How to Read the Documentation

    48 

    49 If you would like to get to know the library, see

    50 <a class="el" href="http://lemon.cs.elte.hu/pub/tutorial/">LEMON Tutorial</a>.

    51 

    52 If you are interested in starting to use the library, see the <a class="el"

    53 href="http://lemon.cs.elte.hu/trac/lemon/wiki/InstallGuide/">Installation

    54 Guide</a>.

    55 

    56 If you know what you are looking for, then try to find it under the

    57 <a class="el" href="modules.html">Modules</a> section.

    58 

    59 If you are a user of the old (0.x) series of LEMON, please check out the

    60 \ref migration "Migration Guide" for the backward incompatibilities.

    61 */
lemon-1.3