xan/awips2
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
awips2/pythonPackages/scientific/Doc/Reference/Scientific.BSP.ParSequence-class.html
root 8e80217e59 Initial revision of AWIPS2 11.9.0-7p5 
Former-commit-id: a02aeb236c [formerly 9f19e3f712] [formerly 06a8b51d6d [formerly 64fa9254b946eae7e61bbc3f513b7c3696c4f54f]]
Former-commit-id: 06a8b51d6d
Former-commit-id: 3360eb6c5f
2012-01-06 08:55:05 -06:00

372 lines
14 KiB
HTML
Executable file
Raw Blame History

<?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.ParSequence</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;ParSequence
</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.ParSequence-class.html"
target="_top">no&nbsp;frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class ParSequence</h1><p class="nomargin-top"></p>
<pre class="base-tree">
object --+
|
<a href="Scientific.BSP.ParValue-class.html">ParValue</a> --+
|
<strong class="uidshort">ParSequence</strong>
</pre>
<dl><dt>Known Subclasses:</dt>
<dd>
<ul class="subclass-list">
<li><a href="Scientific.BSP.ParRootSequence-class.html">ParRootSequence</a></li> </ul>
</dd></dl>
<hr />
<p>Global distributed sequence</p>
<p>The local value of a ParSequence 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">any</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Scientific.BSP.ParSequence-class.html#__getitem__" class="summary-sig-name">__getitem__</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">item</span>)</span><br />
Returns:
the element referred to by the index, if it is in the local subset</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">&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.ParSequence-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 width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code>int</code></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Scientific.BSP.ParSequence-class.html#totalLength" class="summary-sig-name">totalLength</a>(<span class="summary-sig-arg">self</span>)</span><br />
Returns:
the sum of the lengths of the local values</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#__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="__getitem__"></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">__getitem__</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">item</span>)</span>
<br /><em class="fname">(Indexing operator)</em>
</h3>
</td><td align="right" valign="top"
>&nbsp;
</td>
</tr></table>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>item</code></strong> (<code>int</code> or <a href="Scientific.BSP.ParIndex-class.html"
class="link">ParIndex</a>) - an index into the total sequence</li>
</ul></dd>
<dt>Returns: any</dt>
<dd>the element referred to by the index, if it is in the local
subset</dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>IndexError</strong></code> - if the index refers to an item on another processor</li>
</ul></dd>
<dt>Overrides:
<a href="Scientific.BSP.ParValue-class.html#__getitem__">ParValue.__getitem__</a>
</dt>
</dl>
</td></tr></table>
</div>
<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> (arbitrary sequence object) - the full sequence, equal to the concatenation of the local values
of all processors</li>
</ul></dd>
<dt>Overrides:
object.__init__
</dt>
</dl>
</td></tr></table>
</div>
<a name="totalLength"></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">totalLength</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
>&nbsp;
</td>
</tr></table>
<dl class="fields">
<dt>Returns: <code>int</code></dt>
<dd>the sum of the lengths of the local values</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>&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>
Reference in a new issue View git blame Copy permalink