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=UTF-8"> 5<title>Function template register_serialized</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="../../../mpi/reference.html#header.boost.mpi.python_hpp" title="Header <boost/mpi/python.hpp>"> 10<link rel="prev" href="../packed_oarchive.html" title="Class packed_oarchive"> 11<link rel="next" href="regist_1_3_27_7_20_2_1_1_2.html" title="Function template register_skeleton_and_content"> 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="../packed_oarchive.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../mpi/reference.html#header.boost.mpi.python_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="regist_1_3_27_7_20_2_1_1_2.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> 25</div> 26<div class="refentry"> 27<a name="boost.mpi.python.register_serialized"></a><div class="titlepage"></div> 28<div class="refnamediv"> 29<h2><span class="refentrytitle">Function template register_serialized</span></h2> 30<p>boost::mpi::python::register_serialized — Register the type T for direct serialization within Boost.MPI. </p> 31</div> 32<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> 33<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.python_hpp" title="Header <boost/mpi/python.hpp>">boost/mpi/python.hpp</a>> 34 35</span> 36<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> 37 <span class="keyword">void</span> <span class="identifier">register_serialized</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&</span> value <span class="special">=</span> <span class="identifier">T</span><span class="special">(</span><span class="special">)</span><span class="special">,</span> <span class="identifier">PyTypeObject</span> <span class="special">*</span> type <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre></div> 38<div class="refsect1"> 39<a name="id-1.3.27.7.21.4.4"></a><h2>Description</h2> 40<p>The <code class="computeroutput">register_serialized</code> function registers a C++ type for direct serialization within Boost.MPI. Direct serialization elides the use of the Python <code class="computeroutput">pickle</code> package when serializing Python objects that represent C++ values. Direct serialization can be beneficial both to improve serialization performance (Python pickling can be very inefficient) and to permit serialization for Python-wrapped C++ objects that do not support pickling.</p> 41<p> 42</p> 43<div class="variablelist"><table border="0" class="variablelist compact"> 44<colgroup> 45<col align="left" valign="top"> 46<col> 47</colgroup> 48<tbody><tr> 49<td><p><span class="term">Parameters:</span></p></td> 50<td><div class="variablelist"><table border="0" class="variablelist compact"> 51<colgroup> 52<col align="left" valign="top"> 53<col> 54</colgroup> 55<tbody> 56<tr> 57<td><p><span class="term"><code class="computeroutput">type</code></span></p></td> 58<td><p>The Python type associated with the C++ type <code class="computeroutput">T</code>. If not provided, it will be computed from the same value <code class="computeroutput">value</code>. </p></td> 59</tr> 60<tr> 61<td><p><span class="term"><code class="computeroutput">value</code></span></p></td> 62<td><p>A sample value of the type <code class="computeroutput">T</code>. This may be used to compute the Python type associated with the C++ type <code class="computeroutput">T</code>.</p></td> 63</tr> 64</tbody> 65</table></div></td> 66</tr></tbody> 67</table></div> 68</div> 69</div> 70<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 71<td align="left"></td> 72<td align="right"><div class="copyright-footer">Copyright © 2005-2007 Douglas Gregor, 73 Matthias Troyer, Trustees of Indiana University<p> 74 Distributed under the Boost Software License, Version 1.0. (See accompanying 75 file LICENSE_1_0.txt or copy at <ulink url="http://www.boost.org/LICENSE_1_0.txt"> 76 http://www.boost.org/LICENSE_1_0.txt </ulink>) 77 </p> 78</div></td> 79</tr></table> 80<hr> 81<div class="spirit-nav"> 82<a accesskey="p" href="../packed_oarchive.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../mpi/reference.html#header.boost.mpi.python_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="regist_1_3_27_7_20_2_1_1_2.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> 83</div> 84</body> 85</html> 86
