Changeset 1401:9588dcef6793 in lemon-0.x for doc

Timestamp:

05/04/05 15:07:10 (19 years ago)

Author:

Alpar Juttner

Branch:

default

Phase:

public

Convert:

svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@1863

Message:

wrapper -> adaptor

Location:

doc

Files:

• Makefile.am (modified) (1 diff)
• graph-adaptors.dox (moved) (moved from doc/gwrappers.dox) (6 diffs)
• groups.dox (modified) (1 diff)

doc/Makefile.am

@@ -9 +9 @@
         demoprograms.dox graphs.dox undir_graphs.dox named-param.dox \
         maps.dox coding_style.dox groups.dox namespaces.dox license.dox \
-        developers_interface.dox graph_io.dox dirs.dox gwrappers.dox
+        developers_interface.dox graph_io.dox dirs.dox graph-adaptors.dox
 
 

doc/graph-adaptors.dox

@@ -1 +1 @@
 /**
-   @defgroup gwrappers Wrapper Classes for Graphs
-   \brief This group contains several wrapper classes for graphs
+   @defgroup graph_adaptors Adaptor Classes for Graphs
+   \brief This group contains several adaptor classes for graphs
    @ingroup graphs
    
    The main parts of LEMON are the different graph structures, 
    generic graph algorithms, graph concepts which couple these, and 
-   graph wrappers. While the previous notions are more or less clear, the 
+   graph adaptors. While the previous notions are more or less clear, the 
    latter one needs further explanation. 
-   Graph wrappers are graph classes which serve for considering graph 
+   Graph adaptors are graph classes which serve for considering graph 
    structures in different ways. 
 
@@ -19 +19 @@
    It may be expensive (in time or in memory usage) to copy 
    \c g with the reversed orientation. 
-   In this case, a wrapper class is used, which 
+   In this case, an adaptor class is used, which 
    (according to LEMON graph concepts) works as a graph. 
-   The wrapper uses 
+   The adaptor uses 
    the original graph structure and graph operations when methods of the 
    reversed oriented graph are called. 
-   This means that the wrapper have minor memory usage, 
+   This means that the adaptor have minor memory usage, 
    and do not perform sophisticated algorithmic actions. 
    The purpose of it is to give a tool for the cases when 
@@ -30 +30 @@
    If this alteration is obtained by a usual construction 
    like filtering the edge-set or considering a new orientation, then 
-   a wrapper is worthwhile to use. 
+   an adaptor is worthwhile to use. 
    To come back to the reversed oriented graph, in this situation 
-   \code template<typename Graph> class RevGraphWrapper; \endcode 
+   \code template<typename Graph> class RevGraphAdaptor; \endcode 
    template class can be used. 
    The code looks as follows 
    \code
    ListGraph g;
-   RevGraphWrapper<ListGraph> rgw(g);
+   RevGraphAdaptor<ListGraph> rgw(g);
    int result=algorithm(rgw);
    \endcode
@@ -43 +43 @@
    is untouched. 
    This techniques gives rise to an elegant code, and 
-   based on stable graph wrappers, complex algorithms can be 
+   based on stable graph adaptors, complex algorithms can be 
    implemented easily. 
 
    In flow, circulation and bipartite matching problems, the residual 
-   graph is of particular importance. Combining a wrapper implementing 
+   graph is of particular importance. Combining an adaptor implementing 
    this, shortest path algorithms and minimum mean cycle algorithms, 
    a range of weighted and cardinality optimization algorithms can be 
@@ -53 +53 @@
    For other examples, 
    the interested user is referred to the detailed documentation of 
-   particular wrappers. 
+   particular adaptors. 
 
-   The behavior of graph wrappers can be very different. Some of them keep 
+   The behavior of graph adaptors can be very different. Some of them keep 
    capabilities of the original graph while in other cases this would be 
    meaningless. This means that the concepts that they are models of depend 
-   on the graph wrapper, and the wrapped graph(s). 
+   on the graph adaptor, and the wrapped graph(s). 
    If an edge of \c rgw is deleted, this is carried out by 
-   deleting the corresponding edge of \c g, thus the wrapper modifies the 
+   deleting the corresponding edge of \c g, thus the adaptor modifies the 
    original graph. 
    But for a residual 
    graph, this operation has no sense. 
    Let us stand one more example here to simplify your work. 
-   RevGraphWrapper has constructor 
+   RevGraphAdaptor has constructor 
    \code 
-   RevGraphWrapper(Graph& _g);
+   RevGraphAdaptor(Graph& _g);
    \endcode
    This means that in a situation, 
@@ -74 +74 @@
    \code
    int algorithm1(const ListGraph& g) {
-   RevGraphWrapper<const ListGraph> rgw(g);
+   RevGraphAdaptor<const ListGraph> rgw(g);
    return algorithm2(rgw);
    }

doc/groups.dox

@@ -32 +32 @@
 is to be shrunk for an other algorithm. 
 LEMON also provides a variety of graphs for these requirements called 
-\ref gwrappers "graph wrappers". Wrappers cannot be used alone but only 
+\ref graph_adaptors "graph adaptors". Adaptors cannot be used alone but only 
 in conjunction with other graph representation.