doc/dirs.dox
author Peter Kovacs <kpeter@inf.elte.hu>
Tue, 15 Mar 2011 19:54:11 +0100
changeset 938 a07b6b27fe69
parent 440 88ed40ad0d4f
child 1092 dceba191c00d
permissions -rw-r--r--
Change the default scaling factor in CostScaling (#417)
alpar@209
     1
/* -*- mode: C++; indent-tabs-mode: nil; -*-
alpar@40
     2
 *
alpar@209
     3
 * This file is a part of LEMON, a generic C++ optimization library.
alpar@40
     4
 *
alpar@440
     5
 * Copyright (C) 2003-2009
alpar@40
     6
 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
alpar@40
     7
 * (Egervary Research Group on Combinatorial Optimization, EGRES).
alpar@40
     8
 *
alpar@40
     9
 * Permission to use, modify and distribute this software is granted
alpar@40
    10
 * provided that this copyright notice appears in all copies. For
alpar@40
    11
 * precise terms see the accompanying LICENSE file.
alpar@40
    12
 *
alpar@40
    13
 * This software is provided "AS IS" with no warranty of any kind,
alpar@40
    14
 * express or implied, and with no claim as to its suitability for any
alpar@40
    15
 * purpose.
alpar@40
    16
 *
alpar@40
    17
 */
alpar@40
    18
alpar@40
    19
/**
alpar@40
    20
\dir demo
kpeter@318
    21
\brief A collection of demo applications.
alpar@40
    22
kpeter@318
    23
This directory contains several simple demo applications, mainly
alpar@40
    24
for educational purposes.
alpar@40
    25
*/
alpar@40
    26
alpar@40
    27
/**
alpar@40
    28
\dir doc
alpar@40
    29
\brief Auxiliary (and the whole generated) documentation.
alpar@40
    30
kpeter@318
    31
This directory contains some auxiliary pages and the whole generated
kpeter@318
    32
documentation.
alpar@40
    33
*/
alpar@40
    34
alpar@40
    35
/**
alpar@925
    36
\dir contrib
alpar@925
    37
\brief Directory for user contributed source codes.
alpar@925
    38
alpar@925
    39
You can place your own C++ code using LEMON into this directory, which
alpar@925
    40
will compile to an executable along with LEMON when you build the
alpar@925
    41
library. This is probably the easiest way of compiling short to medium
alpar@925
    42
codes, for this does require neither a LEMON installed system-wide nor
alpar@925
    43
adding several paths to the compiler.
alpar@925
    44
alpar@925
    45
Please have a look at <tt>contrib/CMakeLists.txt</tt> for
alpar@925
    46
instruction on how to add your own files into the build process.  */
alpar@925
    47
alpar@925
    48
/**
alpar@40
    49
\dir test
alpar@40
    50
\brief Test programs.
alpar@40
    51
alpar@40
    52
This directory contains several test programs that check the consistency
alpar@40
    53
of the code.
alpar@40
    54
*/
alpar@40
    55
alpar@40
    56
/**
alpar@40
    57
\dir tools
kpeter@318
    58
\brief Some useful executables.
alpar@40
    59
alpar@40
    60
This directory contains the sources of some useful complete executables.
alpar@40
    61
*/
alpar@40
    62
alpar@40
    63
/**
alpar@40
    64
\dir lemon
kpeter@318
    65
\brief Base include directory of LEMON.
alpar@40
    66
kpeter@318
    67
This is the base directory of LEMON includes, so each include file must be
alpar@40
    68
prefixed with this, e.g.
alpar@40
    69
\code
alpar@40
    70
#include<lemon/list_graph.h>
alpar@40
    71
#include<lemon/dijkstra.h>
alpar@40
    72
\endcode
alpar@40
    73
*/
alpar@40
    74
alpar@40
    75
/**
alpar@40
    76
\dir concepts
kpeter@318
    77
\brief Concept descriptors and checking classes.
alpar@40
    78
kpeter@318
    79
This directory contains the concept descriptors and concept checking tools.
kpeter@318
    80
For more information see the \ref concept "Concepts" module.
alpar@40
    81
*/
alpar@40
    82
alpar@40
    83
/**
alpar@40
    84
\dir bits
kpeter@318
    85
\brief Auxiliary tools for implementation.
alpar@40
    86
alpar@440
    87
This directory contains some auxiliary classes for implementing graphs,
kpeter@318
    88
maps and some other classes.
kpeter@318
    89
As a user you typically don't have to deal with these files.
alpar@40
    90
*/