mirror of
https://github.com/sfilippone/psblas3.git
synced 2026-10-12 08:59:04 +00:00
Added entrywise inversion and documentation for vec-vec operation
This commit is contained in:
+210
-65
@@ -3,8 +3,8 @@
|
||||
<!--Converted with LaTeX2HTML 2018 (Released Feb 1, 2018) -->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<TITLE>psb_info -- Return information about PSBLAS parallel environment</TITLE>
|
||||
<META NAME="description" CONTENT="psb_info -- Return information about PSBLAS parallel environment">
|
||||
<TITLE>Sorting utilities -- </TITLE>
|
||||
<META NAME="description" CONTENT="Sorting utilities -- ">
|
||||
<META NAME="keywords" CONTENT="userhtml">
|
||||
<META NAME="resource-type" CONTENT="document">
|
||||
<META NAME="distribution" CONTENT="global">
|
||||
@@ -14,53 +14,67 @@
|
||||
|
||||
<LINK REL="STYLESHEET" HREF="userhtml.css">
|
||||
|
||||
<LINK REL="next" HREF="node102.html">
|
||||
<LINK REL="previous" HREF="node100.html">
|
||||
<LINK REL="up" HREF="node99.html">
|
||||
<LINK REL="up" HREF="node74.html">
|
||||
<LINK REL="next" HREF="node102.html">
|
||||
</HEAD>
|
||||
|
||||
<BODY >
|
||||
|
||||
<DIV CLASS="navigation"><!--Navigation Panel-->
|
||||
<A NAME="tex2html1529"
|
||||
<A NAME="tex2html1521"
|
||||
HREF="node102.html">
|
||||
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
|
||||
<A NAME="tex2html1525"
|
||||
HREF="node99.html">
|
||||
<A NAME="tex2html1517"
|
||||
HREF="node74.html">
|
||||
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
|
||||
<A NAME="tex2html1519"
|
||||
<A NAME="tex2html1513"
|
||||
HREF="node100.html">
|
||||
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
|
||||
<A NAME="tex2html1527"
|
||||
<A NAME="tex2html1519"
|
||||
HREF="node1.html">
|
||||
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
|
||||
<BR>
|
||||
<B> Next:</B> <A NAME="tex2html1530"
|
||||
HREF="node102.html">psb_exit Exit</A>
|
||||
<B> Up:</B> <A NAME="tex2html1526"
|
||||
HREF="node99.html">Parallel environment routines</A>
|
||||
<B> Previous:</B> <A NAME="tex2html1520"
|
||||
HREF="node100.html">psb_init Initializes</A>
|
||||
<B> <A NAME="tex2html1528"
|
||||
<B> Next:</B> <A NAME="tex2html1522"
|
||||
HREF="node102.html">Parallel environment routines</A>
|
||||
<B> Up:</B> <A NAME="tex2html1518"
|
||||
HREF="node74.html">Data management routines</A>
|
||||
<B> Previous:</B> <A NAME="tex2html1514"
|
||||
HREF="node100.html">psb_sizeof Memory</A>
|
||||
<B> <A NAME="tex2html1520"
|
||||
HREF="node1.html">Contents</A></B>
|
||||
<BR>
|
||||
<BR></DIV>
|
||||
<!--End of Navigation Panel-->
|
||||
|
||||
<H2><A NAME="SECTION00082000000000000000">
|
||||
psb_info -- Return information about PSBLAS parallel
|
||||
environment</A>
|
||||
<H2><A NAME="SECTION000727000000000000000">
|
||||
Sorting utilities -- </A>
|
||||
</H2>
|
||||
|
||||
<P>
|
||||
<BIG CLASS="LARGE"><B>psb_msort -- Sorting by the Merge-sort
|
||||
algorithm</B></BIG>
|
||||
|
||||
<P>
|
||||
<BIG CLASS="LARGE"><B>psb_qsort -- Sorting by the Quicksort
|
||||
algorithm</B></BIG>
|
||||
|
||||
<P>
|
||||
<BIG CLASS="LARGE"><B>psb_hsort -- Sorting by the Heapsort algorithm</B></BIG>
|
||||
<PRE>
|
||||
call psb_info(icontxt, iam, np)
|
||||
call psb_msort(x,ix,dir,flag)
|
||||
call psb_qsort(x,ix,dir,flag)
|
||||
call psb_hsort(x,ix,dir,flag)
|
||||
</PRE>
|
||||
|
||||
<P>
|
||||
This subroutine returns information about the PSBLAS parallel environment, defining
|
||||
a virtual parallel machine.
|
||||
These serial routines sort a sequence <SPAN CLASS="MATH"><IMG
|
||||
WIDTH="18" HEIGHT="15" ALIGN="BOTTOM" BORDER="0"
|
||||
SRC="img129.png"
|
||||
ALT="$X$"></SPAN> 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.
|
||||
@@ -68,17 +82,53 @@ a virtual parallel machine.
|
||||
<DT><STRONG><B>On Entry </B></STRONG></DT>
|
||||
<DD>
|
||||
</DD>
|
||||
<DT><STRONG>icontxt</STRONG></DT>
|
||||
<DD>the communication context identifying the virtual
|
||||
parallel machine.
|
||||
<DT><STRONG>x</STRONG></DT>
|
||||
<DD>The sequence to be sorted.
|
||||
<BR>
|
||||
Scope: <B>global</B>.
|
||||
Type:<B>required</B>.
|
||||
<BR>
|
||||
Type: <B>required</B>.
|
||||
Specified as: an integer, real or complex array of rank 1.
|
||||
</DD>
|
||||
<DT><STRONG>ix</STRONG></DT>
|
||||
<DD>A vector of indices.
|
||||
<BR>
|
||||
Intent: <B>in</B>.
|
||||
Type:<B>optional</B>.
|
||||
<BR>
|
||||
Specified as: an integer variable.
|
||||
Specified as: an integer array of (at least) the same size as <SPAN CLASS="MATH"><IMG
|
||||
WIDTH="18" HEIGHT="15" ALIGN="BOTTOM" BORDER="0"
|
||||
SRC="img129.png"
|
||||
ALT="$X$"></SPAN>.
|
||||
</DD>
|
||||
<DT><STRONG>dir</STRONG></DT>
|
||||
<DD>The desired ordering.
|
||||
<BR>
|
||||
Type:<B>optional</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 <SPAN CLASS="MATH"><IMG
|
||||
WIDTH="26" HEIGHT="15" ALIGN="BOTTOM" BORDER="0"
|
||||
SRC="img130.png"
|
||||
ALT="$IX$"></SPAN>.
|
||||
<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>
|
||||
</DD>
|
||||
</DL>
|
||||
|
||||
@@ -87,60 +137,155 @@ Specified as: an integer variable.
|
||||
<DT><STRONG><B>On Return</B></STRONG></DT>
|
||||
<DD>
|
||||
</DD>
|
||||
<DT><STRONG>iam</STRONG></DT>
|
||||
<DD>Identifier of current process in the PSBLAS virtual parallel machine.
|
||||
<DT><STRONG>x</STRONG></DT>
|
||||
<DD>The sequence of values, in the chosen ordering.
|
||||
<BR>
|
||||
Scope: <B>local</B>.
|
||||
Type:<B>required</B>.
|
||||
<BR>
|
||||
Type: <B>required</B>.
|
||||
Specified as: an integer, real or complex array of rank 1.
|
||||
</DD>
|
||||
<DT><STRONG>ix</STRONG></DT>
|
||||
<DD>A vector of indices.
|
||||
<BR>
|
||||
Intent: <B>out</B>.
|
||||
Type: <B>Optional</B>
|
||||
<BR>
|
||||
Specified as: an integer value. <!-- MATH
|
||||
$-1 \le iam \le np-1$
|
||||
-->
|
||||
<SPAN CLASS="MATH"><IMG
|
||||
WIDTH="139" HEIGHT="29" ALIGN="MIDDLE" BORDER="0"
|
||||
SRC="img135.png"
|
||||
ALT="$-1 \le iam \le np-1$"></SPAN> </DD>
|
||||
<DT><STRONG>np</STRONG></DT>
|
||||
<DD>Number of processes in the PSBLAS virtual parallel machine.
|
||||
<BR>
|
||||
Scope: <B>global</B>.
|
||||
<BR>
|
||||
Type: <B>required</B>.
|
||||
<BR>
|
||||
Intent: <B>out</B>.
|
||||
<BR>
|
||||
Specified as: an integer variable. </DD>
|
||||
An integer array of rank 1, whose entries are moved to the same
|
||||
position as the corresponding entries in <SPAN CLASS="MATH"><IMG
|
||||
WIDTH="13" HEIGHT="14" ALIGN="BOTTOM" BORDER="0"
|
||||
SRC="img20.png"
|
||||
ALT="$x$"></SPAN>.
|
||||
</DD>
|
||||
</DL>
|
||||
|
||||
<P>
|
||||
|
||||
<P>
|
||||
<BIG CLASS="LARGE"><B>Notes</B></BIG>
|
||||
|
||||
<OL>
|
||||
<LI>For processes in the virtual parallel machine the identifier
|
||||
will satisfy <!-- MATH
|
||||
$0 \le iam \le np-1$
|
||||
<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\_$
|
||||
-->
|
||||
<SPAN CLASS="MATH"><IMG
|
||||
WIDTH="128" HEIGHT="29" ALIGN="MIDDLE" BORDER="0"
|
||||
SRC="img136.png"
|
||||
ALT="$0 \le iam \le np-1$"></SPAN>;
|
||||
WIDTH="180" HEIGHT="30" ALIGN="MIDDLE" BORDER="0"
|
||||
SRC="img131.png"
|
||||
ALT="$flag = psb\_sort\_ovw\_idx\_$"></SPAN> then the entries in <SPAN CLASS="MATH"><IMG
|
||||
WIDTH="62" HEIGHT="31" ALIGN="MIDDLE" BORDER="0"
|
||||
SRC="img132.png"
|
||||
ALT="$ix(1:n)$"></SPAN>
|
||||
where <SPAN CLASS="MATH"><IMG
|
||||
WIDTH="13" HEIGHT="14" ALIGN="BOTTOM" BORDER="0"
|
||||
SRC="img16.png"
|
||||
ALT="$n$"></SPAN> is the size of <SPAN CLASS="MATH"><IMG
|
||||
WIDTH="13" HEIGHT="14" ALIGN="BOTTOM" BORDER="0"
|
||||
SRC="img20.png"
|
||||
ALT="$x$"></SPAN> are initialized to <!-- MATH
|
||||
$ix(i) \leftarrow
|
||||
i$
|
||||
-->
|
||||
<SPAN CLASS="MATH"><IMG
|
||||
WIDTH="66" HEIGHT="31" ALIGN="MIDDLE" BORDER="0"
|
||||
SRC="img133.png"
|
||||
ALT="$ix(i) \leftarrow
|
||||
i$"></SPAN>; thus, upon return from the subroutine, for each
|
||||
index <SPAN CLASS="MATH"><IMG
|
||||
WIDTH="9" HEIGHT="15" ALIGN="BOTTOM" BORDER="0"
|
||||
SRC="img4.png"
|
||||
ALT="$i$"></SPAN> we have in <SPAN CLASS="MATH"><IMG
|
||||
WIDTH="36" HEIGHT="31" ALIGN="MIDDLE" BORDER="0"
|
||||
SRC="img134.png"
|
||||
ALT="$ix(i)$"></SPAN> the position that the item <SPAN CLASS="MATH"><IMG
|
||||
WIDTH="31" HEIGHT="31" ALIGN="MIDDLE" BORDER="0"
|
||||
SRC="img135.png"
|
||||
ALT="$x(i)$"></SPAN>
|
||||
occupied in the original data sequence;
|
||||
</LI>
|
||||
<LI>If the user has requested on <code>psb_init</code> a number of
|
||||
processes less than the total available in the parallel execution
|
||||
environment, the remaining processes will have on return <SPAN CLASS="MATH"><IMG
|
||||
WIDTH="73" HEIGHT="29" ALIGN="MIDDLE" BORDER="0"
|
||||
<LI>If <!-- MATH
|
||||
$flag = psb\_sort\_keep\_idx\_$
|
||||
-->
|
||||
<SPAN CLASS="MATH"><IMG
|
||||
WIDTH="184" HEIGHT="30" ALIGN="MIDDLE" BORDER="0"
|
||||
SRC="img136.png"
|
||||
ALT="$flag = psb\_sort\_keep\_idx\_$"></SPAN> the routine will assume that
|
||||
the entries in <SPAN CLASS="MATH"><IMG
|
||||
WIDTH="35" HEIGHT="31" ALIGN="MIDDLE" BORDER="0"
|
||||
SRC="img137.png"
|
||||
ALT="$iam=-1$"></SPAN>;
|
||||
the only call involving <code>icontxt</code> that any such process may
|
||||
execute is to <code>psb_exit</code>.
|
||||
ALT="$ix(:)$"></SPAN> have already been initialized by the user;
|
||||
</LI>
|
||||
<LI>The three sorting algorithms have a similar <SPAN CLASS="MATH"><IMG
|
||||
WIDTH="74" HEIGHT="31" ALIGN="MIDDLE" BORDER="0"
|
||||
SRC="img138.png"
|
||||
ALT="$O(n \log n)$"></SPAN> 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 <SPAN CLASS="MATH"><IMG
|
||||
WIDTH="45" HEIGHT="33" ALIGN="MIDDLE" BORDER="0"
|
||||
SRC="img139.png"
|
||||
ALT="$O(n^2)$"></SPAN>; 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
|
||||
<SPAN CLASS="MATH"><IMG
|
||||
WIDTH="74" HEIGHT="31" ALIGN="MIDDLE" BORDER="0"
|
||||
SRC="img138.png"
|
||||
ALT="$O(n \log n)$"></SPAN> 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>
|
||||
<BR><HR>
|
||||
|
||||
<P>
|
||||
|
||||
<DIV CLASS="navigation"><HR>
|
||||
<!--Navigation Panel-->
|
||||
<A NAME="tex2html1521"
|
||||
HREF="node102.html">
|
||||
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
|
||||
<A NAME="tex2html1517"
|
||||
HREF="node74.html">
|
||||
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
|
||||
<A NAME="tex2html1513"
|
||||
HREF="node100.html">
|
||||
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
|
||||
<A NAME="tex2html1519"
|
||||
HREF="node1.html">
|
||||
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
|
||||
<BR>
|
||||
<B> Next:</B> <A NAME="tex2html1522"
|
||||
HREF="node102.html">Parallel environment routines</A>
|
||||
<B> Up:</B> <A NAME="tex2html1518"
|
||||
HREF="node74.html">Data management routines</A>
|
||||
<B> Previous:</B> <A NAME="tex2html1514"
|
||||
HREF="node100.html">psb_sizeof Memory</A>
|
||||
<B> <A NAME="tex2html1520"
|
||||
HREF="node1.html">Contents</A></B> </DIV>
|
||||
<!--End of Navigation Panel-->
|
||||
|
||||
</BODY>
|
||||
</HTML>
|
||||
|
||||
Reference in New Issue
Block a user