fix documentation bug for NRM2
This commit is contained in:
Salvatore Filippone
2010-06-22 12:42:39 +00:00
parent 591166264b
commit e4452fe0a6
214 changed files with 8663 additions and 8784 deletions
+66 -78
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_snd -- Send data</TITLE>
<META NAME="description" CONTENT="psb_snd -- Send 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">
@@ -20,51 +20,52 @@ original version by: Nikos Drakos, CBLU, University of Leeds
<LINK REL="next" HREF="node86.html">
<LINK REL="previous" HREF="node84.html">
<LINK REL="up" HREF="node70.html">
<LINK REL="up" HREF="node71.html">
<LINK REL="next" HREF="node86.html">
</HEAD>
<BODY >
<!--Navigation Panel-->
<A NAME="tex2html1246"
<A NAME="tex2html1248"
HREF="node86.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
<A NAME="tex2html1242"
HREF="node70.html">
<A NAME="tex2html1244"
HREF="node71.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
<A NAME="tex2html1236"
<A NAME="tex2html1238"
HREF="node84.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
<A NAME="tex2html1244"
<A NAME="tex2html1246"
HREF="node1.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
<BR>
<B> Next:</B> <A NAME="tex2html1247"
HREF="node86.html">psb_rcv Receive</A>
<B> Up:</B> <A NAME="tex2html1243"
HREF="node70.html">Parallel environment routines</A>
<B> Previous:</B> <A NAME="tex2html1237"
HREF="node84.html">psb_amn Global</A>
&nbsp; <B> <A NAME="tex2html1245"
<B> Next:</B> <A NAME="tex2html1249"
HREF="node86.html">psb_snd Send</A>
<B> Up:</B> <A NAME="tex2html1245"
HREF="node71.html">Parallel environment routines</A>
<B> Previous:</B> <A NAME="tex2html1239"
HREF="node84.html">psb_amx Global</A>
&nbsp; <B> <A NAME="tex2html1247"
HREF="node1.html">Contents</A></B>
<BR>
<BR>
<!--End of Navigation Panel-->
<H2><A NAME="SECTION000815000000000000000">
psb_snd -- Send data</A>
<H2><A NAME="SECTION000814000000000000000">
psb_amn -- Global minimum absolute value</A>
</H2>
<P>
<PRE>
call psb_snd(icontxt, dat, dst, m)
call psb_amn(icontxt, dat, root)
</PRE>
<P>
This subroutine sends 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>
@@ -82,65 +83,38 @@ Intent: <B>in</B>.
Specified as: an integer variable.
</DD>
<DT><STRONG>dat</STRONG></DT>
<DD>The data to be sent.
<DD>The local contribution to the global minimum.
<BR>
Scope: <B>local</B>.
<BR>
Type: <B>required</B>.
<BR>
Intent: <B>in</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="13" ALIGN="BOTTOM" BORDER="0"
SRC="img130.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>dst</STRONG></DT>
<DD>Destination process.
<DT><STRONG>root</STRONG></DT>
<DD>Process to hold the final value, or <IMG
WIDTH="25" HEIGHT="30" ALIGN="MIDDLE" BORDER="0"
SRC="img82.png"
ALT="$-1$"> to make it available
on all processes.
<BR>
Scope: <B>global</B>.
<BR>
Type: <B>required</B>.
Type: <B>optional</B>.
<BR>
Intent: <B>in</B>.
<BR>
Specified as: an integer value <!-- MATH
$0<= dst <= np-1$
$-1<= root <= np-1$
-->
<IMG
WIDTH="145" HEIGHT="30" ALIGN="MIDDLE" BORDER="0"
SRC="img131.png"
ALT="$0&lt;= dst &lt;= np-1$">.
WIDTH="165" HEIGHT="30" ALIGN="MIDDLE" BORDER="0"
SRC="img128.png"
ALT="$-1&lt;= root &lt;= np-1$">, default -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="img132.png"
ALT="$0&lt;= m &lt;= size(dat,1)$">.
<BR>
When <IMG
WIDTH="26" HEIGHT="14" ALIGN="BOTTOM" BORDER="0"
SRC="img133.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="img134.png"
ALT="$size(dat,1)$">; must have the
same value on sending and receiving processes.
</DD>
</DL>
<P>
@@ -148,43 +122,57 @@ same value on sending and receiving processes.
<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>
<P>
<FONT SIZE="+1"><B>Notes</B></FONT>
<OL>
<LI>This subroutine implies a synchronization, but only between the
calling process and the destination process <IMG
WIDTH="25" HEIGHT="14" ALIGN="BOTTOM" BORDER="0"
SRC="img135.png"
ALT="$dst$">.
<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="tex2html1246"
<A NAME="tex2html1248"
HREF="node86.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
<A NAME="tex2html1242"
HREF="node70.html">
<A NAME="tex2html1244"
HREF="node71.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
<A NAME="tex2html1236"
<A NAME="tex2html1238"
HREF="node84.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
<A NAME="tex2html1244"
<A NAME="tex2html1246"
HREF="node1.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
<BR>
<B> Next:</B> <A NAME="tex2html1247"
HREF="node86.html">psb_rcv Receive</A>
<B> Up:</B> <A NAME="tex2html1243"
HREF="node70.html">Parallel environment routines</A>
<B> Previous:</B> <A NAME="tex2html1237"
HREF="node84.html">psb_amn Global</A>
&nbsp; <B> <A NAME="tex2html1245"
<B> Next:</B> <A NAME="tex2html1249"
HREF="node86.html">psb_snd Send</A>
<B> Up:</B> <A NAME="tex2html1245"
HREF="node71.html">Parallel environment routines</A>
<B> Previous:</B> <A NAME="tex2html1239"
HREF="node84.html">psb_amx Global</A>
&nbsp; <B> <A NAME="tex2html1247"
HREF="node1.html">Contents</A></B>
<!--End of Navigation Panel-->