Updated docs.
This commit is contained in:
Salvatore Filippone
2017-02-12 18:19:15 +00:00
parent 9ab0539881
commit 001aa819fa
147 changed files with 22648 additions and 22177 deletions
+83 -94
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_rcv -- Receive data</TITLE>
<META NAME="description" CONTENT="psb_rcv -- Receive data">
<TITLE>psb_amn -- Global minimum absolute value</TITLE>
<META NAME="description" CONTENT="psb_amn -- Global minimum absolute value">
<META NAME="keywords" CONTENT="userhtml">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
@@ -18,52 +18,54 @@ original version by: Nikos Drakos, CBLU, University of Leeds
<LINK REL="STYLESHEET" HREF="userhtml.css">
<LINK REL="next" HREF="node113.html">
<LINK REL="previous" HREF="node111.html">
<LINK REL="up" HREF="node96.html">
<LINK REL="up" HREF="node98.html">
<LINK REL="next" HREF="node113.html">
</HEAD>
<BODY >
<!--Navigation Panel-->
<A NAME="tex2html1646"
<A NAME="tex2html1654"
HREF="node113.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
<A NAME="tex2html1642"
HREF="node96.html">
<A NAME="tex2html1650"
HREF="node98.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
<A NAME="tex2html1638"
<A NAME="tex2html1644"
HREF="node111.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
<A NAME="tex2html1644"
<A NAME="tex2html1652"
HREF="node1.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
<BR>
<B> Next:</B> <A NAME="tex2html1647"
HREF="node113.html">Error handling</A>
<B> Up:</B> <A NAME="tex2html1643"
HREF="node96.html">Parallel environment routines</A>
<B> Previous:</B> <A NAME="tex2html1639"
HREF="node111.html">psb_snd Send</A>
&nbsp; <B> <A NAME="tex2html1645"
<B> Next:</B> <A NAME="tex2html1655"
HREF="node113.html">psb_snd Send</A>
<B> Up:</B> <A NAME="tex2html1651"
HREF="node98.html">Parallel environment routines</A>
<B> Previous:</B> <A NAME="tex2html1645"
HREF="node111.html">psb_amx Global</A>
&nbsp; <B> <A NAME="tex2html1653"
HREF="node1.html">Contents</A></B>
<BR>
<BR>
<!--End of Navigation Panel-->
<H2><A NAME="SECTION000816000000000000000">
psb_rcv -- Receive data</A>
<H2><A NAME="SECTION000814000000000000000">
psb_amn -- Global minimum absolute value</A>
</H2>
<P>
<PRE>
call psb_rcv(icontxt, dat, src, m)
call psb_amn(icontxt, dat, root)
</PRE>
<P>
This subroutine receives a packet of data to a destination.
This subroutine implements a minimum absolute value reduction
operation based on the underlying communication library.
<DL>
<DT><STRONG>Type:</STRONG></DT>
<DD>Synchronous: see usage notes.
<DD>Synchronous.
</DD>
<DT><STRONG><B>On Entry </B></STRONG></DT>
<DD>
@@ -80,59 +82,8 @@ Intent: <B>in</B>.
<BR>
Specified as: an integer variable.
</DD>
<DT><STRONG>src</STRONG></DT>
<DD>Source process.
<BR>
Scope: <B>global</B>.
<BR>
Type: <B>required</B>.
<BR>
Intent: <B>in</B>.
<BR>
Specified as: an integer value <!-- MATH
$0<= src <= np-1$
-->
<IMG
WIDTH="147" HEIGHT="30" ALIGN="MIDDLE" BORDER="0"
SRC="img139.png"
ALT="$0&lt;= src &lt;= np-1$">.
<BR></DD>
<DT><STRONG>m</STRONG></DT>
<DD>Number of rows.
<BR>
Scope: <B>global</B>.
<BR>
Type: <B>Optional</B>.
<BR>
Intent: <B>in</B>.
<BR>
Specified as: an integer value <!-- MATH
$0<= m <= size(dat,1)$
-->
<IMG
WIDTH="172" HEIGHT="32" ALIGN="MIDDLE" BORDER="0"
SRC="img135.png"
ALT="$0&lt;= m &lt;= size(dat,1)$">.
<BR>
When <IMG
WIDTH="26" HEIGHT="15" ALIGN="BOTTOM" BORDER="0"
SRC="img136.png"
ALT="$dat$"> is a rank 2 array, specifies the number of rows to be sent
independently of the leading dimension <IMG
WIDTH="83" HEIGHT="32" ALIGN="MIDDLE" BORDER="0"
SRC="img137.png"
ALT="$size(dat,1)$">; must have the
same value on sending and receiving processes.
</DD>
</DL>
<P>
<DL>
<DT><STRONG><B>On Return</B></STRONG></DT>
<DD>
</DD>
<DT><STRONG>dat</STRONG></DT>
<DD>The data to be received.
<DD>The local contribution to the global minimum.
<BR>
Scope: <B>local</B>.
<BR>
@@ -141,11 +92,49 @@ Type: <B>required</B>.
Intent: <B>inout</B>.
<BR>
Specified as: an integer, real or complex variable, which may be a
scalar, or a rank 1 or 2 array, or a character or logical scalar. Type, kind and rank must agree on sender and receiver process; if <IMG
WIDTH="18" HEIGHT="14" ALIGN="BOTTOM" BORDER="0"
SRC="img133.png"
ALT="$m$"> is
not specified, size must agree as well.
scalar, or a rank 1 or 2 array. Type, kind, rank and size must agree on all processes.
</DD>
<DT><STRONG>root</STRONG></DT>
<DD>Process to hold the final value, or <IMG
WIDTH="24" HEIGHT="30" ALIGN="MIDDLE" BORDER="0"
SRC="img78.png"
ALT="$-1$"> to make it available
on all processes.
<BR>
Scope: <B>global</B>.
<BR>
Type: <B>optional</B>.
<BR>
Intent: <B>in</B>.
<BR>
Specified as: an integer value <!-- MATH
$-1<= root <= np-1$
-->
<IMG
WIDTH="165" HEIGHT="30" ALIGN="MIDDLE" BORDER="0"
SRC="img132.png"
ALT="$-1&lt;= root &lt;= np-1$">, default -1.
<BR></DD>
</DL>
<P>
<DL>
<DT><STRONG><B>On Return</B></STRONG></DT>
<DD>
</DD>
<DT><STRONG>dat</STRONG></DT>
<DD>On destination process(es), the result of the minimum operation.
<BR>
Scope: <B>global</B>.
<BR>
Type: <B>required</B>.
<BR>
Intent: <B>inout</B>.
<BR>
Specified as: an integer, real or complex variable, which may be a
scalar, or a rank 1 or 2 array.
<BR>
Type, kind, rank and size must agree on all processes.
</DD>
</DL>
@@ -153,37 +142,37 @@ not specified, size must agree as well.
<FONT SIZE="+1"><B>Notes</B></FONT>
<OL>
<LI>This subroutine implies a synchronization, but only between the
calling process and the source process <IMG
WIDTH="26" HEIGHT="14" ALIGN="BOTTOM" BORDER="0"
SRC="img140.png"
ALT="$src$">.
<LI>The <code>dat</code> argument is both input and output, and its
value may be changed even on processes different from the final
result destination.
</LI>
<LI>The <code>dat</code> argument may also be a long integer scalar.
</LI>
</OL>
<P>
<HR>
<!--Navigation Panel-->
<A NAME="tex2html1646"
<A NAME="tex2html1654"
HREF="node113.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
<A NAME="tex2html1642"
HREF="node96.html">
<A NAME="tex2html1650"
HREF="node98.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
<A NAME="tex2html1638"
<A NAME="tex2html1644"
HREF="node111.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
<A NAME="tex2html1644"
<A NAME="tex2html1652"
HREF="node1.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
<BR>
<B> Next:</B> <A NAME="tex2html1647"
HREF="node113.html">Error handling</A>
<B> Up:</B> <A NAME="tex2html1643"
HREF="node96.html">Parallel environment routines</A>
<B> Previous:</B> <A NAME="tex2html1639"
HREF="node111.html">psb_snd Send</A>
&nbsp; <B> <A NAME="tex2html1645"
<B> Next:</B> <A NAME="tex2html1655"
HREF="node113.html">psb_snd Send</A>
<B> Up:</B> <A NAME="tex2html1651"
HREF="node98.html">Parallel environment routines</A>
<B> Previous:</B> <A NAME="tex2html1645"
HREF="node111.html">psb_amx Global</A>
&nbsp; <B> <A NAME="tex2html1653"
HREF="node1.html">Contents</A></B>
<!--End of Navigation Panel-->