[ceph.git] / ceph / src / boost / libs / graph_parallel / doc / html / local_subgraph.html

<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.6: http://docutils.sourceforge.net/" />
<title>Parallel BGL Local Subgraph Adaptor</title>
<link rel="stylesheet" href="../../../../rst.css" type="text/css" />
</head>
<body>
<div class="document" id="logo-local-subgraph-adaptor">
<h1 class="title"><a class="reference external" href="http://www.osl.iu.edu/research/pbgl"><img align="middle" alt="Parallel BGL" class="align-middle" src="pbgl-logo.png" /></a> Local Subgraph Adaptor</h1>

<!-- Copyright (C) 2004-2008 The Trustees of Indiana University.
Use, modification and distribution is subject to 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) -->
<p>The local subgraph adaptor takes an existing <cite>Distributed Graph</cite> and
filters out all of the nonlocal edges and vertices, presenting only
the local portion of the distributed graph to the user. The behavior
is equivalent to (and implemented with) a <a class="reference external" href="http://www.boost.org/libs/graph/doc/filtered_graph.html">filtered graph</a>, and is a
noncopying view into the graph itself. Changes made through the
filtered graph will be reflected in the original graph and vice-versa.</p>
<pre class="literal-block">
template&lt;typename DistributedGraph&gt; class local_subgraph;

template&lt;typename DistributedGraph&gt;
local_subgraph&lt;DistributedGraph&gt; make_local_subgraph(DistributedGraph&amp; g);
</pre>
<div class="section" id="where-defined">
<h1>Where Defined</h1>
<p>&lt;boost/graph/distributed/local_subgraph.hpp&gt;</p>
</div>
<div class="section" id="reference">
<h1>Reference</h1>
<p>The local subgraph adaptor adapts and forwards all operations of
distributed graphs, the signatures of which will be omitted. Only
operations unique to the local subgraph adaptor are presented.</p>
<div class="section" id="member-functions">
<h2>Member Functions</h2>
<pre class="literal-block">
local_subgraph(DistributedGraph&amp; g);
</pre>
<p>Constructs a local subgraph presenting the local portion of the
distributed graph <tt class="docutils literal"><span class="pre">g</span></tt>.</p>
<hr class="docutils" />
<pre class="literal-block">
DistributedGraph&amp;         base()               { return g; }
const DistributedGraph&amp;   base() const         { return g; }
</pre>
<p>Returns the underlying distributed graph.</p>
</div>
<div class="section" id="free-functions">
<h2>Free Functions</h2>
<pre class="literal-block">
template&lt;typename DistributedGraph&gt;
local_subgraph&lt;DistributedGraph&gt; make_local_subgraph(DistributedGraph&amp; g);
</pre>
<p>Constructs a local subgraph presenting the local portion of the
distributed graph <tt class="docutils literal"><span class="pre">g</span></tt>.</p>
</div>
</div>
</div>
<div class="footer">
<hr class="footer" />
Generated on: 2009-05-31 00:22 UTC.
Generated by <a class="reference external" href="http://docutils.sourceforge.net/">Docutils</a> from <a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source.

</div>
</body>
</html>
Commit	Line	Data
7c673cae FG	1	<?xml version="1.0" encoding="utf-8" ?>
	2	<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
	3	<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
	4	<head>
	5	<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
	6	<meta name="generator" content="Docutils 0.6: http://docutils.sourceforge.net/" />
	7	<title>Parallel BGL Local Subgraph Adaptor</title>
	8	<link rel="stylesheet" href="../../../../rst.css" type="text/css" />
	9	</head>
	10	<body>
	11	<div class="document" id="logo-local-subgraph-adaptor">
	12	<h1 class="title"><a class="reference external" href="http://www.osl.iu.edu/research/pbgl"><img align="middle" alt="Parallel BGL" class="align-middle" src="pbgl-logo.png" /></a> Local Subgraph Adaptor</h1>
	13
	14	<!-- Copyright (C) 2004-2008 The Trustees of Indiana University.
	15	Use, modification and distribution is subject to the Boost Software
	16	License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
	17	http://www.boost.org/LICENSE_1_0.txt) -->
	18	<p>The local subgraph adaptor takes an existing <cite>Distributed Graph</cite> and
	19	filters out all of the nonlocal edges and vertices, presenting only
	20	the local portion of the distributed graph to the user. The behavior
	21	is equivalent to (and implemented with) a <a class="reference external" href="http://www.boost.org/libs/graph/doc/filtered_graph.html">filtered graph</a>, and is a
	22	noncopying view into the graph itself. Changes made through the
	23	filtered graph will be reflected in the original graph and vice-versa.</p>
	24	<pre class="literal-block">
	25	template<typename DistributedGraph> class local_subgraph;
	26
	27	template<typename DistributedGraph>
	28	local_subgraph<DistributedGraph> make_local_subgraph(DistributedGraph& g);
	29	</pre>
	30	<div class="section" id="where-defined">
	31	<h1>Where Defined</h1>
	32	<p><boost/graph/distributed/local_subgraph.hpp></p>
	33	</div>
	34	<div class="section" id="reference">
	35	<h1>Reference</h1>
	36	<p>The local subgraph adaptor adapts and forwards all operations of
	37	distributed graphs, the signatures of which will be omitted. Only
	38	operations unique to the local subgraph adaptor are presented.</p>
	39	<div class="section" id="member-functions">
	40	<h2>Member Functions</h2>
	41	<pre class="literal-block">
	42	local_subgraph(DistributedGraph& g);
	43	</pre>
	44	<p>Constructs a local subgraph presenting the local portion of the
	45	distributed graph <tt class="docutils literal"><span class="pre">g</span></tt>.</p>
	46	<hr class="docutils" />
	47	<pre class="literal-block">
	48	DistributedGraph& base() { return g; }
	49	const DistributedGraph& base() const { return g; }
	50	</pre>
	51	<p>Returns the underlying distributed graph.</p>
	52	</div>
	53	<div class="section" id="free-functions">
	54	<h2>Free Functions</h2>
	55	<pre class="literal-block">
	56	template<typename DistributedGraph>
	57	local_subgraph<DistributedGraph> make_local_subgraph(DistributedGraph& g);
	58	</pre>
	59	<p>Constructs a local subgraph presenting the local portion of the
	60	distributed graph <tt class="docutils literal"><span class="pre">g</span></tt>.</p>
	61	</div>
	62	</div>
	63	</div>
	64	<div class="footer">
65	<hr class="footer" />
66	Generated on: 2009-05-31 00:22 UTC.
67	Generated by <a class="reference external" href="http://docutils.sourceforge.net/">Docutils</a> from <a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source.
68
69	</div>
70	</body>
71	</html>