base/internals/psi_idx_ins_cnv.f90
 base/modules/psb_base_tools_mod.f90
 base/modules/psb_gen_block_map_mod.f90
 base/modules/psb_hash_map_mod.f90
 base/modules/psb_indx_map_mod.f90
 base/modules/psb_list_map_mod.f90
 base/modules/psb_repl_map_mod.f90
 base/modules/psi_i_mod.f90
 base/tools/psb_cdins.f90
 docs/html/footnode.html
 docs/html/index.html
 docs/html/node1.html
 docs/html/node10.html
 docs/html/node100.html
 docs/html/node101.html
 docs/html/node102.html
 docs/html/node103.html
 docs/html/node104.html
 docs/html/node105.html
 docs/html/node106.html
 docs/html/node107.html
 docs/html/node108.html
 docs/html/node109.html
 docs/html/node11.html
 docs/html/node110.html
 docs/html/node111.html
 docs/html/node112.html
 docs/html/node113.html
 docs/html/node114.html
 docs/html/node115.html
 docs/html/node116.html
 docs/html/node117.html
 docs/html/node118.html
 docs/html/node119.html
 docs/html/node12.html
 docs/html/node120.html
 docs/html/node13.html
 docs/html/node14.html
 docs/html/node15.html
 docs/html/node16.html
 docs/html/node17.html
 docs/html/node18.html
 docs/html/node19.html
 docs/html/node2.html
 docs/html/node20.html
 docs/html/node21.html
 docs/html/node22.html
 docs/html/node23.html
 docs/html/node24.html
 docs/html/node25.html
 docs/html/node26.html
 docs/html/node27.html
 docs/html/node28.html
 docs/html/node29.html
 docs/html/node3.html
 docs/html/node30.html
 docs/html/node31.html
 docs/html/node32.html
 docs/html/node33.html
 docs/html/node34.html
 docs/html/node35.html
 docs/html/node36.html
 docs/html/node37.html
 docs/html/node38.html
 docs/html/node39.html
 docs/html/node4.html
 docs/html/node40.html
 docs/html/node41.html
 docs/html/node42.html
 docs/html/node43.html
 docs/html/node44.html
 docs/html/node45.html
 docs/html/node46.html
 docs/html/node47.html
 docs/html/node48.html
 docs/html/node49.html
 docs/html/node5.html
 docs/html/node50.html
 docs/html/node51.html
 docs/html/node52.html
 docs/html/node53.html
 docs/html/node54.html
 docs/html/node55.html
 docs/html/node56.html
 docs/html/node57.html
 docs/html/node58.html
 docs/html/node59.html
 docs/html/node6.html
 docs/html/node60.html
 docs/html/node61.html
 docs/html/node62.html
 docs/html/node63.html
 docs/html/node64.html
 docs/html/node65.html
 docs/html/node66.html
 docs/html/node67.html
 docs/html/node68.html
 docs/html/node69.html
 docs/html/node7.html
 docs/html/node70.html
 docs/html/node71.html
 docs/html/node72.html
 docs/html/node73.html
 docs/html/node74.html
 docs/html/node75.html
 docs/html/node76.html
 docs/html/node77.html
 docs/html/node78.html
 docs/html/node79.html
 docs/html/node8.html
 docs/html/node80.html
 docs/html/node81.html
 docs/html/node82.html
 docs/html/node83.html
 docs/html/node84.html
 docs/html/node85.html
 docs/html/node86.html
 docs/html/node87.html
 docs/html/node88.html
 docs/html/node89.html
 docs/html/node9.html
 docs/html/node90.html
 docs/html/node91.html
 docs/html/node92.html
 docs/html/node93.html
 docs/html/node94.html
 docs/html/node95.html
 docs/html/node96.html
 docs/html/node97.html
 docs/html/node98.html
 docs/html/node99.html
 docs/html/userhtml.html
 docs/psblas-3.0.pdf
 docs/src/intro.tex

New docs for LIDX. New LIDX parm in idx_cnv_ins.
This commit is contained in:
Salvatore Filippone
2012-04-17 16:49:25 +00:00
parent 4accecb0c9
commit fe85dcc848
134 changed files with 15319 additions and 14743 deletions
+54 -219
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>Sorting utilities</TITLE>
<META NAME="description" CONTENT="Sorting utilities">
<TITLE>psb_sizeof -- Memory occupation</TITLE>
<META NAME="description" CONTENT="psb_sizeof -- Memory occupation">
<META NAME="keywords" CONTENT="userhtml">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
@@ -18,276 +18,111 @@ original version by: Nikos Drakos, CBLU, University of Leeds
<LINK REL="STYLESHEET" HREF="userhtml.css">
<LINK REL="next" HREF="node83.html">
<LINK REL="previous" HREF="node81.html">
<LINK REL="up" HREF="node55.html">
<LINK REL="up" HREF="node56.html">
<LINK REL="next" HREF="node83.html">
</HEAD>
<BODY >
<!--Navigation Panel-->
<A NAME="tex2html1233"
<A NAME="tex2html1236"
HREF="node83.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
<A NAME="tex2html1229"
HREF="node55.html">
<A NAME="tex2html1232"
HREF="node56.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
<A NAME="tex2html1225"
<A NAME="tex2html1226"
HREF="node81.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
<A NAME="tex2html1231"
<A NAME="tex2html1234"
HREF="node1.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
<BR>
<B> Next:</B> <A NAME="tex2html1234"
HREF="node83.html">Parallel environment routines</A>
<B> Up:</B> <A NAME="tex2html1230"
HREF="node55.html">Data management routines</A>
<B> Previous:</B> <A NAME="tex2html1226"
HREF="node81.html">psb_sizeof Memory</A>
&nbsp; <B> <A NAME="tex2html1232"
<B> Next:</B> <A NAME="tex2html1237"
HREF="node83.html">Sorting utilities</A>
<B> Up:</B> <A NAME="tex2html1233"
HREF="node56.html">Data management routines</A>
<B> Previous:</B> <A NAME="tex2html1227"
HREF="node81.html">psb_sp_getrow Extract</A>
&nbsp; <B> <A NAME="tex2html1235"
HREF="node1.html">Contents</A></B>
<BR>
<BR>
<!--End of Navigation Panel-->
<H2><A NAME="SECTION000727000000000000000">
Sorting utilities</A>
<H2><A NAME="SECTION000726000000000000000">
psb_sizeof -- Memory occupation</A>
</H2>
<P>
<FONT SIZE="+1"><B>psb_msort -- Sorting by the Merge-sort
algorithm</B></FONT>
This function computes the memory occupation of a PSBLAS object.
<P>
<FONT SIZE="+1"><B>psb_qsort -- Sorting by the Quicksort
algorithm</B></FONT>
<P>
<FONT SIZE="+1"><B>psb_hsort -- Sorting by the Heapsort algorithm</B></FONT>
<PRE>
call psb_msort(x,ix,dir,flag)
call psb_qsort(x,ix,dir,flag)
call psb_hsort(x,ix,dir,flag)
isz = psb_sizeof(a)
isz = psb_sizeof(desc_a)
isz = psb_sizeof(prec)
</PRE>
<P>
These serial routines sort a sequence <IMG
WIDTH="18" HEIGHT="14" ALIGN="BOTTOM" BORDER="0"
SRC="img106.png"
ALT="$X$"> into ascending or
descending order. The argument meaning is identical for the three
calls; the only difference is the algorithm used to accomplish the
task (see Usage Notes below).
<DL>
<DT><STRONG>Type:</STRONG></DT>
<DD>Asynchronous.
</DD>
<DT><STRONG><B>On Entry </B></STRONG></DT>
<DT><STRONG><B>On Entry</B></STRONG></DT>
<DD>
</DD>
<DT><STRONG>x</STRONG></DT>
<DD>The sequence to be sorted.
<DT><STRONG>a</STRONG></DT>
<DD>A sparse matrix
<IMG
WIDTH="16" HEIGHT="14" ALIGN="BOTTOM" BORDER="0"
SRC="img1.png"
ALT="$A$">.
<BR>
Type:<B>required</B>.
Scope: <B>local</B>
<BR>
Specified as: an integer, real or complex array of rank 1.
Type: <B>required</B>
<BR>
Intent: <B>in</B>.
<BR>
Specified as: a structured data of type spdata<TT>psb_Tspmat_type</TT>.
</DD>
<DT><STRONG>ix</STRONG></DT>
<DD>A vector of indices.
<DT><STRONG>desc_a</STRONG></DT>
<DD>Communication descriptor.
<BR>
Type:<B>optional</B>.
Scope: <B>local</B>
<BR>
Specified as: an integer array of (at least) the same size as <IMG
WIDTH="18" HEIGHT="14" ALIGN="BOTTOM" BORDER="0"
SRC="img106.png"
ALT="$X$">.
Type: <B>required</B>
<BR>
Intent: <B>in</B>.
<BR>
Specified as: a structured data of type descdata<TT>psb_desc_type</TT>.
</DD>
<DT><STRONG>dir</STRONG></DT>
<DD>The desired ordering.
<DT><STRONG>prec</STRONG></DT>
<DD>Scope: <B>local</B>
<BR>
Type:<B>optional</B>.
Type: <B>required</B>
<BR>
Specified as: an integer value: <DL>
<DT><STRONG>Integer and real data:</STRONG></DT>
<DD><code>psb_sort_up_</code>,
<code>psb_sort_down_</code>, <code>psb_asort_up_</code>, <code>psb_asort_down_</code>;
default <code>psb_sort_up_</code>.
</DD>
<DT><STRONG>Complex data:</STRONG></DT>
<DD><code>psb_lsort_up_</code>,
<code>psb_lsort_down_</code>, <code>psb_asort_up_</code>, <code>psb_asort_down_</code>;
default <code>psb_lsort_up_</code>.
</DD>
</DL>
</DD>
<DT><STRONG>flag</STRONG></DT>
<DD>Whether to keep the original values in <IMG
WIDTH="27" HEIGHT="14" ALIGN="BOTTOM" BORDER="0"
SRC="img107.png"
ALT="$IX$">.
Intent: <B>in</B>.
<BR>
Type:<B>optional</B>.
<BR>
Specified as: an integer value <code>psb_sort_ovw_idx_</code> or
<code>psb_sort_keep_idx_</code>; default <code>psb_sort_ovw_idx_</code>.
<P>
Specified as: a preconditioner data structure precdata<TT>psb_prec_type</TT>.
</DD>
</DL>
<P>
<DL>
<DT><STRONG><B>On Return</B></STRONG></DT>
<DD>
</DD>
<DT><STRONG>x</STRONG></DT>
<DD>The sequence of values, in the chosen ordering.
<DT><STRONG>Function value</STRONG></DT>
<DD>The memory occupation of the object specified in
the calling sequence, in bytes.
<BR>
Type:<B>required</B>.
Scope: <B>local</B>
<BR>
Specified as: an integer, real or complex array of rank 1.
</DD>
<DT><STRONG>ix</STRONG></DT>
<DD>A vector of indices.
<BR>
Type: <B>Optional</B>
<BR>
An integer array of rank 1, whose entries are moved to the same
position as the corresponding entries in <IMG
WIDTH="13" HEIGHT="13" ALIGN="BOTTOM" BORDER="0"
SRC="img20.png"
ALT="$x$">.
Returned as: an <code>integer(psb_long_int_k_)</code> number.
</DD>
</DL>
<P>
<P>
<FONT SIZE="+1"><B>Notes</B></FONT>
<OL>
<LI>For integer or real data the sorting can be performed in the up/down direction, on the
natural or absolute values;
</LI>
<LI>For complex data the sorting can be done in a lexicographic
order (i.e.: sort on the real part with ties broken according to
the imaginary part) or on the absolute values;
</LI>
<LI>The routines return the items in the chosen ordering; the
output difference is the handling of ties (i.e. items with an
equal value) in the original input. With the merge-sort algorithm
ties are preserved in the same relative order as they had in the
original sequence, while this is not guaranteed for quicksort or
heapsort;
</LI>
<LI>If <!-- MATH
$flag = psb\_sort\_ovw\_idx\_$
-->
<IMG
WIDTH="180" HEIGHT="30" ALIGN="MIDDLE" BORDER="0"
SRC="img108.png"
ALT="$flag = psb\_sort\_ovw\_idx\_$"> then the entries in <IMG
WIDTH="62" HEIGHT="32" ALIGN="MIDDLE" BORDER="0"
SRC="img109.png"
ALT="$ix(1:n)$">
where <IMG
WIDTH="13" HEIGHT="13" ALIGN="BOTTOM" BORDER="0"
SRC="img16.png"
ALT="$n$"> is the size of <IMG
WIDTH="13" HEIGHT="13" ALIGN="BOTTOM" BORDER="0"
SRC="img20.png"
ALT="$x$"> are initialized to <!-- MATH
$ix(i) \leftarrow
i$
-->
<IMG
WIDTH="66" HEIGHT="32" ALIGN="MIDDLE" BORDER="0"
SRC="img110.png"
ALT="$ix(i) \leftarrow
i$">; thus, upon return from the subroutine, for each
index <IMG
WIDTH="9" HEIGHT="17" ALIGN="BOTTOM" BORDER="0"
SRC="img4.png"
ALT="$i$"> we have in <IMG
WIDTH="37" HEIGHT="32" ALIGN="MIDDLE" BORDER="0"
SRC="img111.png"
ALT="$ix(i)$"> the position that the item <IMG
WIDTH="31" HEIGHT="32" ALIGN="MIDDLE" BORDER="0"
SRC="img112.png"
ALT="$x(i)$">
occupied in the original data sequence;
</LI>
<LI>If <!-- MATH
$flag = psb\_sort\_keep\_idx\_$
-->
<IMG
WIDTH="185" HEIGHT="30" ALIGN="MIDDLE" BORDER="0"
SRC="img113.png"
ALT="$flag = psb\_sort\_keep\_idx\_$"> the routine will assume that
the entries in <IMG
WIDTH="35" HEIGHT="32" ALIGN="MIDDLE" BORDER="0"
SRC="img114.png"
ALT="$ix(:)$"> have already been initialized by the user;
</LI>
<LI>The three sorting algorithms have a similar <IMG
WIDTH="74" HEIGHT="32" ALIGN="MIDDLE" BORDER="0"
SRC="img115.png"
ALT="$O(n \log n)$"> expected
running time; in the average case quicksort will be the
fastest and merge-sort the slowest. However note that:
<OL>
<LI>The worst case running time for quicksort is <IMG
WIDTH="45" HEIGHT="34" ALIGN="MIDDLE" BORDER="0"
SRC="img116.png"
ALT="$O(n^2)$">; the algorithm
implemented here follows the well-known median-of-three heuristics,
but the worst case may still apply;
</LI>
<LI>The worst case running time for merge-sort and heap-sort is
<IMG
WIDTH="74" HEIGHT="32" ALIGN="MIDDLE" BORDER="0"
SRC="img115.png"
ALT="$O(n \log n)$"> as the average case;
</LI>
<LI>The merge-sort algorithm is implemented to take advantage of
subsequences that may be already in the desired ordering prior to
the subroutine call; this situation is relatively common when
dealing with groups of indices of sparse matrix entries, thus
merge-sort is the preferred choice when a sorting is needed
by other routines in the library.
</LI>
</OL>
</LI>
</OL>
<P>
<P>
<HR>
<!--Navigation Panel-->
<A NAME="tex2html1233"
HREF="node83.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
<A NAME="tex2html1229"
HREF="node55.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
<A NAME="tex2html1225"
HREF="node81.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
<A NAME="tex2html1231"
HREF="node1.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
<BR>
<B> Next:</B> <A NAME="tex2html1234"
HREF="node83.html">Parallel environment routines</A>
<B> Up:</B> <A NAME="tex2html1230"
HREF="node55.html">Data management routines</A>
<B> Previous:</B> <A NAME="tex2html1226"
HREF="node81.html">psb_sizeof Memory</A>
&nbsp; <B> <A NAME="tex2html1232"
HREF="node1.html">Contents</A></B>
<!--End of Navigation Panel-->
<BR><HR>
</BODY>
</HTML>