MPI_Type_get_contents(3)

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

NAME

6       MPI_Type_get_contents -  Get datatype contents
7

SYNOPSIS

9       #include <mpi.h>
10       int
11       MPI_Type_get_contents(MPI_Datatype type, int nints, int naddrs,
12                            int ndtypes, int *ints, MPI_Aint *addrs,
13                            MPI_Datatype *dtypes)
14

INPUT PARAMETER

16       type   - Datatype to access
17       nints  - Number of elements in ints
18       naddrs - Number of elments in addrs
19       ndtypes
20              - Number of elements in dtypes
21
22

OUTPUT PARAMETERS

24       ints   - Contains integer arguments used in constructing datatype
25       addrs  - Contains address arguments used in constructing datatype
26       dtypes - Contains datatype arguments used in constructing datatype
27
28

NOTES FOR FORTRAN

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

ERRORS

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

MORE INFORMATION

78       For more information, please see the official MPI Forum web site, which
79       contains  the  text of both the MPI-1 and MPI-2 standards.  These docu‐
80       ments contain detailed information about each  MPI  function  (most  of
81       which is not duplicated in these man pages).
82
83       http://www.mpi-forum.org/
84

LOCATION

86       tgetconts.c
87
88
89
90LAM/MPI 7.1.2                      2/23/2006          MPI_Type_get_contents(3)