README
author Peter Kovacs <kpeter@inf.elte.hu>
Sat, 08 Jan 2011 22:51:16 +0100
changeset 1033 9a51db038228
parent 658 ebdcc68fe79e
permissions -rw-r--r--
Document and greatly improve TSP algorithms (#386)

- Add LEMON headers.
- Add Doxygen doc for all classes and their members.
- Clarify and unify the public API of the algorithms.
- Various small improvements in the implementations to make
them clearer and faster.
- Avoid using adaptors in ChristofidesTsp.
     1 =====================================================================
     2 LEMON - a Library for Efficient Modeling and Optimization in Networks
     3 =====================================================================
     4 
     5 LEMON is an open source library written in C++. It provides
     6 easy-to-use implementations of common data structures and algorithms
     7 in the area of optimization and helps implementing new ones. The main
     8 focus is on graphs and graph algorithms, thus it is especially
     9 suitable for solving design and optimization problems of
    10 telecommunication networks. To achieve wide usability its data
    11 structures and algorithms provide generic interfaces.
    12 
    13 Contents
    14 ========
    15 
    16 LICENSE
    17 
    18    Copying, distribution and modification conditions and terms.
    19 
    20 NEWS
    21 
    22    News and version history.
    23 
    24 INSTALL
    25 
    26    General building and installation instructions.
    27 
    28 lemon/
    29 
    30    Source code of LEMON library.
    31 
    32 doc/
    33 
    34    Documentation of LEMON. The starting page is doc/html/index.html.
    35 
    36 demo/
    37 
    38    Some example programs to make you easier to get familiar with LEMON.
    39 
    40 scripts/
    41 
    42    Scripts that make it easier to develop LEMON.
    43 
    44 test/
    45 
    46    Programs to check the integrity and correctness of LEMON.
    47 
    48 tools/
    49 
    50    Various utilities related to LEMON.