README
author kpeter
Mon, 18 Feb 2008 03:32:56 +0000
changeset 2576 ae092c63d3ba
parent 2237 5674a5983e1e
permissions -rw-r--r--
Improvements in MinCostFlow and MinCostMaxFlow.

Main changes:
- MinCostMaxFlow also provides dual solution.
- Change the name of private members to start with "_".
- Change the name of function parameters not to start with "_".
- Remove unnecessary documentation for private members.
- Doc improvements.
     1 ------------------------------------------------------------------
     2 LEMON - a Library of Efficient Models and Optimization in Networks
     3 ------------------------------------------------------------------
     4 
     5 LEMON is the abbreviation of Library of Efficient Models and
     6 Optimization in Networks. It is an open source library written in
     7 C++. It provides a set of easy-to-use implementation of common data
     8 structures and algorithms in the area of optimization and helps
     9 implementing new ones. It is an especially suitable tool to solve the
    10 design and optimization problems of telecommunications networks. To
    11 achieve wide usability, a fundamental design requirement is the
    12 genericity of interface of data structures and algorithms. LEMON is an
    13 open source library end invites people all around the world in its
    14 development.
    15 
    16 --------
    17 Contents
    18 --------
    19 
    20 COPYING, LICENSE
    21 
    22   Copying, distribution and modification conditions and terms.
    23 
    24 INSTALL
    25 
    26   For general building and installation instructions, see the file.
    27 
    28 lemon/
    29 
    30   Source code of LEMON itself.
    31 
    32 doc/
    33 
    34   Documentation of LEMON. The starting page is doc/html/index.html.
    35   The documentation installs into the directory
    36 
    37     /usr/local/share/doc/lemon/html
    38 
    39   or -- if you use different prefix -- into
    40 
    41     ${prefix}/share/doc/lemon/html
    42 
    43   (see also INSTALL).
    44 
    45 demo/
    46 
    47   Some demonstration programs to make you easier to get familiar with
    48   LEMON. Use --enable-demo configure option to also compile these codes
    49   (see also INSTALL).
    50 
    51 test/
    52 
    53   Contains programs to check the integrity and correctness of
    54   LEMON. The command 'make check' performs these tests.
    55 
    56 benchmark/
    57   
    58   Contains programs measuring the performance of LEMON. Use
    59   --enable-benchmark configure option to also compile these codes (see
    60   also INSTALL).