Subject: [Boost-commit] svn:boost r83857 - trunk/libs/graph/doc
From: jewillco_at_[hidden]
Date: 2013-04-12 15:54:33
Author: jewillco
Date: 2013-04-12 15:54:31 EDT (Fri, 12 Apr 2013)
New Revision: 83857
URL: http://svn.boost.org/trac/boost/changeset/83857
Log:
Fixed documentation to be correct; fixes #8428
Text files modified:
trunk/libs/graph/doc/johnson_all_pairs_shortest.html | 15 +++++++--------
1 files changed, 7 insertions(+), 8 deletions(-)
Modified: trunk/libs/graph/doc/johnson_all_pairs_shortest.html
==============================================================================
--- trunk/libs/graph/doc/johnson_all_pairs_shortest.html (original)
+++ trunk/libs/graph/doc/johnson_all_pairs_shortest.html 2013-04-12 15:54:31 EDT (Fri, 12 Apr 2013)
@@ -78,7 +78,9 @@
<i>u,v</i> in the graph is stored in <tt>D[u][v]</tt>. The tuple of
types (<tt>DistanceMatrix, vertices_size_type, D</tt>) must be a model
of BasicMatrix where <tt>D</tt> is the
-value type of the <tt>DistanceMap</tt>.
+value type of the <tt>DistanceMap</tt>. There must be implicit conversions
+between the value type of the distance matrix and the value type of the weight
+map.
</blockquote>
@@ -90,7 +92,7 @@
The type <tt>WeightMap</tt> must be a model of
<a href="../../property_map/doc/ReadablePropertyMap.html">Readable Property Map</a>. The edge descriptor type of
the graph needs to be usable as the key type for the weight
- map.<br>
+ map. The value type of the weight map must support a subtraction operation.<br>
<b>Default:</b> <tt>get(edge_weight, g)</tt>
</blockquote>
@@ -111,7 +113,7 @@
<b>Default:</b> <tt>get(vertex_index, g)</tt>
Note: if you use this default, make sure your graph has
an internal <tt>vertex_index</tt> property. For example,
- <tt>adjacenty_list</tt> with <tt>VertexList=listS</tt> does
+ <tt>adjacency_list</tt> with <tt>VertexList=listS</tt> does
not have an internal <tt>vertex_index</tt> property.
<br>
</blockquote>
@@ -139,11 +141,8 @@
This function is used to combine distances to compute the distance
of a path. The <tt>CombineFunction</tt> type must be a model of <a
href="http://www.sgi.com/tech/stl/BinaryFunction.html">Binary
- Function</a>. The first argument type of the binary function must
- match the value type of the <tt>DistanceMap</tt> property map and
- the second argument type must match the value type of the
- <tt>WeightMap</tt> property map. The result type must be the same
- type as the distance value type.<br>
+ Function</a>. Both argument types and the return type of the binary function
+ must match the value type of the <tt>WeightMap</tt> property map. This operation is required to act as the sum operation for the weight type; in particular, it must be the inverse of the binary <tt>-</tt> operator on that type.<br>
<b>Default:</b> <tt>std::plus<DT></tt> with
<tt>DT=typename property_traits<WeightMap>::value_type</tt>
</blockquote>