awips2/pythonPackages/scientific/Doc/Reference/Scientific.BSP.ParRootSequence-class.html
2016-06-27 15:10:22 -05:00

280 lines
12 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.ParRootSequence</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>&nbsp;&nbsp;&nbsp;<a
href="Scientific-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Tree link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Index link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Help link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</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&nbsp;Scientific</a> ::
<a href="Scientific.BSP-module.html">Package&nbsp;BSP</a> ::
Class&nbsp;ParRootSequence
</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
>]&nbsp;|&nbsp;<a href="Scientific.BSP.ParRootSequence-class.html"
target="_top">no&nbsp;frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class ParRootSequence</h1><p class="nomargin-top"></p>
<pre class="base-tree">
object --+
|
<a href="Scientific.BSP.ParValue-class.html">ParValue</a> --+
|
<a href="Scientific.BSP.ParSequence-class.html">ParSequence</a> --+
|
<strong class="uidshort">ParRootSequence</strong>
</pre>
<hr />
<p>Global distributed sequence with data taken from processor 0</p>
<p>The local value of a ParRootSequence object is a slice of the input
sequence, which is constructed such that the concatenation of the local
values of all processors equals the input sequence while making the
number of elements on each processor as equal as possible.</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">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Scientific.BSP.ParRootSequence-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">full_sequence</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 colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="Scientific.BSP.ParSequence-class.html">ParSequence</a></code></b>:
<code><a href="Scientific.BSP.ParSequence-class.html#__getitem__">__getitem__</a></code>,
<code><a href="Scientific.BSP.ParSequence-class.html#totalLength">totalLength</a></code>
</p>
<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#__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">full_sequence</span>)</span>
<br /><em class="fname">(Constructor)</em>
</h3>
</td><td align="right" valign="top"
>&nbsp;
</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>full_sequence</code></strong> (<a href="Scientific.BSP.ParValue-class.html"
class="link">ParValue</a>) - on processor 0: the full sequence, equal to the concatenation of
the local values of all processors. The local values on the other
processors are not used.</li>
</ul></dd>
<dt>Overrides:
object.__init__
</dt>
</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>&nbsp;&nbsp;&nbsp;<a
href="Scientific-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Tree link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Index link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Help link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</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>