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:
+32
-35
@@ -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_write -- Write a sparse matrix to a file in the MatrixMarket format</TITLE>
|
||||
<META NAME="description" CONTENT="mm_mat_write -- Write a sparse matrix to a file in the MatrixMarket format">
|
||||
<TITLE>mm_vet_read -- Read a dense vector from a file in the MatrixMarket format</TITLE>
|
||||
<META NAME="description" CONTENT="mm_vet_read -- Read a dense vector from a file in the MatrixMarket format">
|
||||
<META NAME="keywords" CONTENT="userhtml">
|
||||
<META NAME="resource-type" CONTENT="document">
|
||||
<META NAME="distribution" CONTENT="global">
|
||||
@@ -18,46 +18,49 @@ original version by: Nikos Drakos, CBLU, University of Leeds
|
||||
|
||||
<LINK REL="STYLESHEET" HREF="userhtml.css">
|
||||
|
||||
<LINK REL="next" HREF="node98.html">
|
||||
<LINK REL="previous" HREF="node96.html">
|
||||
<LINK REL="up" HREF="node92.html">
|
||||
<LINK REL="up" HREF="node93.html">
|
||||
<LINK REL="next" HREF="node98.html">
|
||||
</HEAD>
|
||||
|
||||
<BODY >
|
||||
<!--Navigation Panel-->
|
||||
<A NAME="tex2html1393"
|
||||
<A NAME="tex2html1397"
|
||||
HREF="node98.html">
|
||||
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
|
||||
<A NAME="tex2html1389"
|
||||
HREF="node92.html">
|
||||
<A NAME="tex2html1393"
|
||||
HREF="node93.html">
|
||||
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
|
||||
<A NAME="tex2html1385"
|
||||
<A NAME="tex2html1387"
|
||||
HREF="node96.html">
|
||||
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
|
||||
<A NAME="tex2html1391"
|
||||
<A NAME="tex2html1395"
|
||||
HREF="node1.html">
|
||||
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
|
||||
<BR>
|
||||
<B> Next:</B> <A NAME="tex2html1394"
|
||||
HREF="node98.html">Preconditioner routines</A>
|
||||
<B> Up:</B> <A NAME="tex2html1390"
|
||||
HREF="node92.html">Utilities</A>
|
||||
<B> Previous:</B> <A NAME="tex2html1386"
|
||||
HREF="node96.html">mm_vet_read Read</A>
|
||||
<B> <A NAME="tex2html1392"
|
||||
<B> Next:</B> <A NAME="tex2html1398"
|
||||
HREF="node98.html">mm_mat_write Write</A>
|
||||
<B> Up:</B> <A NAME="tex2html1394"
|
||||
HREF="node93.html">Utilities</A>
|
||||
<B> Previous:</B> <A NAME="tex2html1388"
|
||||
HREF="node96.html">mm_mat_read Read</A>
|
||||
<B> <A NAME="tex2html1396"
|
||||
HREF="node1.html">Contents</A></B>
|
||||
<BR>
|
||||
<BR>
|
||||
<!--End of Navigation Panel-->
|
||||
|
||||
<H2><A NAME="SECTION000105000000000000000">
|
||||
mm_mat_write -- Write a sparse matrix to a
|
||||
<H2><A NAME="SECTION000104000000000000000">
|
||||
mm_vet_read -- Read a dense vector from a
|
||||
file in the MatrixMarket format</A>
|
||||
</H2>
|
||||
|
||||
<PRE>
|
||||
call mm_mat_write(a, mtitle, iret, iunit, filename)
|
||||
call mm_vet_read(b, iret, iunit, filename)
|
||||
</PRE>
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><STRONG>Type:</STRONG></DT>
|
||||
<DD>Asynchronous.
|
||||
@@ -65,28 +68,13 @@ call mm_mat_write(a, mtitle, 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>mtitle</STRONG></DT>
|
||||
<DD>Matrix title.
|
||||
<BR>
|
||||
Type: <B>required</B>
|
||||
<BR>
|
||||
A charachter variable holding a descriptive title for the matrix to be
|
||||
written to file.
|
||||
</DD>
|
||||
<DT><STRONG>filename</STRONG></DT>
|
||||
<DD>The name of the file to be written to.
|
||||
<DD>The name of the file to be read.
|
||||
<BR>
|
||||
Type:<B>optional</B>.
|
||||
<BR>
|
||||
Specified as: a character variable containing a valid file name, or
|
||||
<code>-</code>, in which case the default output unit 6 (i.e. standard output
|
||||
<code>-</code>, in which case the default input unit 5 (i.e. standard input
|
||||
in Unix jargon) is used. Default: <code>-</code>.
|
||||
</DD>
|
||||
<DT><STRONG>iunit</STRONG></DT>
|
||||
@@ -103,6 +91,15 @@ 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>b</STRONG></DT>
|
||||
<DD>Rigth hand side(s).
|
||||
<BR>
|
||||
Type: <B>required</B>
|
||||
<BR>
|
||||
An array of type real or complex, rank 2 and having the ALLOCATABLE
|
||||
attribute; will be allocated and filled in if the input file contains
|
||||
a right hand side, otherwise will be left in the UNALLOCATED state.
|
||||
</DD>
|
||||
<DT><STRONG>iret</STRONG></DT>
|
||||
<DD>Error code.
|
||||
<BR>
|
||||
|
||||
Reference in New Issue
Block a user