Skip to content

Commit b32e754

Browse files
committed
Persistent Collectives rename: man pages updates
1 parent fb1eef4 commit b32e754

File tree

66 files changed

+578
-607
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

66 files changed

+578
-607
lines changed

ompi/mpi/man/man3/MPI_Allgather.3in

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
.\" $COPYRIGHT$
88
.TH MPI_Allgather 3 "#OMPI_DATE#" "#PACKAGE_VERSION#" "#PACKAGE_NAME#"
99
.SH NAME
10-
\fBMPI_Allgather, MPI_Iallgather\fP \- Gathers data from all processes and distributes it to all processes
10+
\fBMPI_Allgather, MPI_Iallgather, MPI_Allgather_init\fP \- Gathers data from all processes and distributes it to all processes
1111

1212
.SH SYNTAX
1313
.ft R
@@ -22,6 +22,10 @@ int MPI_Iallgather(const void\fI *sendbuf\fP, int \fI sendcount\fP,
2222
MPI_Datatype\fI sendtype\fP, void\fI *recvbuf\fP, int\fI recvcount\fP,
2323
MPI_Datatype\fI recvtype\fP, MPI_Comm\fI comm\fP, MPI_Request \fI*request\fP)
2424

25+
int MPI_Allgather_init(const void\fI *sendbuf\fP, int \fI sendcount\fP,
26+
MPI_Datatype\fI sendtype\fP, void\fI *recvbuf\fP, int\fI recvcount\fP,
27+
MPI_Datatype\fI recvtype\fP, MPI_Comm\fI comm\fP, MPI_Info\fI info\fP, MPI_Request \fI*request\fP)
28+
2529
.fi
2630
.SH Fortran Syntax
2731
.nf
@@ -39,6 +43,12 @@ MPI_IALLGATHER(\fISENDBUF, SENDCOUNT, SENDTYPE, RECVBUF, RECVCOUNT,
3943
INTEGER \fISENDCOUNT, SENDTYPE, RECVCOUNT, RECVTYPE, COMM\fP
4044
INTEGER \fIREQUEST, IERROR\fP
4145

46+
MPI_ALLGATHER_INIT(\fISENDBUF, SENDCOUNT, SENDTYPE, RECVBUF, RECVCOUNT,
47+
RECVTYPE, COMM, INFO, REQUEST, IERROR\fP)
48+
<type> \fISENDBUF\fP(*)\fI, RECVBUF\fP (*)
49+
INTEGER \fISENDCOUNT, SENDTYPE, RECVCOUNT, RECVTYPE, COMM\fP
50+
INTEGER \fIINFO, REQUEST, IERROR\fP
51+
4252
.fi
4353
.SH Fortran 2008 Syntax
4454
.nf
@@ -62,6 +72,16 @@ MPI_Iallgather(\fIsendbuf\fP, \fIsendcount\fP, \fIsendtype\fP, \fIrecvbuf\fP, \f
6272
TYPE(MPI_Request), INTENT(OUT) :: \fIrequest\fP
6373
INTEGER, OPTIONAL, INTENT(OUT) :: \fIierror\fP
6474

75+
MPI_Allgather_init(\fIsendbuf\fP, \fIsendcount\fP, \fIsendtype\fP, \fIrecvbuf\fP, \fIrecvcount\fP, \fIrecvtype\fP,
76+
\fIcomm\fP, \fIinfo\fP, \fIrequest\fP, \fIierror\fP)
77+
TYPE(*), DIMENSION(..), INTENT(IN), ASYNCHRONOUS :: \fIsendbuf\fP
78+
TYPE(*), DIMENSION(..), ASYNCHRONOUS :: \fIrecvbuf\fP
79+
INTEGER, INTENT(IN) :: \fIsendcount\fP, \fIrecvcount\fP
80+
TYPE(MPI_Datatype), INTENT(IN) :: \fIsendtype\fP, \fIrecvtype\fP
81+
TYPE(MPI_Comm), INTENT(IN) :: \fIcomm\fP
82+
TYPE(MPI_Info), INTENT(IN) :: \fIinfo\fP
83+
TYPE(MPI_Request), INTENT(OUT) :: \fIrequest\fP
84+
INTEGER, OPTIONAL, INTENT(OUT) :: \fIierror\fP
6585
.fi
6686
.SH INPUT PARAMETERS
6787
.ft R
@@ -86,6 +106,9 @@ Datatype of receive buffer elements (handle).
86106
.TP 1i
87107
comm
88108
Communicator (handle).
109+
.TP 1i
110+
info
111+
Info (handle, persistent only).
89112

90113
.SH OUTPUT PARAMETERS
91114
.ft R
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.so man3/MPI_Allgather.3

ompi/mpi/man/man3/MPI_Allgatherv.3in

Lines changed: 29 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
.\" $COPYRIGHT$
88
.TH MPI_Allgatherv 3 "#OMPI_DATE#" "#PACKAGE_VERSION#" "#PACKAGE_NAME#"
99
.SH NAME
10-
\fBMPI_Allgatherv, MPI_Iallgatherv\fP \- Gathers data from all processes and delivers it to all. Each process may contribute a different amount of data.
10+
\fBMPI_Allgatherv, MPI_Iallgatherv, MPI_Allgatherv_init\fP \- Gathers data from all processes and delivers it to all. Each process may contribute a different amount of data.
1111

1212
.SH SYNTAX
1313
.ft R
@@ -23,6 +23,11 @@ int MPI_Iallgatherv(const void\fI *sendbuf\fP, int\fI sendcount\fP,
2323
const int\fI displs[]\fP, MPI_Datatype\fI recvtype\fP, MPI_Comm\fI comm\fP,
2424
MPI_Request \fI*request\fP)
2525

26+
int MPI_Allgatherv_init(const void\fI *sendbuf\fP, int\fI sendcount\fP,
27+
MPI_Datatype\fI sendtype\fP, void\fI *recvbuf\fP, const int\fI recvcounts[]\fP,
28+
const int\fI displs[]\fP, MPI_Datatype\fI recvtype\fP, MPI_Comm\fI comm\fP,
29+
MPI_Info\fI info\fP, MPI_Request \fI*request\fP)
30+
2631
.fi
2732
.SH Fortran Syntax
2833
.nf
@@ -34,12 +39,18 @@ MPI_ALLGATHERV(\fISENDBUF\fP,\fI SENDCOUNT\fP, \fISENDTYPE\fP,\fI RECVBUF\fP,
3439
INTEGER \fISENDCOUNT\fP,\fI SENDTYPE\fP, \fIRECVCOUNT\fP(*)
3540
INTEGER \fIDISPLS\fP(*),\fI RECVTYPE\fP,\fI COMM\fP,\fI IERROR\fP
3641

37-
MPI_IALLGATHERV(\fISENDBUF, SENDCOUNT, SENDTYPE, RECVBUF,
38-
RECVCOUNT, DISPLS, RECVTYPE, COMM, REQUEST, IERROR\fP)
42+
MPI_IALLGATHERV(\fISENDBUF\fP,\fI SENDCOUNT\fP, \fISENDTYPE\fP,\fI RECVBUF\fP,
43+
\fIRECVCOUNT\fP,\fI DISPLS\fP, \fIRECVTYPE\fP,\fI COMM\fP, \fI REQUEST\fP, \fI IERROR\fP)
3944
<type> \fISENDBUF\fP(*)\fI, RECVBUF\fP(*)
4045
INTEGER \fISENDCOUNT, SENDTYPE, RECVCOUNT\fP(*),
4146
INTEGER \fIDISPLS\fP(*)\fI, RECVTYPE, COMM, REQUEST, IERROR\fP
4247

48+
MPI_ALLGATHERV_INIT(\fISENDBUF\fP,\fI SENDCOUNT\fP, \fISENDTYPE\fP,\fI RECVBUF\fP,
49+
\fIRECVCOUNT\fP,\fI DISPLS\fP, \fIRECVTYPE\fP,\fI COMM\fP, \fI INFO\fP, \fI REQUEST\fP, \fI IERROR\fP)
50+
<type> \fISENDBUF\fP(*)\fI, RECVBUF\fP(*)
51+
INTEGER \fISENDCOUNT, SENDTYPE, RECVCOUNT\fP(*),
52+
INTEGER \fIDISPLS\fP(*)\fI, RECVTYPE, COMM, INFO, REQUEST, IERROR\fP
53+
4354
.fi
4455
.SH Fortran 2008 Syntax
4556
.nf
@@ -64,6 +75,18 @@ MPI_Iallgatherv(\fIsendbuf\fP, \fIsendcount\fP, \fIsendtype\fP, \fIrecvbuf\fP, \
6475
TYPE(MPI_Request), INTENT(OUT) :: \fIrequest\fP
6576
INTEGER, OPTIONAL, INTENT(OUT) :: \fIierror\fP
6677

78+
MPI_Allgatherv_init(\fIsendbuf\fP, \fIsendcount\fP, \fIsendtype\fP, \fIrecvbuf\fP, \fIrecvcounts\fP, \fIdispls\fP,
79+
\fIrecvtype\fP, \fIcomm\fP, \fIinfo\fP, \fIrequest\fP, \fIierror\fP)
80+
TYPE(*), DIMENSION(..), INTENT(IN), ASYNCHRONOUS :: \fIsendbuf\fP
81+
TYPE(*), DIMENSION(..), ASYNCHRONOUS :: \fIrecvbuf\fP
82+
INTEGER, INTENT(IN) :: \fIsendcount\fP
83+
INTEGER, INTENT(IN), ASYNCHRONOUS :: \fIrecvcounts(*)\fP, \fIdispls(*)\fP
84+
TYPE(MPI_Datatype), INTENT(IN) :: \fIsendtype\fP, \fIrecvtype\fP
85+
TYPE(MPI_Comm), INTENT(IN) :: \fIcomm\fP
86+
TYPE(MPI_Info), INTENT(IN) :: \fIinfo\fP
87+
TYPE(MPI_Request), INTENT(OUT) :: \fIrequest\fP
88+
INTEGER, OPTIONAL, INTENT(OUT) :: \fIierror\fP
89+
6790
.fi
6891
.SH INPUT PARAMETERS
6992
.ft R
@@ -88,6 +111,9 @@ Datatype of receive buffer elements (handle).
88111
.TP 1i
89112
comm
90113
Communicator (handle).
114+
.TP 1i
115+
info
116+
Info (handle, persistent only).
91117
.sp
92118
.SH OUTPUT PARAMETERS
93119
.ft R
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.so man3/MPI_Allgatherv.3

ompi/mpi/man/man3/MPI_Allreduce.3in

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
.\" $COPYRIGHT$
88
.TH MPI_Allreduce 3 "#OMPI_DATE#" "#PACKAGE_VERSION#" "#PACKAGE_NAME#"
99
.SH NAME
10-
\fBMPI_Allreduce, MPI_Iallreduce\fP \- Combines values from all processes and distributes the result back to all processes.
10+
\fBMPI_Allreduce, MPI_Iallreduce, MPI_Allreduce_init\fP \- Combines values from all processes and distributes the result back to all processes.
1111

1212
.SH SYNTAX
1313
.ft R
@@ -21,6 +21,10 @@ int MPI_Iallreduce(const void \fI*sendbuf\fP, void \fI*recvbuf\fP, int\fI count\
2121
MPI_Datatype\fI datatype\fP, MPI_Op\fI op\fP, MPI_Comm\fI comm\fP,
2222
MPI_Request \fI*request\fP)
2323

24+
int MPI_Allreduce_init(const void \fI*sendbuf\fP, void \fI*recvbuf\fP, int\fI count\fP,
25+
MPI_Datatype\fI datatype\fP, MPI_Op\fI op\fP, MPI_Comm\fI comm\fP,
26+
MPI_Info \fIinfo\fP, MPI_Request \fI*request\fP)
27+
2428
.fi
2529
.SH Fortran Syntax
2630
.nf
@@ -34,6 +38,10 @@ MPI_IALLREDUCE(\fISENDBUF, RECVBUF, COUNT, DATATYPE, OP, COMM, REQUEST, IERROR\f
3438
<type> \fISENDBUF\fP(*)\fI, RECVBUF\fP(*)
3539
INTEGER \fICOUNT, DATATYPE, OP, COMM, REQUEST, IERROR\fP
3640

41+
MPI_ALLREDUCE_INIT(\fISENDBUF, RECVBUF, COUNT, DATATYPE, OP, COMM, INFO, REQUEST, IERROR\fP)
42+
<type> \fISENDBUF\fP(*)\fI, RECVBUF\fP(*)
43+
INTEGER \fICOUNT, DATATYPE, OP, COMM, INFO, REQUEST, IERROR\fP
44+
3745
.fi
3846
.SH Fortran 2008 Syntax
3947
.nf
@@ -58,6 +66,18 @@ MPI_Iallreduce(\fIsendbuf\fP, \fIrecvbuf\fP, \fIcount\fP, \fIdatatype\fP, \fIop\
5866
TYPE(MPI_Request), INTENT(OUT) :: \fIrequest\fP
5967
INTEGER, OPTIONAL, INTENT(OUT) :: \fIierror\fP
6068

69+
MPI_Allreduce_init(\fIsendbuf\fP, \fIrecvbuf\fP, \fIcount\fP, \fIdatatype\fP, \fIop\fP, \fIcomm\fP, \fIinfo\fP, \fIrequest\fP,
70+
\fIierror\fP)
71+
TYPE(*), DIMENSION(..), INTENT(IN), ASYNCHRONOUS :: \fIsendbuf\fP
72+
TYPE(*), DIMENSION(..), ASYNCHRONOUS :: \fIrecvbuf\fP
73+
INTEGER, INTENT(IN) :: \fIcount\fP
74+
TYPE(MPI_Datatype), INTENT(IN) :: \fIdatatype\fP
75+
TYPE(MPI_Op), INTENT(IN) :: \fIop\fP
76+
TYPE(MPI_Comm), INTENT(IN) :: \fIcomm\fP
77+
TYPE(MPI_Info), INTENT(IN) :: \fIinfo\fP
78+
TYPE(MPI_Request), INTENT(OUT) :: \fIrequest\fP
79+
INTEGER, OPTIONAL, INTENT(OUT) :: \fIierror\fP
80+
6181
.fi
6282
.SH INPUT PARAMETERS
6383
.ft R
@@ -76,6 +96,9 @@ Operation (handle).
7696
.TP 1i
7797
comm
7898
Communicator (handle).
99+
.TP 1i
100+
info
101+
Info (handle, persistent only).
79102

80103
.SH OUTPUT PARAMETERS
81104
.ft R
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.so man3/MPI_Allreduce.3

ompi/mpi/man/man3/MPI_Alltoall.3in

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
.TH MPI_Alltoall 3 "#OMPI_DATE#" "#PACKAGE_VERSION#" "#PACKAGE_NAME#"
99

1010
.SH NAME
11-
\fBMPI_Alltoall, MPI_Ialltoall\fP \- All processes send data to all processes
11+
\fBMPI_Alltoall, MPI_Ialltoall, MPI_Alltoall_init\fP \- All processes send data to all processes
1212

1313
.SH SYNTAX
1414
.ft R
@@ -24,6 +24,10 @@ int MPI_Ialltoall(const void *\fIsendbuf\fP, int \fIsendcount\fP,
2424
MPI_Datatype \fIsendtype\fP, void *\fIrecvbuf\fP, int \fIrecvcount\fP,
2525
MPI_Datatype \fIrecvtype\fP, MPI_Comm \fIcomm\fP, MPI_Request \fI*request\fP)
2626

27+
int MPI_Alltoall_init(const void *\fIsendbuf\fP, int \fIsendcount\fP,
28+
MPI_Datatype \fIsendtype\fP, void *\fIrecvbuf\fP, int \fIrecvcount\fP,
29+
MPI_Datatype \fIrecvtype\fP, MPI_Comm \fIcomm\fP, MPI_Info \fIinfo\fP, MPI_Request \fI*request\fP)
30+
2731
.fi
2832
.SH Fortran Syntax
2933
.nf
@@ -43,6 +47,13 @@ MPI_IALLTOALL(\fISENDBUF, SENDCOUNT, SENDTYPE, RECVBUF, RECVCOUNT,
4347
INTEGER \fISENDCOUNT, SENDTYPE, RECVCOUNT, RECVTYPE\fP
4448
INTEGER \fICOMM, REQUEST, IERROR\fP
4549

50+
MPI_ALLTOALL_INIT(\fISENDBUF, SENDCOUNT, SENDTYPE, RECVBUF, RECVCOUNT,
51+
RECVTYPE, COMM, INFO, REQUEST, IERROR\fP)
52+
53+
<type> \fISENDBUF(*), RECVBUF(*)\fP
54+
INTEGER \fISENDCOUNT, SENDTYPE, RECVCOUNT, RECVTYPE\fP
55+
INTEGER \fICOMM, INFO, REQUEST, IERROR\fP
56+
4657
.fi
4758
.SH Fortran 2008 Syntax
4859
.nf
@@ -68,6 +79,18 @@ MPI_Ialltoall(\fIsendbuf\fP, \fIsendcount\fP, \fIsendtype\fP, \fIrecvbuf\fP, \fI
6879
TYPE(MPI_Request), INTENT(OUT) :: \fIrequest\fP
6980
INTEGER, OPTIONAL, INTENT(OUT) :: \fIierror\fP
7081

82+
MPI_Alltoall_init(\fIsendbuf\fP, \fIsendcount\fP, \fIsendtype\fP, \fIrecvbuf\fP, \fIrecvcount\fP, \fIrecvtype\fP,
83+
\fIcomm\fP, \fIinfo\fP, \fIrequest\fP, \fIierror\fP)
84+
85+
TYPE(*), DIMENSION(..), INTENT(IN), ASYNCHRONOUS :: \fIsendbuf\fP
86+
TYPE(*), DIMENSION(..), ASYNCHRONOUS :: \fIrecvbuf\fP
87+
INTEGER, INTENT(IN) :: \fIsendcount\fP, \fIrecvcount\fP
88+
TYPE(MPI_Datatype), INTENT(IN) :: \fIsendtype\fP, \fIrecvtype\fP
89+
TYPE(MPI_Comm), INTENT(IN) :: \fIcomm\fP
90+
TYPE(MPI_Info), INTENT(IN) :: \fIinfo\fP
91+
TYPE(MPI_Request), INTENT(OUT) :: \fIrequest\fP
92+
INTEGER, OPTIONAL, INTENT(OUT) :: \fIierror\fP
93+
7194
.fi
7295
.SH INPUT PARAMETERS
7396
.ft R
@@ -89,6 +112,9 @@ Datatype of receive buffer elements (handle).
89112
.TP 1.2i
90113
comm
91114
Communicator over which data is to be exchanged (handle).
115+
.TP 1.2i
116+
info
117+
Info (handle, persistent only)
92118

93119
.SH OUTPUT PARAMETERS
94120
.ft R
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.so man3/MPI_Alltoall.3

ompi/mpi/man/man3/MPI_Alltoallv.3in

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
.TH MPI_Alltoallv 3 "#OMPI_DATE#" "#PACKAGE_VERSION#" "#PACKAGE_NAME#"
99

1010
.SH NAME
11-
\fBMPI_Alltoallv, MPI_Ialltoallv\fP \- All processes send different amount of data to, and receive different amount of data from, all processes
11+
\fBMPI_Alltoallv, MPI_Ialltoallv, MPI_Alltoallv_init\fP \- All processes send different amount of data to, and receive different amount of data from, all processes
1212
.SH SYNTAX
1313
.ft R
1414

@@ -26,6 +26,12 @@ int MPI_Ialltoallv(const void *\fIsendbuf\fP, const int \fIsendcounts\fP[],
2626
const int \fIrdispls\fP[], MPI_Datatype \fIrecvtype\fP, MPI_Comm \fIcomm\fP,
2727
MPI_Request \fI*request\fP)
2828

29+
int MPI_Alltoallv_init(const void *\fIsendbuf\fP, const int \fIsendcounts\fP[],
30+
const int \fIsdispls\fP[], MPI_Datatype \fIsendtype\fP,
31+
void *\fIrecvbuf\fP, const int\fI recvcounts\fP[],
32+
const int \fIrdispls\fP[], MPI_Datatype \fIrecvtype\fP, MPI_Comm \fIcomm\fP,
33+
MPI_Info \fIinfo\fP, MPI_Request \fI*request\fP)
34+
2935
.fi
3036
.SH Fortran Syntax
3137
.nf
@@ -47,6 +53,14 @@ MPI_IALLTOALLV(\fISENDBUF, SENDCOUNTS, SDISPLS, SENDTYPE,
4753
INTEGER \fIRECVCOUNTS(*), RDISPLS(*), RECVTYPE\fP
4854
INTEGER \fICOMM, REQUEST, IERROR\fP
4955

56+
MPI_ALLTOALLV_INIT(\fISENDBUF, SENDCOUNTS, SDISPLS, SENDTYPE,
57+
RECVBUF, RECVCOUNTS, RDISPLS, RECVTYPE, COMM, INFO, REQUEST, IERROR\fP)
58+
59+
<type> \fISENDBUF(*), RECVBUF(*)\fP
60+
INTEGER \fISENDCOUNTS(*), SDISPLS(*), SENDTYPE\fP
61+
INTEGER \fIRECVCOUNTS(*), RDISPLS(*), RECVTYPE\fP
62+
INTEGER \fICOMM, INFO, REQUEST, IERROR\fP
63+
5064
.fi
5165
.SH Fortran 2008 Syntax
5266
.nf
@@ -74,6 +88,19 @@ MPI_Ialltoallv(\fIsendbuf\fP, \fIsendcounts\fP, \fIsdispls\fP, \fIsendtype\fP, \
7488
TYPE(MPI_Request), INTENT(OUT) :: \fIrequest\fP
7589
INTEGER, OPTIONAL, INTENT(OUT) :: \fIierror\fP
7690

91+
MPI_Alltoallv_init(\fIsendbuf\fP, \fIsendcounts\fP, \fIsdispls\fP, \fIsendtype\fP, \fIrecvbuf\fP, \fIrecvcounts\fP,
92+
\fIrdispls\fP, \fIrecvtype\fP, \fIcomm\fP, \fIinfo\fP, \fIrequest\fP, \fIierror\fP)
93+
94+
TYPE(*), DIMENSION(..), INTENT(IN), ASYNCHRONOUS :: \fIsendbuf\fP
95+
TYPE(*), DIMENSION(..), ASYNCHRONOUS :: \fIrecvbuf\fP
96+
INTEGER, INTENT(IN), ASYNCHRONOUS :: \fIsendcounts(*)\fP, \fIsdispls(*),\fP
97+
\fIrecvcounts(*)\fP, \fIrdispls(*)\fP
98+
TYPE(MPI_Datatype), INTENT(IN) :: \fIsendtype\fP, \fIrecvtype\fP
99+
TYPE(MPI_Comm), INTENT(IN) :: \fIcomm\fP
100+
TYPE(MPI_Info), INTENT(IN) :: \fIinfo\fP
101+
TYPE(MPI_Request), INTENT(OUT) :: \fIrequest\fP
102+
INTEGER, OPTIONAL, INTENT(OUT) :: \fIierror\fP
103+
77104
.fi
78105
.SH INPUT PARAMETERS
79106
.ft R
@@ -107,6 +134,9 @@ Datatype of receive buffer elements.
107134
.TP 1.2i
108135
comm
109136
Communicator over which data is to be exchanged.
137+
.TP 1.2i
138+
info
139+
Info (handle, persistent only)
110140

111141
.SH OUTPUT PARAMETERS
112142
.ft R
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.so man3/MPI_Alltoallv.3

ompi/mpi/man/man3/MPI_Alltoallw.3in

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
.TH MPI_Alltoallw 3 "#OMPI_DATE#" "#PACKAGE_VERSION#" "#PACKAGE_NAME#"
99

1010
.SH NAME
11-
\fBMPI_Alltoallw, MPI_Ialltoallw\fP \- All processes send data of different types to, and receive data of different types from, all processes
11+
\fBMPI_Alltoallw, MPI_Ialltoallw, MPI_Alltoallw_init\fP \- All processes send data of different types to, and receive data of different types from, all processes
1212

1313
.SH SYNTAX
1414
.ft R
@@ -27,6 +27,12 @@ int MPI_Ialltoallw(const void *\fIsendbuf\fP, const int \fIsendcounts\fP[],
2727
const MPI_Datatype \fIrecvtypes\fP[], MPI_Comm \fIcomm\fP,
2828
MPI_Request \fI*request\fP)
2929

30+
int MPI_Alltoallw_init(const void *\fIsendbuf\fP, const int \fIsendcounts\fP[],
31+
const int \fIsdispls\fP[], const MPI_Datatype \fIsendtypes\fP[],
32+
void *\fIrecvbuf\fP, const int \fIrecvcounts\fP[], const int \fIrdispls\fP[],
33+
const MPI_Datatype \fIrecvtypes\fP[], MPI_Comm \fIcomm\fP, MPI_Info \fIinfo\fP,
34+
MPI_Request \fI*request\fP)
35+
3036
.fi
3137
.SH Fortran Syntax
3238
.nf
@@ -48,6 +54,14 @@ MPI_IALLTOALLW(\fISENDBUF, SENDCOUNTS, SDISPLS, SENDTYPES,
4854
INTEGER \fIRECVCOUNTS(*), RDISPLS(*), RECVTYPES(*)\fP
4955
INTEGER \fICOMM, REQUEST, IERROR\fP
5056

57+
MPI_ALLTOALLW_INIT(\fISENDBUF, SENDCOUNTS, SDISPLS, SENDTYPES,
58+
RECVBUF, RECVCOUNTS, RDISPLS, RECVTYPES, COMM, INFO, REQUEST, IERROR\fP)
59+
60+
<type> \fISENDBUF(*), RECVBUF(*)\fP
61+
INTEGER \fISENDCOUNTS(*), SDISPLS(*), SENDTYPES(*)\fP
62+
INTEGER \fIRECVCOUNTS(*), RDISPLS(*), RECVTYPES(*)\fP
63+
INTEGER \fICOMM, INFO, REQUEST, IERROR\fP
64+
5165
.fi
5266
.SH Fortran 2008 Syntax
5367
.nf
@@ -77,6 +91,20 @@ MPI_Ialltoallw(\fIsendbuf\fP, \fIsendcounts\fP, \fIsdispls\fP, \fIsendtypes\fP,
7791
TYPE(MPI_Request), INTENT(OUT) :: \fIrequest\fP
7892
INTEGER, OPTIONAL, INTENT(OUT) :: \fIierror\fP
7993

94+
MPI_Alltoallw_init(\fIsendbuf\fP, \fIsendcounts\fP, \fIsdispls\fP, \fIsendtypes\fP, \fIrecvbuf\fP,
95+
\fIrecvcounts\fP, \fIrdispls\fP, \fIrecvtypes\fP, \fIcomm\fP, fIinfo\fP, \fIrequest\fP, \fIierror\fP)
96+
97+
TYPE(*), DIMENSION(..), INTENT(IN), ASYNCHRONOUS :: \fIsendbuf\fP
98+
TYPE(*), DIMENSION(..), ASYNCHRONOUS :: \fIrecvbuf\fP
99+
INTEGER, INTENT(IN), ASYNCHRONOUS :: \fIsendcounts(*)\fP, \fIsdispls(*),\fP
100+
\fIrecvcounts(*)\fP, \fIrdispls(*)\fP
101+
TYPE(MPI_Datatype), INTENT(IN), ASYNCHRONOUS :: \fIsendtypes(*),\fP
102+
\fIrecvtypes(*)\fP
103+
TYPE(MPI_Comm), INTENT(IN) :: \fIcomm\fP
104+
TYPE(MPI_Info), INTENT(IN) :: \fIinfo\fP
105+
TYPE(MPI_Request), INTENT(OUT) :: \fIrequest\fP
106+
INTEGER, OPTIONAL, INTENT(OUT) :: \fIierror\fP
107+
80108
.fi
81109
.SH INPUT PARAMETERS
82110
.ft R
@@ -111,6 +139,9 @@ receiving data from rank j.
111139
.TP 1.2i
112140
comm
113141
Communicator over which data is to be exchanged.
142+
.TP 1.2i
143+
info
144+
Info (handle, persistent only)
114145

115146
.SH OUTPUT PARAMETERS
116147
.ft R

0 commit comments

Comments
 (0)