boost/python
2
0
Fork 0
mirror of https://github.com/boostorg/python.git synced 2026-01-21 05:02:17 +00:00
Code Issues Projects Releases Wiki Activity
Files
98860632d4c912e3781cc4e20890b055c67ed0a7
python/develop/doc/html/numpy/reference/binary_ufunc.html

212 lines
13 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>binary_ufunc - Boost.NumPy 1.0 documentation</title>
<link rel="stylesheet" href="../_static/style.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '1.0',
COLLAPSE_MODINDEX: false,
FILE_SUFFIX: '.html'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="top" title="Boost.NumPy 1.0 documentation" href="../index.html" />
<link rel="up" title="Boost.NumPy Reference" href="index.html" />
<link rel="next" title="multi_iter" href="multi_iter.html" />
<link rel="prev" title="unary_ufunc" href="unary_ufunc.html" />
</head>
<body>
<div class="header">
<table border="0" cellpadding="7" cellspacing="0" width="100%" summary=
"header">
<tr>
<td valign="top" width="300">
<h3><a href="../index.html"><img
alt="C++ Boost" src="../_static/bpl.png" border="0"></a></h3>
</td>
<td valign="top">
<!-- <h1 align="center"><a href="../index.html">Boost.NumPy</a></h1>-->
<!-- <h2 align="center">CallPolicies Concept</h2>-->
</td>
<td>
<div id="searchbox" style="display: none">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" size="18" />
<input type="submit" value="Search" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</td>
</tr>
</table>
</div>
<hr/>
<div class="content">
<div class="navbar" style="text-align:right;">
<a class="prev" title="unary_ufunc" href="unary_ufunc.html"><img src="../_static/prev.png" alt="prev"/></a>
<a class="up" title="Boost.NumPy Reference" href="index.html"><img src="../_static/up.png" alt="up"/></a>
<a class="next" title="multi_iter" href="multi_iter.html"><img src="../_static/next.png" alt="next"/></a>
</div>
<div class="section" id="binary-ufunc">
<h1><a class="toc-backref" href="#id1">binary_ufunc</a></h1>
<div class="contents topic" id="contents">
<p class="topic-title first">Contents</p>
<ul class="simple">
<li><a class="reference internal" href="#binary-ufunc" id="id1">binary_ufunc</a><ul>
<li><a class="reference internal" href="#synopsis" id="id2">synopsis</a></li>
<li><a class="reference internal" href="#constructors" id="id3">constructors</a></li>
<li><a class="reference internal" href="#accessors" id="id4">accessors</a></li>
<li><a class="reference internal" href="#example-s" id="id5">Example(s)</a></li>
</ul>
</li>
</ul>
</div>
<p>A <tt class="docutils literal"><span class="pre">binary_ufunc</span></tt> is a struct used as an intermediate step to broadcast two arguments so that a C++ function can be converted to a ufunc like function</p>
<blockquote>
<div><tt class="docutils literal"><span class="pre">&lt;boost/python/numpy/ufunc.hpp&gt;</span></tt> contains the <tt class="docutils literal"><span class="pre">binary_ufunc</span></tt> structure definitions</div></blockquote>
<div class="section" id="synopsis">
<h2><a class="toc-backref" href="#id2">synopsis</a></h2>
<div class="highlight-c++"><div class="highlight"><pre><span class="k">namespace</span> <span class="n">boost</span>
<span class="p">{</span>
<span class="k">namespace</span> <span class="n">python</span>
<span class="p">{</span>
<span class="k">namespace</span> <span class="n">numpy</span>
<span class="p">{</span>
<span class="k">template</span> <span class="o">&lt;</span><span class="k">typename</span> <span class="n">TBinaryFunctor</span><span class="p">,</span>
<span class="k">typename</span> <span class="n">TArgument1</span><span class="o">=</span><span class="k">typename</span> <span class="n">TBinaryFunctor</span><span class="o">::</span><span class="n">first_argument_type</span><span class="p">,</span>
<span class="k">typename</span> <span class="n">TArgument2</span><span class="o">=</span><span class="k">typename</span> <span class="n">TBinaryFunctor</span><span class="o">::</span><span class="n">second_argument_type</span><span class="p">,</span>
<span class="k">typename</span> <span class="n">TResult</span><span class="o">=</span><span class="k">typename</span> <span class="n">TBinaryFunctor</span><span class="o">::</span><span class="n">result_type</span><span class="o">&gt;</span>
<span class="k">struct</span> <span class="n">binary_ufunc</span>
<span class="p">{</span>
<span class="k">static</span> <span class="n">object</span> <span class="n">call</span><span class="p">(</span><span class="n">TBinaryFunctor</span> <span class="o">&amp;</span> <span class="n">self</span><span class="p">,</span>
<span class="n">object</span> <span class="k">const</span> <span class="o">&amp;</span> <span class="n">input1</span><span class="p">,</span>
<span class="n">object</span> <span class="k">const</span> <span class="o">&amp;</span> <span class="n">input2</span><span class="p">,</span>
<span class="n">object</span> <span class="k">const</span> <span class="o">&amp;</span> <span class="n">output</span><span class="p">);</span>
<span class="k">static</span> <span class="n">object</span> <span class="nf">make</span><span class="p">();</span>
<span class="p">};</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
</div>
</div>
<div class="section" id="constructors">
<h2><a class="toc-backref" href="#id3">constructors</a></h2>
<div class="highlight-c++"><div class="highlight"><pre><span class="k">struct</span> <span class="n">example_binary_ufunc</span>
<span class="p">{</span>
<span class="k">typedef</span> <span class="n">any_valid</span> <span class="n">first_argument_type</span><span class="p">;</span>
<span class="k">typedef</span> <span class="n">any_valid</span> <span class="n">second_argument_type</span><span class="p">;</span>
<span class="k">typedef</span> <span class="n">any_valid</span> <span class="n">result_type</span><span class="p">;</span>
<span class="p">};</span>
</pre></div>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Requirements:</th><td class="field-body">The <tt class="docutils literal"><span class="pre">any_valid</span></tt> type must be defined using typedef as a valid C++ type in order to use the struct methods correctly</td>
</tr>
<tr class="field-even field"><th class="field-name">Note:</th><td class="field-body">The struct must be exposed as a Python class, and an instance of the class must be created to use the <tt class="docutils literal"><span class="pre">call</span></tt> method corresponding to the <tt class="docutils literal"><span class="pre">__call__</span></tt> attribute of the Python object</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="accessors">
<h2><a class="toc-backref" href="#id4">accessors</a></h2>
<div class="highlight-c++"><div class="highlight"><pre><span class="k">template</span> <span class="o">&lt;</span><span class="k">typename</span> <span class="n">TBinaryFunctor</span><span class="p">,</span>
<span class="k">typename</span> <span class="n">TArgument1</span><span class="o">=</span><span class="k">typename</span> <span class="n">TBinaryFunctor</span><span class="o">::</span><span class="n">first_argument_type</span><span class="p">,</span>
<span class="k">typename</span> <span class="n">TArgument2</span><span class="o">=</span><span class="k">typename</span> <span class="n">TBinaryFunctor</span><span class="o">::</span><span class="n">second_argument_type</span><span class="p">,</span>
<span class="k">typename</span> <span class="n">TResult</span><span class="o">=</span><span class="k">typename</span> <span class="n">TBinaryFunctor</span><span class="o">::</span><span class="n">result_type</span><span class="o">&gt;</span>
<span class="k">static</span> <span class="n">object</span> <span class="n">call</span><span class="p">(</span><span class="n">TBinaryFunctor</span> <span class="o">&amp;</span> <span class="n">self</span><span class="p">,</span>
<span class="n">object</span> <span class="k">const</span> <span class="o">&amp;</span> <span class="n">input</span><span class="p">,</span>
<span class="n">object</span> <span class="k">const</span> <span class="o">&amp;</span> <span class="n">output</span><span class="p">);</span>
</pre></div>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Requires:</th><td class="field-body">Typenames <tt class="docutils literal"><span class="pre">TBinaryFunctor</span></tt> and optionally <tt class="docutils literal"><span class="pre">TArgument1</span></tt> and <tt class="docutils literal"><span class="pre">TArgument2</span></tt> for argument type and <tt class="docutils literal"><span class="pre">TResult</span></tt> for result type</td>
</tr>
<tr class="field-even field"><th class="field-name">Effects:</th><td class="field-body">Passes a Python object to the underlying C++ functor after broadcasting its arguments</td>
</tr>
</tbody>
</table>
<div class="highlight-c++"><div class="highlight"><pre><span class="k">template</span> <span class="o">&lt;</span><span class="k">typename</span> <span class="n">TBinaryFunctor</span><span class="p">,</span>
<span class="k">typename</span> <span class="n">TArgument1</span><span class="o">=</span><span class="k">typename</span> <span class="n">TBinaryFunctor</span><span class="o">::</span><span class="n">first_argument_type</span><span class="p">,</span>
<span class="k">typename</span> <span class="n">TArgument2</span><span class="o">=</span><span class="k">typename</span> <span class="n">TBinaryFunctor</span><span class="o">::</span><span class="n">second_argument_type</span><span class="p">,</span>
<span class="k">typename</span> <span class="n">TResult</span><span class="o">=</span><span class="k">typename</span> <span class="n">TBinaryFunctor</span><span class="o">::</span><span class="n">result_type</span><span class="o">&gt;</span>
<span class="k">static</span> <span class="n">object</span> <span class="n">make</span><span class="p">();</span>
</pre></div>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Requires:</th><td class="field-body">Typenames <tt class="docutils literal"><span class="pre">TBinaryFunctor</span></tt> and optionally <tt class="docutils literal"><span class="pre">TArgument1</span></tt> and <tt class="docutils literal"><span class="pre">TArgument2</span></tt> for argument type and <tt class="docutils literal"><span class="pre">TResult</span></tt> for result type</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">A Python function object to call the overloaded () operator in the struct (in typical usage)</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="example-s">
<h2><a class="toc-backref" href="#id5">Example(s)</a></h2>
<dl class="docutils">
<dt>::</dt>
<dd><p class="first">namespace p = boost::python;
namespace np = boost::python::numpy;</p>
<p>struct BinarySquare
{</p>
<blockquote>
<div><p>typedef double first_argument_type;
typedef double second_argument_type;
typedef double result_type;</p>
<p>double operator()(double a,double b) const { return (a*a + b*b) ; }</p>
</div></blockquote>
<p>};</p>
<p class="last">p::object ud = p::class_&lt;BinarySquare, boost::shared_ptr&lt;BinarySquare&gt; &gt;(&#8220;BinarySquare&#8221;).def(&#8220;__call__&#8221;, np::binary_ufunc&lt;BinarySquare&gt;::make());
p::object inst = ud();
result_array = inst.attr(&#8220;__call__&#8221;)(demo_array,demo_array) ;
std::cout &lt;&lt; &#8220;Square of list with binary ufunc is &#8221; &lt;&lt; p::extract &lt;char const * &gt; (p::str(result_array)) &lt;&lt; std::endl ;</p>
</dd>
</dl>
</div>
</div>
<div class="navbar" style="text-align:right;">
<a class="prev" title="unary_ufunc" href="unary_ufunc.html"><img src="../_static/prev.png" alt="prev"/></a>
<a class="up" title="Boost.NumPy Reference" href="index.html"><img src="../_static/up.png" alt="up"/></a>
<a class="next" title="multi_iter" href="multi_iter.html"><img src="../_static/next.png" alt="next"/></a>
</div>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink