summaryrefslogtreecommitdiff
path: root/doc/html/boost/mpi/cartesian_dimension.html
diff options
context:
space:
mode:
Diffstat (limited to 'doc/html/boost/mpi/cartesian_dimension.html')
-rw-r--r--doc/html/boost/mpi/cartesian_dimension.html96
1 files changed, 96 insertions, 0 deletions
diff --git a/doc/html/boost/mpi/cartesian_dimension.html b/doc/html/boost/mpi/cartesian_dimension.html
new file mode 100644
index 0000000000..b588a74457
--- /dev/null
+++ b/doc/html/boost/mpi/cartesian_dimension.html
@@ -0,0 +1,96 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Struct cartesian_dimension</title>
+<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
+<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/tutorial.html#header.boost.mpi.cartesian_communicator_hpp" title="Header &lt;boost/mpi/cartesian_communicator.hpp&gt;">
+<link rel="prev" href="operat_1_3_26_5_14_2_2_1_4.html" title="Function template operator!=">
+<link rel="next" href="is_mpi_1_3_26_5_14_3_2_1_2.html" title="Struct is_mpi_datatype&lt;cartesian_dimension&gt;">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
+<td align="center"><a href="../../../../index.html">Home</a></td>
+<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
+<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
+<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
+<td align="center"><a href="../../../../more/index.htm">More</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="operat_1_3_26_5_14_2_2_1_4.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../mpi/tutorial.html#header.boost.mpi.cartesian_communicator_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="is_mpi_1_3_26_5_14_3_2_1_2.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+<div class="refentry">
+<a name="boost.mpi.cartesian_dimension"></a><div class="titlepage"></div>
+<div class="refnamediv">
+<h2><span class="refentrytitle">Struct cartesian_dimension</span></h2>
+<p>boost::mpi::cartesian_dimension &#8212; Specify the size and periodicity of the grid in a single dimension. </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: &lt;<a class="link" href="../../mpi/tutorial.html#header.boost.mpi.cartesian_communicator_hpp" title="Header &lt;boost/mpi/cartesian_communicator.hpp&gt;">boost/mpi/cartesian_communicator.hpp</a>&gt;
+
+</span>
+<span class="keyword">struct</span> <a class="link" href="cartesian_dimension.html" title="Struct cartesian_dimension">cartesian_dimension</a> <span class="special">{</span>
+ <span class="comment">// <a class="link" href="cartesian_dimension.html#boost.mpi.cartesian_dimensionconstruct-copy-destruct">construct/copy/destruct</a></span>
+ <a class="link" href="cartesian_dimension.html#id-1_3_26_5_14_3_2_1_1_6-bb"><span class="identifier">cartesian_dimension</span></a><span class="special">(</span><span class="keyword">int</span> <span class="special">=</span> <span class="number">0</span><span class="special">,</span> <span class="keyword">bool</span> <span class="special">=</span> <span class="keyword">false</span><span class="special">)</span><span class="special">;</span>
+
+ <span class="comment">// <a class="link" href="cartesian_dimension.html#id-1_3_26_5_14_3_2_1_1_7-bb">private member functions</a></span>
+ <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Archive<span class="special">&gt;</span> <span class="keyword">void</span> <a class="link" href="cartesian_dimension.html#id-1_3_26_5_14_3_2_1_1_7_1-bb"><span class="identifier">serialize</span></a><span class="special">(</span><span class="identifier">Archive</span> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">unsigned</span> <span class="keyword">int</span><span class="special">)</span><span class="special">;</span>
+
+ <span class="comment">// <a class="link" href="cartesian_dimension.html#boost.mpi.cartesian_dimensionpublic-data-members">public data members</a></span>
+ <span class="keyword">int</span> <a class="link" href="cartesian_dimension.html#boost.mpi.cartesian_dimension.size"><span class="identifier">size</span></a><span class="special">;</span>
+ <span class="keyword">bool</span> <a class="link" href="cartesian_dimension.html#boost.mpi.cartesian_dimension.periodic"><span class="identifier">periodic</span></a><span class="special">;</span>
+<span class="special">}</span><span class="special">;</span></pre></div>
+<div class="refsect1">
+<a name="id-1.3.26.5.14.4.4.4"></a><h2>Description</h2>
+<p>POD lightweight object. </p>
+<div class="refsect2">
+<a name="id-1.3.26.5.14.4.4.4.3"></a><h3>
+<a name="boost.mpi.cartesian_dimensionconstruct-copy-destruct"></a><code class="computeroutput">cartesian_dimension</code>
+ public
+ construct/copy/destruct</h3>
+<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><a name="id-1_3_26_5_14_3_2_1_1_6-bb"></a><span class="identifier">cartesian_dimension</span><span class="special">(</span><span class="keyword">int</span> sz <span class="special">=</span> <span class="number">0</span><span class="special">,</span> <span class="keyword">bool</span> p <span class="special">=</span> <span class="keyword">false</span><span class="special">)</span><span class="special">;</span></pre></li></ol></div>
+</div>
+<div class="refsect2">
+<a name="id-1.3.26.5.14.4.4.4.4"></a><h3>
+<a name="id-1_3_26_5_14_3_2_1_1_7-bb"></a><code class="computeroutput">cartesian_dimension</code> private 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">&lt;</span><span class="keyword">typename</span> Archive<span class="special">&gt;</span>
+ <span class="keyword">void</span> <a name="id-1_3_26_5_14_3_2_1_1_7_1-bb"></a><span class="identifier">serialize</span><span class="special">(</span><span class="identifier">Archive</span> <span class="special">&amp;</span> ar<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">unsigned</span> <span class="keyword">int</span> version<span class="special">)</span><span class="special">;</span></pre></li></ol></div>
+</div>
+<div class="refsect2">
+<a name="id-1.3.26.5.14.4.4.4.5"></a><h3>
+<a name="boost.mpi.cartesian_dimensionpublic-data-members"></a><code class="computeroutput">cartesian_dimension</code>
+ public
+ public data members</h3>
+<div class="orderedlist"><ol class="orderedlist" type="1">
+<li class="listitem">
+<pre class="literallayout"><span class="keyword">int</span> <a name="boost.mpi.cartesian_dimension.size"></a><span class="identifier">size</span><span class="special">;</span></pre>
+<p>The size of the grid n this dimension. </p>
+</li>
+<li class="listitem">
+<pre class="literallayout"><span class="keyword">bool</span> <a name="boost.mpi.cartesian_dimension.periodic"></a><span class="identifier">periodic</span><span class="special">;</span></pre>
+<p>Is the grid periodic in this dimension. </p>
+</li>
+</ol></div>
+</div>
+</div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright &#169; 2005-2007 Douglas Gregor,
+ Matthias Troyer, Trustees of Indiana University<p>
+ Distributed under the Boost Software License, Version 1.0. (See accompanying
+ file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">
+ http://www.boost.org/LICENSE_1_0.txt </a>)
+ </p>
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="operat_1_3_26_5_14_2_2_1_4.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../mpi/tutorial.html#header.boost.mpi.cartesian_communicator_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="is_mpi_1_3_26_5_14_3_2_1_2.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>