| [209] | 1 | /* -*- mode: C++; indent-tabs-mode: nil; -*- |
|---|
| [40] | 2 | * |
|---|
| [209] | 3 | * This file is a part of LEMON, a generic C++ optimization library. |
|---|
| [40] | 4 | * |
|---|
| [440] | 5 | * Copyright (C) 2003-2009 |
|---|
| [40] | 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 | \dir demo |
|---|
| [318] | 21 | \brief A collection of demo applications. |
|---|
| [40] | 22 | |
|---|
| [318] | 23 | This directory contains several simple demo applications, mainly |
|---|
| [40] | 24 | for educational purposes. |
|---|
| 25 | */ |
|---|
| 26 | |
|---|
| 27 | /** |
|---|
| 28 | \dir doc |
|---|
| 29 | \brief Auxiliary (and the whole generated) documentation. |
|---|
| 30 | |
|---|
| [318] | 31 | This directory contains some auxiliary pages and the whole generated |
|---|
| 32 | documentation. |
|---|
| [40] | 33 | */ |
|---|
| 34 | |
|---|
| 35 | /** |
|---|
| [925] | 36 | \dir contrib |
|---|
| 37 | \brief Directory for user contributed source codes. |
|---|
| 38 | |
|---|
| 39 | You can place your own C++ code using LEMON into this directory, which |
|---|
| 40 | will compile to an executable along with LEMON when you build the |
|---|
| 41 | library. This is probably the easiest way of compiling short to medium |
|---|
| 42 | codes, for this does require neither a LEMON installed system-wide nor |
|---|
| 43 | adding several paths to the compiler. |
|---|
| 44 | |
|---|
| 45 | Please have a look at <tt>contrib/CMakeLists.txt</tt> for |
|---|
| 46 | instruction on how to add your own files into the build process. */ |
|---|
| 47 | |
|---|
| 48 | /** |
|---|
| [40] | 49 | \dir test |
|---|
| 50 | \brief Test programs. |
|---|
| 51 | |
|---|
| 52 | This directory contains several test programs that check the consistency |
|---|
| 53 | of the code. |
|---|
| 54 | */ |
|---|
| 55 | |
|---|
| 56 | /** |
|---|
| 57 | \dir tools |
|---|
| [318] | 58 | \brief Some useful executables. |
|---|
| [40] | 59 | |
|---|
| 60 | This directory contains the sources of some useful complete executables. |
|---|
| 61 | */ |
|---|
| 62 | |
|---|
| 63 | /** |
|---|
| 64 | \dir lemon |
|---|
| [318] | 65 | \brief Base include directory of LEMON. |
|---|
| [40] | 66 | |
|---|
| [318] | 67 | This is the base directory of LEMON includes, so each include file must be |
|---|
| [40] | 68 | prefixed with this, e.g. |
|---|
| 69 | \code |
|---|
| 70 | #include<lemon/list_graph.h> |
|---|
| 71 | #include<lemon/dijkstra.h> |
|---|
| 72 | \endcode |
|---|
| 73 | */ |
|---|
| 74 | |
|---|
| 75 | /** |
|---|
| 76 | \dir concepts |
|---|
| [318] | 77 | \brief Concept descriptors and checking classes. |
|---|
| [40] | 78 | |
|---|
| [318] | 79 | This directory contains the concept descriptors and concept checking tools. |
|---|
| 80 | For more information see the \ref concept "Concepts" module. |
|---|
| [40] | 81 | */ |
|---|
| 82 | |
|---|
| 83 | /** |
|---|
| 84 | \dir bits |
|---|
| [318] | 85 | \brief Auxiliary tools for implementation. |
|---|
| [40] | 86 | |
|---|
| [440] | 87 | This directory contains some auxiliary classes for implementing graphs, |
|---|
| [318] | 88 | maps and some other classes. |
|---|
| 89 | As a user you typically don't have to deal with these files. |
|---|
| [40] | 90 | */ |
|---|
