COIN-OR::LEMON - Graph Library

source: lemon-1.2/doc/mainpage.dox @ 559:c5fd2d996909

Last change on this file since 559:c5fd2d996909 was 559:c5fd2d996909, checked in by Peter Kovacs <kpeter@…>, 11 years ago

Various doc improvements (#248)

  • Rename all the ugly template parameters (too long and/or starting with an underscore).
  • Rename function parameters starting with an underscore.
  • Extend the doc for many classes.
  • Use LaTeX-style O(...) expressions only for the complicated ones.
  • A lot of small unification changes.
  • Small fixes.
  • Some other improvements.
File size: 1.7 KB
Line 
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-2009
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\mainpage LEMON Documentation
21
22\section intro Introduction
23
24\subsection whatis What is LEMON
25
26LEMON stands for
27<b>L</b>ibrary of <b>E</b>fficient <b>M</b>odels
28and <b>O</b>ptimization in <b>N</b>etworks.
29It is a C++ template
30library aimed at combinatorial optimization tasks which
31often involve in working
32with graphs.
33
34<b>
35LEMON is an <a class="el" href="http://opensource.org/">open&nbsp;source</a>
36project.
37You are free to use it in your commercial or
38non-commercial applications under very permissive
39\ref license "license terms".
40</b>
41
42\subsection howtoread How to read the documentation
43
44If you want to get a quick start and see the most important features then
45take a look at our \ref quicktour
46"Quick Tour to LEMON" which will guide you along.
47
48If you already feel like using our library, see the
49<a class="el" href="http://lemon.cs.elte.hu/pub/tutorial/">LEMON Tutorial</a>.
50
51If you know what you are looking for then try to find it under the
52<a class="el" href="modules.html">Modules</a> section.
53
54If you are a user of the old (0.x) series of LEMON, please check out the
55\ref migration "Migration Guide" for the backward incompatibilities.
56*/
Note: See TracBrowser for help on using the repository browser.