Changeset 209:765619b7cbb2 in lemon-main for doc

Timestamp:

07/13/08 20:51:02 (16 years ago)

Author:

Alpar Juttner <alpar@…>

Branch:

default

Phase:

public

Message:

Apply unify-sources.sh to the source tree

Location:

doc

Files:

• coding_style.dox (modified) (5 diffs)
• dirs.dox (modified) (2 diffs)
• groups.dox (modified) (22 diffs)
• lgf.dox (modified) (3 diffs)
• license.dox (modified) (1 diff)
• mainpage.dox (modified) (2 diffs)
• namespaces.dox (modified) (1 diff)
• template.h (modified) (1 diff)

doc/coding_style.dox

@@ -1 @@
-/* -*- C++ -*-
+/* -*- mode: C++; indent-tabs-mode: nil; -*-
  *
- * This file is a part of LEMON, a generic C++ optimization library
+ * This file is a part of LEMON, a generic C++ optimization library.
  *
  * Copyright (C) 2003-2008
@@ -19 +19 @@
 /*!
 
-\page coding_style LEMON Coding Style 
+\page coding_style LEMON Coding Style
 
 \section naming_conv Naming Conventions
@@ -69 +69 @@
 
 \code
-AllWordsCapitalizedWithoutUnderscores 
+AllWordsCapitalizedWithoutUnderscores
 \endcode
 
@@ -77 +77 @@
 
 \code
-firstWordLowerCaseRestCapitalizedWithoutUnderscores 
+firstWordLowerCaseRestCapitalizedWithoutUnderscores
 \endcode
 
@@ -85 +85 @@
 
 \code
-ALL_UPPER_CASE_WITH_UNDERSCORES 
+ALL_UPPER_CASE_WITH_UNDERSCORES
 \endcode
 
-\subsection cs-loc-var Class and instance member variables, auto variables 
+\subsection cs-loc-var Class and instance member variables, auto variables
 
 The names of class and instance member variables and auto variables (=variables used locally in methods) should look like the following.
 
 \code
-all_lower_case_with_underscores 
+all_lower_case_with_underscores
 \endcode
 

doc/dirs.dox

@@ -1 @@
-/* -*- C++ -*-
+/* -*- mode: C++; indent-tabs-mode: nil; -*-
  *
- * This file is a part of LEMON, a generic C++ optimization library
+ * This file is a part of LEMON, a generic C++ optimization library.
  *
  * Copyright (C) 2003-2008
@@ -75 +75 @@
 
 This directory contains some helper classes to implement graphs, maps and
-some other classes. As a user you typically don't have to deal with these 
+some other classes. As a user you typically don't have to deal with these
 files.
 */

doc/groups.dox

@@ -1 @@
-/* -*- C++ -*-
+/* -*- mode: C++; indent-tabs-mode: nil; -*-
  *
- * This file is a part of LEMON, a generic C++ optimization library
+ * This file is a part of LEMON, a generic C++ optimization library.
  *
  * Copyright (C) 2003-2008
@@ -27 +27 @@
 \brief Graph structures implemented in LEMON.
 
-The implementation of combinatorial algorithms heavily relies on 
-efficient graph implementations. LEMON offers data structures which are 
-planned to be easily used in an experimental phase of implementation studies, 
-and thereafter the program code can be made efficient by small modifications. 
+The implementation of combinatorial algorithms heavily relies on
+efficient graph implementations. LEMON offers data structures which are
+planned to be easily used in an experimental phase of implementation studies,
+and thereafter the program code can be made efficient by small modifications.
 
 The most efficient implementation of diverse applications require the
@@ -41 +41 @@
 some graph features like arc/edge or node deletion.
 
-Alteration of standard containers need a very limited number of 
-operations, these together satisfy the everyday requirements. 
-In the case of graph structures, different operations are needed which do 
-not alter the physical graph, but gives another view. If some nodes or 
+Alteration of standard containers need a very limited number of
+operations, these together satisfy the everyday requirements.
+In the case of graph structures, different operations are needed which do
+not alter the physical graph, but gives another view. If some nodes or
 arcs have to be hidden or the reverse oriented graph have to be used, then
-this is the case. It also may happen that in a flow implementation 
-the residual graph can be accessed by another algorithm, or a node-set 
-is to be shrunk for another algorithm. 
-LEMON also provides a variety of graphs for these requirements called 
-\ref graph_adaptors "graph adaptors". Adaptors cannot be used alone but only 
-in conjunction with other graph representations. 
+this is the case. It also may happen that in a flow implementation
+the residual graph can be accessed by another algorithm, or a node-set
+is to be shrunk for another algorithm.
+LEMON also provides a variety of graphs for these requirements called
+\ref graph_adaptors "graph adaptors". Adaptors cannot be used alone but only
+in conjunction with other graph representations.
 
 You are free to use the graph structure that fit your requirements
 the best, most graph algorithms and auxiliary data structures can be used
-with any graph structures. 
+with any graph structures.
 */
 
@@ -64 +64 @@
 
 This group describes some graph types between real graphs and graph adaptors.
-These classes wrap graphs to give new functionality as the adaptors do it. 
+These classes wrap graphs to give new functionality as the adaptors do it.
 On the other hand they are not light-weight structures as the adaptors.
 */
 
 /**
-@defgroup maps Maps 
+@defgroup maps Maps
 @ingroup datas
 \brief Map structures implemented in LEMON.
@@ -80 +80 @@
 
 /**
-@defgroup graph_maps Graph Maps 
+@defgroup graph_maps Graph Maps
 @ingroup maps
 \brief Special graph-related maps.
@@ -116 +116 @@
     }
   }
-  
+
   Digraph::NodeMap<int> degree_map(graph);
-  
+
   digraphToEps(graph, "graph.eps")
     .coords(coords).scaleToA4().undirected()
     .nodeColors(composeMap(functorToMap(nodeColor), degree_map))
     .run();
-\endcode 
+\endcode
 The \c functorToMap() function makes an \c int to \c Color map from the
 \e nodeColor() function. The \c composeMap() compose the \e degree_map
@@ -141 +141 @@
   typedef DivMap<DoubleArcMap, DoubleArcMap> TimeMap;
   TimeMap time(length, speed);
-  
+
   Dijkstra<Digraph, TimeMap> dijkstra(graph, time);
   dijkstra.run(source, target);
@@ -153 +153 @@
 
 /**
-@defgroup matrices Matrices 
+@defgroup matrices Matrices
 @ingroup datas
 \brief Two dimensional data storages implemented in LEMON.
@@ -201 +201 @@
 \brief Common graph search algorithms.
 
-This group describes the common graph search algorithms like 
+This group describes the common graph search algorithms like
 Breadth-first search (Bfs) and Depth-first search (Dfs).
 */
@@ -213 +213 @@
 */
 
-/** 
-@defgroup max_flow Maximum Flow algorithms 
-@ingroup algs 
+/**
+@defgroup max_flow Maximum Flow algorithms
+@ingroup algs
 \brief Algorithms for finding maximum flows.
 
@@ -232 +232 @@
 
 LEMON contains several algorithms for solving maximum flow problems:
-- \ref lemon::EdmondsKarp "Edmonds-Karp" 
+- \ref lemon::EdmondsKarp "Edmonds-Karp"
 - \ref lemon::Preflow "Goldberg's Preflow algorithm"
 - \ref lemon::DinitzSleatorTarjan "Dinitz's blocking flow algorithm with dynamic trees"
@@ -251 +251 @@
 
 This group describes the algorithms for finding minimum cost flows and
-circulations.  
-*/
-
-/**
-@defgroup min_cut Minimum Cut algorithms 
-@ingroup algs 
+circulations.
+*/
+
+/**
+@defgroup min_cut Minimum Cut algorithms
+@ingroup algs
 
 \brief Algorithms for finding minimum cut in graphs.
@@ -273 +273 @@
 
 - \ref lemon::HaoOrlin "Hao-Orlin algorithm" to calculate minimum cut
-  in directed graphs  
+  in directed graphs
 - \ref lemon::NagamochiIbaraki "Nagamochi-Ibaraki algorithm" to
   calculate minimum cut in undirected graphs
@@ -308 +308 @@
 
 /**
-@defgroup matching Matching algorithms 
+@defgroup matching Matching algorithms
 @ingroup algs
 \brief Algorithms for finding matchings in graphs and bipartite graphs.
@@ -315 +315 @@
 matchings in graphs and bipartite graphs. The general matching problem is
 finding a subset of the arcs which does not shares common endpoints.
- 
+
 There are several different algorithms for calculate matchings in
 graphs.  The matching problems in bipartite graphs are generally
@@ -324 +324 @@
 
 Lemon contains the next algorithms:
-- \ref lemon::MaxBipartiteMatching "MaxBipartiteMatching" Hopcroft-Karp 
-  augmenting path algorithm for calculate maximum cardinality matching in 
+- \ref lemon::MaxBipartiteMatching "MaxBipartiteMatching" Hopcroft-Karp
+  augmenting path algorithm for calculate maximum cardinality matching in
   bipartite graphs
-- \ref lemon::PrBipartiteMatching "PrBipartiteMatching" Push-Relabel 
-  algorithm for calculate maximum cardinality matching in bipartite graphs 
-- \ref lemon::MaxWeightedBipartiteMatching "MaxWeightedBipartiteMatching" 
-  Successive shortest path algorithm for calculate maximum weighted matching 
+- \ref lemon::PrBipartiteMatching "PrBipartiteMatching" Push-Relabel
+  algorithm for calculate maximum cardinality matching in bipartite graphs
+- \ref lemon::MaxWeightedBipartiteMatching "MaxWeightedBipartiteMatching"
+  Successive shortest path algorithm for calculate maximum weighted matching
   and maximum weighted bipartite matching in bipartite graph
-- \ref lemon::MinCostMaxBipartiteMatching "MinCostMaxBipartiteMatching" 
-  Successive shortest path algorithm for calculate minimum cost maximum 
+- \ref lemon::MinCostMaxBipartiteMatching "MinCostMaxBipartiteMatching"
+  Successive shortest path algorithm for calculate minimum cost maximum
   matching in bipartite graph
 - \ref lemon::MaxMatching "MaxMatching" Edmond's blossom shrinking algorithm
@@ -397 +397 @@
 */
 
-/** 
-@defgroup lp_utils Tools for Lp and Mip solvers 
+/**
+@defgroup lp_utils Tools for Lp and Mip solvers
 @ingroup lp_group
 \brief Helper tools to the Lp and Mip solvers.
@@ -415 +415 @@
 
 /**
-@defgroup utils Tools and Utilities 
+@defgroup utils Tools and Utilities
 \brief Tools and utilities for programming in LEMON
 
@@ -468 +468 @@
 \brief Graph Input-Output methods
 
-This group describes the tools for importing and exporting graphs 
+This group describes the tools for importing and exporting graphs
 and graph related data. Now it supports the LEMON format, the
 \c DIMACS format and the encapsulated postscript (EPS) format.
@@ -487 +487 @@
 
 This group describes general \c EPS drawing methods and special
-graph exporting tools. 
+graph exporting tools.
 */
 
@@ -499 +499 @@
 
 The purpose of the classes in this group is fourfold.
- 
+
 - These classes contain the documentations of the concepts. In order
   to avoid document multiplications, an implementation of a concept
@@ -552 +552 @@
 @defgroup tools Standalone utility applications
 
-Some utility applications are listed here. 
+Some utility applications are listed here.
 
 The standard compilation procedure (<tt>./configure;make</tt>) will compile
-them, as well. 
-*/
-
+them, as well.
+*/
+

doc/lgf.dox

@@ -1 @@
-/* -*- C++ -*-
+/* -*- mode: C++; indent-tabs-mode: nil; -*-
  *
- * This file is a part of LEMON, a generic C++ optimization library
+ * This file is a part of LEMON, a generic C++ optimization library.
  *
  * Copyright (C) 2003-2008
@@ -44 +44 @@
 while a quoted token is a
 character sequence surrounded by double quotes, and it can also
-contain whitespaces and escape sequences. 
+contain whitespaces and escape sequences.
 
 The \c \@nodes section describes a set of nodes and associated
@@ -73 +73 @@
 \code
  @arcs
-              capacity
+               capacity
  1   2   16
  1   3   12

doc/license.dox

@@ -1 @@
-/* -*- C++ -*-
+/* -*- mode: C++; indent-tabs-mode: nil; -*-
  *
- * This file is a part of LEMON, a generic C++ optimization library
+ * This file is a part of LEMON, a generic C++ optimization library.
  *
  * Copyright (C) 2003-2008

doc/mainpage.dox

@@ -1 @@
-/* -*- C++ -*-
+/* -*- mode: C++; indent-tabs-mode: nil; -*-
  *
- * This file is a part of LEMON, a generic C++ optimization library
+ * This file is a part of LEMON, a generic C++ optimization library.
  *
  * Copyright (C) 2003-2008
@@ -42 +42 @@
 \subsection howtoread How to read the documentation
 
-If you want to get a quick start and see the most important features then 
+If you want to get a quick start and see the most important features then
 take a look at our \ref quicktour
 "Quick Tour to LEMON" which will guide you along.
 
-If you already feel like using our library, see the page that tells you 
+If you already feel like using our library, see the page that tells you
 \ref getstart "How to start using LEMON".
 
-If you 
-want to see how LEMON works, see 
+If you
+want to see how LEMON works, see
 some \ref demoprograms "demo programs"!
 

doc/namespaces.dox

@@ -1 @@
-/* -*- C++ -*-
+/* -*- mode: C++; indent-tabs-mode: nil; -*-
  *
- * This file is a part of LEMON, a generic C++ optimization library
+ * This file is a part of LEMON, a generic C++ optimization library.
  *
  * Copyright (C) 2003-2008

doc/template.h

@@ -1 @@
-/* -*- C++ -*-
+/* -*- mode: C++; indent-tabs-mode: nil; -*-
  *
- * This file is a part of LEMON, a generic C++ optimization library
+ * This file is a part of LEMON, a generic C++ optimization library.
  *
  * Copyright (C) 2003-2008