Line | |
---|
1 | .\"Copyright 2006-2008 Sun Microsystems, Inc. |
---|
2 | .\" Copyright (c) 1996 Thinking Machines Corporation |
---|
3 | .TH MPI_Type_free 3 "Dec 08, 2009" "1.4" "Open MPI" |
---|
4 | .SH NAME |
---|
5 | \fBMPI_Type_free\fP \- Frees a data type. |
---|
6 | |
---|
7 | .SH SYNTAX |
---|
8 | .ft R |
---|
9 | .SH C Syntax |
---|
10 | .nf |
---|
11 | #include <mpi.h> |
---|
12 | int MPI_Type_free(MPI_Datatype *\fIdatatype\fP) |
---|
13 | |
---|
14 | .SH Fortran Syntax |
---|
15 | .nf |
---|
16 | INCLUDE 'mpif.h' |
---|
17 | MPI_TYPE_FREE(\fIDATATYPE, IERROR\fP) |
---|
18 | INTEGER \fIDATATYPE, IERROR\fP |
---|
19 | |
---|
20 | .SH C++ Syntax |
---|
21 | .nf |
---|
22 | #include <mpi.h> |
---|
23 | void Datatype::Free() |
---|
24 | |
---|
25 | .SH INPUT/OUTPUT PARAMETER |
---|
26 | .ft R |
---|
27 | .TP 1i |
---|
28 | datatype |
---|
29 | Datatype that is freed (handle). |
---|
30 | .sp |
---|
31 | .SH OUTPUT PARAMETER |
---|
32 | .ft R |
---|
33 | .TP 1i |
---|
34 | IERROR |
---|
35 | Fortran only: Error status (integer). |
---|
36 | |
---|
37 | .SH DESCRIPTION |
---|
38 | .ft R |
---|
39 | Marks the datatype object associated with datatype for de-allocation and sets datatype to MPI_DATATYPE_NULL. Any communication that is currently using this datatype will complete normally. Derived datatypes that were defined from the freed datatype are not affected. |
---|
40 | .sp |
---|
41 | Freeing a datatype does not affect any other datatype that was built from the freed datatype. The system behaves as if input datatype arguments to derived datatype constructors are passed by value. |
---|
42 | |
---|
43 | .SH ERRORS |
---|
44 | 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. |
---|
45 | .sp |
---|
46 | Before the error value is returned, the current MPI error handler is |
---|
47 | 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. |
---|
48 | |
---|
49 | |
---|
50 | |
---|
Note: See
TracBrowser
for help on using the repository browser.