mirror of
https://github.com/sfilippone/psblas3.git
synced 2026-10-16 10:52:08 +00:00
Updated docs with fnd_owner adn set_p_adjcncy
This commit is contained in:
+61
-47
@@ -3,8 +3,8 @@
|
||||
<!--Converted with LaTeX2HTML 2018 (Released Feb 1, 2018) -->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<TITLE>Heap data structure</TITLE>
|
||||
<META NAME="description" CONTENT="Heap data structure">
|
||||
<TITLE>get_vect -- Get a copy of the vector contents</TITLE>
|
||||
<META NAME="description" CONTENT="get_vect -- Get a copy of the vector contents">
|
||||
<META NAME="keywords" CONTENT="userhtml">
|
||||
<META NAME="resource-type" CONTENT="document">
|
||||
<META NAME="distribution" CONTENT="global">
|
||||
@@ -14,81 +14,95 @@
|
||||
|
||||
<LINK REL="STYLESHEET" HREF="userhtml.css">
|
||||
|
||||
<LINK REL="next" HREF="node52.html">
|
||||
<LINK REL="previous" HREF="node50.html">
|
||||
<LINK REL="up" HREF="node9.html">
|
||||
<LINK REL="up" HREF="node46.html">
|
||||
<LINK REL="next" HREF="node52.html">
|
||||
</HEAD>
|
||||
|
||||
<BODY >
|
||||
|
||||
<DIV CLASS="navigation"><!--Navigation Panel-->
|
||||
<A NAME="tex2html874"
|
||||
<A NAME="tex2html887"
|
||||
HREF="node52.html">
|
||||
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
|
||||
<A NAME="tex2html870"
|
||||
HREF="node9.html">
|
||||
<A NAME="tex2html883"
|
||||
HREF="node46.html">
|
||||
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
|
||||
<A NAME="tex2html866"
|
||||
<A NAME="tex2html877"
|
||||
HREF="node50.html">
|
||||
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
|
||||
<A NAME="tex2html872"
|
||||
<A NAME="tex2html885"
|
||||
HREF="node1.html">
|
||||
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
|
||||
<BR>
|
||||
<B> Next:</B> <A NAME="tex2html875"
|
||||
HREF="node52.html">Computational routines</A>
|
||||
<B> Up:</B> <A NAME="tex2html871"
|
||||
HREF="node9.html">Data Structures and Classes</A>
|
||||
<B> Previous:</B> <A NAME="tex2html867"
|
||||
HREF="node50.html">Preconditioner data structure</A>
|
||||
<B> <A NAME="tex2html873"
|
||||
<B> Next:</B> <A NAME="tex2html888"
|
||||
HREF="node52.html">clone Clone</A>
|
||||
<B> Up:</B> <A NAME="tex2html884"
|
||||
HREF="node46.html">Dense Vector Data Structure</A>
|
||||
<B> Previous:</B> <A NAME="tex2html878"
|
||||
HREF="node50.html">set Set</A>
|
||||
<B> <A NAME="tex2html886"
|
||||
HREF="node1.html">Contents</A></B>
|
||||
<BR>
|
||||
<BR></DIV>
|
||||
<!--End of Navigation Panel-->
|
||||
|
||||
<H2><A NAME="SECTION00045000000000000000">
|
||||
Heap data structure</A>
|
||||
</H2>
|
||||
<H3><A NAME="SECTION00043500000000000000">
|
||||
get_vect -- Get a copy of the vector contents</A>
|
||||
</H3>
|
||||
|
||||
<P>
|
||||
<PRE>
|
||||
extv = v%get_vect([n])
|
||||
</PRE>
|
||||
|
||||
<P>
|
||||
Among the tools routines of sec. <A HREF="node71.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>v</STRONG></DT>
|
||||
<DD>the dense vector
|
||||
<BR>
|
||||
Scope: <B>local</B>
|
||||
<BR></DD>
|
||||
<DT><STRONG>n</STRONG></DT>
|
||||
<DD>Size to be returned
|
||||
<BR>
|
||||
Scope: <B>local</B>.
|
||||
<BR>
|
||||
Type: <B>optional</B>; default: entire vector.
|
||||
<BR>
|
||||
<P>
|
||||
</DD>
|
||||
</DL>
|
||||
Given a heap object, the following methods are defined on it:
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><STRONG>init</STRONG></DT>
|
||||
<DD>Initialize memory; also choose ascending or descending
|
||||
order;
|
||||
<DT><STRONG><B>On Return</B></STRONG></DT>
|
||||
<DD>
|
||||
</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.
|
||||
<DT><STRONG>Function value</STRONG></DT>
|
||||
<DD>An allocatable array holding a copy of the dense
|
||||
vector contents. If the argument <SPAN CLASS="MATH"><IMG
|
||||
WIDTH="13" HEIGHT="14" ALIGN="BOTTOM" BORDER="0"
|
||||
SRC="img16.png"
|
||||
ALT="$n$"></SPAN> is specified, the size of the
|
||||
returned array equals the minimum between <SPAN CLASS="MATH"><IMG
|
||||
WIDTH="13" HEIGHT="14" ALIGN="BOTTOM" BORDER="0"
|
||||
SRC="img16.png"
|
||||
ALT="$n$"></SPAN> and the internal size
|
||||
of the vector, or 0 if <SPAN CLASS="MATH"><IMG
|
||||
WIDTH="13" HEIGHT="14" ALIGN="BOTTOM" BORDER="0"
|
||||
SRC="img16.png"
|
||||
ALT="$n$"></SPAN> is negative; otherwise, the size of the
|
||||
array is the same as the internal size of the vector.
|
||||
</DD>
|
||||
</DL>
|
||||
These objects are used in MLD2P4 to implement the factorization
|
||||
algorithms.
|
||||
|
||||
<P>
|
||||
<BR><HR>
|
||||
|
||||
Reference in New Issue
Block a user