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
+48 -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_geall -- Allocates a dense matrix</TITLE>
<META NAME="description" CONTENT="psb_geall -- Allocates a dense matrix">
<TITLE>psb_sprn -- Reinit sparse matrix structure for psblas routines.</TITLE>
<META NAME="description" CONTENT="psb_sprn -- Reinit sparse matrix structure for psblas routines.">
<META NAME="keywords" CONTENT="userhtml">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
@@ -20,44 +20,45 @@ original version by: Nikos Drakos, CBLU, University of Leeds
<LINK REL="next" HREF="node55.html">
<LINK REL="previous" HREF="node53.html">
<LINK REL="up" HREF="node42.html">
<LINK REL="up" HREF="node43.html">
<LINK REL="next" HREF="node55.html">
</HEAD>
<BODY >
<!--Navigation Panel-->
<A NAME="tex2html860"
<A NAME="tex2html862"
HREF="node55.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
<A NAME="tex2html856"
HREF="node42.html">
<A NAME="tex2html858"
HREF="node43.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
<A NAME="tex2html850"
<A NAME="tex2html852"
HREF="node53.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
<A NAME="tex2html858"
<A NAME="tex2html860"
HREF="node1.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
<BR>
<B> Next:</B> <A NAME="tex2html861"
HREF="node55.html">psb_geins Dense</A>
<B> Up:</B> <A NAME="tex2html857"
HREF="node42.html">Data management routines</A>
<B> Previous:</B> <A NAME="tex2html851"
HREF="node53.html">psb_sprn Reinit</A>
&nbsp; <B> <A NAME="tex2html859"
<B> Next:</B> <A NAME="tex2html863"
HREF="node55.html">psb_geall Allocates</A>
<B> Up:</B> <A NAME="tex2html859"
HREF="node43.html">Data management routines</A>
<B> Previous:</B> <A NAME="tex2html853"
HREF="node53.html">psb_spfree Frees</A>
&nbsp; <B> <A NAME="tex2html861"
HREF="node1.html">Contents</A></B>
<BR>
<BR>
<!--End of Navigation Panel-->
<H2><A NAME="SECTION000712000000000000000">
psb_geall -- Allocates a dense matrix</A>
<H2><A NAME="SECTION000711000000000000000">
psb_sprn -- Reinit sparse matrix structure for psblas
routines.</A>
</H2>
<P>
<PRE>
call psb_geall(x, desc_a, info, n, lb)
call psb_sprn(a, decsc_a, info, clear)
</PRE>
<P>
@@ -68,52 +69,38 @@ call psb_geall(x, desc_a, info, n, lb)
<DT><STRONG><B>On Entry</B></STRONG></DT>
<DD>
</DD>
<DT><STRONG>desc_a</STRONG></DT>
<DD>The communication descriptor.
<DT><STRONG>a</STRONG></DT>
<DD>the matrix to be reinitialized.
<BR>
Scope: <B>local</B>
Scope:<B>local</B>
<BR>
Type: <B>required</B>
Type:<B>required</B>
<BR>
Intent: <B>in</B>.
Intent: <B>inout</B>.
<BR>
Specified as: a variable of type descdata<TT>psb_desc_type</TT>.
<BR></DD>
<DT><STRONG>n</STRONG></DT>
<DD>The number of columns of the dense matrix to be allocated.
<BR>
Scope: <B>local</B>
<BR>
Type: <B>optional</B>
<BR>
Intent: <B>in</B>.
<BR>
Specified as: Integer scalar, default <IMG
WIDTH="12" HEIGHT="13" ALIGN="BOTTOM" BORDER="0"
SRC="img104.png"
ALT="$1$">. It is not a valid argument if <IMG
WIDTH="13" HEIGHT="13" ALIGN="BOTTOM" BORDER="0"
SRC="img26.png"
ALT="$x$"> is a
rank-1 array.
Specified as: a structured data of type spdata<TT>psb_spmat_type</TT>.
</DD>
<DT><STRONG>lb</STRONG></DT>
<DD>The lower bound for the column index range of the dense matrix to be allocated.
<DT><STRONG>desc_a</STRONG></DT>
<DD>the communication descriptor.
<BR>
Scope: <B>local</B>
Scope:<B>local</B>.
<BR>
Type: <B>optional</B>
Type:<B>required</B>.
<BR>
Intent: <B>in</B>.
<BR>
Specified as: Integer scalar, default <IMG
WIDTH="12" HEIGHT="13" ALIGN="BOTTOM" BORDER="0"
SRC="img104.png"
ALT="$1$">. It is not a valid argument if <IMG
WIDTH="13" HEIGHT="13" ALIGN="BOTTOM" BORDER="0"
SRC="img26.png"
ALT="$x$"> is a
rank-1 array.
Specified as: a structured data of type descdata<TT>psb_desc_type</TT>.
</DD>
<DT><STRONG>clear</STRONG></DT>
<DD>Choose whether to zero out matrix coefficients
<BR>
Scope:<B>local</B>.
<BR>
Type:<B>optional</B>.
<BR>
Intent: <B>in</B>.
<BR>
Default: true.
</DD>
</DL>
@@ -122,18 +109,6 @@ rank-1 array.
<DT><STRONG><B>On Return</B></STRONG></DT>
<DD>
</DD>
<DT><STRONG>x</STRONG></DT>
<DD>The dense matrix to be allocated.
<BR>
Scope: <B>local</B>
<BR>
Type: <B>required</B>
<BR>
Intent: <B>out</B>.
<BR>
Specified as: a rank one or two array with the ALLOCATABLE
attribute, of type real, complex or integer.
<BR></DD>
<DT><STRONG>info</STRONG></DT>
<DD>Error code.
<BR>
@@ -146,6 +121,13 @@ Intent: <B>out</B>.
An integer value; 0 means no error has been detected.
</DD>
</DL>
<FONT SIZE="+1"><B>Notes</B></FONT>
<OL>
<LI>On exit from this routine the sparse matrix is in the update
state.
</LI>
</OL>
<P>
<BR><HR>