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
+79 -29
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>mm_mat_read -- Read a sparse matrix from a file in the MatrixMarket format</TITLE>
<META NAME="description" CONTENT="mm_mat_read -- Read a sparse matrix from a file in the MatrixMarket format">
<TITLE>hb_write -- Write a sparse matrix to a file in the Harwell-Boeing format</TITLE>
<META NAME="description" CONTENT="hb_write -- Write a sparse matrix to a file in the Harwell-Boeing format">
<META NAME="keywords" CONTENT="userhtml">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
@@ -20,45 +20,45 @@ original version by: Nikos Drakos, CBLU, University of Leeds
<LINK REL="next" HREF="node96.html">
<LINK REL="previous" HREF="node94.html">
<LINK REL="up" HREF="node92.html">
<LINK REL="up" HREF="node93.html">
<LINK REL="next" HREF="node96.html">
</HEAD>
<BODY >
<!--Navigation Panel-->
<A NAME="tex2html1371"
<A NAME="tex2html1373"
HREF="node96.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
<A NAME="tex2html1367"
HREF="node92.html">
<A NAME="tex2html1369"
HREF="node93.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
<A NAME="tex2html1361"
<A NAME="tex2html1363"
HREF="node94.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
<A NAME="tex2html1369"
<A NAME="tex2html1371"
HREF="node1.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
<BR>
<B> Next:</B> <A NAME="tex2html1372"
HREF="node96.html">mm_vet_read Read</A>
<B> Up:</B> <A NAME="tex2html1368"
HREF="node92.html">Utilities</A>
<B> Previous:</B> <A NAME="tex2html1362"
HREF="node94.html">hb_write Write</A>
&nbsp; <B> <A NAME="tex2html1370"
<B> Next:</B> <A NAME="tex2html1374"
HREF="node96.html">mm_mat_read Read</A>
<B> Up:</B> <A NAME="tex2html1370"
HREF="node93.html">Utilities</A>
<B> Previous:</B> <A NAME="tex2html1364"
HREF="node94.html">hb_read Read</A>
&nbsp; <B> <A NAME="tex2html1372"
HREF="node1.html">Contents</A></B>
<BR>
<BR>
<!--End of Navigation Panel-->
<H2><A NAME="SECTION000103000000000000000">
mm_mat_read -- Read a sparse matrix from a
file in the MatrixMarket format</A>
<H2><A NAME="SECTION000102000000000000000">
hb_write -- Write a sparse matrix to a file
in the Harwell-Boeing format</A>
</H2>
<P>
<PRE>
call mm_mat_read(a, iret, iunit, filename)
call hb_write(a, iret, iunit, filename, key, rhs, mtitle)
</PRE>
<P>
@@ -69,13 +69,29 @@ call mm_mat_read(a, iret, iunit, filename)
<DT><STRONG><B>On Entry </B></STRONG></DT>
<DD>
</DD>
<DT><STRONG>a</STRONG></DT>
<DD>the sparse matrix to be written.
<BR>
Type:<B>required</B>.
<BR>
Specified as: a structured data of type spdata<TT>psb_spmat_type</TT>.
</DD>
<DT><STRONG>b</STRONG></DT>
<DD>Rigth hand side.
<BR>
Type: <B>Optional</B>
<BR>
An array of type real or complex, rank 1 and having the ALLOCATABLE
attribute; will be allocated and filled in if the input file contains
a right hand side.
</DD>
<DT><STRONG>filename</STRONG></DT>
<DD>The name of the file to be read.
<DD>The name of the file to be written to.
<BR>
Type:<B>optional</B>.
<BR>
Specified as: a character variable containing a valid file name, or
<code>-</code>, in which case the default input unit 5 (i.e. standard input
<code>-</code>, in which case the default output unit 6 (i.e. standard output
in Unix jargon) is used. Default: <code>-</code>.
</DD>
<DT><STRONG>iunit</STRONG></DT>
@@ -85,6 +101,24 @@ Type:<B>optional</B>.
<BR>
Specified as: an integer value. Only meaningful if filename is not <code>-</code>.
</DD>
<DT><STRONG>key</STRONG></DT>
<DD>Matrix key.
<BR>
Type: <B>Optional</B>
<BR>
A charachter variable of length 8 holding the
matrix key as specified by the Harwell-Boeing format and to be
written to file.
</DD>
<DT><STRONG>mtitle</STRONG></DT>
<DD>Matrix title.
<BR>
Type: <B>Optional</B>
<BR>
A charachter variable of length 72 holding the
matrix title as specified by the Harwell-Boeing format and to be
written to file.
</DD>
</DL>
<P>
@@ -92,13 +126,6 @@ Specified as: an integer value. Only meaningful if filename is not <code>-</code
<DT><STRONG><B>On Return</B></STRONG></DT>
<DD>
</DD>
<DT><STRONG>a</STRONG></DT>
<DD>the sparse matrix read from file.
<BR>
Type:<B>required</B>.
<BR>
Specified as: a structured data of type spdata<TT>psb_spmat_type</TT>.
</DD>
<DT><STRONG>iret</STRONG></DT>
<DD>Error code.
<BR>
@@ -109,7 +136,30 @@ An integer value; 0 means no error has been detected.
</DL>
<P>
<BR><HR>
<HR>
<!--Navigation Panel-->
<A NAME="tex2html1373"
HREF="node96.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
<A NAME="tex2html1369"
HREF="node93.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
<A NAME="tex2html1363"
HREF="node94.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
<A NAME="tex2html1371"
HREF="node1.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
<BR>
<B> Next:</B> <A NAME="tex2html1374"
HREF="node96.html">mm_mat_read Read</A>
<B> Up:</B> <A NAME="tex2html1370"
HREF="node93.html">Utilities</A>
<B> Previous:</B> <A NAME="tex2html1364"
HREF="node94.html">hb_read Read</A>
&nbsp; <B> <A NAME="tex2html1372"
HREF="node1.html">Contents</A></B>
<!--End of Navigation Panel-->
</BODY>
</HTML>