Changeset 2288:ef8af928c54e in lemon-0.x for doc/basic_concepts.dox

Timestamp:

10/31/06 16:57:53 (17 years ago)

Author:

athos

Branch:

default

Phase:

public

Convert:

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

Message:

Corrected some typos and grammatical errors.

File:

• doc/basic_concepts.dox (modified) (8 diffs)

doc/basic_concepts.dox

@@ -3 +3 @@
 
 \section basic_graph The graph classes
-The most important classes in LEMON are the graph classes. A instance of a graph
+The most important classes in LEMON are the graph classes. An instance of a graph
 class is the representation of the mathematical graph. It holds the topology and
 every structural information of the graph. The structural manipulations are also
@@ -9 +9 @@
 different classes for different purposes. They can differ in many ways, but all
 have to satisfy one or more \ref concept "graph concepts" which are standardized
-interfaces to work whit the rest of the library. The most basic concept is the
+interfaces to work with the rest of the library. The most basic concept is the
 \ref Graph.<br>
 A good example is the \ref ListGraph which we already know from Hello World and
@@ -27 +27 @@
 If the graph fits the ExtendableGraphComponent concept, then you can add new nodes
 to the graph with the addNode() member function. It returns the newly added node
-(as value). So if you need the new node to do something useful with it, for example
-create a edge, assign a value to it through \ref map1 maps.
+(as value). So if you need the new node to do something useful with, for example
+create an edge, assign a value to it through \ref map1 maps.
 \code lemon::ListGraph::Node  new_node = graph.addNode(); \endcode
 
-If the graph fits the ErasableGraphComponent concept you also can remove nodes
+If the graph fits into the ErasableGraphComponent concept you can also remove nodes
 from the graph with the erase() member function.
 \code graph.erase( new_node ); \endcode
@@ -44 +44 @@
 \subsection basic_edge Edges
 An Edge is what you think it is. It goes from one node to another node (they can
-be identical). If the graph class is directed, the Edge is directed too. Otherwise
+be identical if the edge is a loop). If the graph class is directed, the Edge is directed too. Otherwise
 the edge is considered undirected and called UEdge.
 \code lemon::ListUGraph::UEdge \endcode
@@ -51 +51 @@
 source node and the target node. The graph class must be extendable.
 \code lemon::ListGraph::Edge  new_edge = graph.addEdge( src_node, trg_node ); \endcode
-You can handle edge similar as nodes. The erase() member function has an edge taking
+You can handle edges similar as nodes. The erase() member function has an edge taking
 overload too.
 
@@ -65 +65 @@
 \section basic_iterators Iterators
 Graphs are some kind of containers. And as you expect they have iterator types.
-One fore nodes and a couple for edges - and special classes can have additional
+One for nodes and a couple for edges - and special classes can have additional
 iterators too. An example:
 \code lemon::ListGraph::NodeIt \endcode
-That is a node iterator. Every iterator type starts whit an name what refers to
-the iterated object, and ends whit 'It'.
+This is a node iterator. Every iterator type starts with a name that refers to
+the iterated object, and ends with 'It'.
 
-LEMON style iterators differs from \c stl or \c boost iterators in a very tasty
+LEMON style iterators differ from \c stl or \c boost iterators in a very tasty
 way. A graph has no begin or end - or at least a generic graph class has none.
 If by some topology you could pick a good begin node, it would be misleading and
@@ -81 +81 @@
 \code
 for( ListGraph::NodeIt n(graph); n != INVALID; ++n )
-    do_useful_things_whit_node(n);
+    do_useful_things_with_node(n);
 \endcode
 Note that the function \c do_useful_things_with_node() expects a Node type argument
@@ -90 +90 @@
 
 <b>Very important!</b> The iteration has no defined order. There is absolutely no
-guaranty that the next time the iteration will give us the nodes in the same order.
+warranty that the next time the iteration will give us the nodes in the same order.
 Don't use this order to identify nodes! Use the \c id() member function of the
 graph class described above. (There is a powerful technique using maps right in