Documentation changes. We have barely begun.....
This commit is contained in:
Salvatore Filippone
2011-12-16 16:45:25 +00:00
parent c730f15b58
commit 844a942947
243 changed files with 14860 additions and 15182 deletions
+70 -72
View File
@@ -7,8 +7,8 @@ original version by: Nikos Drakos, CBLU, University of Leeds
Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
<HTML>
<HEAD>
<TITLE>psb_gather -- Gather Global Dense Matrix</TITLE>
<META NAME="description" CONTENT="psb_gather -- Gather Global Dense Matrix">
<TITLE>psb_scatter -- Scatter Global Dense Matrix</TITLE>
<META NAME="description" CONTENT="psb_scatter -- Scatter Global Dense Matrix">
<META NAME="keywords" CONTENT="userhtml">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
@@ -18,61 +18,59 @@ original version by: Nikos Drakos, CBLU, University of Leeds
<LINK REL="STYLESHEET" HREF="userhtml.css">
<LINK REL="next" HREF="node44.html">
<LINK REL="previous" HREF="node42.html">
<LINK REL="up" HREF="node40.html">
<LINK REL="up" HREF="node39.html">
<LINK REL="next" HREF="node44.html">
</HEAD>
<BODY >
<!--Navigation Panel-->
<A NAME="tex2html710"
<A NAME="tex2html706"
HREF="node44.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
<A NAME="tex2html706"
HREF="node40.html">
<A NAME="tex2html702"
HREF="node39.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
<A NAME="tex2html700"
<A NAME="tex2html698"
HREF="node42.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
<A NAME="tex2html708"
<A NAME="tex2html704"
HREF="node1.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
<BR>
<B> Next:</B> <A NAME="tex2html711"
HREF="node44.html">psb_scatter Scatter</A>
<B> Up:</B> <A NAME="tex2html707"
HREF="node40.html">Communication routines</A>
<B> Previous:</B> <A NAME="tex2html701"
HREF="node42.html">psb_ovrl Overlap</A>
&nbsp; <B> <A NAME="tex2html709"
<B> Next:</B> <A NAME="tex2html707"
HREF="node44.html">Data management routines</A>
<B> Up:</B> <A NAME="tex2html703"
HREF="node39.html">Communication routines</A>
<B> Previous:</B> <A NAME="tex2html699"
HREF="node42.html">psb_gather Gather</A>
&nbsp; <B> <A NAME="tex2html705"
HREF="node1.html">Contents</A></B>
<BR>
<BR>
<!--End of Navigation Panel-->
<H2><A NAME="SECTION00063000000000000000">
psb_gather -- Gather Global Dense Matrix</A>
<H2><A NAME="SECTION00064000000000000000">
psb_scatter -- Scatter Global Dense Matrix</A>
</H2>
<P>
These subroutines collect the portions of global dense matrix
distributed over all process into one single array stored on one
process.
These subroutines scatters the portions of global dense matrix owned
by a process to all the processes in the processes grid.
<P>
<BR><P></P>
<DIV ALIGN="CENTER">
<!-- MATH
\begin{displaymath}
glob\_x \leftarrow collect(loc\_x_i)
loc\_x_i \leftarrow scatter(glob\_x)
\end{displaymath}
-->
<IMG
WIDTH="163" HEIGHT="28" BORDER="0"
SRC="img76.png"
ALT="\begin{displaymath}glob\_x \leftarrow collect(loc\_x_i) \end{displaymath}">
WIDTH="168" HEIGHT="28" BORDER="0"
SRC="img84.png"
ALT="\begin{displaymath}loc\_x_i \leftarrow scatter(glob\_x) \end{displaymath}">
</DIV>
<BR CLEAR="ALL">
<P></P>
@@ -80,19 +78,19 @@ where:
<DL>
<DT><STRONG><IMG
WIDTH="47" HEIGHT="30" ALIGN="MIDDLE" BORDER="0"
SRC="img77.png"
SRC="img76.png"
ALT="$glob\_x$"></STRONG></DT>
<DD>is the global submatrix <!-- MATH
<DD>is the global matrix <!-- MATH
$glob\_x_{1:m,1:n}$
-->
<IMG
WIDTH="90" HEIGHT="30" ALIGN="MIDDLE" BORDER="0"
SRC="img78.png"
SRC="img77.png"
ALT="$glob\_x_{1:m,1:n}$">
</DD>
<DT><STRONG><IMG
WIDTH="44" HEIGHT="30" ALIGN="MIDDLE" BORDER="0"
SRC="img79.png"
SRC="img78.png"
ALT="$loc\_x_i$"></STRONG></DT>
<DD>is the local portion of global dense matrix on
process <IMG
@@ -101,42 +99,42 @@ process <IMG
ALT="$i$">.
</DD>
<DT><STRONG><IMG
WIDTH="48" HEIGHT="15" ALIGN="BOTTOM" BORDER="0"
SRC="img80.png"
ALT="$collect$"></STRONG></DT>
<DD>is the collect function.
WIDTH="53" HEIGHT="14" ALIGN="BOTTOM" BORDER="0"
SRC="img85.png"
ALT="$scatter$"></STRONG></DT>
<DD>is the scatter function.
</DD>
</DL>
<P>
<BR><P></P>
<DIV ALIGN="CENTER"><A NAME="2763"></A>
<DIV ALIGN="CENTER"><A NAME="2692"></A>
<TABLE>
<CAPTION><STRONG>Table 15:</STRONG>
<CAPTION><STRONG>Table 16:</STRONG>
Data types</CAPTION>
<TR><TD>
<DIV ALIGN="CENTER">
<TABLE CELLPADDING=3 BORDER="1" ALIGN="CENTER">
<TR><TD ALIGN="LEFT"><IMG
WIDTH="34" HEIGHT="30" ALIGN="MIDDLE" BORDER="0"
SRC="img81.png"
SRC="img80.png"
ALT="$x_i, y$"></TD>
<TD ALIGN="LEFT"><B>Subroutine</B></TD>
</TR>
<TR><TD ALIGN="LEFT">Integer</TD>
<TD ALIGN="LEFT">psb_gather</TD>
<TD ALIGN="LEFT">psb_scatter</TD>
</TR>
<TR><TD ALIGN="LEFT">Short Precision Real</TD>
<TD ALIGN="LEFT">psb_gather</TD>
<TD ALIGN="LEFT">psb_scatter</TD>
</TR>
<TR><TD ALIGN="LEFT">Long Precision Real</TD>
<TD ALIGN="LEFT">psb_gather</TD>
<TD ALIGN="LEFT">psb_scatter</TD>
</TR>
<TR><TD ALIGN="LEFT">Short Precision Complex</TD>
<TD ALIGN="LEFT">psb_gather</TD>
<TD ALIGN="LEFT">psb_scatter</TD>
</TR>
<TR><TD ALIGN="LEFT">Long Precision Complex</TD>
<TD ALIGN="LEFT">psb_gather</TD>
<TD ALIGN="LEFT">psb_scatter</TD>
</TR>
</TABLE>
</DIV>
@@ -147,8 +145,8 @@ Data types</CAPTION>
<P>
<PRE>
call psb_gather(glob_x, loc_x, desc_a, info, root)
call psb_gather(glob_x, loc_x, desc_a, info, root)
call psb_scatter(glob_x, loc_x, desc_a, info, root)
call psb_scatter(glob_x, loc_x, desc_a, info, root)
</PRE>
<P>
@@ -159,21 +157,16 @@ call psb_gather(glob_x, loc_x, desc_a, info, root)
<DT><STRONG><B>On Entry</B></STRONG></DT>
<DD>
</DD>
<DT><STRONG>loc_x</STRONG></DT>
<DD>the local portion of global dense matrix
<IMG
WIDTH="47" HEIGHT="30" ALIGN="MIDDLE" BORDER="0"
SRC="img77.png"
ALT="$glob\_x$">.
<DT><STRONG>glob_x</STRONG></DT>
<DD>The array that must be scattered into local pieces.
<BR>
Scope: <B>local</B>
Scope: <B>global</B>
<BR>
Type: <B>required</B>
<BR>
Intent: <B>in</B>.
<BR>
Specified as: a rank one or two array containing numbers of the type
indicated in Table&nbsp;<A HREF="#tab:gather">15</A>.
Specified as: a rank one or two array.
</DD>
<DT><STRONG>desc_a</STRONG></DT>
<DD>contains data structures for communications.
@@ -189,9 +182,9 @@ Specified as: a structured data of type descdata<TT>psb_desc_type</TT>.
<DT><STRONG>root</STRONG></DT>
<DD>The process that holds the global copy. If <IMG
WIDTH="74" HEIGHT="30" ALIGN="MIDDLE" BORDER="0"
SRC="img82.png"
SRC="img81.png"
ALT="$root=-1$"> all
the processes will have a copy of the global vector.
the processes have a copy of the global vector.
<BR>
Scope: <B>global</B>
<BR>
@@ -204,25 +197,30 @@ Specified as: an integer variable <!-- MATH
-->
<IMG
WIDTH="141" HEIGHT="30" ALIGN="MIDDLE" BORDER="0"
SRC="img83.png"
SRC="img82.png"
ALT="$-1\le root\le np-1$">, default <IMG
WIDTH="24" HEIGHT="30" ALIGN="MIDDLE" BORDER="0"
SRC="img84.png"
SRC="img83.png"
ALT="$-1$">.
</DD>
<DT><STRONG><B>On Return</B></STRONG></DT>
<DD>
</DD>
<DT><STRONG>glob_x</STRONG></DT>
<DD>The array where the local parts must be gathered.
<DT><STRONG>loc_x</STRONG></DT>
<DD>the local portion of global dense matrix
<IMG
WIDTH="47" HEIGHT="30" ALIGN="MIDDLE" BORDER="0"
SRC="img76.png"
ALT="$glob\_x$">.
<BR>
Scope: <B>global</B>
Scope: <B>local</B>
<BR>
Type: <B>required</B>
<BR>
Intent: <B>out</B>.
<BR>
Specified as: a rank one or two array.
Specified as: a rank one or two array containing numbers of the type
indicated in Table&nbsp;<A HREF="#tab:scatter">16</A>.
</DD>
<DT><STRONG>info</STRONG></DT>
<DD>Error code.
@@ -240,26 +238,26 @@ An integer value; 0 means no error has been detected.
<P>
<HR>
<!--Navigation Panel-->
<A NAME="tex2html710"
<A NAME="tex2html706"
HREF="node44.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
<A NAME="tex2html706"
HREF="node40.html">
<A NAME="tex2html702"
HREF="node39.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
<A NAME="tex2html700"
<A NAME="tex2html698"
HREF="node42.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
<A NAME="tex2html708"
<A NAME="tex2html704"
HREF="node1.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
<BR>
<B> Next:</B> <A NAME="tex2html711"
HREF="node44.html">psb_scatter Scatter</A>
<B> Up:</B> <A NAME="tex2html707"
HREF="node40.html">Communication routines</A>
<B> Previous:</B> <A NAME="tex2html701"
HREF="node42.html">psb_ovrl Overlap</A>
&nbsp; <B> <A NAME="tex2html709"
<B> Next:</B> <A NAME="tex2html707"
HREF="node44.html">Data management routines</A>
<B> Up:</B> <A NAME="tex2html703"
HREF="node39.html">Communication routines</A>
<B> Previous:</B> <A NAME="tex2html699"
HREF="node42.html">psb_gather Gather</A>
&nbsp; <B> <A NAME="tex2html705"
HREF="node1.html">Contents</A></B>
<!--End of Navigation Panel-->