Imported Upstream version 1.72.0
[platform/upstream/boost.git] / doc / html / mpi.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2 <html>
3 <head>
4 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
5 <title>Chapter&#160;26.&#160;Boost.MPI</title>
6 <link rel="stylesheet" href="../../doc/src/boostbook.css" type="text/css">
7 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
8 <link rel="home" href="index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
9 <link rel="up" href="libraries.html" title="Part&#160;I.&#160;The Boost C++ Libraries (BoostBook Subset)">
10 <link rel="prev" href="boost/move_if_n_1_3_26_20_16_2_4.html" title="Function template move_if_not_lvalue_reference">
11 <link rel="next" href="mpi/getting_started.html" title="Getting started">
12 </head>
13 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
14 <table cellpadding="2" width="100%"><tr>
15 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../boost.png"></td>
16 <td align="center"><a href="../../index.html">Home</a></td>
17 <td align="center"><a href="../../libs/libraries.htm">Libraries</a></td>
18 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
19 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
20 <td align="center"><a href="../../more/index.htm">More</a></td>
21 </tr></table>
22 <hr>
23 <div class="spirit-nav">
24 <a accesskey="p" href="boost/move_if_n_1_3_26_20_16_2_4.html"><img src="../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="libraries.html"><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="mpi/getting_started.html"><img src="../../doc/src/images/next.png" alt="Next"></a>
25 </div>
26 <div class="chapter">
27 <div class="titlepage"><div>
28 <div><h2 class="title">
29 <a name="mpi"></a>Chapter&#160;26.&#160;Boost.MPI</h2></div>
30 <div><div class="author"><h3 class="author">
31 <span class="firstname">Douglas</span> <span class="surname">Gregor</span>
32 </h3></div></div>
33 <div><div class="author"><h3 class="author">
34 <span class="firstname">Matthias</span> <span class="surname">Troyer</span>
35 </h3></div></div>
36 <div><p class="copyright">Copyright &#169; 2005-2007 Douglas Gregor,
37       Matthias Troyer, Trustees of Indiana University</p></div>
38 <div><div class="legalnotice">
39 <a name="mpi.legal"></a><p>
40         Distributed under the Boost Software License, Version 1.0. (See accompanying
41         file LICENSE_1_0.txt or copy at &lt;ulink url="http://www.boost.org/LICENSE_1_0.txt"&gt;
42         http://www.boost.org/LICENSE_1_0.txt &lt;/ulink&gt;)
43       </p>
44 </div></div>
45 </div></div>
46 <div class="toc">
47 <p><b>Table of Contents</b></p>
48 <dl class="toc">
49 <dt><span class="section"><a href="mpi.html#mpi.introduction">Introduction</a></span></dt>
50 <dt><span class="section"><a href="mpi/getting_started.html">Getting started</a></span></dt>
51 <dd><dl>
52 <dt><span class="section"><a href="mpi/getting_started.html#mpi.getting_started.implementation">MPI Implementation</a></span></dt>
53 <dt><span class="section"><a href="mpi/getting_started.html#mpi.getting_started.config">Configure and Build</a></span></dt>
54 <dt><span class="section"><a href="mpi/getting_started.html#mpi.getting_started.using">Using Boost.MPI</a></span></dt>
55 </dl></dd>
56 <dt><span class="section"><a href="mpi/tutorial.html">Tutorial</a></span></dt>
57 <dd><dl>
58 <dt><span class="section"><a href="mpi/tutorial.html#mpi.tutorial.point_to_point">Point-to-Point communication</a></span></dt>
59 <dt><span class="section"><a href="mpi/tutorial.html#mpi.tutorial.collectives">Collective operations</a></span></dt>
60 <dt><span class="section"><a href="mpi/tutorial.html#mpi.tutorial.user_data_types">User-defined data types</a></span></dt>
61 <dt><span class="section"><a href="mpi/tutorial.html#mpi.tutorial.communicators">Communicators</a></span></dt>
62 <dt><span class="section"><a href="mpi/tutorial.html#mpi.tutorial.threading">Threads</a></span></dt>
63 <dt><span class="section"><a href="mpi/tutorial.html#mpi.tutorial.skeleton_and_content">Separating structure
64       from content</a></span></dt>
65 <dt><span class="section"><a href="mpi/tutorial.html#mpi.tutorial.performance_optimizations">Performance optimizations</a></span></dt>
66 </dl></dd>
67 <dt><span class="section"><a href="mpi/c_mapping.html">Mapping from C MPI to Boost.MPI</a></span></dt>
68 <dt><span class="section"><a href="mpi/reference.html">Reference</a></span></dt>
69 <dd><dl>
70 <dt><span class="section"><a href="mpi/reference.html#header.boost.mpi_hpp">Header &lt;boost/mpi.hpp&gt;</a></span></dt>
71 <dt><span class="section"><a href="mpi/reference.html#header.boost.mpi.allocator_hpp">Header &lt;boost/mpi/allocator.hpp&gt;</a></span></dt>
72 <dt><span class="section"><a href="mpi/reference.html#header.boost.mpi.cartesian_communicator_hpp">Header &lt;boost/mpi/cartesian_communicator.hpp&gt;</a></span></dt>
73 <dt><span class="section"><a href="mpi/reference.html#header.boost.mpi.collectives_hpp">Header &lt;boost/mpi/collectives.hpp&gt;</a></span></dt>
74 <dt><span class="section"><a href="mpi/reference.html#header.boost.mpi.collectives_fwd_hpp">Header &lt;boost/mpi/collectives_fwd.hpp&gt;</a></span></dt>
75 <dt><span class="section"><a href="mpi/reference.html#header.boost.mpi.communicator_hpp">Header &lt;boost/mpi/communicator.hpp&gt;</a></span></dt>
76 <dt><span class="section"><a href="mpi/reference.html#header.boost.mpi.config_hpp">Header &lt;boost/mpi/config.hpp&gt;</a></span></dt>
77 <dt><span class="section"><a href="mpi/reference.html#header.boost.mpi.datatype_hpp">Header &lt;boost/mpi/datatype.hpp&gt;</a></span></dt>
78 <dt><span class="section"><a href="mpi/reference.html#header.boost.mpi.datatype_fwd_hpp">Header &lt;boost/mpi/datatype_fwd.hpp&gt;</a></span></dt>
79 <dt><span class="section"><a href="mpi/reference.html#header.boost.mpi.environment_hpp">Header &lt;boost/mpi/environment.hpp&gt;</a></span></dt>
80 <dt><span class="section"><a href="mpi/reference.html#header.boost.mpi.exception_hpp">Header &lt;boost/mpi/exception.hpp&gt;</a></span></dt>
81 <dt><span class="section"><a href="mpi/reference.html#header.boost.mpi.graph_communicator_hpp">Header &lt;boost/mpi/graph_communicator.hpp&gt;</a></span></dt>
82 <dt><span class="section"><a href="mpi/reference.html#header.boost.mpi.group_hpp">Header &lt;boost/mpi/group.hpp&gt;</a></span></dt>
83 <dt><span class="section"><a href="mpi/reference.html#header.boost.mpi.inplace_hpp">Header &lt;boost/mpi/inplace.hpp&gt;</a></span></dt>
84 <dt><span class="section"><a href="mpi/reference.html#header.boost.mpi.intercommunicator_hpp">Header &lt;boost/mpi/intercommunicator.hpp&gt;</a></span></dt>
85 <dt><span class="section"><a href="mpi/reference.html#header.boost.mpi.nonblocking_hpp">Header &lt;boost/mpi/nonblocking.hpp&gt;</a></span></dt>
86 <dt><span class="section"><a href="mpi/reference.html#header.boost.mpi.operations_hpp">Header &lt;boost/mpi/operations.hpp&gt;</a></span></dt>
87 <dt><span class="section"><a href="mpi/reference.html#header.boost.mpi.packed_iarchive_hpp">Header &lt;boost/mpi/packed_iarchive.hpp&gt;</a></span></dt>
88 <dt><span class="section"><a href="mpi/reference.html#header.boost.mpi.packed_oarchive_hpp">Header &lt;boost/mpi/packed_oarchive.hpp&gt;</a></span></dt>
89 <dt><span class="section"><a href="mpi/reference.html#header.boost.mpi.python_hpp">Header &lt;boost/mpi/python.hpp&gt;</a></span></dt>
90 <dt><span class="section"><a href="mpi/reference.html#header.boost.mpi.request_hpp">Header &lt;boost/mpi/request.hpp&gt;</a></span></dt>
91 <dt><span class="section"><a href="mpi/reference.html#header.boost.mpi.skeleton_and_content_hpp">Header &lt;boost/mpi/skeleton_and_content.hpp&gt;</a></span></dt>
92 <dt><span class="section"><a href="mpi/reference.html#header.boost.mpi.skeleton_and_content_fwd_hpp">Header &lt;boost/mpi/skeleton_and_content_fwd.hpp&gt;</a></span></dt>
93 <dt><span class="section"><a href="mpi/reference.html#header.boost.mpi.status_hpp">Header &lt;boost/mpi/status.hpp&gt;</a></span></dt>
94 <dt><span class="section"><a href="mpi/reference.html#header.boost.mpi.timer_hpp">Header &lt;boost/mpi/timer.hpp&gt;</a></span></dt>
95 </dl></dd>
96 <dt><span class="section"><a href="mpi/python.html">Python Bindings</a></span></dt>
97 <dd><dl>
98 <dt><span class="section"><a href="mpi/python.html#mpi.python.quickstart">Quickstart</a></span></dt>
99 <dt><span class="section"><a href="mpi/python.html#mpi.python.user_data">Transmitting User-Defined Data</a></span></dt>
100 <dt><span class="section"><a href="mpi/python.html#mpi.python.collectives">Collectives</a></span></dt>
101 <dt><span class="section"><a href="mpi/python.html#mpi.python.skeleton_content">Skeleton/Content Mechanism</a></span></dt>
102 <dt><span class="section"><a href="mpi/python.html#mpi.python.compatibility">C++/Python MPI Compatibility</a></span></dt>
103 <dt><span class="section"><a href="mpi/python.html#mpi.python.reference">Reference</a></span></dt>
104 </dl></dd>
105 <dt><span class="section"><a href="mpi/design.html">Design Philosophy</a></span></dt>
106 <dt><span class="section"><a href="mpi/performance.html">Performance Evaluation</a></span></dt>
107 <dt><span class="section"><a href="mpi/history.html">Revision History</a></span></dt>
108 <dt><span class="section"><a href="mpi/acknowledge.html">Acknowledgments</a></span></dt>
109 </dl>
110 </div>
111 <div class="section">
112 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
113 <a name="mpi.introduction"></a><a class="link" href="mpi.html#mpi.introduction" title="Introduction">Introduction</a>
114 </h2></div></div></div>
115 <p>
116       Boost.MPI is a library for message passing in high-performance parallel applications.
117       A Boost.MPI program is one or more processes that can communicate either via
118       sending and receiving individual messages (point-to-point communication) or
119       by coordinating as a group (collective communication). Unlike communication
120       in threaded environments or using a shared-memory library, Boost.MPI processes
121       can be spread across many different machines, possibly with different operating
122       systems and underlying architectures.
123     </p>
124 <p>
125       Boost.MPI is not a completely new parallel programming library. Rather, it
126       is a C++-friendly interface to the standard Message Passing Interface (<a href="http://www-unix.mcs.anl.gov/mpi/" target="_top">MPI</a>), the most popular library
127       interface for high-performance, distributed computing. MPI defines a library
128       interface, available from C, Fortran, and C++, for which there are many <a href="http://www-unix.mcs.anl.gov/mpi/implementations.html" target="_top">MPI implementations</a>.
129       Although there exist C++ bindings for MPI, they offer little functionality
130       over the C bindings. The Boost.MPI library provides an alternative C++ interface
131       to MPI that better supports modern C++ development styles, including complete
132       support for user-defined data types and C++ Standard Library types, arbitrary
133       function objects for collective algorithms, and the use of modern C++ library
134       techniques to maintain maximal efficiency.
135     </p>
136 <p>
137       At present, Boost.MPI supports the majority of functionality in MPI 1.1. The
138       thin abstractions in Boost.MPI allow one to easily combine it with calls to
139       the underlying C MPI library. Boost.MPI currently supports:
140     </p>
141 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
142 <li class="listitem">
143           Communicators: Boost.MPI supports the creation, destruction, cloning, and
144           splitting of MPI communicators, along with manipulation of process groups.
145         </li>
146 <li class="listitem">
147           Point-to-point communication: Boost.MPI supports point-to-point communication
148           of primitive and user-defined data types with send and receive operations,
149           with blocking and non-blocking interfaces.
150         </li>
151 <li class="listitem">
152           Collective communication: Boost.MPI supports collective operations such
153           as <code class="computeroutput"><a class="link" href="boost/mpi/reduce.html" title="Function reduce">reduce</a></code>
154           and <code class="computeroutput"><a class="link" href="boost/mpi/gather.html" title="Function gather">gather</a></code>
155           with both built-in and user-defined data types and function objects.
156         </li>
157 <li class="listitem">
158           MPI Datatypes: Boost.MPI can build MPI data types for user-defined types
159           using the <a href="../../libs/serialization/doc" target="_top">Boost.Serialization</a>
160           library.
161         </li>
162 <li class="listitem">
163           Separating structure from content: Boost.MPI can transfer the shape (or
164           "skeleton") of complex data structures (lists, maps, etc.) and
165           then separately transfer their content. This facility optimizes for cases
166           where the data within a large, static data structure needs to be transmitted
167           many times.
168         </li>
169 </ul></div>
170 <p>
171       Boost.MPI can be accessed either through its native C++ bindings, or through
172       its alternative, <a class="link" href="mpi/python.html" title="Python Bindings">Python interface</a>.
173     </p>
174 </div>
175 </div>
176 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
177 <td align="left"><p><small>Last revised: December 10, 2019 at 00:26:27 GMT</small></p></td>
178 <td align="right"><div class="copyright-footer"></div></td>
179 </tr></table>
180 <hr>
181 <div class="spirit-nav">
182 <a accesskey="p" href="boost/move_if_n_1_3_26_20_16_2_4.html"><img src="../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="libraries.html"><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="mpi/getting_started.html"><img src="../../doc/src/images/next.png" alt="Next"></a>
183 </div>
184 </body>
185 </html>