336 lines
13 KiB
HTML
Executable file
336 lines
13 KiB
HTML
Executable file
<?xml version="1.0" encoding="ascii"?>
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
"DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
<head>
|
|
<title>Scientific.BSP.ParAccumulator</title>
|
|
<link rel="stylesheet" href="epydoc.css" type="text/css" />
|
|
<script type="text/javascript" src="epydoc.js"></script>
|
|
</head>
|
|
|
|
<body bgcolor="white" text="black" link="blue" vlink="#204080"
|
|
alink="#204080">
|
|
<!-- ==================== NAVIGATION BAR ==================== -->
|
|
<table class="navbar" border="0" width="100%" cellpadding="0"
|
|
bgcolor="#a0c0ff" cellspacing="0">
|
|
<tr valign="middle">
|
|
<!-- Home link -->
|
|
<th> <a
|
|
href="Scientific-module.html">Home</a> </th>
|
|
|
|
<!-- Tree link -->
|
|
<th> <a
|
|
href="module-tree.html">Trees</a> </th>
|
|
|
|
<!-- Index link -->
|
|
<th> <a
|
|
href="identifier-index.html">Indices</a> </th>
|
|
|
|
<!-- Help link -->
|
|
<th> <a
|
|
href="help.html">Help</a> </th>
|
|
|
|
<!-- Project homepage -->
|
|
<th class="navbar" align="right" width="100%">
|
|
<table border="0" cellpadding="0" cellspacing="0">
|
|
<tr><th class="navbar" align="center"
|
|
><a class="navbar" target="_top" href="http://dirac.cnrs-orleans.fr/ScientificPython/">Scientific Python</a></th>
|
|
</tr></table></th>
|
|
</tr>
|
|
</table>
|
|
<table width="100%" cellpadding="0" cellspacing="0">
|
|
<tr valign="top">
|
|
<td width="100%">
|
|
<span class="breadcrumbs">
|
|
<a href="Scientific-module.html">Package Scientific</a> ::
|
|
<a href="Scientific.BSP-module.html">Package BSP</a> ::
|
|
Class ParAccumulator
|
|
</span>
|
|
</td>
|
|
<td>
|
|
<table cellpadding="0" cellspacing="0">
|
|
<!-- hide/show private -->
|
|
<tr><td align="right"><span class="options"
|
|
>[<a href="frames.html" target="_top">frames</a
|
|
>] | <a href="Scientific.BSP.ParAccumulator-class.html"
|
|
target="_top">no frames</a>]</span></td></tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<!-- ==================== CLASS DESCRIPTION ==================== -->
|
|
<h1 class="epydoc">Class ParAccumulator</h1><p class="nomargin-top"></p>
|
|
<pre class="base-tree">
|
|
object --+
|
|
|
|
|
<a href="Scientific.BSP.ParValue-class.html">ParValue</a> --+
|
|
|
|
|
<strong class="uidshort">ParAccumulator</strong>
|
|
</pre>
|
|
|
|
<hr />
|
|
<p>Global accumulator</p>
|
|
<p>ParAccumulator objects are used to perform iterative reduction
|
|
operations in loops. The initial local value is zero (i.e. the passed-in
|
|
zero object, not the number 0), which is modified by subsequent calls to
|
|
the method addValue.</p>
|
|
|
|
<!-- ==================== INSTANCE METHODS ==================== -->
|
|
<a name="section-InstanceMethods"></a>
|
|
<table class="summary" border="1" cellpadding="3"
|
|
cellspacing="0" width="100%" bgcolor="white">
|
|
<tr bgcolor="#70b0f0" class="table-header">
|
|
<td align="left" colspan="2" class="table-header">
|
|
<span class="table-header">Instance Methods</span></td>
|
|
</tr>
|
|
<tr>
|
|
<td width="15%" align="right" valign="top" class="summary">
|
|
<span class="summary-type"> </span>
|
|
</td><td class="summary">
|
|
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td><span class="summary-sig"><a href="Scientific.BSP.ParAccumulator-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
|
|
<span class="summary-sig-arg">operator</span>,
|
|
<span class="summary-sig-arg">zero</span>)</span><br />
|
|
x.__init__(...) initializes x; see x.__class__.__doc__ for signature</td>
|
|
<td align="right" valign="top">
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td width="15%" align="right" valign="top" class="summary">
|
|
<span class="summary-type"> </span>
|
|
</td><td class="summary">
|
|
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td><span class="summary-sig"><a name="addValue"></a><span class="summary-sig-name">addValue</span>(<span class="summary-sig-arg">self</span>,
|
|
<span class="summary-sig-arg">value</span>)</span><br />
|
|
Replace the internal value of the accumulator by internal_value =
|
|
operator(internal_value, value).</td>
|
|
<td align="right" valign="top">
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td width="15%" align="right" valign="top" class="summary">
|
|
<span class="summary-type"><a href="Scientific.BSP.ParValue-class.html"
|
|
class="link">ParValue</a></span>
|
|
</td><td class="summary">
|
|
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td><span class="summary-sig"><a href="Scientific.BSP.ParAccumulator-class.html#calculateTotal" class="summary-sig-name">calculateTotal</a>(<span class="summary-sig-arg">self</span>)</span><br />
|
|
Returns:
|
|
a reduction over the local values on all processors</td>
|
|
<td align="right" valign="top">
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td colspan="2" class="summary">
|
|
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="Scientific.BSP.ParValue-class.html">ParValue</a></code></b>:
|
|
<code><a href="Scientific.BSP.ParValue-class.html#__add__">__add__</a></code>,
|
|
<code><a href="Scientific.BSP.ParValue-class.html#__call__">__call__</a></code>,
|
|
<code><a href="Scientific.BSP.ParValue-class.html#__div__">__div__</a></code>,
|
|
<code><a href="Scientific.BSP.ParValue-class.html#__divmod__">__divmod__</a></code>,
|
|
<code><a href="Scientific.BSP.ParValue-class.html#__eq__">__eq__</a></code>,
|
|
<code><a href="Scientific.BSP.ParValue-class.html#__ge__">__ge__</a></code>,
|
|
<code><a href="Scientific.BSP.ParValue-class.html#__getattr__">__getattr__</a></code>,
|
|
<code><a href="Scientific.BSP.ParValue-class.html#__getitem__">__getitem__</a></code>,
|
|
<code><a href="Scientific.BSP.ParValue-class.html#__gt__">__gt__</a></code>,
|
|
<code><a href="Scientific.BSP.ParValue-class.html#__le__">__le__</a></code>,
|
|
<code><a href="Scientific.BSP.ParValue-class.html#__len__">__len__</a></code>,
|
|
<code><a href="Scientific.BSP.ParValue-class.html#__lt__">__lt__</a></code>,
|
|
<code><a href="Scientific.BSP.ParValue-class.html#__mod__">__mod__</a></code>,
|
|
<code><a href="Scientific.BSP.ParValue-class.html#__mul__">__mul__</a></code>,
|
|
<code><a href="Scientific.BSP.ParValue-class.html#__ne__">__ne__</a></code>,
|
|
<code><a href="Scientific.BSP.ParValue-class.html#__neg__">__neg__</a></code>,
|
|
<code><a href="Scientific.BSP.ParValue-class.html#__nonzero__">__nonzero__</a></code>,
|
|
<code><a href="Scientific.BSP.ParValue-class.html#__pow__">__pow__</a></code>,
|
|
<code><a href="Scientific.BSP.ParValue-class.html#__repr__">__repr__</a></code>,
|
|
<code><a href="Scientific.BSP.ParValue-class.html#__str__">__str__</a></code>,
|
|
<code><a href="Scientific.BSP.ParValue-class.html#__sub__">__sub__</a></code>,
|
|
<code><a href="Scientific.BSP.ParValue-class.html#accumulate">accumulate</a></code>,
|
|
<code><a href="Scientific.BSP.ParValue-class.html#alltrue">alltrue</a></code>,
|
|
<code><a href="Scientific.BSP.ParValue-class.html#anytrue">anytrue</a></code>,
|
|
<code><a href="Scientific.BSP.ParValue-class.html#broadcast">broadcast</a></code>,
|
|
<code><a href="Scientific.BSP.ParValue-class.html#fullExchange">fullExchange</a></code>,
|
|
<code><a href="Scientific.BSP.ParValue-class.html#get">get</a></code>,
|
|
<code><a href="Scientific.BSP.ParValue-class.html#getattr">getattr</a></code>,
|
|
<code><a href="Scientific.BSP.ParValue-class.html#map">map</a></code>,
|
|
<code><a href="Scientific.BSP.ParValue-class.html#put">put</a></code>,
|
|
<code><a href="Scientific.BSP.ParValue-class.html#reduce">reduce</a></code>
|
|
</p>
|
|
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
|
|
<code>__delattr__</code>,
|
|
<code>__getattribute__</code>,
|
|
<code>__hash__</code>,
|
|
<code>__new__</code>,
|
|
<code>__reduce__</code>,
|
|
<code>__reduce_ex__</code>,
|
|
<code>__setattr__</code>
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<!-- ==================== CLASS VARIABLES ==================== -->
|
|
<a name="section-ClassVariables"></a>
|
|
<table class="summary" border="1" cellpadding="3"
|
|
cellspacing="0" width="100%" bgcolor="white">
|
|
<tr bgcolor="#70b0f0" class="table-header">
|
|
<td align="left" colspan="2" class="table-header">
|
|
<span class="table-header">Class Variables</span></td>
|
|
</tr>
|
|
<tr>
|
|
<td colspan="2" class="summary">
|
|
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="Scientific.BSP.ParValue-class.html">ParValue</a></code></b>:
|
|
<code><a href="Scientific.BSP.ParValue-class.html#is_parvalue">is_parvalue</a></code>
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<!-- ==================== PROPERTIES ==================== -->
|
|
<a name="section-Properties"></a>
|
|
<table class="summary" border="1" cellpadding="3"
|
|
cellspacing="0" width="100%" bgcolor="white">
|
|
<tr bgcolor="#70b0f0" class="table-header">
|
|
<td align="left" colspan="2" class="table-header">
|
|
<span class="table-header">Properties</span></td>
|
|
</tr>
|
|
<tr>
|
|
<td colspan="2" class="summary">
|
|
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
|
|
<code>__class__</code>
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<!-- ==================== METHOD DETAILS ==================== -->
|
|
<a name="section-MethodDetails"></a>
|
|
<table class="details" border="1" cellpadding="3"
|
|
cellspacing="0" width="100%" bgcolor="white">
|
|
<tr bgcolor="#70b0f0" class="table-header">
|
|
<td align="left" colspan="2" class="table-header">
|
|
<span class="table-header">Method Details</span></td>
|
|
</tr>
|
|
</table>
|
|
<a name="__init__"></a>
|
|
<div>
|
|
<table class="details" border="1" cellpadding="3"
|
|
cellspacing="0" width="100%" bgcolor="white">
|
|
<tr><td>
|
|
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
<tr valign="top"><td>
|
|
<h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
|
|
<span class="sig-arg">operator</span>,
|
|
<span class="sig-arg">zero</span>)</span>
|
|
<br /><em class="fname">(Constructor)</em>
|
|
</h3>
|
|
</td><td align="right" valign="top"
|
|
>
|
|
</td>
|
|
</tr></table>
|
|
|
|
<p>x.__init__(...) initializes x; see x.__class__.__doc__ for
|
|
signature</p>
|
|
<dl class="fields">
|
|
<dt>Parameters:</dt>
|
|
<dd><ul class="nomargin-top">
|
|
<li><strong class="pname"><code>operator</code></strong> (function of two variables) - a local function taking two arguments and returning one argument
|
|
of the same type</li>
|
|
<li><strong class="pname"><code>zero</code></strong> - the initial value for reduction</li>
|
|
</ul></dd>
|
|
<dt>Overrides:
|
|
object.__init__
|
|
</dt>
|
|
</dl>
|
|
</td></tr></table>
|
|
</div>
|
|
<a name="calculateTotal"></a>
|
|
<div>
|
|
<table class="details" border="1" cellpadding="3"
|
|
cellspacing="0" width="100%" bgcolor="white">
|
|
<tr><td>
|
|
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
<tr valign="top"><td>
|
|
<h3 class="epydoc"><span class="sig"><span class="sig-name">calculateTotal</span>(<span class="sig-arg">self</span>)</span>
|
|
</h3>
|
|
</td><td align="right" valign="top"
|
|
>
|
|
</td>
|
|
</tr></table>
|
|
|
|
|
|
<dl class="fields">
|
|
<dt>Returns: <a href="Scientific.BSP.ParValue-class.html"
|
|
class="link">ParValue</a></dt>
|
|
<dd>a reduction over the local values on all processors</dd>
|
|
</dl>
|
|
</td></tr></table>
|
|
</div>
|
|
<br />
|
|
<!-- ==================== NAVIGATION BAR ==================== -->
|
|
<table class="navbar" border="0" width="100%" cellpadding="0"
|
|
bgcolor="#a0c0ff" cellspacing="0">
|
|
<tr valign="middle">
|
|
<!-- Home link -->
|
|
<th> <a
|
|
href="Scientific-module.html">Home</a> </th>
|
|
|
|
<!-- Tree link -->
|
|
<th> <a
|
|
href="module-tree.html">Trees</a> </th>
|
|
|
|
<!-- Index link -->
|
|
<th> <a
|
|
href="identifier-index.html">Indices</a> </th>
|
|
|
|
<!-- Help link -->
|
|
<th> <a
|
|
href="help.html">Help</a> </th>
|
|
|
|
<!-- Project homepage -->
|
|
<th class="navbar" align="right" width="100%">
|
|
<table border="0" cellpadding="0" cellspacing="0">
|
|
<tr><th class="navbar" align="center"
|
|
><a class="navbar" target="_top" href="http://dirac.cnrs-orleans.fr/ScientificPython/">Scientific Python</a></th>
|
|
</tr></table></th>
|
|
</tr>
|
|
</table>
|
|
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
|
<tr>
|
|
<td align="left" class="footer">
|
|
Generated by Epydoc 3.0 on Tue Oct 28 14:16:02 2008
|
|
</td>
|
|
<td align="right" class="footer">
|
|
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
|
>http://epydoc.sourceforge.net</a>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<script type="text/javascript">
|
|
<!--
|
|
// Private objects are initially displayed (because if
|
|
// javascript is turned off then we want them to be
|
|
// visible); but by default, we want to hide them. So hide
|
|
// them unless we have a cookie that says to show them.
|
|
checkCookie();
|
|
// -->
|
|
</script>
|
|
</body>
|
|
</html>
|