mirror of
https://github.com/sfilippone/psblas3.git
synced 2026-10-16 02:49:03 +00:00
psblas3:
Updated docs.
This commit is contained in:
+71
-27
@@ -7,8 +7,8 @@ original version by: Nikos Drakos, CBLU, University of Leeds
|
||||
Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<TITLE>clone -- Clone current object</TITLE>
|
||||
<META NAME="description" CONTENT="clone -- Clone current object">
|
||||
<TITLE>set -- Set contents of the vector</TITLE>
|
||||
<META NAME="description" CONTENT="set -- Set contents of the vector">
|
||||
<META NAME="keywords" CONTENT="userhtml">
|
||||
<META NAME="resource-type" CONTENT="document">
|
||||
<META NAME="distribution" CONTENT="global">
|
||||
@@ -18,44 +18,48 @@ original version by: Nikos Drakos, CBLU, University of Leeds
|
||||
|
||||
<LINK REL="STYLESHEET" HREF="userhtml.css">
|
||||
|
||||
<LINK REL="next" HREF="node47.html">
|
||||
<LINK REL="previous" HREF="node45.html">
|
||||
<LINK REL="up" HREF="node41.html">
|
||||
<LINK REL="up" HREF="node42.html">
|
||||
<LINK REL="next" HREF="node47.html">
|
||||
</HEAD>
|
||||
|
||||
<BODY >
|
||||
<!--Navigation Panel-->
|
||||
<A NAME="tex2html804"
|
||||
<A NAME="tex2html812"
|
||||
HREF="node47.html">
|
||||
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
|
||||
<A NAME="tex2html800"
|
||||
HREF="node41.html">
|
||||
<A NAME="tex2html808"
|
||||
HREF="node42.html">
|
||||
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
|
||||
<A NAME="tex2html796"
|
||||
<A NAME="tex2html802"
|
||||
HREF="node45.html">
|
||||
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
|
||||
<A NAME="tex2html802"
|
||||
<A NAME="tex2html810"
|
||||
HREF="node1.html">
|
||||
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
|
||||
<BR>
|
||||
<B> Next:</B> <A NAME="tex2html805"
|
||||
HREF="node47.html">Preconditioner data structure</A>
|
||||
<B> Up:</B> <A NAME="tex2html801"
|
||||
HREF="node41.html">Dense Vector Data Structure</A>
|
||||
<B> Previous:</B> <A NAME="tex2html797"
|
||||
HREF="node45.html">get_vect Get</A>
|
||||
<B> <A NAME="tex2html803"
|
||||
<B> Next:</B> <A NAME="tex2html813"
|
||||
HREF="node47.html">get_vect Get</A>
|
||||
<B> Up:</B> <A NAME="tex2html809"
|
||||
HREF="node42.html">Dense Vector Data Structure</A>
|
||||
<B> Previous:</B> <A NAME="tex2html803"
|
||||
HREF="node45.html">sizeof Get</A>
|
||||
<B> <A NAME="tex2html811"
|
||||
HREF="node1.html">Contents</A></B>
|
||||
<BR>
|
||||
<BR>
|
||||
<!--End of Navigation Panel-->
|
||||
|
||||
<H3><A NAME="SECTION00043500000000000000">
|
||||
clone -- Clone current object</A>
|
||||
<H3><A NAME="SECTION00043400000000000000">
|
||||
set -- Set contents of the vector</A>
|
||||
</H3>
|
||||
|
||||
<P>
|
||||
<PRE>
|
||||
call x%clone(y,info)
|
||||
call v%set(alpha[,first,last])
|
||||
call v%set(vect[,first,last])
|
||||
call v%zero()
|
||||
</PRE>
|
||||
|
||||
<P>
|
||||
@@ -66,24 +70,64 @@ call x%clone(y,info)
|
||||
<DT><STRONG><B>On Entry</B></STRONG></DT>
|
||||
<DD>
|
||||
</DD>
|
||||
<DT><STRONG>x</STRONG></DT>
|
||||
<DD>the dense vector.
|
||||
<DT><STRONG>v</STRONG></DT>
|
||||
<DD>the dense vector
|
||||
<BR>
|
||||
Scope: <B>local</B>.
|
||||
Scope: <B>local</B>
|
||||
<BR></DD>
|
||||
<DT><STRONG>alpha</STRONG></DT>
|
||||
<DD>A scalar value.
|
||||
<BR>
|
||||
Scope: <B>local</B>
|
||||
<BR>
|
||||
Type: <B>required</B>
|
||||
<BR>
|
||||
Intent: <B>in</B>.
|
||||
<BR>
|
||||
Specified as: a number of the data
|
||||
type indicated in Table <A HREF="#tab:f90axpby">1</A>.
|
||||
|
||||
<P>
|
||||
</DD>
|
||||
<DT><STRONG>first,last</STRONG></DT>
|
||||
<DD>Boundaries for setting in the vector.
|
||||
<BR>
|
||||
Scope: <B> local</B>
|
||||
<BR>
|
||||
Type: <B>optional</B>
|
||||
<BR>
|
||||
Intent: <B>in</B>.
|
||||
<BR>
|
||||
Specified
|
||||
as: integers.
|
||||
</DD>
|
||||
<DT><STRONG>vect</STRONG></DT>
|
||||
<DD>An array
|
||||
<BR>
|
||||
Scope: <B>local</B>
|
||||
<BR>
|
||||
Type: <B>required</B>
|
||||
<BR>
|
||||
Intent: <B>in</B>.
|
||||
<BR>
|
||||
Specified as: a number of the data
|
||||
type indicated in Table <A HREF="#tab:f90axpby">1</A>.
|
||||
</DD>
|
||||
</DL>
|
||||
Note that a call to <code>v%zero()</code> is provided as a shorthand, but
|
||||
is equivalent to a call to <code>v%set(zero)</code> with the <code>zero</code>
|
||||
constant having the appropriate type and kind.
|
||||
|
||||
<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>
|
||||
<DT><STRONG>v</STRONG></DT>
|
||||
<DD>the dense vector, with updated entries
|
||||
<BR>
|
||||
Scope: <B>local</B>
|
||||
<BR></DD>
|
||||
</DL>
|
||||
|
||||
<P>
|
||||
|
||||
Reference in New Issue
Block a user