1MPI_Type_create_hindexed(3)         LAM/MPI        MPI_Type_create_hindexed(3)
2
3
4

NAME

6       MPI_Type_create_hindexed -  Create extended hindexed derived datatype
7

SYNOPSIS

9       #include <mpi.h>
10       int
11       MPI_Type_create_hindexed(int count, int *lengths, MPI_Aint *disps,
12                              MPI_Datatype oldtype, MPI_Datatype *newtype)
13

INPUT PARAMETERS

15       count  - Number of blocks
16       lengths
17              -  Number  of elements in each block (array of nonnegative inte‐
18              gers)
19       displacements
20              - Byte displacement of each block (array of integer)
21       oldtype
22              - Old datatype (handle)
23
24

OUTPUT PARAMETER

26       newtype
27              - New datatype (handle)
28
29

NOTES FOR FORTRAN

31       All MPI routines in Fortran (except for MPI_WTIME and MPI_WTICK )  have
32       an  additional  argument ierr at the end of the argument list.  ierr is
33       an integer and has the same meaning as the return value of the  routine
34       in  C.   In Fortran, MPI routines are subroutines, and are invoked with
35       the call statement.
36
37       All MPI objects (e.g., MPI_Datatype , MPI_Comm ) are of type INTEGER in
38       Fortran.
39
40

ERRORS

42       If an error occurs in an MPI function, the current MPI error handler is
43       called to handle it.  By default, this error  handler  aborts  the  MPI
44       job.   The  error  handler may be changed with MPI_Errhandler_set ; the
45       predefined error handler MPI_ERRORS_RETURN may be used to  cause  error
46       values  to  be  returned  (in C and Fortran; this error handler is less
47       useful in with the C++ MPI  bindings.   The  predefined  error  handler
48       MPI::ERRORS_THROW_EXCEPTIONS  should  be used in C++ if the error value
49       needs to be recovered).  Note that MPI does not guarantee that  an  MPI
50       program can continue past an error.
51
52       All  MPI  routines  (except  MPI_Wtime  and MPI_Wtick ) return an error
53       value; C routines as the value of the function and Fortran routines  in
54       the  last  argument.  The C++ bindings for MPI do not return error val‐
55       ues; instead, error values are communicated by throwing  exceptions  of
56       type  MPI::Exception  (but not by default).  Exceptions are only thrown
57       if the error value is not MPI::SUCCESS .
58
59
60       Note that if the MPI::ERRORS_RETURN handler is set in  C++,  while  MPI
61       functions  will  return  upon an error, there will be no way to recover
62       what the actual error value was.
63       MPI_SUCCESS
64              - No error; MPI routine completed successfully.
65       MPI_ERR_TYPE
66              - Invalid datatype argument.  May be an uncommitted MPI_Datatype
67              (see MPI_Type_commit ).
68       MPI_ERR_COUNT
69              - Invalid count argument.  Count arguments must be non-negative;
70              a count of zero is often valid.
71       MPI_ERR_ARG
72              - Invalid argument.  Some argument is invalid and is not identi‐
73              fied  by  a  specific  error  class.   This  is typically a NULL
74              pointer or other such error.
75       MPI_ERR_OTHER
76              - Other error; use  MPI_Error_string  to  get  more  information
77              about this error code.
78
79

SEE ALSO

81       MPI_Type_create_hvector(3),                  MPI_Type_create_struct(3),
82       MPI_Get_address(3)
83
84

MORE INFORMATION

86       For more information, please see the official MPI Forum web site, which
87       contains  the  text of both the MPI-1 and MPI-2 standards.  These docu‐
88       ments contain detailed information about each  MPI  function  (most  of
89       which is not duplicated in these man pages).
90
91       http://www.mpi-forum.org/
92

LOCATION

94       tcreatehindex.c
95
96
97
98LAM/MPI 7.1.2                      2/23/2006       MPI_Type_create_hindexed(3)
Impressum