fdurastante/psblas3
1
0
Fork 0
mirror of https://github.com/sfilippone/psblas3.git synced 2026-10-19 20:32:12 +00:00
Code Issues Packages Projects Releases Wiki Activity

Doc fixes

Browse Source
This commit is contained in:
Salvatore Filippone
2024-11-16 12:03:28 +01:00
parent eefc67bbdd
commit 9c4f4c4d15
64 changed files with 18806 additions and 17588 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/html/userhtmlse9.html
+110 -110
View File
@@ -16,7 +16,7 @@ href="userhtmlse8.html" >prev</a>] [<a
href="userhtmlse8.html#tailuserhtmlse8.html" >prev-tail</a>] [<a
href="userhtmlse6.html#tailuserhtmlse9.html">tail</a>] [<a
href="userhtml.html#userhtmlse12.html" >up</a>] </p></div>
<h3 class="sectionHead"><span class="titlemark">9 </span> <a
<h3 class="sectionHead"><span class="titlemark">9 </span> <a
id="x14-1280009"></a>Utilities</h3>
<!--l. 4--><p class="noindent" >We have some utilities available for input and output of sparse matrices; the
interfaces to these routines are available in the module <span class="obeylines-h"><span class="verb"><span
@@ -24,7 +24,7 @@ class="cmtt-10">psb_util_mod</span></span></span>.
<h4 class="subsectionHead"><span class="titlemark">9.1 </span> <a
<h4 class="subsectionHead"><span class="titlemark">9.1 </span> <a
id="x14-1290009.1"></a> hb_read &#8212; Read a sparse matrix from a file in the Harwell&#8211;Boeing
format</h4>
<!--l. 16-->
@@ -50,53 +50,53 @@ class="cmtt-10">)</span></span></pre>
<dl class="description"><dt class="description">
<!--l. 21--><p class="noindent" >
<span
class="cmbx-10">Type:</span> </dt><dd
class="pplb7t-">Type:</span> </dt><dd
class="description">
<!--l. 21--><p class="noindent" >Asynchronous.
</dd><dt class="description">
<!--l. 22--><p class="noindent" >
<span
class="cmbx-10">On Entry</span> </dt><dd
class="pplb7t-">On Entry</span> </dt><dd
class="description">
<!--l. 22--><p class="noindent" >
</dd><dt class="description">
<!--l. 23--><p class="noindent" >
<span
class="cmbx-10">filename</span> </dt><dd
class="pplb7t-">filename</span> </dt><dd
class="description">
<!--l. 23--><p class="noindent" >The name of the file to be read.<br
class="newline" />Type:<span
class="cmbx-10">optional</span>.<br
class="newline" />Specified as: a character variable containing a valid file name, or <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">-</span></span></span>, in
class="pplb7t-">optional</span>.<br
class="newline" />Specified as: a character variable containing a valid file name, or <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">-</span></span></span>, in
which case the default input unit 5 (i.e. standard input in Unix jargon) is
used. Default: <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">-</span></span></span>.
</dd><dt class="description">
<!--l. 28--><p class="noindent" >
<span
class="cmbx-10">iunit</span> </dt><dd
class="pplb7t-">iunit</span> </dt><dd
class="description">
<!--l. 28--><p class="noindent" >The Fortran file unit number.<br
class="newline" />Type:<span
class="cmbx-10">optional</span>.<br
class="pplb7t-">optional</span>.<br
class="newline" />Specified as: an integer value. Only meaningful if filename is not <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">-</span></span></span>.</dd></dl>
<!--l. 33--><p class="noindent" >
<dl class="description"><dt class="description">
<!--l. 34--><p class="noindent" >
<span
class="cmbx-10">On Return</span> </dt><dd
class="pplb7t-">On Return</span> </dt><dd
class="description">
<!--l. 34--><p class="noindent" >
</dd><dt class="description">
<!--l. 35--><p class="noindent" >
<span
class="cmbx-10">a</span> </dt><dd
class="pplb7t-">a</span> </dt><dd
class="description">
<!--l. 35--><p class="noindent" >the sparse matrix read from file.<br
class="newline" />Type:<span
class="cmbx-10">required</span>.<br
class="pplb7t-">required</span>.<br
class="newline" />Specified as: a structured data of type <a
href="userhtmlse3.html#spdata"><span
class="cmtt-10">psb</span><span
@@ -108,37 +108,37 @@ class="cmtt-10">_type</span></a>.
</dd><dt class="description">
<!--l. 38--><p class="noindent" >
<span
class="cmbx-10">b</span> </dt><dd
class="pplb7t-">b</span> </dt><dd
class="description">
<!--l. 38--><p class="noindent" >Rigth hand side(s).<br
class="newline" />Type: <span
class="cmbx-10">Optional </span><br
class="pplb7t-">Optional </span><br
class="newline" />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 class="description">
<!--l. 43--><p class="noindent" >
<span
class="cmbx-10">mtitle</span> </dt><dd
class="pplb7t-">mtitle</span> </dt><dd
class="description">
<!--l. 43--><p class="noindent" >Matrix title.<br
class="newline" />Type: <span
class="cmbx-10">Optional </span><br
class="pplb7t-">Optional </span><br
class="newline" />A charachter variable of length 72 holding a copy of the matrix title as
specified by the Harwell-Boeing format and contained in the input file.
</dd><dt class="description">
<!--l. 48--><p class="noindent" >
<span
class="cmbx-10">iret</span> </dt><dd
class="pplb7t-">iret</span> </dt><dd
class="description">
<!--l. 48--><p class="noindent" >Error code.<br
class="newline" />Type: <span
class="cmbx-10">required </span><br
class="pplb7t-">required </span><br
class="newline" />An integer value; 0 means no error has been detected.</dd></dl>
<h4 class="subsectionHead"><span class="titlemark">9.2 </span> <a
<h4 class="subsectionHead"><span class="titlemark">9.2 </span> <a
id="x14-1300009.2"></a>hb_write &#8212; Write a sparse matrix to a file in the Harwell&#8211;Boeing
format</h4>
<!--l. 59-->
@@ -166,23 +166,23 @@ class="cmtt-10">)</span></span></pre>
<dl class="description"><dt class="description">
<!--l. 66--><p class="noindent" >
<span
class="cmbx-10">Type:</span> </dt><dd
class="pplb7t-">Type:</span> </dt><dd
class="description">
<!--l. 66--><p class="noindent" >Asynchronous.
</dd><dt class="description">
<!--l. 67--><p class="noindent" >
<span
class="cmbx-10">On Entry</span> </dt><dd
class="pplb7t-">On Entry</span> </dt><dd
class="description">
<!--l. 67--><p class="noindent" >
</dd><dt class="description">
<!--l. 68--><p class="noindent" >
<span
class="cmbx-10">a</span> </dt><dd
class="pplb7t-">a</span> </dt><dd
class="description">
<!--l. 68--><p class="noindent" >the sparse matrix to be written.<br
class="newline" />Type:<span
class="cmbx-10">required</span>.<br
class="pplb7t-">required</span>.<br
class="newline" />Specified as: a structured data of type <a
href="userhtmlse3.html#spdata"><span
class="cmtt-10">psb</span><span
@@ -191,35 +191,35 @@ class="cmtt-10">_type</span></a>.
</dd><dt class="description">
<!--l. 71--><p class="noindent" >
<span
class="cmbx-10">b</span> </dt><dd
class="pplb7t-">b</span> </dt><dd
class="description">
<!--l. 71--><p class="noindent" >Rigth hand side.<br
class="newline" />Type: <span
class="cmbx-10">Optional </span><br
class="pplb7t-">Optional </span><br
class="newline" />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 class="description">
<!--l. 76--><p class="noindent" >
<span
class="cmbx-10">filename</span> </dt><dd
class="pplb7t-">filename</span> </dt><dd
class="description">
<!--l. 76--><p class="noindent" >The name of the file to be written to.<br
class="newline" />Type:<span
class="cmbx-10">optional</span>.<br
class="newline" />Specified as: a character variable containing a valid file name, or <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">-</span></span></span>, in
class="pplb7t-">optional</span>.<br
class="newline" />Specified as: a character variable containing a valid file name, or <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">-</span></span></span>, in
which case the default output unit 6 (i.e. standard output in Unix jargon)
is used. Default: <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">-</span></span></span>.
</dd><dt class="description">
<!--l. 81--><p class="noindent" >
<span
class="cmbx-10">iunit</span> </dt><dd
class="pplb7t-">iunit</span> </dt><dd
class="description">
<!--l. 81--><p class="noindent" >The Fortran file unit number.<br
class="newline" />Type:<span
class="cmbx-10">optional</span>.<br
class="pplb7t-">optional</span>.<br
class="newline" />Specified as: an integer value. Only meaningful if filename is not <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">-</span></span></span>.
@@ -228,43 +228,43 @@ class="cmtt-10">-</span></span></span>.
</dd><dt class="description">
<!--l. 84--><p class="noindent" >
<span
class="cmbx-10">key</span> </dt><dd
class="pplb7t-">key</span> </dt><dd
class="description">
<!--l. 84--><p class="noindent" >Matrix key.<br
class="newline" />Type: <span
class="cmbx-10">Optional </span><br
class="pplb7t-">Optional </span><br
class="newline" />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 class="description">
<!--l. 89--><p class="noindent" >
<span
class="cmbx-10">mtitle</span> </dt><dd
class="pplb7t-">mtitle</span> </dt><dd
class="description">
<!--l. 89--><p class="noindent" >Matrix title.<br
class="newline" />Type: <span
class="cmbx-10">Optional </span><br
class="pplb7t-">Optional </span><br
class="newline" />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>
<!--l. 96--><p class="noindent" >
<dl class="description"><dt class="description">
<!--l. 97--><p class="noindent" >
<span
class="cmbx-10">On Return</span> </dt><dd
class="pplb7t-">On Return</span> </dt><dd
class="description">
<!--l. 97--><p class="noindent" >
</dd><dt class="description">
<!--l. 98--><p class="noindent" >
<span
class="cmbx-10">iret</span> </dt><dd
class="pplb7t-">iret</span> </dt><dd
class="description">
<!--l. 98--><p class="noindent" >Error code.<br
class="newline" />Type: <span
class="cmbx-10">required </span><br
class="pplb7t-">required </span><br
class="newline" />An integer value; 0 means no error has been detected.</dd></dl>
<h4 class="subsectionHead"><span class="titlemark">9.3 </span> <a
<h4 class="subsectionHead"><span class="titlemark">9.3 </span> <a
id="x14-1310009.3"></a>mm_mat_read &#8212; Read a sparse matrix from a file in the MatrixMarket
format</h4>
<!--l. 111-->
@@ -286,53 +286,53 @@ class="cmtt-10">)</span></span></pre>
<dl class="description"><dt class="description">
<!--l. 116--><p class="noindent" >
<span
class="cmbx-10">Type:</span> </dt><dd
class="pplb7t-">Type:</span> </dt><dd
class="description">
<!--l. 116--><p class="noindent" >Asynchronous.
</dd><dt class="description">
<!--l. 117--><p class="noindent" >
<span
class="cmbx-10">On Entry</span> </dt><dd
class="pplb7t-">On Entry</span> </dt><dd
class="description">
<!--l. 117--><p class="noindent" >
</dd><dt class="description">
<!--l. 118--><p class="noindent" >
<span
class="cmbx-10">filename</span> </dt><dd
class="pplb7t-">filename</span> </dt><dd
class="description">
<!--l. 118--><p class="noindent" >The name of the file to be read.<br
class="newline" />Type:<span
class="cmbx-10">optional</span>.<br
class="newline" />Specified as: a character variable containing a valid file name, or <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">-</span></span></span>, in
class="pplb7t-">optional</span>.<br
class="newline" />Specified as: a character variable containing a valid file name, or <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">-</span></span></span>, in
which case the default input unit 5 (i.e. standard input in Unix jargon) is
used. Default: <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">-</span></span></span>.
</dd><dt class="description">
<!--l. 123--><p class="noindent" >
<span
class="cmbx-10">iunit</span> </dt><dd
class="pplb7t-">iunit</span> </dt><dd
class="description">
<!--l. 123--><p class="noindent" >The Fortran file unit number.<br
class="newline" />Type:<span
class="cmbx-10">optional</span>.<br
class="pplb7t-">optional</span>.<br
class="newline" />Specified as: an integer value. Only meaningful if filename is not <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">-</span></span></span>.</dd></dl>
<!--l. 128--><p class="noindent" >
<dl class="description"><dt class="description">
<!--l. 129--><p class="noindent" >
<span
class="cmbx-10">On Return</span> </dt><dd
class="pplb7t-">On Return</span> </dt><dd
class="description">
<!--l. 129--><p class="noindent" >
</dd><dt class="description">
<!--l. 130--><p class="noindent" >
<span
class="cmbx-10">a</span> </dt><dd
class="pplb7t-">a</span> </dt><dd
class="description">
<!--l. 130--><p class="noindent" >the sparse matrix read from file.<br
class="newline" />Type:<span
class="cmbx-10">required</span>.<br
class="pplb7t-">required</span>.<br
class="newline" />Specified as: a structured data of type <a
href="userhtmlse3.html#spdata"><span
class="cmtt-10">psb</span><span
@@ -344,16 +344,16 @@ class="cmtt-10">_type</span></a>.
</dd><dt class="description">
<!--l. 133--><p class="noindent" >
<span
class="cmbx-10">iret</span> </dt><dd
class="pplb7t-">iret</span> </dt><dd
class="description">
<!--l. 133--><p class="noindent" >Error code.<br
class="newline" />Type: <span
class="cmbx-10">required </span><br
class="pplb7t-">required </span><br
class="newline" />An integer value; 0 means no error has been detected.</dd></dl>
<h4 class="subsectionHead"><span class="titlemark">9.4 </span> <a
<h4 class="subsectionHead"><span class="titlemark">9.4 </span> <a
id="x14-1320009.4"></a>mm_array_read &#8212; Read a dense array from a file in the MatrixMarket
format</h4>
<!--l. 142-->
@@ -375,54 +375,54 @@ class="cmtt-10">)</span></span></pre>
<dl class="description"><dt class="description">
<!--l. 147--><p class="noindent" >
<span
class="cmbx-10">Type:</span> </dt><dd
class="pplb7t-">Type:</span> </dt><dd
class="description">
<!--l. 147--><p class="noindent" >Asynchronous.
</dd><dt class="description">
<!--l. 148--><p class="noindent" >
<span
class="cmbx-10">On Entry</span> </dt><dd
class="pplb7t-">On Entry</span> </dt><dd
class="description">
<!--l. 148--><p class="noindent" >
</dd><dt class="description">
<!--l. 149--><p class="noindent" >
<span
class="cmbx-10">filename</span> </dt><dd
class="pplb7t-">filename</span> </dt><dd
class="description">
<!--l. 149--><p class="noindent" >The name of the file to be read.<br
class="newline" />Type:<span
class="cmbx-10">optional</span>.<br
class="newline" />Specified as: a character variable containing a valid file name, or <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">-</span></span></span>, in
class="pplb7t-">optional</span>.<br
class="newline" />Specified as: a character variable containing a valid file name, or <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">-</span></span></span>, in
which case the default input unit 5 (i.e. standard input in Unix jargon) is
used. Default: <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">-</span></span></span>.
</dd><dt class="description">
<!--l. 154--><p class="noindent" >
<span
class="cmbx-10">iunit</span> </dt><dd
class="pplb7t-">iunit</span> </dt><dd
class="description">
<!--l. 154--><p class="noindent" >The Fortran file unit number.<br
class="newline" />Type:<span
class="cmbx-10">optional</span>.<br
class="pplb7t-">optional</span>.<br
class="newline" />Specified as: an integer value. Only meaningful if filename is not <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">-</span></span></span>.</dd></dl>
<!--l. 159--><p class="noindent" >
<dl class="description"><dt class="description">
<!--l. 160--><p class="noindent" >
<span
class="cmbx-10">On Return</span> </dt><dd
class="pplb7t-">On Return</span> </dt><dd
class="description">
<!--l. 160--><p class="noindent" >
</dd><dt class="description">
<!--l. 161--><p class="noindent" >
<span
class="cmbx-10">b</span> </dt><dd
class="pplb7t-">b</span> </dt><dd
class="description">
<!--l. 161--><p class="noindent" >Rigth hand side(s).<br
class="newline" />Type: <span
class="cmbx-10">required </span><br
class="newline" />An array of type real or complex, rank 1 or 2 and having the
class="pplb7t-">required </span><br
class="newline" />An array of type real or complex, rank 1 or 2 and having the
@@ -431,24 +431,24 @@ href="userhtmlse3.html#vdata"><span
class="cmtt-10">psb</span><span
class="cmtt-10">_T</span><span
class="cmtt-10">_vect</span><span
class="cmtt-10">_type</span></a>, of
type real or complex.<br
class="cmtt-10">_type</span></a>, of type
real or complex.<br
class="newline" />Will be allocated and filled in if the input file contains a right hand side,
otherwise will be left in the UNALLOCATED state. <br
class="newline" />
</dd><dt class="description">
<!--l. 168--><p class="noindent" >
<span
class="cmbx-10">iret</span> </dt><dd
class="pplb7t-">iret</span> </dt><dd
class="description">
<!--l. 168--><p class="noindent" >Error code.<br
class="newline" />Type: <span
class="cmbx-10">required </span><br
class="pplb7t-">required </span><br
class="newline" />An integer value; 0 means no error has been detected.</dd></dl>
<h4 class="subsectionHead"><span class="titlemark">9.5 </span> <a
<h4 class="subsectionHead"><span class="titlemark">9.5 </span> <a
id="x14-1330009.5"></a>mm_mat_write &#8212; Write a sparse matrix to a file in the MatrixMarket
format</h4>
<!--l. 179-->
@@ -472,23 +472,23 @@ class="cmtt-10">)</span></span></pre>
<dl class="description"><dt class="description">
<!--l. 183--><p class="noindent" >
<span
class="cmbx-10">Type:</span> </dt><dd
class="pplb7t-">Type:</span> </dt><dd
class="description">
<!--l. 183--><p class="noindent" >Asynchronous.
</dd><dt class="description">
<!--l. 184--><p class="noindent" >
<span
class="cmbx-10">On Entry</span> </dt><dd
class="pplb7t-">On Entry</span> </dt><dd
class="description">
<!--l. 184--><p class="noindent" >
</dd><dt class="description">
<!--l. 185--><p class="noindent" >
<span
class="cmbx-10">a</span> </dt><dd
class="pplb7t-">a</span> </dt><dd
class="description">
<!--l. 185--><p class="noindent" >the sparse matrix to be written.<br
class="newline" />Type:<span
class="cmbx-10">required</span>.<br
class="pplb7t-">required</span>.<br
class="newline" />Specified as: a structured data of type <a
href="userhtmlse3.html#spdata"><span
class="cmtt-10">psb</span><span
@@ -497,34 +497,34 @@ class="cmtt-10">_type</span></a>.
</dd><dt class="description">
<!--l. 188--><p class="noindent" >
<span
class="cmbx-10">mtitle</span> </dt><dd
class="pplb7t-">mtitle</span> </dt><dd
class="description">
<!--l. 188--><p class="noindent" >Matrix title.<br
class="newline" />Type: <span
class="cmbx-10">required </span><br
class="pplb7t-">required </span><br
class="newline" />A charachter variable holding a descriptive title for the matrix to be
written to file.
</dd><dt class="description">
<!--l. 192--><p class="noindent" >
<span
class="cmbx-10">filename</span> </dt><dd
class="pplb7t-">filename</span> </dt><dd
class="description">
<!--l. 192--><p class="noindent" >The name of the file to be written to.<br
class="newline" />Type:<span
class="cmbx-10">optional</span>.<br
class="newline" />Specified as: a character variable containing a valid file name, or <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">-</span></span></span>, in
class="pplb7t-">optional</span>.<br
class="newline" />Specified as: a character variable containing a valid file name, or <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">-</span></span></span>, in
which case the default output unit 6 (i.e. standard output in Unix jargon)
is used. Default: <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">-</span></span></span>.
</dd><dt class="description">
<!--l. 197--><p class="noindent" >
<span
class="cmbx-10">iunit</span> </dt><dd
class="pplb7t-">iunit</span> </dt><dd
class="description">
<!--l. 197--><p class="noindent" >The Fortran file unit number.<br
class="newline" />Type:<span
class="cmbx-10">optional</span>.<br
class="pplb7t-">optional</span>.<br
class="newline" />Specified as: an integer value. Only meaningful if filename is not <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">-</span></span></span>.</dd></dl>
@@ -534,27 +534,27 @@ class="cmtt-10">-</span></span></span>.</dd></dl>
<dl class="description"><dt class="description">
<!--l. 203--><p class="noindent" >
<span
class="cmbx-10">On Return</span> </dt><dd
class="pplb7t-">On Return</span> </dt><dd
class="description">
<!--l. 203--><p class="noindent" >
</dd><dt class="description">
<!--l. 204--><p class="noindent" >
<span
class="cmbx-10">iret</span> </dt><dd
class="pplb7t-">iret</span> </dt><dd
class="description">
<!--l. 204--><p class="noindent" >Error code.<br
class="newline" />Type: <span
class="cmbx-10">required </span><br
class="pplb7t-">required </span><br
class="newline" />An integer value; 0 means no error has been detected.</dd></dl>
<!--l. 209--><p class="noindent" ><span
class="cmbx-12">Notes</span>
class="pplb7t-x-x-120">Notes</span>
<!--l. 211--><p class="indent" > If this function is called on a matrix <code class="lstinline"><span style="color:#000000">a</span></code> on a distributed communicator only the
local part is written in output. To get a single MatrixMarket file with the whole
matrix when appropriate, e.g. for debugging purposes, one could <span
class="cmti-10">gather </span>the whole
class="pplri7t-">gather </span>the whole
matrix on a single rank and then write it. Consider the following example for a
<span
class="cmti-10">double </span>precision matrix
class="pplri7t-">double </span>precision matrix
<div class="center"
>
<!--l. 227--><p class="noindent" >
@@ -581,7 +581,7 @@ psb_i_t&#x00A0;psb_c_&#x003C;s,d,c,z&#x003E;global_mat_write(ah,cdh);
<h4 class="subsectionHead"><span class="titlemark">9.6 </span> <a
<h4 class="subsectionHead"><span class="titlemark">9.6 </span> <a
id="x14-1340009.6"></a>mm_array_write &#8212; Write a dense array from a file in the MatrixMarket
format</h4>
<!--l. 261-->
@@ -605,23 +605,23 @@ class="cmtt-10">)</span></span></pre>
<dl class="description"><dt class="description">
<!--l. 266--><p class="noindent" >
<span
class="cmbx-10">Type:</span> </dt><dd
class="pplb7t-">Type:</span> </dt><dd
class="description">
<!--l. 266--><p class="noindent" >Asynchronous.
</dd><dt class="description">
<!--l. 267--><p class="noindent" >
<span
class="cmbx-10">On Entry</span> </dt><dd
class="pplb7t-">On Entry</span> </dt><dd
class="description">
<!--l. 267--><p class="noindent" >
</dd><dt class="description">
<!--l. 268--><p class="noindent" >
<span
class="cmbx-10">b</span> </dt><dd
class="pplb7t-">b</span> </dt><dd
class="description">
<!--l. 268--><p class="noindent" >Rigth hand side(s).<br
class="newline" />Type: <span
class="cmbx-10">required </span><br
class="pplb7t-">required </span><br
class="newline" />An array of type real or complex, rank 1 or 2, or an object of type
<a
href="userhtmlse3.html#vdata"><span
@@ -634,63 +634,63 @@ class="newline" />
</dd><dt class="description">
<!--l. 273--><p class="noindent" >
<span
class="cmbx-10">filename</span> </dt><dd
class="pplb7t-">filename</span> </dt><dd
class="description">
<!--l. 273--><p class="noindent" >The name of the file to be written.<br
class="newline" />
</dd><dt class="description">
<!--l. 274--><p class="noindent" >
<span
class="cmbx-10">vtitle</span> </dt><dd
class="pplb7t-">vtitle</span> </dt><dd
class="description">
<!--l. 274--><p class="noindent" >Matrix title.<br
class="newline" />Type: <span
class="cmbx-10">required </span><br
class="newline" />A charachter variable holding a descriptive title for the vector to be written
to file. Type:<span
class="cmbx-10">optional</span>.<br
class="newline" />Specified as: a character variable containing a valid file name, or <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">-</span></span></span>, in
class="pplb7t-">required </span><br
class="newline" />A charachter variable holding a descriptive title for the vector to be
written to file. Type:<span
class="pplb7t-">optional</span>.<br
class="newline" />Specified as: a character variable containing a valid file name, or <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">-</span></span></span>, in
which case the default input unit 5 (i.e. standard input in Unix jargon) is
used. Default: <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">-</span></span></span>.
</dd><dt class="description">
<!--l. 282--><p class="noindent" >
<span
class="cmbx-10">iunit</span> </dt><dd
class="pplb7t-">iunit</span> </dt><dd
class="description">
<!--l. 282--><p class="noindent" >The Fortran file unit number.<br
class="newline" />Type:<span
class="cmbx-10">optional</span>.<br
class="pplb7t-">optional</span>.<br
class="newline" />Specified as: an integer value. Only meaningful if filename is not <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">-</span></span></span>.</dd></dl>
<!--l. 287--><p class="noindent" >
<dl class="description"><dt class="description">
<!--l. 288--><p class="noindent" >
<span
class="cmbx-10">On Return</span> </dt><dd
class="pplb7t-">On Return</span> </dt><dd
class="description">
<!--l. 288--><p class="noindent" >
</dd><dt class="description">
<!--l. 289--><p class="noindent" >
<span
class="cmbx-10">iret</span> </dt><dd
class="pplb7t-">iret</span> </dt><dd
class="description">
<!--l. 289--><p class="noindent" >Error code.<br
class="newline" />Type: <span
class="cmbx-10">required </span><br
class="pplb7t-">required </span><br
class="newline" />An integer value; 0 means no error has been detected.</dd></dl>
<!--l. 294--><p class="noindent" ><span
class="cmbx-12">Notes</span>
class="pplb7t-x-x-120">Notes</span>
<!--l. 296--><p class="indent" > If this function is called on a vector <code class="lstinline"><span style="color:#000000">v</span></code> on a distributed communicator only the
local part is written in output. To get a single MatrixMarket file with the whole
vector when appropriate, e.g. for debugging purposes, one could <span
class="cmti-10">gather </span>the whole
class="pplri7t-">gather </span>the whole
vector on a single rank and then write it. Consider the following example for a <span
class="cmti-10">double</span>
class="pplri7t-">double</span>
precision vector
<div class="center"
>