[97] | 1 | .\"Copyright 2006-2008 Sun Microsystems, Inc. |
---|
| 2 | .\" Copyright (c) 1996 Thinking Machines Corporation |
---|
| 3 | .TH MPI_Type_hvector 3 "Dec 08, 2009" "1.4" "Open MPI" |
---|
| 4 | .SH NAME |
---|
| 5 | \fBMPI_Type_hvector\fP \- Creates a vector (strided) datatype with offset 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_hvector(int \fIcount\fP, int\fI blocklength\fP, MPI_Aint\fI stride\fP, |
---|
| 13 | MPI_Datatype\fI oldtype\fP, MPI_Datatype\fI *newtype\fP) |
---|
| 14 | |
---|
| 15 | .SH Fortran Syntax |
---|
| 16 | .nf |
---|
| 17 | INCLUDE 'mpif.h' |
---|
| 18 | MPI_TYPE_HVECTOR(\fICOUNT, BLOCKLENGTH, STRIDE, OLDTYPE, NEWTYPE, |
---|
| 19 | IERROR\fP) |
---|
| 20 | INTEGER \fICOUNT, BLOCKLENGTH, STRIDE, OLDTYPE\fP |
---|
| 21 | INTEGER \fINEWTYPE, IERROR\fP |
---|
| 22 | |
---|
| 23 | .SH INPUT PARAMETERS |
---|
| 24 | .ft R |
---|
| 25 | .TP 1i |
---|
| 26 | count |
---|
| 27 | Number of blocks (nonnegative integer). |
---|
| 28 | .TP 1i |
---|
| 29 | blocklength |
---|
| 30 | Number of elements in each block (nonnegative integer). |
---|
| 31 | .TP 1i |
---|
| 32 | stride |
---|
| 33 | Number of bytes between start of each block (integer). |
---|
| 34 | .TP 1i |
---|
| 35 | oldtype |
---|
| 36 | Old datatype (handle). |
---|
| 37 | .sp |
---|
| 38 | .SH OUTPUT PARAMETERS |
---|
| 39 | .ft R |
---|
| 40 | .TP 1i |
---|
| 41 | newtype |
---|
| 42 | New datatype (handle). |
---|
| 43 | .ft R |
---|
| 44 | .TP 1i |
---|
| 45 | IERROR |
---|
| 46 | Fortran only: Error status (integer). |
---|
| 47 | |
---|
| 48 | .SH DESCRIPTION |
---|
| 49 | .ft R |
---|
| 50 | Note that use of this routine is \fIdeprecated\fP as of MPI-2. Use MPI_Type_create_hvector instead. |
---|
| 51 | .sp |
---|
| 52 | This deprecated routine is not available in C++. |
---|
| 53 | .sp |
---|
| 54 | The function MPI_Type_hvector is identical to MPI_Type_vector, except that |
---|
| 55 | stride is given in bytes, rather than in elements. The use for both types |
---|
| 56 | of vector constructors is illustrated in the examples in Section 3.12.7 of the MPI-1 Standard. |
---|
| 57 | .sp |
---|
| 58 | Assume that oldtype has type map |
---|
| 59 | .sp |
---|
| 60 | .nf |
---|
| 61 | {(type(0), disp(0)), ..., (type(n-1), disp(n-1))} |
---|
| 62 | .fi |
---|
| 63 | .sp |
---|
| 64 | with extent ex. Let bl be the blocklength. The newly created datatype has a type map with count * bl * n entries: |
---|
| 65 | .sp |
---|
| 66 | .nf |
---|
| 67 | {(type(0), disp(0)), ..., (type(n-1), disp(n-1)), |
---|
| 68 | (type(0), disp(0) + ex), ..., (type(n-1), disp(n-1) + ex), |
---|
| 69 | ..., (type(0), disp(0) + (bl -1) * ex),...,(type(n-1), |
---|
| 70 | disp(n-1) + (bl -1) * ex), (type(0), disp(0) + stride), |
---|
| 71 | ...,(type(n-1), disp(n-1) + stride), ..., (type(0), |
---|
| 72 | disp(0) + stride + (bl - 1) * ex), ..., (type(n-1), |
---|
| 73 | disp(n-1) + stride + (bl -1) * ex), ..., (type(0), |
---|
| 74 | disp(0) + stride * (count -1)), ...,(type(n-1), |
---|
| 75 | disp(n-1) + stride * (count -1)), ..., (type(0), |
---|
| 76 | disp(0) + stride * (count -1) + (bl -1) * ex), ..., |
---|
| 77 | (type(n-1), disp(n-1) + stride * (count -1) + (bl -1) * ex)} |
---|
| 78 | |
---|
| 79 | .SH ERRORS |
---|
| 80 | 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. |
---|
| 81 | .sp |
---|
| 82 | Before the error value is returned, the current MPI error handler is |
---|
| 83 | 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. |
---|
| 84 | |
---|
| 85 | .SH SEE ALSO |
---|
| 86 | .ft R |
---|
| 87 | .sp |
---|
| 88 | MPI_Type_create_hvector |
---|
| 89 | .br |
---|
| 90 | MPI_Type_vector |
---|
| 91 | .br |
---|
| 92 | |
---|