diff options
Diffstat (limited to 'doc/html/boost/mpi/packed_oarchive.html')
-rw-r--r-- | doc/html/boost/mpi/packed_oarchive.html | 82 |
1 files changed, 49 insertions, 33 deletions
diff --git a/doc/html/boost/mpi/packed_oarchive.html b/doc/html/boost/mpi/packed_oarchive.html index 5fcd76d2d9..1b183f6e09 100644 --- a/doc/html/boost/mpi/packed_oarchive.html +++ b/doc/html/boost/mpi/packed_oarchive.html @@ -3,7 +3,7 @@ <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> <title>Class packed_oarchive</title> <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../mpi/reference.html#header.boost.mpi.packed_oarchive_hpp" title="Header <boost/mpi/packed_oarchive.hpp>"> <link rel="prev" href="packed_iarchive.html" title="Class packed_iarchive"> @@ -26,59 +26,67 @@ <a name="boost.mpi.packed_oarchive"></a><div class="titlepage"></div> <div class="refnamediv"> <h2><span class="refentrytitle">Class packed_oarchive</span></h2> -<p>boost::mpi::packed_oarchive — An archive that unpacks binary data from an MPI buffer. </p> +<p>boost::mpi::packed_oarchive — An archive that packs binary data into an MPI buffer. </p> </div> <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../mpi/reference.html#header.boost.mpi.packed_oarchive_hpp" title="Header <boost/mpi/packed_oarchive.hpp>">boost/mpi/packed_oarchive.hpp</a>> </span> -<span class="keyword">class</span> <a class="link" href="packed_oarchive.html" title="Class packed_oarchive">packed_oarchive</a> <span class="special">{</span> +<span class="keyword">class</span> <a class="link" href="packed_oarchive.html" title="Class packed_oarchive">packed_oarchive</a> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">oprimitive</span> <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> <span class="comment">// <a class="link" href="packed_oarchive.html#boost.mpi.packed_oarchiveconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="packed_oarchive.html#id773653-bb"><span class="identifier">packed_oarchive</span></a><span class="special">(</span><span class="identifier">MPI_Comm</span> <span class="keyword">const</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">buffer_type</span> <span class="special">&</span><span class="special">,</span> + <a class="link" href="packed_oarchive.html#idp228568880-bb"><span class="identifier">packed_oarchive</span></a><span class="special">(</span><span class="identifier">MPI_Comm</span> <span class="keyword">const</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">buffer_type</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">unsigned</span> <span class="keyword">int</span> <span class="special">=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">archive</span><span class="special">::</span><span class="identifier">no_header</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="packed_oarchive.html#id773702-bb"><span class="identifier">packed_oarchive</span></a><span class="special">(</span><span class="identifier">MPI_Comm</span> <span class="keyword">const</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">unsigned</span> <span class="keyword">int</span> <span class="special">=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">archive</span><span class="special">::</span><span class="identifier">no_header</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="packed_oarchive.html#idp228477504-bb"><span class="identifier">packed_oarchive</span></a><span class="special">(</span><span class="identifier">MPI_Comm</span> <span class="keyword">const</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">unsigned</span> <span class="keyword">int</span> <span class="special">=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">archive</span><span class="special">::</span><span class="identifier">no_header</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="packed_oarchive.html#id779965-bb">public member functions</a></span> - <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="keyword">void</span> <a class="link" href="packed_oarchive.html#id779969-bb"><span class="identifier">save_override</span></a><span class="special">(</span><span class="identifier">T</span> <span class="keyword">const</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">int</span><span class="special">,</span> <span class="identifier">mpl</span><span class="special">::</span><span class="identifier">false_</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="keyword">void</span> <a class="link" href="packed_oarchive.html#id773557-bb"><span class="identifier">save_override</span></a><span class="special">(</span><span class="identifier">T</span> <span class="keyword">const</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">int</span><span class="special">,</span> <span class="identifier">mpl</span><span class="special">::</span><span class="identifier">true_</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="keyword">void</span> <a class="link" href="packed_oarchive.html#id773588-bb"><span class="identifier">save_override</span></a><span class="special">(</span><span class="identifier">T</span> <span class="keyword">const</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">int</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="packed_oarchive.html#id773614-bb"><span class="identifier">save_override</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">archive</span><span class="special">::</span><span class="identifier">class_id_optional_type</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">int</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="packed_oarchive.html#id773633-bb"><span class="identifier">save_override</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">archive</span><span class="special">::</span><span class="identifier">class_name_type</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">int</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="packed_oarchive.html#idp93531760-bb">public member functions</a></span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="keyword">void</span> <a class="link" href="packed_oarchive.html#idp93532320-bb"><span class="identifier">save_override</span></a><span class="special">(</span><span class="identifier">T</span> <span class="keyword">const</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">int</span><span class="special">,</span> <span class="identifier">mpl</span><span class="special">::</span><span class="identifier">false_</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="keyword">void</span> <a class="link" href="packed_oarchive.html#idp93536080-bb"><span class="identifier">save_override</span></a><span class="special">(</span><span class="identifier">T</span> <span class="keyword">const</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">int</span><span class="special">,</span> <span class="identifier">mpl</span><span class="special">::</span><span class="identifier">true_</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="keyword">void</span> <a class="link" href="packed_oarchive.html#idp229892112-bb"><span class="identifier">save_override</span></a><span class="special">(</span><span class="identifier">T</span> <span class="keyword">const</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">int</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="packed_oarchive.html#idp229895184-bb"><span class="identifier">save_override</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">archive</span><span class="special">::</span><span class="identifier">class_id_optional_type</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">int</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="packed_oarchive.html#idp229897424-bb"><span class="identifier">save_override</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">archive</span><span class="special">::</span><span class="identifier">class_name_type</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">int</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="packed_oarchive.html#idp228564368-bb"><span class="identifier">save_override</span></a><span class="special">(</span><span class="identifier">archive</span><span class="special">::</span><span class="identifier">class_id_type</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">int</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="packed_oarchive.html#idp228566496-bb"><span class="identifier">save_override</span></a><span class="special">(</span><span class="identifier">archive</span><span class="special">::</span><span class="identifier">version_type</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">int</span><span class="special">)</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="id2537980"></a><h2>Description</h2> -<p>The <code class="computeroutput"><a class="link" href="packed_oarchive.html" title="Class packed_oarchive">packed_oarchive</a></code> class is an Archiver (as in the Boost.Serialization library) that unpacks binary data from a buffer received via MPI. It can operate on any Serializable data type and will use the <code class="computeroutput">MPI_Unpack</code> function of the underlying MPI implementation to perform deserialization. </p> +<a name="idp341872928"></a><h2>Description</h2> +<p>The <code class="computeroutput"><a class="link" href="packed_iarchive.html" title="Class packed_iarchive">packed_iarchive</a></code> class is an Archiver (as in the Boost.Serialization library) that packs binary data into a buffer for transmission via MPI. It can operate on any Serializable data type and will use the <code class="computeroutput">MPI_Pack</code> function of the underlying MPI implementation to perform serialization. </p> <div class="refsect2"> -<a name="id2538007"></a><h3> +<a name="idp341875904"></a><h3> <a name="boost.mpi.packed_oarchiveconstruct-copy-destruct"></a><code class="computeroutput">packed_oarchive</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a name="id773653-bb"></a><span class="identifier">packed_oarchive</span><span class="special">(</span><span class="identifier">MPI_Comm</span> <span class="keyword">const</span> <span class="special">&</span> comm<span class="special">,</span> <span class="identifier">buffer_type</span> <span class="special">&</span> b<span class="special">,</span> +<pre class="literallayout"><a name="idp228568880-bb"></a><span class="identifier">packed_oarchive</span><span class="special">(</span><span class="identifier">MPI_Comm</span> <span class="keyword">const</span> <span class="special">&</span> comm<span class="special">,</span> <span class="identifier">buffer_type</span> <span class="special">&</span> b<span class="special">,</span> <span class="keyword">unsigned</span> <span class="keyword">int</span> flags <span class="special">=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">archive</span><span class="special">::</span><span class="identifier">no_header</span><span class="special">)</span><span class="special">;</span></pre> -<p>Construct a <code class="computeroutput"><code class="computeroutput"><a class="link" href="packed_oarchive.html" title="Class packed_oarchive">packed_oarchive</a></code></code> to receive data over the given MPI communicator and with an initial buffer.</p> +<p>Construct a <code class="computeroutput"><code class="computeroutput"><a class="link" href="packed_oarchive.html" title="Class packed_oarchive">packed_oarchive</a></code></code> for transmission over the given MPI communicator and with an initial buffer.</p> <p> </p> -<div class="variablelist"><table border="0"> +<div class="variablelist"><table border="0" class="variablelist compact"> +<colgroup> <col align="left" valign="top"> +<col> +</colgroup> <tbody><tr> <td><p><span class="term">Parameters:</span></p></td> -<td><div class="variablelist"><table border="0"> +<td><div class="variablelist"><table border="0" class="variablelist compact"> +<colgroup> <col align="left" valign="top"> +<col> +</colgroup> <tbody> <tr> <td><p><span class="term"><code class="computeroutput">b</code></span></p></td> -<td><p>A user-defined buffer that contains the binary representation of serialized objects.</p></td> +<td><p>A user-defined buffer that will be filled with the binary representation of serialized objects.</p></td> </tr> <tr> <td><p><span class="term"><code class="computeroutput">comm</code></span></p></td> -<td><p>The communicator over which this archive will be received.</p></td> +<td><p>The communicator over which this archive will be sent.</p></td> </tr> <tr> <td><p><span class="term"><code class="computeroutput">flags</code></span></p></td> -<td><p>Control the serialization of the data types. Refer to the Boost.Serialization documentation before changing the default flags. </p></td> +<td><p>Control the serialization of the data types. Refer to the Boost.Serialization documentation before changing the default flags.</p></td> </tr> </tbody> </table></div></td> @@ -86,21 +94,27 @@ </table></div> </li> <li class="listitem"> -<pre class="literallayout"><a name="id773702-bb"></a><span class="identifier">packed_oarchive</span><span class="special">(</span><span class="identifier">MPI_Comm</span> <span class="keyword">const</span> <span class="special">&</span> comm<span class="special">,</span> +<pre class="literallayout"><a name="idp228477504-bb"></a><span class="identifier">packed_oarchive</span><span class="special">(</span><span class="identifier">MPI_Comm</span> <span class="keyword">const</span> <span class="special">&</span> comm<span class="special">,</span> <span class="keyword">unsigned</span> <span class="keyword">int</span> flags <span class="special">=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">archive</span><span class="special">::</span><span class="identifier">no_header</span><span class="special">)</span><span class="special">;</span></pre> -<p>Construct a <code class="computeroutput"><code class="computeroutput"><a class="link" href="packed_oarchive.html" title="Class packed_oarchive">packed_oarchive</a></code></code> to receive data over the given MPI communicator.</p> +<p>Construct a <code class="computeroutput"><code class="computeroutput"><a class="link" href="packed_oarchive.html" title="Class packed_oarchive">packed_oarchive</a></code></code> for transmission over the given MPI communicator.</p> <p> </p> -<div class="variablelist"><table border="0"> +<div class="variablelist"><table border="0" class="variablelist compact"> +<colgroup> <col align="left" valign="top"> +<col> +</colgroup> <tbody><tr> <td><p><span class="term">Parameters:</span></p></td> -<td><div class="variablelist"><table border="0"> +<td><div class="variablelist"><table border="0" class="variablelist compact"> +<colgroup> <col align="left" valign="top"> +<col> +</colgroup> <tbody> <tr> <td><p><span class="term"><code class="computeroutput">comm</code></span></p></td> -<td><p>The communicator over which this archive will be received.</p></td> +<td><p>The communicator over which this archive will be sent.</p></td> </tr> <tr> <td><p><span class="term"><code class="computeroutput">flags</code></span></p></td> @@ -114,14 +128,16 @@ </ol></div> </div> <div class="refsect2"> -<a name="id2538351"></a><h3> -<a name="id779965-bb"></a><code class="computeroutput">packed_oarchive</code> public member functions</h3> +<a name="idp341916736"></a><h3> +<a name="idp93531760-bb"></a><code class="computeroutput">packed_oarchive</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> -<li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="keyword">void</span> <a name="id779969-bb"></a><span class="identifier">save_override</span><span class="special">(</span><span class="identifier">T</span> <span class="keyword">const</span> <span class="special">&</span> x<span class="special">,</span> <span class="keyword">int</span> version<span class="special">,</span> <span class="identifier">mpl</span><span class="special">::</span><span class="identifier">false_</span><span class="special">)</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="keyword">void</span> <a name="id773557-bb"></a><span class="identifier">save_override</span><span class="special">(</span><span class="identifier">T</span> <span class="keyword">const</span> <span class="special">&</span> x<span class="special">,</span> <span class="keyword">int</span><span class="special">,</span> <span class="identifier">mpl</span><span class="special">::</span><span class="identifier">true_</span><span class="special">)</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="keyword">void</span> <a name="id773588-bb"></a><span class="identifier">save_override</span><span class="special">(</span><span class="identifier">T</span> <span class="keyword">const</span> <span class="special">&</span> x<span class="special">,</span> <span class="keyword">int</span> version<span class="special">)</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="id773614-bb"></a><span class="identifier">save_override</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">archive</span><span class="special">::</span><span class="identifier">class_id_optional_type</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">int</span><span class="special">)</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="id773633-bb"></a><span class="identifier">save_override</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">archive</span><span class="special">::</span><span class="identifier">class_name_type</span> <span class="special">&</span> t<span class="special">,</span> <span class="keyword">int</span><span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="keyword">void</span> <a name="idp93532320-bb"></a><span class="identifier">save_override</span><span class="special">(</span><span class="identifier">T</span> <span class="keyword">const</span> <span class="special">&</span> x<span class="special">,</span> <span class="keyword">int</span> version<span class="special">,</span> <span class="identifier">mpl</span><span class="special">::</span><span class="identifier">false_</span><span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="keyword">void</span> <a name="idp93536080-bb"></a><span class="identifier">save_override</span><span class="special">(</span><span class="identifier">T</span> <span class="keyword">const</span> <span class="special">&</span> x<span class="special">,</span> <span class="keyword">int</span><span class="special">,</span> <span class="identifier">mpl</span><span class="special">::</span><span class="identifier">true_</span><span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="keyword">void</span> <a name="idp229892112-bb"></a><span class="identifier">save_override</span><span class="special">(</span><span class="identifier">T</span> <span class="keyword">const</span> <span class="special">&</span> x<span class="special">,</span> <span class="keyword">int</span> version<span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idp229895184-bb"></a><span class="identifier">save_override</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">archive</span><span class="special">::</span><span class="identifier">class_id_optional_type</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">int</span><span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idp229897424-bb"></a><span class="identifier">save_override</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">archive</span><span class="special">::</span><span class="identifier">class_name_type</span> <span class="special">&</span> t<span class="special">,</span> <span class="keyword">int</span><span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idp228564368-bb"></a><span class="identifier">save_override</span><span class="special">(</span><span class="identifier">archive</span><span class="special">::</span><span class="identifier">class_id_type</span> <span class="special">&</span> t<span class="special">,</span> <span class="keyword">int</span> version<span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idp228566496-bb"></a><span class="identifier">save_override</span><span class="special">(</span><span class="identifier">archive</span><span class="special">::</span><span class="identifier">version_type</span> <span class="special">&</span> t<span class="special">,</span> <span class="keyword">int</span> version<span class="special">)</span><span class="special">;</span></pre></li> </ol></div> </div> </div> |