summaryrefslogtreecommitdiff
path: root/doc/html/boost/mpi/content.html
diff options
context:
space:
mode:
authorDongHun Kwak <dh0128.kwak@samsung.com>2016-10-06 10:41:18 +0900
committerDongHun Kwak <dh0128.kwak@samsung.com>2016-10-06 10:43:11 +0900
commitf763a99a501650eff2c60288aa6f10ef916d769e (patch)
tree02af7e13f9a38c888ebf340fe764cbe7dae99da9 /doc/html/boost/mpi/content.html
parent5cde13f21d36c7224b0e13d11c4b49379ae5210d (diff)
downloadboost-f763a99a501650eff2c60288aa6f10ef916d769e.tar.gz
boost-f763a99a501650eff2c60288aa6f10ef916d769e.tar.bz2
boost-f763a99a501650eff2c60288aa6f10ef916d769e.zip
Imported Upstream version 1.62.0upstream/1.62.0
Change-Id: I9d4c1ddb7b7d8f0069217ecc582700f9fda6dd4c Signed-off-by: DongHun Kwak <dh0128.kwak@samsung.com>
Diffstat (limited to 'doc/html/boost/mpi/content.html')
-rw-r--r--doc/html/boost/mpi/content.html57
1 files changed, 36 insertions, 21 deletions
diff --git a/doc/html/boost/mpi/content.html b/doc/html/boost/mpi/content.html
index c1dbfec88a..28792f4565 100644
--- a/doc/html/boost/mpi/content.html
+++ b/doc/html/boost/mpi/content.html
@@ -4,7 +4,7 @@
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Class content</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.79.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.skeleton_and_content_hpp" title="Header &lt;boost/mpi/skeleton_and_content.hpp&gt;">
<link rel="prev" href="skeleton_proxy.html" title="Struct template skeleton_proxy">
@@ -36,39 +36,45 @@
<span class="keyword">class</span> <a class="link" href="content.html" title="Class content">content</a> <span class="special">{</span>
<span class="keyword">public</span><span class="special">:</span>
<span class="comment">// <a class="link" href="content.html#boost.mpi.contentconstruct-copy-destruct">construct/copy/destruct</a></span>
- <a class="link" href="content.html#idp68522656-bb"><span class="identifier">content</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
- <a class="link" href="content.html#idp68523888-bb"><span class="identifier">content</span></a><span class="special">(</span><span class="identifier">MPI_Datatype</span><span class="special">,</span> <span class="keyword">bool</span> <span class="special">=</span> <span class="keyword">true</span><span class="special">)</span><span class="special">;</span>
- <span class="keyword">const</span> <a class="link" href="content.html" title="Class content">content</a> <span class="special">&amp;</span> <a class="link" href="content.html#idp68529120-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="identifier">MPI_Datatype</span><span class="special">)</span><span class="special">;</span>
+ <a class="link" href="content.html#idm46563251828944-bb"><span class="identifier">content</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
+ <a class="link" href="content.html#idm46563251827712-bb"><span class="identifier">content</span></a><span class="special">(</span><span class="identifier">MPI_Datatype</span><span class="special">,</span> <span class="keyword">bool</span> <span class="special">=</span> <span class="keyword">true</span><span class="special">)</span><span class="special">;</span>
+ <span class="keyword">const</span> <a class="link" href="content.html" title="Class content">content</a> <span class="special">&amp;</span> <a class="link" href="content.html#idm46563251822416-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="identifier">MPI_Datatype</span><span class="special">)</span><span class="special">;</span>
- <span class="comment">// <a class="link" href="content.html#idp124509360-bb">public member functions</a></span>
- <span class="identifier">MPI_Datatype</span> <a class="link" href="content.html#idp124509920-bb"><span class="identifier">get_mpi_datatype</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
- <span class="keyword">void</span> <a class="link" href="content.html#idp124512704-bb"><span class="identifier">commit</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
+ <span class="comment">// <a class="link" href="content.html#idm46563251833760-bb">public member functions</a></span>
+ <span class="identifier">MPI_Datatype</span> <a class="link" href="content.html#idm46563251833200-bb"><span class="identifier">get_mpi_datatype</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
+ <span class="keyword">void</span> <a class="link" href="content.html#idm46563251830416-bb"><span class="identifier">commit</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
<span class="special">}</span><span class="special">;</span></pre></div>
<div class="refsect1">
-<a name="idp307860496"></a><h2>Description</h2>
+<a name="idm45927875746336"></a><h2>Description</h2>
<p>The <code class="computeroutput">content</code> class indicates that Boost.MPI should transmit or receive the content of an object, but without any information about the structure of the object. It is only meaningful to transmit the content of an object after the receiver has already received the skeleton for the same object.</p>
<p>Most users will not use <code class="computeroutput">content</code> objects directly. Rather, they will invoke <code class="computeroutput">send</code>, <code class="computeroutput">recv</code>, or <code class="computeroutput">broadcast</code> operations using <code class="computeroutput">get_content()</code>. </p>
<div class="refsect2">
-<a name="idp307866064"></a><h3>
+<a name="idm45927875740768"></a><h3>
<a name="boost.mpi.contentconstruct-copy-destruct"></a><code class="computeroutput">content</code>
public
construct/copy/destruct</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
-<pre class="literallayout"><a name="idp68522656-bb"></a><span class="identifier">content</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
+<pre class="literallayout"><a name="idm46563251828944-bb"></a><span class="identifier">content</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
<p>Constructs an empty <code class="computeroutput">content</code> object. This object will not be useful for any Boost.MPI operations until it is reassigned. </p>
</li>
<li class="listitem">
-<pre class="literallayout"><a name="idp68523888-bb"></a><span class="identifier">content</span><span class="special">(</span><span class="identifier">MPI_Datatype</span> d<span class="special">,</span> <span class="keyword">bool</span> committed <span class="special">=</span> <span class="keyword">true</span><span class="special">)</span><span class="special">;</span></pre>
+<pre class="literallayout"><a name="idm46563251827712-bb"></a><span class="identifier">content</span><span class="special">(</span><span class="identifier">MPI_Datatype</span> d<span class="special">,</span> <span class="keyword">bool</span> committed <span class="special">=</span> <span class="keyword">true</span><span class="special">)</span><span class="special">;</span></pre>
<p>This routine initializes the <code class="computeroutput">content</code> object with an MPI data type that refers to the content of an object without its structure.</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">committed</code></span></p></td>
@@ -84,18 +90,24 @@
</table></div>
</li>
<li class="listitem">
-<pre class="literallayout"><span class="keyword">const</span> <a class="link" href="content.html" title="Class content">content</a> <span class="special">&amp;</span> <a name="idp68529120-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="identifier">MPI_Datatype</span> d<span class="special">)</span><span class="special">;</span></pre>
+<pre class="literallayout"><span class="keyword">const</span> <a class="link" href="content.html" title="Class content">content</a> <span class="special">&amp;</span> <a name="idm46563251822416-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="identifier">MPI_Datatype</span> d<span class="special">)</span><span class="special">;</span></pre>
<p>Replace the MPI data type referencing the content of an object.</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">d</code></span></p></td>
<td><p>the new MPI data type referring to the content of the object.</p></td>
@@ -112,16 +124,19 @@
</ol></div>
</div>
<div class="refsect2">
-<a name="idp307898736"></a><h3>
-<a name="idp124509360-bb"></a><code class="computeroutput">content</code> public member functions</h3>
+<a name="idm45927875707904"></a><h3>
+<a name="idm46563251833760-bb"></a><code class="computeroutput">content</code> public member functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
-<pre class="literallayout"><span class="identifier">MPI_Datatype</span> <a name="idp124509920-bb"></a><span class="identifier">get_mpi_datatype</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
+<pre class="literallayout"><span class="identifier">MPI_Datatype</span> <a name="idm46563251833200-bb"></a><span class="identifier">get_mpi_datatype</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Retrieve the MPI data type that refers to the content of the object.</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">Returns:</span></p></td>
<td><p>the MPI data type, which should only be transmitted or received using <code class="computeroutput">MPI_BOTTOM</code> as the address. </p></td>
@@ -129,7 +144,7 @@
</table></div>
</li>
<li class="listitem">
-<pre class="literallayout"><span class="keyword">void</span> <a name="idp124512704-bb"></a><span class="identifier">commit</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
+<pre class="literallayout"><span class="keyword">void</span> <a name="idm46563251830416-bb"></a><span class="identifier">commit</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
<p>Commit the MPI data type referring to the content of the object. </p>
</li>
</ol></div>