[ceph.git] / ceph / src / boost / libs / graph / doc / distance_recorder.html

<HTML>
<!--
     Copyright (c) Jeremy Siek, Lie-Quan Lee, and Andrew Lumsdaine 2000
    
     Distributed under the Boost Software License, Version 1.0.
     (See accompanying file LICENSE_1_0.txt or copy at
     http://www.boost.org/LICENSE_1_0.txt)
  -->
<Head>
<Title>Boost Graph Library: distance_recorder</Title>
<BODY BGCOLOR="#ffffff" LINK="#0000ee" TEXT="#000000" VLINK="#551a8b" 
        ALINK="#ff0000"> 
<IMG SRC="../../../boost.png" 
     ALT="C++ Boost" width="277" height="86"> 

<BR Clear>

<H1>
<pre>
distance_recorder&lt;DistanceMap, EventTag&gt;
</pre>
</H1>

This is an <a href="./EventVisitor.html">EventVisitor</a> that records
the distance of a vertex (using a <a
href="property_map.html">property map</a>) from some
source vertex during a graph search. When applied to edge <i>e =
(u,v)</i>, the distance of <i>v</i> is recorded to be one more than
the distance of <i>u</i>. The distance recorder is typically used with
the <tt>on_tree_edge</tt> or <tt>on_relax_edge</tt> events and
cannot be used with vertex events.

<p>
<tt>distance_recorder</tt> can be used with graph algorithms by
wrapping it with the algorithm specific adaptor, such as <a
href="./bfs_visitor.html"><tt>bfs_visitor</tt></a> and <a
href="./dfs_visitor.html"><tt>dfs_visitor</tt></a>. Also, this event
visitor can be combined with other event visitors using
<tt>std::pair</tt> to form an EventVisitorList.

<h3>Example</h3>

See the example for <a href="./bfs_visitor.html"><tt>bfs_visitor</tt></a>.

<h3>Model of</h3>

<a href="./EventVisitor.html">EventVisitor</a>


<H3>Where Defined</H3>

<P>
<a href="../../../boost/graph/visitors.hpp">
<TT>boost/graph/visitors.hpp</TT></a>

<H3>Template Parameters</H3>

<P>
<TABLE border>
<TR>
<th>Parameter</th><th>Description</th><th>Default</th>
</tr>

<TR><TD><TT>DistanceMap</TT></TD>
<TD>
A <a
href="../../property_map/doc/WritablePropertyMap.html">WritablePropertyMap</a>
where the key type and the value type are the vertex descriptor type
of the graph.
</TD>
<TD>&nbsp;</TD>
</TR>

<TR><TD><TT>EventTag</TT></TD>
<TD>
The tag to specify when the <tt>distance_recorder</tt> should be
applied during the graph algorithm. <tt>EventTag</tt> must be an
edge event.
</TD>
<TD>&nbsp;</TD>
</TR>

</table>

<H2>Associated Types</H2>

<table border>

<tr>
<th>Type</th><th>Description</th>
</tr>

<tr>
<td><tt>distance_recorder::event_filter</tt></td>
<td>
This will be the same type as the template parameter <tt>EventTag</tt>.
</td>
</tr>

</table>

<h3>Member Functions</h3>

<p>

<table border>
<tr>
<th>Member</th><th>Description</th>
</tr>

<tr>
<td><tt>
distance_recorder(DistanceMap pa);
</tt></td>
<td>
Construct a distance recorder object with distance property map
<tt>pa</tt>.
</td>
</tr>

<tr>
<td><tt>
template &lt;class Edge, class Graph&gt;<br>
void operator()(Edge e, const Graph& g);
</tt></td>
<td>
Given edge <i>e = (u,v)</i>, this records the distance of <i>v</i> as 
one plus the distance of <i>u</i>.
</td>
</tr>

</table>

<h3>Non-Member Functions</h3>

<table border>
<tr>
<th>Function</th><th>Description</th>
</tr>

<tr><td><tt>
template &lt;class DistanceMap, class Tag&gt;<br>
distance_recorder&lt;DistanceMap, Tag&gt; <br>
record_distances(DistanceMap pa, Tag);
</tt></td><td>
A convenient way to create a <tt>distance_recorder</tt>.
</td></tr>

</table>

<h3>See Also</h3>

<a href="./visitor_concepts.html">Visitor concepts</a>
<p>
The following are other event visitors: <a
 href="./predecessor_recorder.html"><tt>predecessor_recorder</tt></a>,
<a href="./time_stamper.html"><tt>time_stamper</tt></a>,
and <a href="./property_writer.html"><tt>property_writer</tt></a>.


<br>
<HR>
<TABLE>
<TR valign=top>
<TD nowrap>Copyright &copy; 2000-2001</TD><TD>
<A HREF="http://www.boost.org/people/jeremy_siek.htm">Jeremy Siek</A>,
Indiana University (<A
HREF="mailto:jsiek@osl.iu.edu">jsiek@osl.iu.edu</A>)<br>
<A HREF="http://www.boost.org/people/liequan_lee.htm">Lie-Quan Lee</A>, Indiana University (<A HREF="mailto:llee@cs.indiana.edu">llee@cs.indiana.edu</A>)<br>
<A HREF="http://www.osl.iu.edu/~lums">Andrew Lumsdaine</A>,
Indiana University (<A
HREF="mailto:lums@osl.iu.edu">lums@osl.iu.edu</A>)
</TD></TR></TABLE>

</BODY>
</HTML> 
<!--  LocalWords:  DistanceMap EventTag EventVisitor map bfs dfs const Siek
 -->
<!--  LocalWords:  EventVisitorList WritablePropertyMap Univ Quan
 -->
<!--  LocalWords:  Lumsdaine
 -->
Commit	Line	Data
7c673cae FG	1	<HTML>
	2	<!--
	3	Copyright (c) Jeremy Siek, Lie-Quan Lee, and Andrew Lumsdaine 2000
	4
	5	Distributed under the Boost Software License, Version 1.0.
	6	(See accompanying file LICENSE_1_0.txt or copy at
	7	http://www.boost.org/LICENSE_1_0.txt)
	8	-->
	9	<Head>
	10	<Title>Boost Graph Library: distance_recorder</Title>
	11	<BODY BGCOLOR="#ffffff" LINK="#0000ee" TEXT="#000000" VLINK="#551a8b"
	12	ALINK="#ff0000">
	13	<IMG SRC="../../../boost.png"
	14	ALT="C++ Boost" width="277" height="86">
	15
	16	<BR Clear>
	17
	18	<H1>
	19	<pre>
	20	distance_recorder<DistanceMap, EventTag>
	21	</pre>
	22	</H1>
	23
	24	This is an <a href="./EventVisitor.html">EventVisitor</a> that records
	25	the distance of a vertex (using a <a
	26	href="property_map.html">property map</a>) from some
	27	source vertex during a graph search. When applied to edge <i>e =
	28	(u,v)</i>, the distance of <i>v</i> is recorded to be one more than
	29	the distance of <i>u</i>. The distance recorder is typically used with
	30	the <tt>on_tree_edge</tt> or <tt>on_relax_edge</tt> events and
	31	cannot be used with vertex events.
	32
	33	<p>
	34	<tt>distance_recorder</tt> can be used with graph algorithms by
	35	wrapping it with the algorithm specific adaptor, such as <a
	36	href="./bfs_visitor.html"><tt>bfs_visitor</tt></a> and <a
	37	href="./dfs_visitor.html"><tt>dfs_visitor</tt></a>. Also, this event
	38	visitor can be combined with other event visitors using
	39	<tt>std::pair</tt> to form an EventVisitorList.
	40
	41	<h3>Example</h3>
	42
	43	See the example for <a href="./bfs_visitor.html"><tt>bfs_visitor</tt></a>.
	44
	45	<h3>Model of</h3>
	46
	47	<a href="./EventVisitor.html">EventVisitor</a>
	48
	49
	50	<H3>Where Defined</H3>
	51
	52	<P>
	53	<a href="../../../boost/graph/visitors.hpp">
	54	<TT>boost/graph/visitors.hpp</TT></a>
	55
	56	<H3>Template Parameters</H3>
	57
	58	<P>
	59	<TABLE border>
	60	<TR>
	61	<th>Parameter</th><th>Description</th><th>Default</th>
	62	</tr>
	63
	64	<TR><TD><TT>DistanceMap</TT></TD>
65	<TD>
66	A <a
67	href="../../property_map/doc/WritablePropertyMap.html">WritablePropertyMap</a>
68	where the key type and the value type are the vertex descriptor type
69	of the graph.
70	</TD>
71	<TD> </TD>
72	</TR>
73
74	<TR><TD><TT>EventTag</TT></TD>
75	<TD>
76	The tag to specify when the <tt>distance_recorder</tt> should be
77	applied during the graph algorithm. <tt>EventTag</tt> must be an
78	edge event.
79	</TD>
80	<TD> </TD>
81	</TR>
82
83	</table>
84
85	<H2>Associated Types</H2>
86
87	<table border>
88
89	<tr>
90	<th>Type</th><th>Description</th>
91	</tr>
92
93	<tr>
94	<td><tt>distance_recorder::event_filter</tt></td>
95	<td>
96	This will be the same type as the template parameter <tt>EventTag</tt>.
97	</td>
98	</tr>
99
100	</table>
101
102	<h3>Member Functions</h3>
103
104	<p>
105
106	<table border>
107	<tr>
108	<th>Member</th><th>Description</th>
109	</tr>
110
111	<tr>
112	<td><tt>
113	distance_recorder(DistanceMap pa);
114	</tt></td>
115	<td>
116	Construct a distance recorder object with distance property map
117	<tt>pa</tt>.
118	</td>
119	</tr>
120
121	<tr>
122	<td><tt>
123	template <class Edge, class Graph><br>
124	void operator()(Edge e, const Graph& g);
125	</tt></td>
126	<td>
127	Given edge <i>e = (u,v)</i>, this records the distance of <i>v</i> as
128	one plus the distance of <i>u</i>.
129	</td>
130	</tr>
131
132	</table>
133
134	<h3>Non-Member Functions</h3>
135
136	<table border>
137	<tr>
138	<th>Function</th><th>Description</th>
139	</tr>
140
141	<tr><td><tt>
142	template <class DistanceMap, class Tag><br>
143	distance_recorder<DistanceMap, Tag> <br>
144	record_distances(DistanceMap pa, Tag);
145	</tt></td><td>
146	A convenient way to create a <tt>distance_recorder</tt>.
147	</td></tr>
148
149	</table>
150
151	<h3>See Also</h3>
152
153	<a href="./visitor_concepts.html">Visitor concepts</a>
154	<p>
155	The following are other event visitors: <a
156	href="./predecessor_recorder.html"><tt>predecessor_recorder</tt></a>,
157	<a href="./time_stamper.html"><tt>time_stamper</tt></a>,
158	and <a href="./property_writer.html"><tt>property_writer</tt></a>.
159
160
161	<br>
162	<HR>
163	<TABLE>
164	<TR valign=top>
165	<TD nowrap>Copyright © 2000-2001</TD><TD>
166	<A HREF="http://www.boost.org/people/jeremy_siek.htm">Jeremy Siek</A>,
167	Indiana University (<A
168	HREF="mailto:jsiek@osl.iu.edu">jsiek@osl.iu.edu</A>)<br>
169	<A HREF="http://www.boost.org/people/liequan_lee.htm">Lie-Quan Lee</A>, Indiana University (<A HREF="mailto:llee@cs.indiana.edu">llee@cs.indiana.edu</A>)<br>
170	<A HREF="http://www.osl.iu.edu/~lums">Andrew Lumsdaine</A>,
171	Indiana University (<A
172	HREF="mailto:lums@osl.iu.edu">lums@osl.iu.edu</A>)
173	</TD></TR></TABLE>
174
175	</BODY>
176	</HTML>
177	<!-- LocalWords: DistanceMap EventTag EventVisitor map bfs dfs const Siek
178	-->
179	<!-- LocalWords: EventVisitorList WritablePropertyMap Univ Quan
180	-->
181	<!-- LocalWords: Lumsdaine
182	-->