ceph/src/boost/libs/graph_parallel/doc/html/GlobalDescriptor.html

   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 Concept Global Descriptor</title>
   8 <link rel="stylesheet" href="../../../../rst.css" type="text/css" />
   9 </head>
  10 <body>
  11 <div class="document" id="logo-concept-global-descriptor">
  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> Concept Global Descriptor</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 <div class="contents topic" id="contents">
  19 <p class="topic-title first">Contents</p>
  20 <ul class="simple">
  21 <li><a class="reference internal" href="#description" id="id1">Description</a></li>
  22 <li><a class="reference internal" href="#refinement-of" id="id2">Refinement of</a></li>
  23 <li><a class="reference internal" href="#notation" id="id3">Notation</a></li>
  24 <li><a class="reference internal" href="#associated-types" id="id4">Associated types</a></li>
  25 <li><a class="reference internal" href="#valid-expressions" id="id5">Valid Expressions</a></li>
  26 </ul>
  27 </div>
  28 <div class="section" id="description">
  29 <h1><a class="toc-backref" href="#id1">Description</a></h1>
  30 <p>A global descriptor is an object that represents an entity that is
  31 owned by some process and may reside in an address space not
  32 accessible to the currently-executing process. The global descriptor
  33 consists of two parts: the <em>owner</em> of the entity, which is the
  34 identifier of that process in which the entity resides, and a <em>local
  35 descriptor</em>, that uniquely identifies the entity with the address
  36 space of the owner.</p>
  37 </div>
  38 <div class="section" id="refinement-of">
  39 <h1><a class="toc-backref" href="#id2">Refinement of</a></h1>
  40 <blockquote>
  41 <ul class="simple">
  42 <li><a class="reference external" href="http://www.sgi.com/tech/stl/DefaultConstructible.html">Default Constructible</a></li>
  43 <li><a class="reference external" href="http://www.sgi.com/tech/stl/Assignable.html">Assignable</a></li>
  44 </ul>
  45 </blockquote>
  46 </div>
  47 <div class="section" id="notation">
  48 <h1><a class="toc-backref" href="#id3">Notation</a></h1>
  49 <dl class="docutils">
  50 <dt>X</dt>
  51 <dd>A type that models the Global Descriptor concept.</dd>
  52 <dt>x</dt>
  53 <dd>Object of type X</dd>
  54 </dl>
  55 </div>
  56 <div class="section" id="associated-types">
  57 <h1><a class="toc-backref" href="#id4">Associated types</a></h1>
  58 <table border="1" class="docutils">
  59 <colgroup>
  60 <col width="23%" />
  61 <col width="29%" />
  62 <col width="48%" />
  63 </colgroup>
  64 <tbody valign="top">
  65 <tr><td>Process ID type</td>
  66 <td><tt class="docutils literal"><span class="pre">process_id_type</span></tt></td>
  67 <td>Determined by the process group
  68 associated with type X.</td>
  69 </tr>
  70 <tr><td>Local descriptor
  71 type</td>
  72 <td><tt class="docutils literal"><span class="pre">local_type</span></tt></td>
  73 <td>Determined by the data structure
  74 the descriptor accesses.
  75 Must model <a class="reference external" href="http://www.sgi.com/tech/stl/EqualityComparable.html">Equality Comparable</a>
  76 and <a class="reference external" href="http://www.sgi.com/tech/stl/CopyConstructible.html">Copy Constructible</a>.</td>
  77 </tr>
  78 </tbody>
  79 </table>
  80 </div>
  81 <div class="section" id="valid-expressions">
  82 <h1><a class="toc-backref" href="#id5">Valid Expressions</a></h1>
  83 <table border="1" class="docutils">
  84 <colgroup>
  85 <col width="17%" />
  86 <col width="22%" />
  87 <col width="22%" />
  88 <col width="39%" />
  89 </colgroup>
  90 <thead valign="bottom">
  91 <tr><th class="head">Name</th>
  92 <th class="head">Expression</th>
  93 <th class="head">Type</th>
  94 <th class="head">Semantics</th>
  95 </tr>
  96 </thead>
  97 <tbody valign="top">
  98 <tr><td>Owner</td>
  99 <td><tt class="docutils literal"><span class="pre">owner(x)</span></tt></td>
 100 <td><tt class="docutils literal"><span class="pre">process_id_type</span></tt></td>
 101 <td>Returns the owner of <tt class="docutils literal"><span class="pre">x</span></tt>.</td>
 102 </tr>
 103 <tr><td>Local descriptor</td>
 104 <td><tt class="docutils literal"><span class="pre">local(x)</span></tt></td>
 105 <td><tt class="docutils literal"><span class="pre">local_type</span></tt></td>
 106 <td>Returns the local descriptor
 107 uniquely identifying <tt class="docutils literal"><span class="pre">x</span></tt>.</td>
 108 </tr>
 109 </tbody>
 110 </table>
 111 <hr class="docutils" />
 112 <p>Copyright (C) 2005 The Trustees of Indiana University.</p>
 113 <p>Authors: Douglas Gregor and Andrew Lumsdaine</p>
 114 </div>
 115 </div>
 116 <div class="footer">
 117 <hr class="footer" />
 118 Generated on: 2009-05-31 00:22 UTC.
 119 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.
 120
 121 </div>
 122 </body>
 123 </html>