1 | .\"Copyright 2006-2008 Sun Microsystems, Inc. |
---|
2 | .\" Copyright (c) 1996 Thinking Machines Corporation |
---|
3 | .TH MPI_Get_elements 3 "Dec 08, 2009" "1.4" "Open MPI" |
---|
4 | .SH NAME |
---|
5 | \fBMPI_Get_elements \fP \- Returns the number of basic elements in a data type. |
---|
6 | |
---|
7 | .SH SYNTAX |
---|
8 | .ft R |
---|
9 | .SH C Syntax |
---|
10 | .nf |
---|
11 | #include <mpi.h> |
---|
12 | int MPI_Get_elements(MPI_Status *\fIstatus\fP, MPI_Datatype\fI datatype\fP, |
---|
13 | int\fI *count\fP) |
---|
14 | |
---|
15 | .SH Fortran Syntax |
---|
16 | .nf |
---|
17 | INCLUDE 'mpif.h' |
---|
18 | MPI_GET_ELEMENTS(\fISTATUS, DATATYPE, COUNT, IERROR\fP) |
---|
19 | INTEGER \fISTATUS(MPI_STATUS_SIZE), DATATYPE, COUNT, IERROR\fP |
---|
20 | |
---|
21 | .SH C++ Syntax |
---|
22 | .nf |
---|
23 | #include <mpi.h> |
---|
24 | int Status::Get_elements(const Datatype& \fIdatatype\fP) const |
---|
25 | |
---|
26 | .SH INPUT PARAMETERS |
---|
27 | .ft R |
---|
28 | .TP 1i |
---|
29 | status |
---|
30 | Return status of receive operation (status). |
---|
31 | .TP 1i |
---|
32 | datatype |
---|
33 | Datatype used by receive operation (handle). |
---|
34 | |
---|
35 | .SH OUTPUT PARAMETERS |
---|
36 | .ft R |
---|
37 | count Number of received basic elements (integer). |
---|
38 | .ft R |
---|
39 | .TP 1i |
---|
40 | IERROR |
---|
41 | Fortran only: Error status (integer). |
---|
42 | |
---|
43 | .SH DESCRIPTION |
---|
44 | .ft R |
---|
45 | MPI_Get_elements behaves different from MPI_Get_count, which returns the number of "top-level entries" received, i.e., the number of "copies" of type datatype. MPI_Get_count may return any integer value k, where 0 =< k =< count. If MPI_Get_count returns k, then the number of basic elements received (and the value returned by MPI_Get_elements) is n * k, where n is the number of basic elements in the type map of datatype. If the number of basic elements received is not a multiple of n, that is, if the receive operation has not received an integral number of datatype "copies," then MPI_Get_count returns the value MPI_UNDEFINED. |
---|
46 | .sp |
---|
47 | \fBExample:\fP Usage of MPI_Get_count and MPI_Get_element: |
---|
48 | .sp |
---|
49 | .nf |
---|
50 | \&... |
---|
51 | CALL MPI_TYPE_CONTIGUOUS(2, MPI_REAL, Type2, ierr) |
---|
52 | CALL MPI_TYPE_COMMIT(Type2, ierr) |
---|
53 | \&... |
---|
54 | CALL MPI_COMM_RANK(comm, rank, ierr) |
---|
55 | IF(rank.EQ.0) THEN |
---|
56 | CALL MPI_SEND(a, 2, MPI_REAL, 1, 0, comm, ierr) |
---|
57 | CALL MPI_SEND(a, 3, MPI_REAL, 1, 0, comm, ierr) |
---|
58 | ELSE |
---|
59 | CALL MPI_RECV(a, 2, Type2, 0, 0, comm, stat, ierr) |
---|
60 | CALL MPI_GET_COUNT(stat, Type2, i, ierr) ! returns i=1 |
---|
61 | CALL MPI_GET_ELEMENTS(stat, Type2, i, ierr) ! returns i=2 |
---|
62 | CALL MPI_RECV(a, 2, Type2, 0, 0, comm, stat, ierr) |
---|
63 | CALL MPI_GET_COUNT(stat, Type2, i, ierr) ! returns i=MPI_UNDEFINED |
---|
64 | CALL MPI_GET_ELEMENTS(stat, Type2, i, ierr) ! returns i=3 |
---|
65 | END IF |
---|
66 | .fi |
---|
67 | .sp |
---|
68 | The function MPI_Get_elements can also be used after a probe to find the number of elements in the probed message. Note that the two functions MPI_Get_count and MPI_Get_elements return the same values when they are used with primitive data types. |
---|
69 | |
---|
70 | .SH ERRORS |
---|
71 | 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. |
---|
72 | .sp |
---|
73 | Before the error value is returned, the current MPI error handler is |
---|
74 | 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. |
---|
75 | |
---|
76 | .SH SEE ALSO |
---|
77 | .ft R |
---|
78 | .sp |
---|
79 | MPI_Get_count |
---|
80 | |
---|