README
author Peter Kovacs <kpeter@inf.elte.hu>
Sun, 03 Aug 2008 13:34:57 +0200
changeset 244 c30731a37f91
parent 5 233b4094ceae
child 246 7c67988fca07
permissions -rw-r--r--
Many improvements in bfs.h, dfs.h and dijkstra.h
- Add run() function to Bfs and run(s,t) function to DfsVisit.
- Add debug checking to addSource() function of Dfs and DfsVisit.
- Add a few missing named parameters (according to \todo notes).
- Small fixes in the code (e.g. missing derivations).
- Many doc improvements.
- Remove \todo and \warning comments which are no longer valid.
- Remove \author commands (see ticket #39).
- Fixes in the the doc (e.g. wrong references).
- Hide the doc of most of the private and protected members.
- Use public typedefs instead of template parameters in public functions.
- Use better parameter names for some functions.
- Other small changes to make the doc more uniform.
     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).