intro.dox
author Peter Kovacs <kpeter@inf.elte.hu>
Mon, 11 May 2009 16:36:11 +0200
changeset 24 2965b19071f7
parent 20 3ffc47b666b1
child 25 66d164ef72d1
permissions -rw-r--r--
Change the explanation of the acronym LEMON (#289)
kpeter@3
     1
/* -*- mode: C++; indent-tabs-mode: nil; -*-
kpeter@3
     2
 *
kpeter@3
     3
 * This file is a part of LEMON, a generic C++ optimization library.
kpeter@3
     4
 *
kpeter@20
     5
 * Copyright (C) 2003-2009
kpeter@3
     6
 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
kpeter@3
     7
 * (Egervary Research Group on Combinatorial Optimization, EGRES).
kpeter@3
     8
 *
kpeter@3
     9
 * Permission to use, modify and distribute this software is granted
kpeter@3
    10
 * provided that this copyright notice appears in all copies. For
kpeter@3
    11
 * precise terms see the accompanying LICENSE file.
kpeter@3
    12
 *
kpeter@3
    13
 * This software is provided "AS IS" with no warranty of any kind,
kpeter@3
    14
 * express or implied, and with no claim as to its suitability for any
kpeter@3
    15
 * purpose.
kpeter@3
    16
 *
kpeter@3
    17
 */
kpeter@3
    18
kpeter@3
    19
/**
alpar@10
    20
[PAGE]intro[PAGE] Introduction
kpeter@3
    21
alpar@10
    22
[SEC]intro_lemon[SEC] What is LEMON
kpeter@3
    23
kpeter@24
    24
<b>LEMON</b> stands for <b>L</b>ibrary for <b>E</b>fficient <b>M</b>odeling and
kpeter@3
    25
<b>O</b>ptimization in <b>N</b>etworks. It is a C++ template
kpeter@6
    26
library aimed at combinatorial optimization tasks, especially those
kpeter@6
    27
working with graphs and networks.
kpeter@3
    28
kpeter@3
    29
<b>LEMON is an <a class="el" href="http://opensource.org/">open&nbsp;source</a>
kpeter@3
    30
project.
kpeter@3
    31
You are free to use it in your commercial or non-commercial applications
kpeter@6
    32
under very permissive \ref license "license terms".</b>
kpeter@6
    33
kpeter@6
    34
This library helps to write programs that solve optimization problems
kpeter@6
    35
that arise frequently when designing and testing certain networks,
kpeter@6
    36
for example in telecommunication, computer networks, logistics, scheduling,
kpeter@6
    37
and other areas.
kpeter@6
    38
A very natural way of modelling these networks is by means of a graph.
kpeter@6
    39
Generally if you want to write any program that works with graphs,
kpeter@6
    40
then you might find it useful and convenient to use LEMON.
kpeter@6
    41
kpeter@6
    42
For more information visit the LEMON web site:
kpeter@6
    43
<a href="http://lemon.cs.elte.hu/"><b>http://lemon.cs.elte.hu/</b></a>.
kpeter@3
    44
alpar@10
    45
[SEC]intro_tutorial[SEC] LEMON Tutorial
kpeter@3
    46
kpeter@3
    47
This tutorial introduces the reader to the basic concepts and features of
kpeter@6
    48
LEMON, and there are also some sections about advanced topics showing the
kpeter@6
    49
power of various tools implemented in the library.
kpeter@3
    50
kpeter@6
    51
After getting familiar with the basics of the library, you may start using
kpeter@6
    52
LEMON with the help of the detailed documentation (that can also be used
kpeter@6
    53
as a reference manual).
kpeter@3
    54
alpar@10
    55
alpar@10
    56
[TRAILER]
alpar@10
    57
kpeter@3
    58
*/