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

NAME

6       MPI_Type_free -  Frees the datatype
7

SYNOPSIS

9       #include <mpi.h>
10       int MPI_Type_free(MPI_Datatype *dtype)
11

INPUT/OUTPUT PARAMETER

13       dtype  - datatype that is freed (handle)
14
15

PREDEFINED TYPES

17       The MPI standard states that (in Opaque Objects)
18
19       MPI provides certain predefined opaque objects and predefined, static
20       handles to these objects. Such objects may not be destroyed.
21
22
23       Thus,  it  is an error to free a predefined datatype.  The same section
24       makes it clear that it is an error to free a null datatype.
25
26       Upon successful completion, dtype is set to MPI_DATATYPE_NULL .
27
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_ARG
69              - Invalid argument.  Some argument is invalid and is not identi‐
70              fied by a specific  error  class.   This  is  typically  a  NULL
71              pointer or other such error.
72
73

MORE INFORMATION

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

ACKNOWLEDGEMENTS

85       The LAM Team would like the thank the MPICH Team for the handy  program
86       to  generate  man  pages ("doctext" from ftp://ftp.mcs.anl.gov/pub/sow‐
87       ing/sowing.tar.gz ), the initial formatting, and some initial text  for
88       most of the MPI-1 man pages.
89

LOCATION

91       tfree.c
92
93
94
95LAM/MPI 7.1.2                      2/23/2006                  MPI_Type_free(3)