intro.dox
author Alpar Juttner <alpar@cs.elte.hu>
Thu, 30 Oct 2008 17:13:33 +0000
changeset 10 55e2f7712e87
parent 6 da96f28684f7
child 20 3ffc47b666b1
permissions -rw-r--r--
TOC and section numbering are generated from toc.txt
     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-2008
     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]intro[PAGE] Introduction
    21 
    22 [SEC]intro_lemon[SEC] What is LEMON
    23 
    24 <b>LEMON</b> stands for <b>L</b>ibrary of <b>E</b>fficient <b>M</b>odels and
    25 <b>O</b>ptimization in <b>N</b>etworks. It is a C++ template
    26 library aimed at combinatorial optimization tasks, especially those
    27 working with graphs and networks.
    28 
    29 <b>LEMON is an <a class="el" href="http://opensource.org/">open&nbsp;source</a>
    30 project.
    31 You are free to use it in your commercial or non-commercial applications
    32 under very permissive \ref license "license terms".</b>
    33 
    34 This library helps to write programs that solve optimization problems
    35 that arise frequently when designing and testing certain networks,
    36 for example in telecommunication, computer networks, logistics, scheduling,
    37 and other areas.
    38 A very natural way of modelling these networks is by means of a graph.
    39 Generally if you want to write any program that works with graphs,
    40 then you might find it useful and convenient to use LEMON.
    41 
    42 For more information visit the LEMON web site:
    43 <a href="http://lemon.cs.elte.hu/"><b>http://lemon.cs.elte.hu/</b></a>.
    44 
    45 [SEC]intro_tutorial[SEC] LEMON Tutorial
    46 
    47 This tutorial introduces the reader to the basic concepts and features of
    48 LEMON, and there are also some sections about advanced topics showing the
    49 power of various tools implemented in the library.
    50 
    51 After getting familiar with the basics of the library, you may start using
    52 LEMON with the help of the detailed documentation (that can also be used
    53 as a reference manual).
    54 
    55 
    56 [TRAILER]
    57 
    58 */