|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
<HTML>
|
|
Packit Service |
c5cf8c |
<HEAD>
|
|
Packit Service |
c5cf8c |
<META NAME="GENERATOR" CONTENT="DOCTEXT">
|
|
Packit Service |
c5cf8c |
<TITLE>MPI_Type_hindexed</TITLE>
|
|
Packit Service |
c5cf8c |
</HEAD>
|
|
Packit Service |
c5cf8c |
<BODY BGCOLOR="FFFFFF">
|
|
Packit Service |
c5cf8c |
MPI_Type_hindexed
|
|
Packit Service |
c5cf8c |
Creates an indexed datatype with offsets in bytes
|
|
Packit Service |
c5cf8c |
Synopsis
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
int MPI_Type_hindexed(int count,
|
|
Packit Service |
c5cf8c |
int *array_of_blocklengths,
|
|
Packit Service |
c5cf8c |
MPI_Aint * array_of_displacements,
|
|
Packit Service |
c5cf8c |
MPI_Datatype oldtype, MPI_Datatype * newtype)
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
Input Parameters
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
count number of blocks -- also number of entries in array_of_displacements and array_of_blocklengths
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
array_of_blocklengths number of elements in each block (array of nonnegative integers)
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
array_of_displacements byte displacement of each block (array of MPI_Aint)
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
oldtype old datatype (handle)
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
Output Parameters
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
newtype new datatype (handle)
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
Deprecated Function
|
|
Packit Service |
c5cf8c |
The MPI-2 standard deprecated a number of routines because MPI-2 provides
|
|
Packit Service |
c5cf8c |
better versions. This routine is one of those that was deprecated. The
|
|
Packit Service |
c5cf8c |
routine may continue to be used, but new code should use the replacement
|
|
Packit Service |
c5cf8c |
routine.
|
|
Packit Service |
c5cf8c |
This routine is replaced by <tt>MPI_Type_create_hindexed</tt>.
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
Thread and Interrupt Safety
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
This routine is thread-safe. This means that this routine may be
|
|
Packit Service |
c5cf8c |
safely used by multiple threads without the need for any user-provided
|
|
Packit Service |
c5cf8c |
thread locks. However, the routine is not interrupt safe. Typically,
|
|
Packit Service |
c5cf8c |
this is due to the use of memory allocation routines such as <tt>malloc
|
|
Packit Service |
c5cf8c |
</tt>or other non-MPICH runtime routines that are themselves not interrupt-safe.
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
Notes for Fortran
|
|
Packit Service |
c5cf8c |
All MPI routines in Fortran (except for <tt>MPI_WTIME</tt> and <tt>MPI_WTICK</tt>) have
|
|
Packit Service |
c5cf8c |
an additional argument <tt>ierr</tt> at the end of the argument list. <tt>ierr
|
|
Packit Service |
c5cf8c |
</tt>is an integer and has the same meaning as the return value of the routine
|
|
Packit Service |
c5cf8c |
in C. In Fortran, MPI routines are subroutines, and are invoked with the
|
|
Packit Service |
c5cf8c |
<tt>call</tt> statement.
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
All MPI objects (e.g., <tt>MPI_Datatype</tt>, <tt>MPI_Comm</tt>) are of type <tt>INTEGER
|
|
Packit Service |
c5cf8c |
</tt>in Fortran.
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
The array_of_displacements are displacements, and are based on a zero origin. A common error
|
|
Packit Service |
c5cf8c |
is to do something like to following
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
integer a(100)
|
|
Packit Service |
c5cf8c |
integer array_of_blocklengths(10), array_of_displacements(10)
|
|
Packit Service |
c5cf8c |
do i=1,10
|
|
Packit Service |
c5cf8c |
array_of_blocklengths(i) = 1
|
|
Packit Service |
c5cf8c |
10 array_of_displacements(i) = (1 + (i-1)*10) * sizeofint
|
|
Packit Service |
c5cf8c |
call MPI_TYPE_HINDEXED(10,array_of_blocklengths,array_of_displacements,MPI_INTEGER,newtype,ierr)
|
|
Packit Service |
c5cf8c |
call MPI_TYPE_COMMIT(newtype,ierr)
|
|
Packit Service |
c5cf8c |
call MPI_SEND(a,1,newtype,...)
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
expecting this to send "a(1),a(11),..." because the array_of_displacements have values
|
|
Packit Service |
c5cf8c |
"1,11,...". Because these are displacements from the beginning of "a",
|
|
Packit Service |
c5cf8c |
it actually sends "a(1+1),a(1+11),...".
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
If you wish to consider the displacements as array_of_displacements into a Fortran array,
|
|
Packit Service |
c5cf8c |
consider declaring the Fortran array with a zero origin
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
integer a(0:99)
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
Errors
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
All MPI routines (except <tt>MPI_Wtime</tt> and <tt>MPI_Wtick</tt>) return an error value;
|
|
Packit Service |
c5cf8c |
C routines as the value of the function and Fortran routines in the last
|
|
Packit Service |
c5cf8c |
argument. Before the value is returned, the current MPI error handler is
|
|
Packit Service |
c5cf8c |
called. By default, this error handler aborts the MPI job. The error handler
|
|
Packit Service |
c5cf8c |
may be changed with <tt>MPI_Comm_set_errhandler</tt> (for communicators),
|
|
Packit Service |
c5cf8c |
<tt>MPI_File_set_errhandler</tt> (for files), and <tt>MPI_Win_set_errhandler</tt> (for
|
|
Packit Service |
c5cf8c |
RMA windows). The MPI-1 routine <tt>MPI_Errhandler_set</tt> may be used but
|
|
Packit Service |
c5cf8c |
its use is deprecated. The predefined error handler
|
|
Packit Service |
c5cf8c |
<tt>MPI_ERRORS_RETURN</tt> may be used to cause error values to be returned.
|
|
Packit Service |
c5cf8c |
Note that MPI does not guarentee that an MPI program can continue past
|
|
Packit Service |
c5cf8c |
an error; however, MPI implementations will attempt to continue whenever
|
|
Packit Service |
c5cf8c |
possible.
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
MPI_SUCCESS No error; MPI routine completed successfully.
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
MPI_ERR_TYPE Invalid datatype argument. Additionally, this error can
|
|
Packit Service |
c5cf8c |
occur if an uncommitted MPI_Datatype (see <tt>MPI_Type_commit</tt>) is used
|
|
Packit Service |
c5cf8c |
in a communication call.
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
MPI_ERR_COUNT Invalid count argument. Count arguments must be
|
|
Packit Service |
c5cf8c |
non-negative; a count of zero is often valid.
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
MPI_ERR_INTERN This error is returned when some part of the MPICH
|
|
Packit Service |
c5cf8c |
implementation is unable to acquire memory.
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
MPI_ERR_ARG Invalid argument. Some argument is invalid and is not
|
|
Packit Service |
c5cf8c |
identified by a specific error class (e.g., <tt>MPI_ERR_RANK</tt>).
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
</BODY></HTML>
|