Updated docs.
This commit is contained in:
Salvatore Filippone
2014-03-25 11:24:42 +00:00
parent 38b70b287f
commit fdaa0f5d74
127 changed files with 14415 additions and 14395 deletions
+80 -66
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_gedot -- Dot Product</TITLE>
<META NAME="description" CONTENT="psb_gedot -- Dot Product">
<META NAME="keywords" CONTENT="userhtml">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
@@ -20,117 +20,132 @@ original version by: Nikos Drakos, CBLU, University of Leeds
<LINK REL="next" HREF="node50.html">
<LINK REL="previous" HREF="node48.html">
<LINK REL="up" HREF="node46.html">
<LINK REL="up" HREF="node47.html">
<LINK REL="next" HREF="node50.html">
</HEAD>
<BODY >
<!--Navigation Panel-->
<A NAME="tex2html835"
<A NAME="tex2html838"
HREF="node50.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
<A NAME="tex2html831"
HREF="node46.html">
<A NAME="tex2html834"
HREF="node47.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
<A NAME="tex2html825"
<A NAME="tex2html828"
HREF="node48.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
<A NAME="tex2html833"
<A NAME="tex2html836"
HREF="node1.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
<BR>
<B> Next:</B> <A NAME="tex2html836"
HREF="node50.html">psb_geamax Infinity-Norm</A>
<B> Up:</B> <A NAME="tex2html832"
HREF="node46.html">Computational routines</A>
<B> Previous:</B> <A NAME="tex2html826"
HREF="node48.html">psb_gedot Dot</A>
&nbsp; <B> <A NAME="tex2html834"
<B> Next:</B> <A NAME="tex2html839"
HREF="node50.html">psb_gedots Generalized</A>
<B> Up:</B> <A NAME="tex2html835"
HREF="node47.html">Computational routines</A>
<B> Previous:</B> <A NAME="tex2html829"
HREF="node48.html">psb_geaxpby General</A>
&nbsp; <B> <A NAME="tex2html837"
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="SECTION00052000000000000000">
psb_gedot -- Dot Product</A>
</H2>
<P>
This subroutine computes a series of dot products among the columns of
two dense matrices <IMG
This function computes dot product between two vectors <IMG
WIDTH="14" HEIGHT="13" ALIGN="BOTTOM" BORDER="0"
SRC="img20.png"
ALT="$x$"> and
<IMG
WIDTH="13" HEIGHT="30" ALIGN="MIDDLE" BORDER="0"
SRC="img21.png"
ALT="$y$">.
<BR>
If <IMG
WIDTH="14" HEIGHT="13" ALIGN="BOTTOM" BORDER="0"
SRC="img20.png"
ALT="$x$"> and <IMG
WIDTH="13" HEIGHT="30" ALIGN="MIDDLE" BORDER="0"
SRC="img21.png"
ALT="$y$">:
ALT="$y$"> are real vectors
it computes dot-product as:
<BR><P></P>
<DIV ALIGN="CENTER">
<!-- MATH
\begin{displaymath}
res(i) \leftarrow x(:,i)^T y(:,i)
dot \leftarrow x^T y
\end{displaymath}
-->
<IMG
WIDTH="150" HEIGHT="28" BORDER="0"
SRC="img27.png"
ALT="\begin{displaymath}res(i) \leftarrow x(:,i)^T y(:,i)\end{displaymath}">
WIDTH="74" HEIGHT="27" BORDER="0"
SRC="img24.png"
ALT="\begin{displaymath}dot \leftarrow x^T y\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
WIDTH="14" HEIGHT="13" ALIGN="BOTTOM" BORDER="0"
SRC="img20.png"
ALT="$x$"> is
used. If <IMG
Else if <IMG
WIDTH="14" HEIGHT="13" ALIGN="BOTTOM" BORDER="0"
SRC="img20.png"
ALT="$x$"> and <IMG
WIDTH="13" HEIGHT="30" ALIGN="MIDDLE" BORDER="0"
SRC="img21.png"
ALT="$y$"> are of rank one, then <IMG
WIDTH="27" HEIGHT="13" ALIGN="BOTTOM" BORDER="0"
SRC="img28.png"
ALT="$res$"> is a scalar, else it
is a rank one array.
ALT="$y$"> are complex vectors then it computes dot-product as:
<BR><P></P>
<DIV ALIGN="CENTER">
<!-- MATH
\begin{displaymath}
dot \leftarrow x^H y
\end{displaymath}
-->
<IMG
WIDTH="76" HEIGHT="27" BORDER="0"
SRC="img25.png"
ALT="\begin{displaymath}dot \leftarrow x^H y\end{displaymath}">
</DIV>
<BR CLEAR="ALL">
<P></P>
<P>
<PRE>
call psb_gedots(res, x, y, desc_a, info)
psb_gedot(x, y, desc_a, info)
</PRE>
<BR><P></P>
<DIV ALIGN="CENTER"><A NAME="1794"></A>
<DIV ALIGN="CENTER"><A NAME="1814"></A>
<TABLE>
<CAPTION><STRONG>Table 3:</STRONG>
<CAPTION><STRONG>Table 2:</STRONG>
Data types</CAPTION>
<TR><TD>
<DIV ALIGN="CENTER">
<TABLE CELLPADDING=3 BORDER="1" ALIGN="CENTER">
<TR><TD ALIGN="LEFT"><IMG
WIDTH="27" HEIGHT="13" ALIGN="BOTTOM" BORDER="0"
SRC="img28.png"
ALT="$res$">, <IMG
WIDTH="25" HEIGHT="14" ALIGN="BOTTOM" BORDER="0"
SRC="img26.png"
ALT="$dot$">, <IMG
WIDTH="14" HEIGHT="13" ALIGN="BOTTOM" BORDER="0"
SRC="img20.png"
ALT="$x$">, <IMG
WIDTH="13" HEIGHT="30" ALIGN="MIDDLE" BORDER="0"
SRC="img21.png"
ALT="$y$"></TD>
<TD ALIGN="LEFT"><B>Subroutine</B></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">psb_gedot</TD>
</TR>
<TR><TD ALIGN="LEFT">Long Precision Real</TD>
<TD ALIGN="LEFT">psb_gedots</TD>
<TD ALIGN="LEFT">psb_gedot</TD>
</TR>
<TR><TD ALIGN="LEFT">Short Precision Complex</TD>
<TD ALIGN="LEFT">psb_gedots</TD>
<TD ALIGN="LEFT">psb_gedot</TD>
</TR>
<TR><TD ALIGN="LEFT">Long Precision Complex</TD>
<TD ALIGN="LEFT">psb_gedots</TD>
<TD ALIGN="LEFT">psb_gedot</TD>
</TR>
</TABLE>
</DIV>
@@ -152,7 +167,7 @@ Data types</CAPTION>
<IMG
WIDTH="14" HEIGHT="13" ALIGN="BOTTOM" BORDER="0"
SRC="img20.png"
ALT="$x$">.
ALT="$x$">.
<BR>
Scope: <B>local</B>
<BR>
@@ -162,7 +177,7 @@ Intent: <B>in</B>.
<BR>
Specified as: a rank one or two array or an object of type vdata<TT>psb_T_vect_type</TT>
containing numbers of type specified in
Table&nbsp;<A HREF="#tab:f90mdot">3</A>. The rank of <IMG
Table&nbsp;<A HREF="#tab:f90dot">2</A>. The rank of <IMG
WIDTH="14" HEIGHT="13" ALIGN="BOTTOM" BORDER="0"
SRC="img20.png"
ALT="$x$"> must be the same of <IMG
@@ -185,7 +200,7 @@ Intent: <B>in</B>.
<BR>
Specified as: a rank one or two array or an object of type vdata<TT>psb_T_vect_type</TT>
containing numbers of type specified in
Table&nbsp;<A HREF="#tab:f90mdot">3</A>. The rank of <IMG
Table&nbsp;<A HREF="#tab:f90dot">2</A>. The rank of <IMG
WIDTH="13" HEIGHT="30" ALIGN="MIDDLE" BORDER="0"
SRC="img21.png"
ALT="$y$"> must be the same of <IMG
@@ -203,11 +218,13 @@ Type: <B>required</B>
Intent: <B>in</B>.
<BR>
Specified as: an object 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>
<DT><STRONG>Function value</STRONG></DT>
<DD>is the dot product of subvectors <IMG
WIDTH="14" HEIGHT="13" ALIGN="BOTTOM" BORDER="0"
SRC="img20.png"
@@ -218,10 +235,7 @@ Specified as: an object of type descdata<TT>psb_desc_type</TT>.
<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 number of the data type indicated in Table&nbsp;<A HREF="#tab:f90dot">2</A>.
</DD>
<DT><STRONG>info</STRONG></DT>
<DD>Error code.
@@ -239,26 +253,26 @@ An integer value; 0 means no error has been detected.
<P>
<HR>
<!--Navigation Panel-->
<A NAME="tex2html835"
<A NAME="tex2html838"
HREF="node50.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
<A NAME="tex2html831"
HREF="node46.html">
<A NAME="tex2html834"
HREF="node47.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
<A NAME="tex2html825"
<A NAME="tex2html828"
HREF="node48.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
<A NAME="tex2html833"
<A NAME="tex2html836"
HREF="node1.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
<BR>
<B> Next:</B> <A NAME="tex2html836"
HREF="node50.html">psb_geamax Infinity-Norm</A>
<B> Up:</B> <A NAME="tex2html832"
HREF="node46.html">Computational routines</A>
<B> Previous:</B> <A NAME="tex2html826"
HREF="node48.html">psb_gedot Dot</A>
&nbsp; <B> <A NAME="tex2html834"
<B> Next:</B> <A NAME="tex2html839"
HREF="node50.html">psb_gedots Generalized</A>
<B> Up:</B> <A NAME="tex2html835"
HREF="node47.html">Computational routines</A>
<B> Previous:</B> <A NAME="tex2html829"
HREF="node48.html">psb_geaxpby General</A>
&nbsp; <B> <A NAME="tex2html837"
HREF="node1.html">Contents</A></B>
<!--End of Navigation Panel-->