[GRASS-SVN] r51448 - grass/branches/releasebranch_6_4/vector/v.net.allpairs

[svn_grass at osgeo.org]

Author: mmetz
Date: 2012-04-14 23:53:31 -0700 (Sat, 14 Apr 2012)
New Revision: 51448

Modified:
   grass/branches/releasebranch_6_4/vector/v.net.allpairs/description.html
   grass/branches/releasebranch_6_4/vector/v.net.allpairs/main.c
Log:
update documentation

Modified: grass/branches/releasebranch_6_4/vector/v.net.allpairs/description.html
===================================================================
--- grass/branches/releasebranch_6_4/vector/v.net.allpairs/description.html	2012-04-15 01:03:13 UTC (rev 51447)
+++ grass/branches/releasebranch_6_4/vector/v.net.allpairs/description.html	2012-04-15 06:53:31 UTC (rev 51448)
@@ -3,29 +3,30 @@
 <em>v.net.allpairs</em> computes the shortest path between each selected 
 node and all other selected nodes.
 <p>
-<b><font color="red">WARNING:</font></b> This module is experimental 
-and will produce unexpected results if the input vector has been 
-prepared with <em>v.net</em>. A stable version is available in the next 
-version of GRASS (GRASS 7).
+If the input vector has been prepared with <em>v.net</em> and 
+<em>v.net.allpairs</em> should use cost columns, further preparation is 
+of the input vector required. In contrast to the output of <em>v.net</em> 
+and the behaviour of other <em>v.net.*</em> modules, <em>v.net.allpairs</em> 
+uses the same layer to read cost columns for arcs and to read node 
+categories. Therefore new, unique categories for points must be added 
+to the layer with cost columns for lines with <em>v.category</em>.
+<br>
+If <b>abcolumn</b> is not given then then the same costs are used for 
+forward and backward arcs.
 
 <h2>NOTES</h2>
 
-An attribute table is created and linked to <b>layer</b>. The table 
+An attribute table is created and linked to layer 1. The table 
 contains three columns: <em>cat</em>, <em>to_cat</em>, <em>cost</em>. 
 Each entry denotes the cost of the shortest path from <em>cat</em> to 
 <em>to_cat</em>. If the cost is negative then no path exists. If points 
 are specified by <b>cats, layer</b> or <b>where</b> parameters then 
-the table is filled only for the selected points. In other words, 
-<em>cat</em> columns contains only selected points but the distances 
-are computed and updated for <em>all</em> other nodes.<br> If flag 
-<b>-a</b> is set then new points are added on nodes without nodes. 
-These points have the largest categorie. Precisely, category of each 
-new point is larger than any of the old categories. If the flag is not 
-set then no new points are created and hence the attribute table 
-stores the costs only between the points already present in the input. 
-Output consists of all points mentioned in either of the columns.<br>
-If <b>abcolumn</b> is not given then then the same costs are used for 
-forward and backward arcs.
+the table is filled only for the selected points.
+<br>
+If the <b>-a</b> flag is set then new points are added on nodes without 
+nodes. These points have the largest category. Precisely, the category 
+value of each new point is larger than any of the old categories. Note 
+that these new points are not included in the output table.
 
 <h2>EXAMPLE</h2>
 
@@ -67,7 +68,8 @@
 <h2>AUTHORS</h2>
 
 Daniel Bundala, Google Summer of Code 2009, Student<br>
-Wolf Bergenheim, Mentor
+Wolf Bergenheim, Mentor<br>
+Markus Metz
 
 <p>
 <i>Last changed: $Date$</i>

Modified: grass/branches/releasebranch_6_4/vector/v.net.allpairs/main.c
===================================================================
--- grass/branches/releasebranch_6_4/vector/v.net.allpairs/main.c	2012-04-15 01:03:13 UTC (rev 51447)
+++ grass/branches/releasebranch_6_4/vector/v.net.allpairs/main.c	2012-04-15 06:53:31 UTC (rev 51448)
@@ -4,6 +4,7 @@
  * MODULE:     v.net.allpairs
  *
  * AUTHOR(S):  Daniel Bundala
+ *             Markus Metz
  *
  * PURPOSE:    Shortest paths between all nodes
  *