Mercuriallemon-1.2 / file revision
summary | shortlog | changelog | graph | tags | bookmarks | branches | files | changeset | file | latest | revisions | annotate | diff | comparison | raw | help
doc/dirs.dox
author Peter Kovacs <kpeter@inf.elte.hu>
Sat, 15 Mar 2008 21:07:24 +0100
changeset 80 15968e25ca08
child 209 765619b7cbb2
permissions -rw-r--r--
Overall clean-up in maps.h

- Rename some map types:
* IntegerMap -> RangeMap
* StdMap -> SparseMap
* FunctorMap -> FunctorToMap
* MapFunctor -> MapToFunctor
* ForkWriteMap -> ForkMap
* SimpleMap -> WrapMap
* SimpleWriteMap -> WrapWriteMap
- Remove the read-only ForkMap version.
- Rename map-creator functions for the read-write arithmetic and
logical maps.
- Small fixes and improvements in the code.
- Fix the typedefs of RangeMap to work correctly with bool type, too.
- Rename template parameters, function parameters, and private members
in many classes to be uniform and to avoid parameter names starting
with underscore.
- Use Key and Value types instead of K and V template parameters in
public functions.
- Extend the documentation with examples (e.g. for basic arithmetic and
logical maps).
- Many doc improvements.
- Reorder the classes.
- StoreBoolMap, BackInserterBoolMap, FrontInserterBoolMap,
InserterBoolMap, FillBoolMap, SettingOrderBoolMap are almost unchanged,
since they will be removed.
- Also improve maps_test.cc to correctly check every map class, every
constructor, and every creator function. 
     1 /* -*- C++ -*-

     2  *

     3  * This file is a part of LEMON, a generic C++ optimization library

     4  *

     5  * Copyright (C) 2003-2008

     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

    21 \brief A collection of demo application.

    22 

    23 This directory contains several simple demo application, mainly

    24 for educational purposes.

    25 */

    26 

    27 /**

    28 \dir doc

    29 \brief Auxiliary (and the whole generated) documentation.

    30 

    31 Auxiliary (and the whole generated) documentation.

    32 */

    33 

    34 /**

    35 \dir test

    36 \brief Test programs.

    37 

    38 This directory contains several test programs that check the consistency

    39 of the code.

    40 */

    41 

    42 /**

    43 \dir tools

    44 \brief Some useful executables

    45 

    46 This directory contains the sources of some useful complete executables.

    47 

    48 */

    49 

    50 

    51 

    52 /**

    53 \dir lemon

    54 \brief Base include directory of LEMON

    55 

    56 This is the base directory of lemon includes, so each include file must be

    57 prefixed with this, e.g.

    58 \code

    59 #include<lemon/list_graph.h>

    60 #include<lemon/dijkstra.h>

    61 \endcode

    62 */

    63 

    64 /**

    65 \dir concepts

    66 \brief Concept descriptors and checking classes

    67 

    68 This directory contains the concept descriptors and concept checkers. As a user

    69 you typically don't have to deal with these files.

    70 */

    71 

    72 /**

    73 \dir bits

    74 \brief Implementation helper files

    75 

    76 This directory contains some helper classes to implement graphs, maps and

    77 some other classes. As a user you typically don't have to deal with these 

    78 files.

    79 */
lemon-1.2