intro.dox
author Peter Kovacs <kpeter@inf.elte.hu>
Mon, 01 Mar 2010 02:30:00 +0100
changeset 58 10b6a5b7d4c0
parent 32 ef12f83752f6
permissions -rw-r--r--
Improve Algorithms section (it is still under construction)
     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-2010
     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 [PAGE]sec_intro[PAGE] Introduction
    21 
    22 [SEC]sec_intro_lemon[SEC] What is LEMON
    23 
    24 <b>LEMON</b> stands for <b>L</b>ibrary for <b>E</b>fficient <b>M</b>odeling and
    25 <b>O</b>ptimization in <b>N</b>etworks. It is a C++ template library providing
    26 efficient implementations of common data structures and algorithms with
    27 focus on combinatorial optimization tasks connected mainly with graphs
    28 and networks.
    29 
    30 <b>LEMON is an <a class="el" href="http://opensource.org/">open&nbsp;source</a>
    31 project.
    32 You are free to use it in your commercial or non-commercial applications
    33 under very permissive \ref license "license terms".</b>
    34 
    35 This library helps to write programs that solve various optimization problems,
    36 which often arise when designing and testing certain networks,
    37 for example in telecommunication, computer networks, logistics, scheduling,
    38 and other areas.
    39 A very natural way of modeling these networks is by means of a graph.
    40 Generally, if you want to write any program that works with graphs,
    41 then you might find it useful and convenient to use LEMON.
    42 
    43 For more information, visit the LEMON web site:
    44 <a href="http://lemon.cs.elte.hu/"><b>http://lemon.cs.elte.hu/</b></a>.
    45 
    46 [SEC]sec_intro_tutorial[SEC] LEMON Tutorial
    47 
    48 This tutorial introduces the reader to the basic concepts and features of
    49 LEMON, and there are also some sections about advanced topics showing the
    50 power of various tools implemented in the library.
    51 
    52 After getting familiar with the basics of the library, you may start using
    53 LEMON with the help of the detailed documentation (which can be viewed
    54 as a reference manual).
    55 
    56 
    57 [TRAILER]
    58 
    59 */