1 | .\"Copyright 2006-2008 Sun Microsystems, Inc. |
---|
2 | .\"Copyright (c) 1996 Thinking Machines |
---|
3 | .TH MPI_Type_create_indexed_block 3 "Dec 08, 2009" "1.4" "Open MPI" |
---|
4 | .SH NAME |
---|
5 | \fBMPI_Type_create_indexed_block\fP \- Creates an indexed data type with the same block length for all blocks. |
---|
6 | |
---|
7 | .SH SYNTAX |
---|
8 | .ft R |
---|
9 | .SH C Syntax |
---|
10 | .nf |
---|
11 | #include <mpi.h> |
---|
12 | int MPI_Type_create_indexed_block(int \fIcount\fP, int \fIblocklength\fP, int \fIarray_of_displacements\fP[], MPI_Datatype \fIoldtype\fP, MPI_Datatype *\fInewtype\fP) |
---|
13 | |
---|
14 | .SH Fortran Syntax |
---|
15 | .nf |
---|
16 | INCLUDE 'mpif.h' |
---|
17 | MPI_TYPE_CREATE_INDEXED_BLOCK(\fICOUNT, BLOCKLENGTH, |
---|
18 | ARRAY_OF_DISPLACEMENTS, OLDTYPE, NEWTYPE, IERROR\fP) |
---|
19 | INTEGER \fICOUNT, BLOCKLENGTH, ARRAY_OF_DISPLACEMENTS(*), |
---|
20 | OLDTYPE, NEWTYPE, IERROR \fP |
---|
21 | |
---|
22 | .SH C++ Syntax |
---|
23 | .nf |
---|
24 | #include <mpi.h> |
---|
25 | MPI::Datatype MPI::Datatype::Create_indexed_block( int \fIcount\fP, |
---|
26 | int \fIblocklength\fP, const int \fIarray_of_displacements\fP[]) const |
---|
27 | |
---|
28 | .SH INPUT PARAMETERS |
---|
29 | .ft R |
---|
30 | .TP 1i |
---|
31 | count |
---|
32 | Length of array of displacements (integer). |
---|
33 | .TP 1i |
---|
34 | blocklength |
---|
35 | Size of block (integer). |
---|
36 | .TP 1i |
---|
37 | array_of_displacements |
---|
38 | Array of displacements (array of integers). |
---|
39 | .TP 1i |
---|
40 | oldtype |
---|
41 | Old data type (handle). |
---|
42 | |
---|
43 | .SH OUTPUT PARAMETERS |
---|
44 | .ft R |
---|
45 | .TP 1i |
---|
46 | newtype |
---|
47 | New data type (handle). |
---|
48 | .TP 1i |
---|
49 | IERROR |
---|
50 | Fortran only: Error status (integer). |
---|
51 | |
---|
52 | .SH DESCRIPTION |
---|
53 | .ft R |
---|
54 | MPI_Type_create_indexed_block creates an indexed data type with the same block length for all blocks. |
---|
55 | |
---|
56 | .SH ERRORS |
---|
57 | Almost all MPI routines return an error value; C routines as the value of the function and Fortran routines in the last argument. C++ functions do not return errors. If the default error handler is set to MPI::ERRORS_THROW_EXCEPTIONS, then on error the C++ exception mechanism will be used to throw an MPI:Exception object. |
---|
58 | .sp |
---|
59 | Before the error value is returned, the current MPI error handler is |
---|
60 | called. By default, this error handler aborts the MPI job, except for I/O function errors. The error handler may be changed with MPI_Comm_set_errhandler; the predefined error handler MPI_ERRORS_RETURN may be used to cause error values to be returned. Note that MPI does not guarantee that an MPI program can continue past an error. |
---|
61 | |
---|
62 | .SH SEE ALSO |
---|
63 | .ft R |
---|
64 | .sp |
---|
65 | MPI_Type_indexed |
---|
66 | .br |
---|
67 | |
---|