mirror of
https://github.com/sfilippone/psblas3.git
synced 2026-10-07 15:14:57 +00:00
psblas3:
fix documentation bug for NRM2
This commit is contained in:
+59
-271
@@ -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_spmm -- Sparse Matrix by Dense Matrix Product</TITLE>
|
||||
<META NAME="description" CONTENT="psb_spmm -- Sparse Matrix by Dense Matrix Product">
|
||||
<TITLE>psb_spnrmi -- Infinity Norm of Sparse Matrix</TITLE>
|
||||
<META NAME="description" CONTENT="psb_spnrmi -- Infinity Norm of Sparse Matrix">
|
||||
<META NAME="keywords" CONTENT="userhtml">
|
||||
<META NAME="resource-type" CONTENT="document">
|
||||
<META NAME="distribution" CONTENT="global">
|
||||
@@ -26,140 +26,75 @@ original version by: Nikos Drakos, CBLU, University of Leeds
|
||||
|
||||
<BODY >
|
||||
<!--Navigation Panel-->
|
||||
<A NAME="tex2html605"
|
||||
<A NAME="tex2html607"
|
||||
HREF="node36.html">
|
||||
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
|
||||
<A NAME="tex2html601"
|
||||
<A NAME="tex2html603"
|
||||
HREF="node25.html">
|
||||
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
|
||||
<A NAME="tex2html595"
|
||||
<A NAME="tex2html597"
|
||||
HREF="node34.html">
|
||||
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
|
||||
<A NAME="tex2html603"
|
||||
<A NAME="tex2html605"
|
||||
HREF="node1.html">
|
||||
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
|
||||
<BR>
|
||||
<B> Next:</B> <A NAME="tex2html606"
|
||||
HREF="node36.html">psb_spsm Triangular</A>
|
||||
<B> Up:</B> <A NAME="tex2html602"
|
||||
<B> Next:</B> <A NAME="tex2html608"
|
||||
HREF="node36.html">psb_spmm Sparse</A>
|
||||
<B> Up:</B> <A NAME="tex2html604"
|
||||
HREF="node25.html">Computational routines</A>
|
||||
<B> Previous:</B> <A NAME="tex2html596"
|
||||
HREF="node34.html">psb_spnrmi Infinity</A>
|
||||
<B> <A NAME="tex2html604"
|
||||
<B> Previous:</B> <A NAME="tex2html598"
|
||||
HREF="node34.html">psb_genrm2s Generalized</A>
|
||||
<B> <A NAME="tex2html606"
|
||||
HREF="node1.html">Contents</A></B>
|
||||
<BR>
|
||||
<BR>
|
||||
<!--End of Navigation Panel-->
|
||||
|
||||
<H2><A NAME="SECTION000510000000000000000">
|
||||
psb_spmm -- Sparse Matrix by Dense Matrix Product</A>
|
||||
psb_spnrmi -- Infinity Norm of Sparse Matrix</A>
|
||||
</H2>
|
||||
|
||||
<P>
|
||||
This subroutine computes the Sparse Matrix by Dense Matrix Product:
|
||||
|
||||
This function computes the infinity-norm of a matrix <IMG
|
||||
WIDTH="16" HEIGHT="14" ALIGN="BOTTOM" BORDER="0"
|
||||
SRC="img1.png"
|
||||
ALT="$A$">:
|
||||
<BR>
|
||||
<P>
|
||||
<BR>
|
||||
<DIV ALIGN="RIGHT">
|
||||
|
||||
<BR><P></P>
|
||||
<DIV ALIGN="CENTER">
|
||||
<!-- MATH
|
||||
\begin{equation}
|
||||
y \leftarrow \alpha P_r A P_c x + \beta y
|
||||
\end{equation}
|
||||
\begin{displaymath}
|
||||
nrmi \leftarrow \|A\|_\infty
|
||||
\end{displaymath}
|
||||
-->
|
||||
<TABLE WIDTH="100%" ALIGN="CENTER">
|
||||
<TR VALIGN="MIDDLE"><TD ALIGN="CENTER" NOWRAP><A NAME="eq:f90spmm_no_tra"></A><IMG
|
||||
WIDTH="136" HEIGHT="27" BORDER="0"
|
||||
SRC="img50.png"
|
||||
ALT="\begin{displaymath}
|
||||
y \leftarrow \alpha P_r A P_c x + \beta y
|
||||
\end{displaymath}"></TD>
|
||||
<TD WIDTH=10 ALIGN="RIGHT">
|
||||
(1)</TD></TR>
|
||||
</TABLE>
|
||||
<BR CLEAR="ALL"></DIV><P></P>
|
||||
<BR>
|
||||
<DIV ALIGN="RIGHT">
|
||||
|
||||
<!-- MATH
|
||||
\begin{equation}
|
||||
y \leftarrow \alpha P_r A^T P_c x + \beta y
|
||||
\end{equation}
|
||||
-->
|
||||
<TABLE WIDTH="100%" ALIGN="CENTER">
|
||||
<TR VALIGN="MIDDLE"><TD ALIGN="CENTER" NOWRAP><A NAME="eq:f90spmm_tra"></A><IMG
|
||||
WIDTH="145" HEIGHT="27" BORDER="0"
|
||||
SRC="img51.png"
|
||||
ALT="\begin{displaymath}
|
||||
y \leftarrow \alpha P_r A^T P_c x + \beta y
|
||||
\end{displaymath}"></TD>
|
||||
<TD WIDTH=10 ALIGN="RIGHT">
|
||||
(2)</TD></TR>
|
||||
</TABLE>
|
||||
<BR CLEAR="ALL"></DIV><P></P>
|
||||
<BR>
|
||||
<DIV ALIGN="RIGHT">
|
||||
|
||||
<!-- MATH
|
||||
\begin{equation}
|
||||
y \leftarrow \alpha P_r A^H P_c x + \beta y
|
||||
\end{equation}
|
||||
-->
|
||||
<TABLE WIDTH="100%" ALIGN="CENTER">
|
||||
<TR VALIGN="MIDDLE"><TD ALIGN="CENTER" NOWRAP><A NAME="eq:f90spmm_con"></A><IMG
|
||||
WIDTH="148" HEIGHT="27" BORDER="0"
|
||||
SRC="img52.png"
|
||||
ALT="\begin{displaymath}
|
||||
y \leftarrow \alpha P_r A^H P_c x + \beta y
|
||||
\end{displaymath}"></TD>
|
||||
<TD WIDTH=10 ALIGN="RIGHT">
|
||||
(3)</TD></TR>
|
||||
</TABLE>
|
||||
<BR CLEAR="ALL"></DIV><P></P>
|
||||
|
||||
<P>
|
||||
<IMG
|
||||
WIDTH="101" HEIGHT="28" BORDER="0"
|
||||
SRC="img48.png"
|
||||
ALT="\begin{displaymath}nrmi \leftarrow \Vert A\Vert _\infty \end{displaymath}">
|
||||
</DIV>
|
||||
<BR CLEAR="ALL">
|
||||
<P></P>
|
||||
where:
|
||||
<DL>
|
||||
<DT><STRONG><IMG
|
||||
WIDTH="13" HEIGHT="13" ALIGN="BOTTOM" BORDER="0"
|
||||
SRC="img26.png"
|
||||
ALT="$x$"></STRONG></DT>
|
||||
<DD>is the global dense submatrix <IMG
|
||||
WIDTH="25" HEIGHT="30" ALIGN="MIDDLE" BORDER="0"
|
||||
SRC="img53.png"
|
||||
ALT="$x_{:, :}$">
|
||||
</DD>
|
||||
<DT><STRONG><IMG
|
||||
WIDTH="13" HEIGHT="30" ALIGN="MIDDLE" BORDER="0"
|
||||
SRC="img27.png"
|
||||
ALT="$y$"></STRONG></DT>
|
||||
<DD>is the global dense submatrix <IMG
|
||||
WIDTH="23" HEIGHT="30" ALIGN="MIDDLE" BORDER="0"
|
||||
SRC="img54.png"
|
||||
ALT="$y_{:, :}$">
|
||||
</DD>
|
||||
<DT><STRONG><IMG
|
||||
WIDTH="16" HEIGHT="14" ALIGN="BOTTOM" BORDER="0"
|
||||
SRC="img1.png"
|
||||
ALT="$A$"></STRONG></DT>
|
||||
<DD>is the global sparse submatrix <IMG
|
||||
<DD>represents the global matrix <IMG
|
||||
WIDTH="16" HEIGHT="14" ALIGN="BOTTOM" BORDER="0"
|
||||
SRC="img1.png"
|
||||
ALT="$A$">
|
||||
</DD>
|
||||
<DT><STRONG><IMG
|
||||
WIDTH="45" HEIGHT="30" ALIGN="MIDDLE" BORDER="0"
|
||||
SRC="img55.png"
|
||||
ALT="$P_r, P_c$"></STRONG></DT>
|
||||
<DD>are the permutation matrices.
|
||||
</DD>
|
||||
</DL>
|
||||
|
||||
<P>
|
||||
<BR><P></P>
|
||||
<DIV ALIGN="CENTER"><A NAME="1426"></A>
|
||||
<DIV ALIGN="CENTER"><A NAME="1425"></A>
|
||||
<TABLE>
|
||||
<CAPTION><STRONG>Table 11:</STRONG>
|
||||
<CAPTION><STRONG>Table 10:</STRONG>
|
||||
Data types</CAPTION>
|
||||
<TR><TD>
|
||||
<DIV ALIGN="CENTER">
|
||||
@@ -167,32 +102,20 @@ Data types</CAPTION>
|
||||
<TR><TD ALIGN="LEFT"><IMG
|
||||
WIDTH="16" HEIGHT="14" ALIGN="BOTTOM" BORDER="0"
|
||||
SRC="img1.png"
|
||||
ALT="$A$">, <IMG
|
||||
WIDTH="13" HEIGHT="13" ALIGN="BOTTOM" BORDER="0"
|
||||
SRC="img26.png"
|
||||
ALT="$x$">, <IMG
|
||||
WIDTH="13" HEIGHT="30" ALIGN="MIDDLE" BORDER="0"
|
||||
SRC="img27.png"
|
||||
ALT="$y$">, <IMG
|
||||
WIDTH="14" HEIGHT="13" ALIGN="BOTTOM" BORDER="0"
|
||||
SRC="img28.png"
|
||||
ALT="$\alpha$">, <IMG
|
||||
WIDTH="14" HEIGHT="30" ALIGN="MIDDLE" BORDER="0"
|
||||
SRC="img29.png"
|
||||
ALT="$\beta$"></TD>
|
||||
<TD ALIGN="LEFT"><B>Subroutine</B></TD>
|
||||
ALT="$A$"></TD>
|
||||
<TD ALIGN="LEFT"><B>Function</B></TD>
|
||||
</TR>
|
||||
<TR><TD ALIGN="LEFT">Short Precision Real</TD>
|
||||
<TD ALIGN="LEFT">psb_spmm</TD>
|
||||
<TD ALIGN="LEFT">psb_spnrmi</TD>
|
||||
</TR>
|
||||
<TR><TD ALIGN="LEFT">Long Precision Real</TD>
|
||||
<TD ALIGN="LEFT">psb_spmm</TD>
|
||||
<TD ALIGN="LEFT">psb_spnrmi</TD>
|
||||
</TR>
|
||||
<TR><TD ALIGN="LEFT">Short Precision Complex</TD>
|
||||
<TD ALIGN="LEFT">psb_spmm</TD>
|
||||
<TD ALIGN="LEFT">psb_spnrmi</TD>
|
||||
</TR>
|
||||
<TR><TD ALIGN="LEFT">Long Precision Complex</TD>
|
||||
<TD ALIGN="LEFT">psb_spmm</TD>
|
||||
<TD ALIGN="LEFT">psb_spnrmi</TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
</DIV>
|
||||
@@ -203,10 +126,8 @@ Data types</CAPTION>
|
||||
|
||||
<P>
|
||||
<PRE>
|
||||
call psb_spmm(alpha, a, x, beta, y, desc_a, info)
|
||||
call psb_spmm(alpha, a, x, beta, y,desc_a, info, &
|
||||
& trans, work)
|
||||
</PRE>
|
||||
psb_spnrmi(A, desc_a, info)
|
||||
</PRE>
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
@@ -216,23 +137,8 @@ call psb_spmm(alpha, a, x, beta, y,desc_a, info, &
|
||||
<DT><STRONG><B>On Entry</B></STRONG></DT>
|
||||
<DD>
|
||||
</DD>
|
||||
<DT><STRONG>alpha</STRONG></DT>
|
||||
<DD>the scalar <IMG
|
||||
WIDTH="14" HEIGHT="13" ALIGN="BOTTOM" BORDER="0"
|
||||
SRC="img28.png"
|
||||
ALT="$\alpha$">.
|
||||
<BR>
|
||||
Scope: <B>global</B>
|
||||
<BR>
|
||||
Type: <B>required</B>
|
||||
<BR>
|
||||
Intent: <B>in</B>.
|
||||
<BR>
|
||||
Specified as: a number of the data type indicated in
|
||||
Table <A HREF="#tab:f90spmm">11</A>.
|
||||
</DD>
|
||||
<DT><STRONG>a</STRONG></DT>
|
||||
<DD>the local portion of the sparse matrix
|
||||
<DD>the local portion of the global sparse matrix
|
||||
<IMG
|
||||
WIDTH="16" HEIGHT="14" ALIGN="BOTTOM" BORDER="0"
|
||||
SRC="img1.png"
|
||||
@@ -246,68 +152,6 @@ Intent: <B>in</B>.
|
||||
<BR>
|
||||
Specified as: a structured data of type spdata<TT>psb_spmat_type</TT>.
|
||||
</DD>
|
||||
<DT><STRONG>x</STRONG></DT>
|
||||
<DD>the local portion of global dense matrix
|
||||
<IMG
|
||||
WIDTH="13" HEIGHT="13" ALIGN="BOTTOM" BORDER="0"
|
||||
SRC="img26.png"
|
||||
ALT="$x$">.
|
||||
|
||||
<BR>
|
||||
Scope: <B>local</B>
|
||||
<BR>
|
||||
Type: <B>required</B>
|
||||
<BR>
|
||||
Intent: <B>in</B>.
|
||||
<BR>
|
||||
Specified as: a rank one or two array
|
||||
containing numbers of type specified in
|
||||
Table <A HREF="#tab:f90spmm">11</A>. The rank of <IMG
|
||||
WIDTH="13" HEIGHT="13" ALIGN="BOTTOM" BORDER="0"
|
||||
SRC="img26.png"
|
||||
ALT="$x$"> must be the same of <IMG
|
||||
WIDTH="13" HEIGHT="30" ALIGN="MIDDLE" BORDER="0"
|
||||
SRC="img27.png"
|
||||
ALT="$y$">.
|
||||
</DD>
|
||||
<DT><STRONG>beta</STRONG></DT>
|
||||
<DD>the scalar <IMG
|
||||
WIDTH="14" HEIGHT="30" ALIGN="MIDDLE" BORDER="0"
|
||||
SRC="img29.png"
|
||||
ALT="$\beta$">.
|
||||
<BR>
|
||||
Scope: <B>global</B>
|
||||
<BR>
|
||||
Type: <B>required</B>
|
||||
<BR>
|
||||
Intent: <B>in</B>.
|
||||
<BR>
|
||||
Specified as: a number of the data type indicated in Table <A HREF="#tab:f90spmm">11</A>.
|
||||
</DD>
|
||||
<DT><STRONG>y</STRONG></DT>
|
||||
<DD>the local portion of global dense matrix
|
||||
<IMG
|
||||
WIDTH="13" HEIGHT="30" ALIGN="MIDDLE" BORDER="0"
|
||||
SRC="img27.png"
|
||||
ALT="$y$">.
|
||||
|
||||
<BR>
|
||||
Scope: <B>local</B>
|
||||
<BR>
|
||||
Type: <B>required</B>
|
||||
<BR>
|
||||
Intent: <B>inout</B>.
|
||||
<BR>
|
||||
Specified as: a rank one or two array
|
||||
containing numbers of type specified in
|
||||
Table <A HREF="#tab:f90spmm">11</A>. The rank of <IMG
|
||||
WIDTH="13" HEIGHT="30" ALIGN="MIDDLE" BORDER="0"
|
||||
SRC="img27.png"
|
||||
ALT="$y$"> must be the same of <IMG
|
||||
WIDTH="13" HEIGHT="13" ALIGN="BOTTOM" BORDER="0"
|
||||
SRC="img26.png"
|
||||
ALT="$x$">.
|
||||
</DD>
|
||||
<DT><STRONG>desc_a</STRONG></DT>
|
||||
<DD>contains data structures for communications.
|
||||
<BR>
|
||||
@@ -319,74 +163,18 @@ Intent: <B>in</B>.
|
||||
<BR>
|
||||
Specified as: a structured data of type descdata<TT>psb_desc_type</TT>.
|
||||
</DD>
|
||||
<DT><STRONG>trans</STRONG></DT>
|
||||
<DD>indicate what kind of operation to perform.
|
||||
<DL>
|
||||
<DT><STRONG>trans = N</STRONG></DT>
|
||||
<DD>the operation is specified by equation <A HREF="#eq:f90spmm_no_tra">1</A>
|
||||
</DD>
|
||||
<DT><STRONG>trans = T</STRONG></DT>
|
||||
<DD>the operation is specified by equation
|
||||
<A HREF="#eq:f90spmm_tra">2</A>
|
||||
</DD>
|
||||
<DT><STRONG>trans = C</STRONG></DT>
|
||||
<DD>the operation is specified by equation
|
||||
<A HREF="#eq:f90spmm_con">3</A>
|
||||
</DD>
|
||||
</DL>
|
||||
Scope: <B>global</B>
|
||||
<BR>
|
||||
Type: <B>optional</B>
|
||||
<BR>
|
||||
Intent: <B>in</B>.
|
||||
<BR>
|
||||
Default: <IMG
|
||||
WIDTH="78" HEIGHT="14" ALIGN="BOTTOM" BORDER="0"
|
||||
SRC="img56.png"
|
||||
ALT="$trans = N$">
|
||||
<BR>
|
||||
Specified as: a character variable.
|
||||
|
||||
<P>
|
||||
</DD>
|
||||
<DT><STRONG>work</STRONG></DT>
|
||||
<DD>work array.
|
||||
<BR>
|
||||
Scope: <B>local</B>
|
||||
<BR>
|
||||
Type: <B>optional</B>
|
||||
<BR>
|
||||
Intent: <B>inout</B>.
|
||||
<BR>
|
||||
Specified as: a rank one array of the same type of <IMG
|
||||
WIDTH="13" HEIGHT="13" ALIGN="BOTTOM" BORDER="0"
|
||||
SRC="img26.png"
|
||||
ALT="$x$"> and <IMG
|
||||
WIDTH="13" HEIGHT="30" ALIGN="MIDDLE" BORDER="0"
|
||||
SRC="img27.png"
|
||||
ALT="$y$"> with
|
||||
the TARGET attribute.
|
||||
|
||||
<P>
|
||||
</DD>
|
||||
<DT><STRONG><B>On Return</B></STRONG></DT>
|
||||
<DD>
|
||||
</DD>
|
||||
<DT><STRONG>y</STRONG></DT>
|
||||
<DD>the local portion of result submatrix <IMG
|
||||
WIDTH="13" HEIGHT="30" ALIGN="MIDDLE" BORDER="0"
|
||||
SRC="img27.png"
|
||||
ALT="$y$">.
|
||||
<DT><STRONG>Function value</STRONG></DT>
|
||||
<DD>is the infinity-norm of sparse submatrix <IMG
|
||||
WIDTH="16" HEIGHT="14" ALIGN="BOTTOM" BORDER="0"
|
||||
SRC="img1.png"
|
||||
ALT="$A$">.
|
||||
<BR>
|
||||
Scope: <B>local</B>
|
||||
Scope: <B>global</B>
|
||||
<BR>
|
||||
Type: <B>required</B>
|
||||
<BR>
|
||||
Intent: <B>inout</B>.
|
||||
<BR>
|
||||
Specified as: an array of rank one or two
|
||||
containing numbers of type specified in
|
||||
Table <A HREF="#tab:f90spmm">11</A>.
|
||||
Specified as: a long precision real number.
|
||||
</DD>
|
||||
<DT><STRONG>info</STRONG></DT>
|
||||
<DD>Error code.
|
||||
@@ -404,26 +192,26 @@ An integer value; 0 means no error has been detected.
|
||||
<P>
|
||||
<HR>
|
||||
<!--Navigation Panel-->
|
||||
<A NAME="tex2html605"
|
||||
<A NAME="tex2html607"
|
||||
HREF="node36.html">
|
||||
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
|
||||
<A NAME="tex2html601"
|
||||
<A NAME="tex2html603"
|
||||
HREF="node25.html">
|
||||
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
|
||||
<A NAME="tex2html595"
|
||||
<A NAME="tex2html597"
|
||||
HREF="node34.html">
|
||||
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
|
||||
<A NAME="tex2html603"
|
||||
<A NAME="tex2html605"
|
||||
HREF="node1.html">
|
||||
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
|
||||
<BR>
|
||||
<B> Next:</B> <A NAME="tex2html606"
|
||||
HREF="node36.html">psb_spsm Triangular</A>
|
||||
<B> Up:</B> <A NAME="tex2html602"
|
||||
<B> Next:</B> <A NAME="tex2html608"
|
||||
HREF="node36.html">psb_spmm Sparse</A>
|
||||
<B> Up:</B> <A NAME="tex2html604"
|
||||
HREF="node25.html">Computational routines</A>
|
||||
<B> Previous:</B> <A NAME="tex2html596"
|
||||
HREF="node34.html">psb_spnrmi Infinity</A>
|
||||
<B> <A NAME="tex2html604"
|
||||
<B> Previous:</B> <A NAME="tex2html598"
|
||||
HREF="node34.html">psb_genrm2s Generalized</A>
|
||||
<B> <A NAME="tex2html606"
|
||||
HREF="node1.html">Contents</A></B>
|
||||
<!--End of Navigation Panel-->
|
||||
|
||||
|
||||
Reference in New Issue
Block a user