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_Type_hindexed</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<A NAME="MPI_Type_hindexed"><H1>MPI_Type_hindexed</H1></A>
Creates an indexed datatype with offsets in bytes 
<H2>Synopsis</H2>
<PRE>
int MPI_Type_hindexed(int count,
                     int blocklens[],
                     MPI_Aint indices[],
                     MPI_Datatype old_type,
                     MPI_Datatype *newtype)
</PRE>
<H2>Input Parameters</H2>
<DL>
<DT><B>count </B><DD>number of blocks -- also number of entries in indices and blocklens

<DT><B>blocklens </B><DD>number of elements in each block (array of nonnegative integers) 

<DT><B>indices </B><DD>byte displacement of each block (array of MPI_Aint) 

<DT><B>old_type </B><DD>old datatype (handle) 
</DL>
<P>
<H2>Output Parameter</H2>
<DL><DT><B>newtype </B> <DD> new datatype (handle) 
</DL>
<P>
<H2>Deprecated Function</H2>
The MPI-2 standard deprecated a number of routines because MPI-2 provides
better versions.  This routine is one of those that was deprecated.  The
routine may continue to be used, but new code should use the replacement
routine.
This routine is replaced by <TT>MPI_Type_create_hindexed</TT>.
<P>
<H2>Thread and Interrupt Safety</H2>
<P>
This routine is thread-safe.  This means that this routine may be
safely used by multiple threads without the need for any user-provided
thread locks.  However, the routine is not interrupt safe.  Typically,
this is due to the use of memory allocation routines such as <TT>malloc
</TT>or other non-MPICH runtime routines that are themselves not interrupt-safe.
<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>
The indices are displacements, and are based on a zero origin.  A common error
is to do something like to following
<PRE>
    integer a(100)
    integer blens(10), indices(10)
    do i=1,10
         blens(i)   = 1
10       indices(i) = (1 + (i-1)*10) * sizeofint
    call MPI_TYPE_HINDEXED(10,blens,indices,MPI_INTEGER,newtype,ierr)
    call MPI_TYPE_COMMIT(newtype,ierr)
    call MPI_SEND(a,1,newtype,...)
</PRE>

expecting this to send <TT>a(1),a(11),...</TT> because the indices have values
<TT>1,11,...</TT>.   Because these are <EM>displacements</EM> from the beginning of <TT>a</TT>,
it actually sends <TT>a(1+1),a(1+11),...</TT>.
<P>
If you wish to consider the displacements as indices into a Fortran array,
consider declaring the Fortran array with a zero origin
<PRE>
    integer a(0:99)
</PRE>

<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>
<DL><DT><B>MPI_ERR_TYPE </B> <DD> Invalid datatype argument.  May be an uncommitted 
MPI_Datatype (see <TT>MPI_Type_commit</TT>).
</DL>
<DL><DT><B>MPI_ERR_COUNT </B> <DD> Invalid count argument.  Count arguments must be 
non-negative; a count of zero is often valid.
</DL>
<DL><DT><B>MPI_ERR_INTERN </B> <DD> This error is returned when some part of the MPICH 
implementation is unable to acquire memory.  
</DL>
<DL><DT><B>MPI_ERR_ARG </B> <DD> Invalid argument.  Some argument is invalid and is not
identified by a specific error class (e.g., <TT>MPI_ERR_RANK</TT>).
</DL>
<P><B>Location:</B>type_hindexed.c<P>
</BODY></HTML>