Documentation changes. We have barely begun.....
This commit is contained in:
Salvatore Filippone
2011-12-16 16:45:25 +00:00
parent c730f15b58
commit 844a942947
243 changed files with 14860 additions and 15182 deletions
+38 -19
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_spfree -- Frees a sparse matrix</TITLE>
<META NAME="description" CONTENT="psb_spfree -- Frees a sparse 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="node56.html">
<LINK REL="previous" HREF="node54.html">
<LINK REL="up" HREF="node45.html">
<LINK REL="up" HREF="node44.html">
<LINK REL="next" HREF="node56.html">
</HEAD>
<BODY >
<!--Navigation Panel-->
<A NAME="tex2html879"
<A NAME="tex2html877"
HREF="node56.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
<A NAME="tex2html875"
HREF="node45.html">
<A NAME="tex2html873"
HREF="node44.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
<A NAME="tex2html869"
<A NAME="tex2html867"
HREF="node54.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
<A NAME="tex2html877"
<A NAME="tex2html875"
HREF="node1.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
<BR>
<B> Next:</B> <A NAME="tex2html880"
HREF="node56.html">psb_sprn Reinit</A>
<B> Up:</B> <A NAME="tex2html876"
HREF="node45.html">Data management routines</A>
<B> Previous:</B> <A NAME="tex2html870"
HREF="node54.html">psb_spasb Sparse</A>
&nbsp; <B> <A NAME="tex2html878"
<B> Next:</B> <A NAME="tex2html878"
HREF="node56.html">psb_geall Allocates</A>
<B> Up:</B> <A NAME="tex2html874"
HREF="node44.html">Data management routines</A>
<B> Previous:</B> <A NAME="tex2html868"
HREF="node54.html">psb_spfree Frees</A>
&nbsp; <B> <A NAME="tex2html876"
HREF="node1.html">Contents</A></B>
<BR>
<BR>
<!--End of Navigation Panel-->
<H2><A NAME="SECTION000710000000000000000">
psb_spfree -- Frees a sparse matrix</A>
<H2><A NAME="SECTION000711000000000000000">
psb_sprn -- Reinit sparse matrix structure for psblas
routines.</A>
</H2>
<P>
<PRE>
call psb_spfree(a, desc_a, info)
call psb_sprn(a, decsc_a, info, clear)
</PRE>
<P>
@@ -69,7 +70,7 @@ call psb_spfree(a, desc_a, info)
<DD>
</DD>
<DT><STRONG>a</STRONG></DT>
<DD>the matrix to be freed.
<DD>the matrix to be reinitialized.
<BR>
Scope:<B>local</B>
<BR>
@@ -90,6 +91,17 @@ Intent: <B>in</B>.
<BR>
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>
<P>
@@ -109,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>