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
+34 -27
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_cd_set_large_threshold -- Set threshold for index mapping switch</TITLE>
<META NAME="description" CONTENT="psb_cd_set_large_threshold -- Set threshold for index mapping switch">
<TITLE>get_nrows -- Get number of rows in a sparse matrix</TITLE>
<META NAME="description" CONTENT="get_nrows -- Get number of rows in a sparse matrix">
<META NAME="keywords" CONTENT="userhtml">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
@@ -20,44 +20,44 @@ original version by: Nikos Drakos, CBLU, University of Leeds
<LINK REL="next" HREF="node24.html">
<LINK REL="previous" HREF="node22.html">
<LINK REL="up" HREF="node21.html">
<LINK REL="up" HREF="node20.html">
<LINK REL="next" HREF="node24.html">
</HEAD>
<BODY >
<!--Navigation Panel-->
<A NAME="tex2html458"
<A NAME="tex2html456"
HREF="node24.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
<A NAME="tex2html454"
HREF="node21.html">
<A NAME="tex2html452"
HREF="node20.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
<A NAME="tex2html448"
<A NAME="tex2html446"
HREF="node22.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
<A NAME="tex2html456"
<A NAME="tex2html454"
HREF="node1.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
<BR>
<B> Next:</B> <A NAME="tex2html459"
HREF="node24.html">get_nrows Get</A>
<B> Up:</B> <A NAME="tex2html455"
HREF="node21.html">get_context Get communication context</A>
<B> Previous:</B> <A NAME="tex2html449"
HREF="node22.html">psb_cd_get_large_threshold Get</A>
&nbsp; <B> <A NAME="tex2html457"
<B> Next:</B> <A NAME="tex2html457"
HREF="node24.html">get_ncols Get</A>
<B> Up:</B> <A NAME="tex2html453"
HREF="node20.html">get_context Get communication context</A>
<B> Previous:</B> <A NAME="tex2html447"
HREF="node22.html">psb_cd_set_large_threshold Set</A>
&nbsp; <B> <A NAME="tex2html455"
HREF="node1.html">Contents</A></B>
<BR>
<BR>
<!--End of Navigation Panel-->
<H3><A NAME="SECTION00046200000000000000">
psb_cd_set_large_threshold -- Set threshold for
index mapping switch</A>
<H3><A NAME="SECTION00046300000000000000">
get_nrows -- Get number of rows in a sparse matrix</A>
</H3>
<P>
<PRE>
call psb_cd_set_large_threshold(ith)
nr = a%get_nrows()
</PRE>
<P>
@@ -68,21 +68,28 @@ call psb_cd_set_large_threshold(ith)
<DT><STRONG><B>On Entry</B></STRONG></DT>
<DD>
</DD>
<DT><STRONG>ith</STRONG></DT>
<DD>the new threshold for communication descriptors.
<DT><STRONG>a</STRONG></DT>
<DD>the sparse matrix
<BR>
Scope: <B>global</B>.
Scope: <B>local</B>
<BR>
Type: <B>required</B>.
Type: <B>required</B>
<BR>
Intent: <B>in</B>.
<BR>
Specified as: an integer value greater than zero.
Specified as: a structured data of type spdata<TT>psb_spmat_type</TT>.
</DD>
</DL>
<P>
<DL>
<DT><STRONG><B>On Return</B></STRONG></DT>
<DD>
</DD>
<DT><STRONG>Function value</STRONG></DT>
<DD>The number of rows of sparse matrix <code>a</code>.
</DD>
</DL>
Note: the threshold value is only queried by the library at the time a
call to <code>psb_cdall</code> is executed, therefore changing the threshold
has no effect on communication descriptors that have already been initialized.
<P>
<BR><HR>