ceph/src/boost/libs/graph_parallel/doc/local_subgraph.rst

   1 .. Copyright (C) 2004-2008 The Trustees of Indiana University.
   2    Use, modification and distribution is subject to the Boost Software
   3    License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
   4    http://www.boost.org/LICENSE_1_0.txt)
   5
   6 =============================
   7 |Logo| Local Subgraph Adaptor
   8 =============================
   9
  10 The local subgraph adaptor takes an existing `Distributed Graph` and
  11 filters out all of the nonlocal edges and vertices, presenting only
  12 the local portion of the distributed graph to the user. The behavior
  13 is equivalent to (and implemented with) a `filtered graph`_, and is a
  14 noncopying view into the graph itself. Changes made through the
  15 filtered graph will be reflected in the original graph and vice-versa.
  16
  17 ::
  18
  19   template<typename DistributedGraph> class local_subgraph;
  20
  21   template<typename DistributedGraph>
  22   local_subgraph<DistributedGraph> make_local_subgraph(DistributedGraph& g);
  23
  24 Where Defined
  25 -------------
  26 <boost/graph/distributed/local_subgraph.hpp>
  27
  28 Reference
  29 ---------
  30 The local subgraph adaptor adapts and forwards all operations of
  31 distributed graphs, the signatures of which will be omitted. Only
  32 operations unique to the local subgraph adaptor are presented.
  33
  34 Member Functions
  35 ~~~~~~~~~~~~~~~~
  36
  37 ::
  38
  39   local_subgraph(DistributedGraph& g);
  40
  41 Constructs a local subgraph presenting the local portion of the
  42 distributed graph ``g``.
  43
  44 --------------------------------------------------------------------------
  45
  46 ::
  47
  48   DistributedGraph&         base()               { return g; }
  49   const DistributedGraph&   base() const         { return g; }
  50
  51 Returns the underlying distributed graph.
  52
  53 Free Functions
  54 ~~~~~~~~~~~~~~
  55
  56 ::
  57
  58   template<typename DistributedGraph>
  59   local_subgraph<DistributedGraph> make_local_subgraph(DistributedGraph& g);
  60
  61 Constructs a local subgraph presenting the local portion of the
  62 distributed graph ``g``.
  63
  64 .. |Logo| image:: pbgl-logo.png
  65             :align: middle
  66             :alt: Parallel BGL
  67             :target: http://www.osl.iu.edu/research/pbgl
  68
  69 .. _filtered graph: http://www.boost.org/libs/graph/doc/filtered_graph.html