Sophie: mpich2-doc-1.0.8-2mdv2010.0 i586

mpich2-doc-1.0.8-2mdv2010.0.i586.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD>
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>MPI_Pack</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<A NAME="MPI_Pack"><H1>MPI_Pack</H1></A>
Packs a datatype into contiguous memory 
<H2>Synopsis</H2>
<PRE>
int MPI_Pack(void *inbuf,
             int incount,
             MPI_Datatype datatype,
             void *outbuf, 
             int outcount,
             int *position,
             MPI_Comm comm)
</PRE>
<H2>Arguments</H2>
<DL>
<DT><B>void *inbuf </B><DD>input buffer

<DT><B>int incount </B><DD>input count

<DT><B>MPI_Datatype datatype </B><DD>datatype

<DT><B>void *outbuf </B><DD>output buffer

<DT><B>int outcount </B><DD>output count

<DT><B>int *position </B><DD>position

<DT><B>MPI_Comm comm </B><DD>communicator
</DL>
<P>
<H2>Notes (from the specifications)</H2>
<P>
The input value of position is the first location in the output buffer to be
used for packing.  position is incremented by the size of the packed message,
and the output value of position is the first location in the output buffer
following the locations occupied by the packed message.  The comm argument is
the communicator that will be subsequently used for sending the packed
message.
<P>
<P>
<H2>Notes for Fortran</H2>
All MPI routines in Fortran (except for <TT>MPI_WTIME</TT> and <TT>MPI_WTICK</TT>) have
an additional argument <TT>ierr</TT> at the end of the argument list.  <TT>ierr
</TT>is an integer and has the same meaning as the return value of the routine
in C.  In Fortran, MPI routines are subroutines, and are invoked with the
<TT>call</TT> statement.
<P>
All MPI objects (e.g., <TT>MPI_Datatype</TT>, <TT>MPI_Comm</TT>) are of type <TT>INTEGER
</TT>in Fortran.
<P>
<H2>Errors</H2>
<P>
All MPI routines (except <TT>MPI_Wtime</TT> and <TT>MPI_Wtick</TT>) return an error value;
C routines as the value of the function and Fortran routines in the last
argument.  Before the value is returned, the current MPI error handler is
called.  By default, this error handler aborts the MPI job.  The error handler
may be changed with <TT>MPI_Comm_set_errhandler</TT> (for communicators),
<TT>MPI_File_set_errhandler</TT> (for files), and <TT>MPI_Win_set_errhandler</TT> (for
RMA windows).  The MPI-1 routine <TT>MPI_Errhandler_set</TT> may be used but
its use is deprecated.  The predefined error handler
<TT>MPI_ERRORS_RETURN</TT> may be used to cause error values to be returned.
Note that MPI does <EM>not</EM> guarentee that an MPI program can continue past
an error; however, MPI implementations will attempt to continue whenever
possible.
<P>
<DL><DT><B>MPI_SUCCESS </B> <DD> No error; MPI routine completed successfully.
</DL>
<P><B>Location:</B>pack.c<P>
</BODY></HTML>