Updated docs.
This commit is contained in:
Salvatore Filippone
2014-03-25 11:24:42 +00:00
parent 38b70b287f
commit fdaa0f5d74
127 changed files with 14415 additions and 14395 deletions
+16 -31
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>tril -- Return the lower triangle</TITLE>
<META NAME="description" CONTENT="tril -- Return the lower triangle">
<TITLE>clip_diag -- Cut out main diagonal</TITLE>
<META NAME="description" CONTENT="clip_diag -- Cut out main diagonal">
<META NAME="keywords" CONTENT="userhtml">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
@@ -26,44 +26,41 @@ original version by: Nikos Drakos, CBLU, University of Leeds
<BODY >
<!--Navigation Panel-->
<A NAME="tex2html643"
<A NAME="tex2html646"
HREF="node35.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
<A NAME="tex2html639"
<A NAME="tex2html642"
HREF="node21.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
<A NAME="tex2html633"
<A NAME="tex2html636"
HREF="node33.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
<A NAME="tex2html641"
<A NAME="tex2html644"
HREF="node1.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
<BR>
<B> Next:</B> <A NAME="tex2html644"
HREF="node35.html">triu Return</A>
<B> Up:</B> <A NAME="tex2html640"
<B> Next:</B> <A NAME="tex2html647"
HREF="node35.html">tril Return</A>
<B> Up:</B> <A NAME="tex2html643"
HREF="node21.html">Sparse Matrix class</A>
<B> Previous:</B> <A NAME="tex2html634"
HREF="node33.html">clip_diag Cut</A>
&nbsp; <B> <A NAME="tex2html642"
<B> Previous:</B> <A NAME="tex2html637"
HREF="node33.html">get_diag Get</A>
&nbsp; <B> <A NAME="tex2html645"
HREF="node1.html">Contents</A></B>
<BR>
<BR>
<!--End of Navigation Panel-->
<H3><A NAME="SECTION000421300000000000000">
tril -- Return the lower triangle</A>
clip_diag -- Cut out main diagonal</A>
</H3>
<PRE>
call a%tril(b,info[,&amp;
&amp; diag,imin,imax,jmin,jmax,rscale,cscale])
call a%clip_diag(b,info)
</PRE>
<P>
Returns the lower triangular part of submatrix
<code>A(imin:imax,jmin:jmax)</code>, optionally rescaling row/col indices to
the range <code>1:imax-imin+1,1:jmax-jmin+1</code>.
Returns a copy of <code>a</code> without the main diagonal.
<DL>
<DT><STRONG>Type:</STRONG></DT>
<DD>Asynchronous.
@@ -78,25 +75,13 @@ A variable of type <code>psb_Tspmat_type</code>.
<BR>
Scope: <B>local</B>.
<BR></DD>
<DT><STRONG>diag</STRONG></DT>
<DD>How many additional diagonals above the main one, default 0.
</DD>
<DT><STRONG>imin,imax,jmin,jmax</STRONG></DT>
<DD>Minimum and maximum row and column indices.
<BR>
Type: optional.
</DD>
<DT><STRONG>rscale,cscale</STRONG></DT>
<DD>Whether to rescale row/column indices.
Type: optional.
</DD>
</DL>
<DL>
<DT><STRONG><B>On Return</B></STRONG></DT>
<DD>
</DD>
<DT><STRONG>b</STRONG></DT>
<DD>A copy of a subtriangle of <code>a</code>.
<DD>A copy of <code>a</code> without the main diagonal.
<BR>
A variable of type <code>psb_Tspmat_type</code>.
</DD>