blob: 29b47833b089c827a950199127a9f5af32a93739 [file] [log] [blame]
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Struct template is_mpi_op</title>
<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
<link rel="up" href="../../mpi/reference.html#header.boost.mpi.operations_hpp" title="Header &lt;boost/mpi/operations.hpp&gt;">
<link rel="prev" href="bitwise_xor.html" title="Struct template bitwise_xor">
<link rel="next" href="packed_iarchive.html" title="Class packed_iarchive">
</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="bitwise_xor.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../mpi/reference.html#header.boost.mpi.operations_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="packed_iarchive.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="refentry">
<a name="boost.mpi.is_mpi_op"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Struct template is_mpi_op</span></h2>
<p>boost::mpi::is_mpi_op &#8212; Determine if a function object has an associated <code class="computeroutput">MPI_Op</code>. </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/reference.html#header.boost.mpi.operations_hpp" title="Header &lt;boost/mpi/operations.hpp&gt;">boost/mpi/operations.hpp</a>&gt;
</span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Op<span class="special">,</span> <span class="keyword">typename</span> T<span class="special">&gt;</span>
<span class="keyword">struct</span> <a class="link" href="is_mpi_op.html" title="Struct template is_mpi_op">is_mpi_op</a> <span class="special">{</span>
<span class="special">}</span><span class="special">;</span></pre></div>
<div class="refsect1">
<a name="id2060468"></a><h2>Description</h2>
<p>This trait determines if a function object type <code class="computeroutput">Op</code>, when used with argument type <code class="computeroutput">T</code>, has an associated <code class="computeroutput">MPI_Op</code>. If so, <code class="computeroutput">is_mpi_op&lt;Op,T&gt;</code> will derive from <code class="computeroutput">mpl::false_</code> and will contain a static member function <code class="computeroutput">op</code> that takes no arguments but returns the associated <code class="computeroutput">MPI_Op</code> value. For instance, <code class="computeroutput">is_mpi_op&lt;std::plus&lt;int&gt;</code>,int&gt;op() returns <code class="computeroutput">MPI_SUM</code>.</p>
<p>Users may specialize <code class="computeroutput">is_mpi_op</code> for any other class templates that map onto operations that have <code class="computeroutput">MPI_Op</code> equivalences, such as bitwise OR, logical and, or maximum. However, users are encouraged to use the standard function objects in the <code class="computeroutput">functional</code> and <code class="computeroutput">boost/mpi/operations.hpp</code> headers whenever possible. For function objects that are class templates with a single template parameter, it may be easier to specialize <code class="computeroutput">is_builtin_mpi_op</code>. </p>
</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="bitwise_xor.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../mpi/reference.html#header.boost.mpi.operations_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="packed_iarchive.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>