1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147
|
.TH MPI_Type_indexed 3 "2/18/1997" " " "MPI"
.SH NAME
MPI_Type_indexed \- Creates an indexed datatype
.SH SYNOPSIS
.nf
#include "mpi.h"
int MPI_Type_indexed( count, blocklens, indices, old_type, newtype )
int count;
int blocklens[];
int indices[];
MPI_Datatype old_type;
MPI_Datatype *newtype;
.fi
.SH INPUT PARAMETERS
.PD 0
.TP
.B count
- number of blocks -- also number of entries in indices and blocklens
.PD 1
.PD 0
.TP
.B blocklens
- number of elements in each block (array of nonnegative integers)
.PD 1
.PD 0
.TP
.B indices
- displacement of each block in multiples of old_type (array of
integers)
.PD 1
.PD 0
.TP
.B old_type
- old datatype (handle)
.PD 1
.SH OUTPUT PARAMETER
.PD 0
.TP
.B newtype
- new datatype (handle)
.PD 1
.SH NOTES FOR FORTRAN
All MPI routines in Fortran (except for
.I MPI_WTIME
and
.I MPI_WTICK
) have
an additional argument
.I ierr
at the end of the argument list.
.I ierr
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
.I call
statement.
All MPI objects (e.g.,
.I MPI_Datatype
,
.I MPI_Comm
) are of type
.I INTEGER
in Fortran.
The indices are displacements, and are based on a zero origin. A common error
is to do something like to following
.nf
integer a(100)
integer blens(10), indices(10)
do i=1,10
blens(i) = 1
10 indices(i) = 1 + (i-1)*10
call MPI_TYPE_INDEXED(10,blens,indices,MPI_INTEGER,newtype,ierr)
call MPI_TYPE_COMMIT(newtype,ierr)
call MPI_SEND(a,1,newtype,...)
.fi
expecting this to send
.I a(1),a(11),...
because the indices have values
.I 1,11,...
. Because these are
.B displacements
from the beginning of
.I a
,
it actually sends
.I a(1+1),a(1+11),...
.
If you wish to consider the displacements as indices into a Fortran array,
consider declaring the Fortran array with a zero origin
.nf
integer a(0:99)
.fi
.SH ERRORS
All MPI routines (except
.I MPI_Wtime
and
.I MPI_Wtick
) 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
.I MPI_Errhandler_set
; the predefined error handler
.I MPI_ERRORS_RETURN
may be used to cause error values to be returned.
Note that MPI does
.B not
guarentee that an MPI program can continue past
an error.
.PD 0
.TP
.B MPI_ERR_COUNT
- Invalid count argument. Count arguments must be
non-negative; a count of zero is often valid.
.PD 1
.PD 0
.TP
.B MPI_ERR_TYPE
- Invalid datatype argument. May be an uncommitted
.PD 1
MPI_Datatype (see
.I MPI_Type_commit
).
.PD 0
.TP
.B MPI_ERR_ARG
- Invalid argument. Some argument is invalid and is not
identified by a specific error class (e.g.,
.I MPI_ERR_RANK
).
.PD 1
.PD 0
.TP
.B MPI_ERR_INTERN
- This error is returned when some part of the MPICH
implementation is unable to acquire memory.
.PD 1
.SH LOCATION
type_ind.c
|