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
+94 -116
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_gedots -- Generalized Dot Product</TITLE>
<META NAME="description" CONTENT="psb_gedots -- Generalized Dot Product">
<TITLE>psb_geamax -- Infinity-Norm of Vector</TITLE>
<META NAME="description" CONTENT="psb_geamax -- Infinity-Norm of Vector">
<META NAME="keywords" CONTENT="userhtml">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
@@ -20,117 +20,127 @@ original version by: Nikos Drakos, CBLU, University of Leeds
<LINK REL="next" HREF="node31.html">
<LINK REL="previous" HREF="node29.html">
<LINK REL="up" HREF="node27.html">
<LINK REL="up" HREF="node26.html">
<LINK REL="next" HREF="node31.html">
</HEAD>
<BODY >
<!--Navigation Panel-->
<A NAME="tex2html552"
<A NAME="tex2html550"
HREF="node31.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
<A NAME="tex2html548"
HREF="node27.html">
<A NAME="tex2html546"
HREF="node26.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
<A NAME="tex2html542"
<A NAME="tex2html540"
HREF="node29.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
<A NAME="tex2html550"
<A NAME="tex2html548"
HREF="node1.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
<BR>
<B> Next:</B> <A NAME="tex2html553"
HREF="node31.html">psb_geamax Infinity-Norm</A>
<B> Up:</B> <A NAME="tex2html549"
HREF="node27.html">Computational routines</A>
<B> Previous:</B> <A NAME="tex2html543"
HREF="node29.html">psb_gedot Dot</A>
&nbsp; <B> <A NAME="tex2html551"
<B> Next:</B> <A NAME="tex2html551"
HREF="node31.html">psb_geamaxs Generalized</A>
<B> Up:</B> <A NAME="tex2html547"
HREF="node26.html">Computational routines</A>
<B> Previous:</B> <A NAME="tex2html541"
HREF="node29.html">psb_gedots Generalized</A>
&nbsp; <B> <A NAME="tex2html549"
HREF="node1.html">Contents</A></B>
<BR>
<BR>
<!--End of Navigation Panel-->
<H2><A NAME="SECTION00053000000000000000">
psb_gedots -- Generalized Dot Product</A>
<H2><A NAME="SECTION00054000000000000000">
psb_geamax -- Infinity-Norm of Vector</A>
</H2>
<P>
This subroutine computes a series of dot products among the columns of
two dense matrices <IMG
This function computes
the infinity-norm of a vector <IMG
WIDTH="13" HEIGHT="14" ALIGN="BOTTOM" BORDER="0"
SRC="img28.png"
ALT="$x$"> and <IMG
WIDTH="13" HEIGHT="30" ALIGN="MIDDLE" BORDER="0"
SRC="img29.png"
ALT="$y$">:
SRC="img27.png"
ALT="$x$">.
<BR>
If <IMG
WIDTH="13" HEIGHT="14" ALIGN="BOTTOM" BORDER="0"
SRC="img27.png"
ALT="$x$"> is a real vector
it computes infinity norm as:
<BR><P></P>
<DIV ALIGN="CENTER">
<!-- MATH
\begin{displaymath}
res(i) \leftarrow x(:,i)^T y(:,i)
amax \leftarrow \max_i |x_i|
\end{displaymath}
-->
<IMG
WIDTH="150" HEIGHT="28" BORDER="0"
SRC="img35.png"
ALT="\begin{displaymath}res(i) \leftarrow x(:,i)^T y(:,i)\end{displaymath}">
WIDTH="118" HEIGHT="36" BORDER="0"
SRC="img36.png"
ALT="\begin{displaymath}amax \leftarrow \max_i \vert x_i\vert\end{displaymath}">
</DIV>
<BR CLEAR="ALL">
<P></P>
If the matrices are complex, then the
usual convention applies, i.e. the conjugate transpose of <IMG
else if <IMG
WIDTH="13" HEIGHT="14" ALIGN="BOTTOM" BORDER="0"
SRC="img28.png"
ALT="$x$"> is
used. If <IMG
WIDTH="13" HEIGHT="14" ALIGN="BOTTOM" BORDER="0"
SRC="img28.png"
ALT="$x$"> and <IMG
WIDTH="13" HEIGHT="30" ALIGN="MIDDLE" BORDER="0"
SRC="img29.png"
ALT="$y$"> are of rank one, then <IMG
WIDTH="26" HEIGHT="14" ALIGN="BOTTOM" BORDER="0"
SRC="img36.png"
ALT="$res$"> is a scalar, else it
is a rank one array.
SRC="img27.png"
ALT="$x$"> is a complex vector then it computes infinity-norm as:
<BR><P></P>
<DIV ALIGN="CENTER">
<!-- MATH
\begin{displaymath}
amax \leftarrow \max_i {(|re(x_i)| + |im(x_i)|)}
\end{displaymath}
-->
<IMG
WIDTH="233" HEIGHT="36" BORDER="0"
SRC="img37.png"
ALT="\begin{displaymath}amax \leftarrow \max_i {(\vert re(x_i)\vert + \vert im(x_i)\vert)}\end{displaymath}">
</DIV>
<BR CLEAR="ALL">
<P></P>
<P>
<PRE>
call psb_gedots(res, x, y, desc_a, info)
psb_geamax(x, desc_a, info)
</PRE>
<P>
<BR><P></P>
<DIV ALIGN="CENTER"><A NAME="1512"></A>
<DIV ALIGN="CENTER"><A NAME="1441"></A>
<TABLE>
<CAPTION><STRONG>Table 3:</STRONG>
<CAPTION><STRONG>Table 4:</STRONG>
Data types</CAPTION>
<TR><TD>
<DIV ALIGN="CENTER">
<TABLE CELLPADDING=3 BORDER="1" ALIGN="CENTER">
<TR><TD ALIGN="LEFT"><IMG
WIDTH="26" HEIGHT="14" ALIGN="BOTTOM" BORDER="0"
SRC="img36.png"
ALT="$res$">, <IMG
WIDTH="44" HEIGHT="14" ALIGN="BOTTOM" BORDER="0"
SRC="img38.png"
ALT="$amax$"></TD>
<TD ALIGN="LEFT"><IMG
WIDTH="13" HEIGHT="14" ALIGN="BOTTOM" BORDER="0"
SRC="img28.png"
ALT="$x$">, <IMG
WIDTH="13" HEIGHT="30" ALIGN="MIDDLE" BORDER="0"
SRC="img29.png"
ALT="$y$"></TD>
<TD ALIGN="LEFT"><B>Subroutine</B></TD>
SRC="img27.png"
ALT="$x$"></TD>
<TD ALIGN="LEFT"><B>Function</B></TD>
</TR>
<TR><TD ALIGN="LEFT">Short Precision Real</TD>
<TD ALIGN="LEFT">psb_gedots</TD>
<TD ALIGN="LEFT">Short Precision Real</TD>
<TD ALIGN="LEFT">psb_geamax</TD>
</TR>
<TR><TD ALIGN="LEFT">Long Precision Real</TD>
<TD ALIGN="LEFT">psb_gedots</TD>
<TD ALIGN="LEFT">Long Precision Real</TD>
<TD ALIGN="LEFT">psb_geamax</TD>
</TR>
<TR><TD ALIGN="LEFT">Short Precision Complex</TD>
<TD ALIGN="LEFT">psb_gedots</TD>
<TR><TD ALIGN="LEFT">Short Precision Real</TD>
<TD ALIGN="LEFT">Short Precision Complex</TD>
<TD ALIGN="LEFT">psb_geamax</TD>
</TR>
<TR><TD ALIGN="LEFT">Long Precision Complex</TD>
<TD ALIGN="LEFT">psb_gedots</TD>
<TR><TD ALIGN="LEFT">Long Precision Real</TD>
<TD ALIGN="LEFT">Long Precision Complex</TD>
<TD ALIGN="LEFT">psb_geamax</TD>
</TR>
</TABLE>
</DIV>
@@ -151,8 +161,9 @@ Data types</CAPTION>
<DD>the local portion of global dense matrix
<IMG
WIDTH="13" HEIGHT="14" ALIGN="BOTTOM" BORDER="0"
SRC="img28.png"
SRC="img27.png"
ALT="$x$">.
<BR>
Scope: <B>local</B>
<BR>
@@ -160,38 +171,9 @@ Type: <B>required</B>
<BR>
Intent: <B>in</B>.
<BR>
Specified as: an array of rank one or two
Specified as: a rank one or two array
containing numbers of type specified in
Table&nbsp;<A HREF="#tab:f90mdot">3</A>. The rank of <IMG
WIDTH="13" HEIGHT="14" ALIGN="BOTTOM" BORDER="0"
SRC="img28.png"
ALT="$x$"> must be the same of <IMG
WIDTH="13" HEIGHT="30" ALIGN="MIDDLE" BORDER="0"
SRC="img29.png"
ALT="$y$">.
</DD>
<DT><STRONG>y</STRONG></DT>
<DD>the local portion of global dense matrix
<IMG
WIDTH="13" HEIGHT="30" ALIGN="MIDDLE" BORDER="0"
SRC="img29.png"
ALT="$y$">.
<BR>
Scope: <B>local</B>
<BR>
Type: <B>required</B>
<BR>
Intent: <B>in</B>.
<BR>
Specified as: an array of rank one or two
containing numbers of type specified in
Table&nbsp;<A HREF="#tab:f90mdot">3</A>. The rank of <IMG
WIDTH="13" HEIGHT="30" ALIGN="MIDDLE" BORDER="0"
SRC="img29.png"
ALT="$y$"> must be the same of <IMG
WIDTH="13" HEIGHT="14" ALIGN="BOTTOM" BORDER="0"
SRC="img28.png"
ALT="$x$">.
Table&nbsp;<A HREF="#tab:f90amax">4</A>.
</DD>
<DT><STRONG>desc_a</STRONG></DT>
<DD>contains data structures for communications.
@@ -203,25 +185,21 @@ Type: <B>required</B>
Intent: <B>in</B>.
<BR>
Specified as: a structured data of type descdata<TT>psb_desc_type</TT>.
<P>
</DD>
<DT><STRONG><B>On Return</B></STRONG></DT>
<DD>
</DD>
<DT><STRONG>res</STRONG></DT>
<DD>is the dot product of subvectors <IMG
<DT><STRONG>Function value</STRONG></DT>
<DD>is the infinity norm of subvector <IMG
WIDTH="13" HEIGHT="14" ALIGN="BOTTOM" BORDER="0"
SRC="img28.png"
ALT="$x$"> and <IMG
WIDTH="13" HEIGHT="30" ALIGN="MIDDLE" BORDER="0"
SRC="img29.png"
ALT="$y$">.
SRC="img27.png"
ALT="$x$">.
<BR>
Scope: <B>global</B>
<BR>
Intent: <B>out</B>.
<BR>
Specified as: a number or a rank-one array of the data type indicated
in Table&nbsp;<A HREF="#tab:f90dot">2</A>.
Specified as: a long precision real number.
</DD>
<DT><STRONG>info</STRONG></DT>
<DD>Error code.
@@ -239,26 +217,26 @@ An integer value; 0 means no error has been detected.
<P>
<HR>
<!--Navigation Panel-->
<A NAME="tex2html552"
<A NAME="tex2html550"
HREF="node31.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
<A NAME="tex2html548"
HREF="node27.html">
<A NAME="tex2html546"
HREF="node26.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
<A NAME="tex2html542"
<A NAME="tex2html540"
HREF="node29.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
<A NAME="tex2html550"
<A NAME="tex2html548"
HREF="node1.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
<BR>
<B> Next:</B> <A NAME="tex2html553"
HREF="node31.html">psb_geamax Infinity-Norm</A>
<B> Up:</B> <A NAME="tex2html549"
HREF="node27.html">Computational routines</A>
<B> Previous:</B> <A NAME="tex2html543"
HREF="node29.html">psb_gedot Dot</A>
&nbsp; <B> <A NAME="tex2html551"
<B> Next:</B> <A NAME="tex2html551"
HREF="node31.html">psb_geamaxs Generalized</A>
<B> Up:</B> <A NAME="tex2html547"
HREF="node26.html">Computational routines</A>
<B> Previous:</B> <A NAME="tex2html541"
HREF="node29.html">psb_gedots Generalized</A>
&nbsp; <B> <A NAME="tex2html549"
HREF="node1.html">Contents</A></B>
<!--End of Navigation Panel-->