doc/dirs.dox
author Peter Kovacs <kpeter@inf.elte.hu>
Fri, 17 Apr 2009 18:04:36 +0200
changeset 656 e6927fe719e6
parent 318 1e2d6ca80793
child 1031 06491fd08efd
permissions -rw-r--r--
Support >= and <= constraints in NetworkSimplex (#219, #234)

By default the same inequality constraints are supported as by
Circulation (the GEQ form), but the LEQ form can also be selected
using the problemType() function.

The documentation of the min. cost flow module is reworked and
extended with important notes and explanations about the different
variants of the problem and about the dual solution and optimality
conditions.
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@463
     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@40
    36
\dir test
alpar@40
    37
\brief Test programs.
alpar@40
    38
alpar@40
    39
This directory contains several test programs that check the consistency
alpar@40
    40
of the code.
alpar@40
    41
*/
alpar@40
    42
alpar@40
    43
/**
alpar@40
    44
\dir tools
kpeter@318
    45
\brief Some useful executables.
alpar@40
    46
alpar@40
    47
This directory contains the sources of some useful complete executables.
alpar@40
    48
*/
alpar@40
    49
alpar@40
    50
/**
alpar@40
    51
\dir lemon
kpeter@318
    52
\brief Base include directory of LEMON.
alpar@40
    53
kpeter@318
    54
This is the base directory of LEMON includes, so each include file must be
alpar@40
    55
prefixed with this, e.g.
alpar@40
    56
\code
alpar@40
    57
#include<lemon/list_graph.h>
alpar@40
    58
#include<lemon/dijkstra.h>
alpar@40
    59
\endcode
alpar@40
    60
*/
alpar@40
    61
alpar@40
    62
/**
alpar@40
    63
\dir concepts
kpeter@318
    64
\brief Concept descriptors and checking classes.
alpar@40
    65
kpeter@318
    66
This directory contains the concept descriptors and concept checking tools.
kpeter@318
    67
For more information see the \ref concept "Concepts" module.
alpar@40
    68
*/
alpar@40
    69
alpar@40
    70
/**
alpar@40
    71
\dir bits
kpeter@318
    72
\brief Auxiliary tools for implementation.
alpar@40
    73
alpar@463
    74
This directory contains some auxiliary classes for implementing graphs,
kpeter@318
    75
maps and some other classes.
kpeter@318
    76
As a user you typically don't have to deal with these files.
alpar@40
    77
*/