1 | .\"Copyright 2006-2008 Sun Microsystems, Inc. |
---|
2 | .\" Copyright (c) 1996 Thinking Machines Corporation |
---|
3 | .TH MPI_Type_hindexed 3 "Dec 08, 2009" "1.4" "Open MPI" |
---|
4 | .SH NAME |
---|
5 | \fBMPI_Type_hindexed\fP \- Creates an indexed datatype with offsets in bytes -- use of this routine is deprecated. |
---|
6 | |
---|
7 | .SH SYNTAX |
---|
8 | .ft R |
---|
9 | .SH C Syntax |
---|
10 | .nf |
---|
11 | #include <mpi.h> |
---|
12 | int MPI_Type_hindexed(int \fIcount\fP, int\fI *array_of_blocklengths\fP, |
---|
13 | MPI_Aint\fI *array_of_displacements\fP, MPI_Datatype\fI oldtype\fP, |
---|
14 | MPI_Datatype\fI *newtype\fP) |
---|
15 | |
---|
16 | .SH Fortran Syntax |
---|
17 | .nf |
---|
18 | INCLUDE 'mpif.h' |
---|
19 | MPI_TYPE_HINDEXED(\fICOUNT, ARRAY_OF_BLOCKLENGTHS, |
---|
20 | ARRAY_OF_DISPLACEMENTS, OLDTYPE, NEWTYPE, IERROR\fP) |
---|
21 | INTEGER \fICOUNT, ARRAY_OF_BLOCKLENGTHS(*)\fP |
---|
22 | INTEGER \fIARRAY_OF_DISPLACEMENTS(*), OLDTYPE, NEWTYPE\fP |
---|
23 | INTEGER \fIIERROR\fP |
---|
24 | |
---|
25 | |
---|
26 | .SH INPUT PARAMETERS |
---|
27 | .ft R |
---|
28 | .TP 1i |
---|
29 | count |
---|
30 | Number of blocks -- also number of entries in array_of_displacements and |
---|
31 | array_of_blocklengths (integer). |
---|
32 | .TP 1i |
---|
33 | array_of_blocklengths |
---|
34 | Number of elements in each block (array of nonnegative integers). |
---|
35 | .TP 1i |
---|
36 | array_of_displacements |
---|
37 | Byte displacement of each block (array of integer). |
---|
38 | .TP 1i |
---|
39 | oldtype |
---|
40 | Old datatype (handle). |
---|
41 | .sp |
---|
42 | .SH OUTPUT PARAMETERS |
---|
43 | .ft R |
---|
44 | .TP 1i |
---|
45 | newtype |
---|
46 | New datatype (handle). |
---|
47 | .sp |
---|
48 | .ft R |
---|
49 | .TP 1i |
---|
50 | IERROR |
---|
51 | Fortran only: Error status (integer). |
---|
52 | |
---|
53 | .SH DESCRIPTION |
---|
54 | .ft R |
---|
55 | Note that use of this routine is \fIdeprecated\fP as of MPI-2. Use MPI_Type_create_hindexed instead. |
---|
56 | .sp |
---|
57 | This deprecated routine is not available in C++. |
---|
58 | .sp |
---|
59 | The function is identical to MPI_Type_indexed, except that block displacements in array_of_displacements are specified in bytes, rather than in multiples of the oldtype extent. |
---|
60 | .sp |
---|
61 | Assume that oldtype has type map |
---|
62 | .sp |
---|
63 | .nf |
---|
64 | {(type(0), disp(0)), ..., (type(n-1), disp(n-1))}, |
---|
65 | .fi |
---|
66 | .sp |
---|
67 | with extent ex. Let B be the array_of_blocklength argument and D be the |
---|
68 | array_of_displacements argument. The newly created datatype has |
---|
69 | .nf |
---|
70 | n x S^count-1 |
---|
71 | (i=0) B[i] entries: |
---|
72 | |
---|
73 | {(type(0), disp(0) + D[0]),...,(type(n-1), disp(n-1) + D[0]),..., |
---|
74 | (type(0), disp(0) + (D[0] + B[0]-1)* ex),..., |
---|
75 | type(n-1), disp(n-1) + (D[0]+ B[0]-1)* ex),..., |
---|
76 | (type(0), disp(0) + D[count-1]),...,(type(n-1), disp(n-1) + D[count-1]),..., |
---|
77 | (type(0), disp(0) + D[count-1] + (B[count-1] -1)* ex),..., |
---|
78 | (type(n-1), disp(n-1) + D[count-1] + (B[count-1] -1)* ex)} |
---|
79 | .fi |
---|
80 | |
---|
81 | .SH ERRORS |
---|
82 | 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. |
---|
83 | .sp |
---|
84 | Before the error value is returned, the current MPI error handler is |
---|
85 | 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. |
---|
86 | |
---|
87 | .SH SEE ALSO |
---|
88 | .ft R |
---|
89 | MPI_Type_create_hindexed |
---|
90 | .br |
---|
91 | MPI_Type_indexed |
---|
92 | .br |
---|
93 | |
---|