alpar@209: /* -*- mode: C++; indent-tabs-mode: nil; -*-
alpar@40:  *
alpar@209:  * This file is a part of LEMON, a generic C++ optimization library.
alpar@40:  *
alpar@440:  * Copyright (C) 2003-2009
alpar@40:  * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
alpar@40:  * (Egervary Research Group on Combinatorial Optimization, EGRES).
alpar@40:  *
alpar@40:  * Permission to use, modify and distribute this software is granted
alpar@40:  * provided that this copyright notice appears in all copies. For
alpar@40:  * precise terms see the accompanying LICENSE file.
alpar@40:  *
alpar@40:  * This software is provided "AS IS" with no warranty of any kind,
alpar@40:  * express or implied, and with no claim as to its suitability for any
alpar@40:  * purpose.
alpar@40:  *
alpar@40:  */
alpar@40: 
alpar@40: /**
alpar@40: \dir demo
kpeter@318: \brief A collection of demo applications.
alpar@40: 
kpeter@318: This directory contains several simple demo applications, mainly
alpar@40: for educational purposes.
alpar@40: */
alpar@40: 
alpar@40: /**
alpar@40: \dir doc
alpar@40: \brief Auxiliary (and the whole generated) documentation.
alpar@40: 
kpeter@318: This directory contains some auxiliary pages and the whole generated
kpeter@318: documentation.
alpar@40: */
alpar@40: 
alpar@40: /**
alpar@925: \dir contrib
alpar@925: \brief Directory for user contributed source codes.
alpar@925: 
alpar@925: You can place your own C++ code using LEMON into this directory, which
alpar@925: will compile to an executable along with LEMON when you build the
alpar@925: library. This is probably the easiest way of compiling short to medium
alpar@925: codes, for this does require neither a LEMON installed system-wide nor
alpar@925: adding several paths to the compiler.
alpar@925: 
alpar@925: Please have a look at <tt>contrib/CMakeLists.txt</tt> for
alpar@925: instruction on how to add your own files into the build process.  */
alpar@925: 
alpar@925: /**
alpar@40: \dir test
alpar@40: \brief Test programs.
alpar@40: 
alpar@40: This directory contains several test programs that check the consistency
alpar@40: of the code.
alpar@40: */
alpar@40: 
alpar@40: /**
alpar@40: \dir tools
kpeter@318: \brief Some useful executables.
alpar@40: 
alpar@40: This directory contains the sources of some useful complete executables.
alpar@40: */
alpar@40: 
alpar@40: /**
alpar@40: \dir lemon
kpeter@318: \brief Base include directory of LEMON.
alpar@40: 
kpeter@318: This is the base directory of LEMON includes, so each include file must be
alpar@40: prefixed with this, e.g.
alpar@40: \code
alpar@40: #include<lemon/list_graph.h>
alpar@40: #include<lemon/dijkstra.h>
alpar@40: \endcode
alpar@40: */
alpar@40: 
alpar@40: /**
alpar@40: \dir concepts
kpeter@318: \brief Concept descriptors and checking classes.
alpar@40: 
kpeter@318: This directory contains the concept descriptors and concept checking tools.
kpeter@318: For more information see the \ref concept "Concepts" module.
alpar@40: */
alpar@40: 
alpar@40: /**
alpar@40: \dir bits
kpeter@318: \brief Auxiliary tools for implementation.
alpar@40: 
alpar@440: This directory contains some auxiliary classes for implementing graphs,
kpeter@318: maps and some other classes.
kpeter@318: As a user you typically don't have to deal with these files.
alpar@40: */