1 | .\"Copyright 2006-2008 Sun Microsystems, Inc. |
---|
2 | .\" Copyright (c) 1996 Thinking Machines Corporation |
---|
3 | .TH MPI_Type_commit 3 "Dec 08, 2009" "1.4" "Open MPI" |
---|
4 | .SH NAME |
---|
5 | \fBMPI_Type_commit\fP \- Commits a data type. |
---|
6 | |
---|
7 | .SH SYNTAX |
---|
8 | .ft R |
---|
9 | .SH C Syntax |
---|
10 | .nf |
---|
11 | #include <mpi.h> |
---|
12 | int MPI_Type_commit(MPI_Datatype *\fIdatatype\fP) |
---|
13 | |
---|
14 | .SH Fortran Syntax |
---|
15 | .nf |
---|
16 | INCLUDE 'mpif.h' |
---|
17 | MPI_TYPE_COMMIT(\fIDATATYPE, IERROR\fP) |
---|
18 | INTEGER \fIDATATYPE, IERROR\fP |
---|
19 | |
---|
20 | .SH C++ Syntax |
---|
21 | .nf |
---|
22 | #include <mpi.h> |
---|
23 | void Datatype::Commit() |
---|
24 | |
---|
25 | .SH INPUT PARAMETER |
---|
26 | .ft R |
---|
27 | .TP 1i |
---|
28 | datatype |
---|
29 | Data type (handle). |
---|
30 | |
---|
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 | The commit operation commits the data type. A data type is the formal description of a communication buffer, not the content of that buffer. After a data type has been committed, it can be repeatedly reused to communicate the changing content of a buffer or, indeed, the content of different buffers, with different starting addresses. |
---|
40 | .sp |
---|
41 | \fBExample:\fP The following Fortran code fragment gives examples of using MPI_Type_commit. |
---|
42 | .sp |
---|
43 | .nf |
---|
44 | INTEGER type1, type2 |
---|
45 | CALL MPI_TYPE_CONTIGUOUS(5, MPI_REAL, type1, ierr) |
---|
46 | ! new type object created |
---|
47 | CALL MPI_TYPE_COMMIT(type1, ierr) |
---|
48 | ! now type1 can be used for communication |
---|
49 | .fi |
---|
50 | .sp |
---|
51 | If the data type specified in \fIdatatype\fP is already committed, it is equivalent to a no-op. |
---|
52 | |
---|
53 | .SH ERRORS |
---|
54 | 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. |
---|
55 | .sp |
---|
56 | Before the error value is returned, the current MPI error handler is |
---|
57 | 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. |
---|
58 | |
---|