fdurastante/psblas3
1
0
Fork 0
mirror of https://github.com/sfilippone/psblas3.git synced 2026-10-16 10:52:08 +00:00
Code Issues Packages Projects Releases Wiki Activity

psblas3:

Browse Source 
Updated docs.
This commit is contained in:
Salvatore Filippone
2017-02-12 18:19:15 +00:00
parent 9ab0539881
commit 001aa819fa
147 changed files with 22648 additions and 22177 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/html/node48.html
+44 -51
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>Heap data structure</TITLE>
<META NAME="description" CONTENT="Heap data structure">
<TITLE>clone -- Clone current object</TITLE>
<META NAME="description" CONTENT="clone -- Clone current object">
<META NAME="keywords" CONTENT="userhtml">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
@@ -19,79 +19,72 @@ original version by: Nikos Drakos, CBLU, University of Leeds
<LINK REL="STYLESHEET" HREF="userhtml.css">
<LINK REL="previous" HREF="node47.html">
<LINK REL="up" HREF="node9.html">
<LINK REL="up" HREF="node42.html">
<LINK REL="next" HREF="node49.html">
</HEAD>
<BODY >
<!--Navigation Panel-->
<A NAME="tex2html826"
<A NAME="tex2html834"
HREF="node49.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
<A NAME="tex2html822"
HREF="node9.html">
<A NAME="tex2html830"
HREF="node42.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
<A NAME="tex2html818"
<A NAME="tex2html826"
HREF="node47.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
<A NAME="tex2html824"
<A NAME="tex2html832"
HREF="node1.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
<BR>
<B> Next:</B> <A NAME="tex2html827"
HREF="node49.html">Computational routines</A>
<B> Up:</B> <A NAME="tex2html823"
HREF="node9.html">Data Structures and Classes</A>
<B> Previous:</B> <A NAME="tex2html819"
HREF="node47.html">Preconditioner data structure</A>
&nbsp; <B> <A NAME="tex2html825"
<B> Next:</B> <A NAME="tex2html835"
HREF="node49.html">Preconditioner data structure</A>
<B> Up:</B> <A NAME="tex2html831"
HREF="node42.html">Dense Vector Data Structure</A>
<B> Previous:</B> <A NAME="tex2html827"
HREF="node47.html">get_vect Get</A>
&nbsp; <B> <A NAME="tex2html833"
HREF="node1.html">Contents</A></B>
<BR>
<BR>
<!--End of Navigation Panel-->
<H2><A NAME="SECTION00045000000000000000">
Heap data structure</A>
</H2>
<H3><A NAME="SECTION00043600000000000000">
clone -- Clone current object</A>
</H3>
<PRE>
call x%clone(y,info)
</PRE>
<P>
Among the tools routines of sec.&nbsp;<A HREF="node68.html#sec:toolsrout">6</A>, we have a number
of sorting utilities; the heap sort is implemented in terms of heaps
having the following signatures:
<DL>
<DT><STRONG><TT>psb_T_heap</TT></STRONG></DT>
<DD>: a heap containing elements of type T, where T
can be <code>i,s,c,d,z</code> for integer, real and complex data;
<DT><STRONG>Type:</STRONG></DT>
<DD>Asynchronous.
</DD>
<DT><STRONG><TT>psb_T_idx_heap</TT></STRONG></DT>
<DD>: a heap containing elements of type T, as
above, together with an integer index.
<DT><STRONG><B>On Entry</B></STRONG></DT>
<DD>
</DD>
<DT><STRONG>x</STRONG></DT>
<DD>the dense vector.
<BR>
Scope: <B>local</B>.
<BR></DD>
</DL>
<P>
<DL>
<DT><STRONG><B>On Return</B></STRONG></DT>
<DD>
</DD>
<DT><STRONG>y</STRONG></DT>
<DD>A copy of the input object.
</DD>
<DT><STRONG>info</STRONG></DT>
<DD>Return code.
</DD>
</DL>
Given a heap object, the following methods are defined on it:
<DL>
<DT><STRONG>init</STRONG></DT>
<DD>Initialize memory; also choose ascending or descending
order;
</DD>
<DT><STRONG>howmany</STRONG></DT>
<DD>Current heap occupancy;
</DD>
<DT><STRONG>insert</STRONG></DT>
<DD>Add an item (or an item and its index);
</DD>
<DT><STRONG>get_first</STRONG></DT>
<DD>Remove and return the first element;
</DD>
<DT><STRONG>dump</STRONG></DT>
<DD>Print on file;
</DD>
<DT><STRONG>free</STRONG></DT>
<DD>Release memory.
</DD>
</DL>
These objects are used in MLD2P4 to implement the factorization
algorithms.
<P>
<BR><HR>