1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149
|
.TH MPI_Allgatherv 3 "2/18/1997" " " "MPI"
.SH NAME
MPI_Allgatherv \- Gathers data from all tasks and deliver it to all
.SH SYNOPSIS
.nf
#include "mpi.h"
int MPI_Allgatherv ( sendbuf, sendcount, sendtype,
recvbuf, recvcounts, displs, recvtype, comm )
void *sendbuf;
int sendcount;
MPI_Datatype sendtype;
void *recvbuf;
int *recvcounts;
int *displs;
MPI_Datatype recvtype;
MPI_Comm comm;
.fi
.SH INPUT PARAMETERS
.PD 0
.TP
.B sendbuf
- starting address of send buffer (choice)
.PD 1
.PD 0
.TP
.B sendcount
- number of elements in send buffer (integer)
.PD 1
.PD 0
.TP
.B sendtype
- data type of send buffer elements (handle)
.PD 1
.PD 0
.TP
.B recvcounts
- integer array (of length group size)
containing the number of elements that are received from each process
.PD 1
.PD 0
.TP
.B displs
- integer array (of length group size). Entry
.I i
specifies the displacement (relative to recvbuf ) at
which to place the incoming data from process
.I i
.PD 1
.PD 0
.TP
.B recvtype
- data type of receive buffer elements (handle)
.PD 1
.PD 0
.TP
.B comm
- communicator (handle)
.PD 1
.SH OUTPUT PARAMETER
.PD 0
.TP
.B recvbuf
- address of receive buffer (choice)
.PD 1
.SH NOTES
The MPI standard (1.0 and 1.1) says that
The jth block of data sent from
each proess is received by every process and placed in the jth block of the
buffer
.I recvbuf
.
This is misleading; a better description is
The block of data sent from the jth process is received by every
process and placed in the jth block of the buffer
.I recvbuf
.
This text was suggested by Rajeev Thakur.
.SH NOTES FOR FORTRAN
All MPI routines in Fortran (except for
.I MPI_WTIME
and
.I MPI_WTICK
) have
an additional argument
.I ierr
at the end of the argument list.
.I ierr
is an integer and has the same meaning as the return value of the routine
in C. In Fortran, MPI routines are subroutines, and are invoked with the
.I call
statement.
All MPI objects (e.g.,
.I MPI_Datatype
,
.I MPI_Comm
) are of type
.I INTEGER
in Fortran.
.SH ERRORS
All MPI routines (except
.I MPI_Wtime
and
.I MPI_Wtick
) return an error value;
C routines as the value of the function and Fortran routines in the last
argument. Before the value is returned, the current MPI error handler is
called. By default, this error handler aborts the MPI job. The error handler
may be changed with
.I MPI_Errhandler_set
; the predefined error handler
.I MPI_ERRORS_RETURN
may be used to cause error values to be returned.
Note that MPI does
.B not
guarentee that an MPI program can continue past
an error.
.PD 0
.TP
.B MPI_ERR_BUFFER
- Invalid buffer pointer. Usually a null buffer where
one is not valid.
.PD 1
.PD 0
.TP
.B MPI_ERR_COUNT
- Invalid count argument. Count arguments must be
non-negative; a count of zero is often valid.
.PD 1
.PD 0
.TP
.B MPI_ERR_TYPE
- Invalid datatype argument. May be an uncommitted
.PD 1
MPI_Datatype (see
.I MPI_Type_commit
).
.SH LOCATION
allgatherv.c
|