Commit 7d983392 authored by Huiwei Lu's avatar Huiwei Lu
Browse files

Fix #1920 - NBC Man Pages have no description



Adds man pages for nonblocking collectives
Signed-off-by: default avatarWesley Bland <wbland@mcs.anl.gov>
parent e61b9a5b
......@@ -634,7 +634,8 @@ fn_fail:
#undef FCNAME
#define FCNAME MPIU_QUOTE(FUNCNAME)
/*@
MPI_Iallgather - XXX description here
MPI_Iallgather - Gathers data from all tasks and distribute the combined data
to all tasks in a nonblocking way
Input Parameters:
+ sendbuf - starting address of the send buffer (choice)
......
......@@ -736,7 +736,8 @@ fn_fail:
#undef FCNAME
#define FCNAME MPIU_QUOTE(FUNCNAME)
/*@
MPI_Iallgatherv - XXX description here
MPI_Iallgatherv - Gathers data from all tasks and deliver the combined data
to all tasks in a nonblocking way
Input Parameters:
+ sendbuf - starting address of the send buffer (choice)
......
......@@ -691,7 +691,8 @@ fn_fail:
#undef FCNAME
#define FCNAME MPIU_QUOTE(FUNCNAME)
/*@
MPI_Iallreduce - XXX description here
MPI_Iallreduce - Combines values from all processes and distributes the result
back to all processes in a nonblocking way
Input Parameters:
+ sendbuf - starting address of the send buffer (choice)
......
......@@ -564,7 +564,7 @@ fn_fail:
#undef FCNAME
#define FCNAME MPIU_QUOTE(FUNCNAME)
/*@
MPI_Ialltoall - XXX description here
MPI_Ialltoall - Sends data from all to all processes in a nonblocking way
Input Parameters:
+ sendbuf - starting address of the send buffer (choice)
......
......@@ -291,7 +291,9 @@ fn_fail:
#undef FCNAME
#define FCNAME MPIU_QUOTE(FUNCNAME)
/*@
MPI_Ialltoallv - XXX description here
MPI_Ialltoallv - Sends data from all to all processes in a nonblocking way;
each process may send a different amount of data and provide displacements
for the input and output data.
Input Parameters:
+ sendbuf - starting address of the send buffer (choice)
......
......@@ -297,7 +297,8 @@ fn_fail:
#undef FCNAME
#define FCNAME MPIU_QUOTE(FUNCNAME)
/*@
MPI_Ialltoallw - XXX description here
MPI_Ialltoallw - Nonblocking generalized all-to-all communication allowing
different datatypes, counts, and displacements for each partner
Input Parameters:
+ sendbuf - starting address of the send buffer (choice)
......
......@@ -215,7 +215,8 @@ fn_fail:
#undef FCNAME
#define FCNAME MPIU_QUOTE(FUNCNAME)
/*@
MPI_Ibarrier - XXX description here
MPI_Ibarrier - Notifies the process that it has reached the barrier and returns
immediately
Input Parameters:
. comm - communicator (handle)
......@@ -223,6 +224,16 @@ Input Parameters:
Output Parameters:
. request - communication request (handle)
Notes:
MPI_Ibarrier is a nonblocking version of MPI_barrier. By calling MPI_Ibarrier,
a process notifies that it has reached the barrier. The call returns
immediately, independent of whether other processes have called MPI_Ibarrier.
The usual barrier semantics are enforced at the corresponding completion
operation (test or wait), which in the intra-communicator case will complete
only after all other processes in the communicator have called MPI_Ibarrier. In
the intercommunicator case, it will complete when all processes in the remote
group have called MPI_Ibarrier.
.N ThreadSafe
.N Fortran
......
......@@ -902,7 +902,8 @@ fn_fail:
#undef FCNAME
#define FCNAME MPIU_QUOTE(FUNCNAME)
/*@
MPI_Ibcast - XXX description here
MPI_Ibcast - Broadcasts a message from the process with rank "root" to
all other processes of the communicator in a nonblocking way
Input/Output Parameters:
. buffer - starting address of buffer (choice)
......
......@@ -229,7 +229,9 @@ fn_fail:
#undef FCNAME
#define FCNAME MPIU_QUOTE(FUNCNAME)
/*@
MPI_Iexscan - XXX description here
MPI_Iexscan - Computes the exclusive scan (partial reductions) of data on a
collection of processes in a nonblocking way
Input Parameters:
+ sendbuf - starting address of the send buffer (choice)
......
......@@ -558,7 +558,8 @@ fn_fail:
#undef FCNAME
#define FCNAME MPIU_QUOTE(FUNCNAME)
/*@
MPI_Igather - XXX description here
MPI_Igather - Gathers together values from a group of processes in
a nonblocking way
Input Parameters:
+ sendbuf - starting address of the send buffer (choice)
......
......@@ -157,7 +157,8 @@ fn_fail:
#undef FCNAME
#define FCNAME MPIU_QUOTE(FUNCNAME)
/*@
MPI_Igatherv - XXX description here
MPI_Igatherv - Gathers into specified locations from all processes in a group
in a nonblocking way
Input Parameters:
+ sendbuf - starting address of the send buffer (choice)
......
......@@ -1056,7 +1056,8 @@ fn_fail:
#undef FCNAME
#define FCNAME MPIU_QUOTE(FUNCNAME)
/*@
MPI_Ireduce_scatter - XXX description here
MPI_Ireduce_scatter - Combines values and scatters the results in
a nonblocking way
Input Parameters:
+ sendbuf - starting address of the send buffer (choice)
......
......@@ -958,7 +958,8 @@ fn_fail:
#undef FCNAME
#define FCNAME MPIU_QUOTE(FUNCNAME)
/*@
MPI_Ireduce_scatter_block - XXX description here
MPI_Ireduce_scatter_block - Combines values and scatters the results in
a nonblocking way
Input Parameters:
+ sendbuf - starting address of the send buffer (choice)
......
......@@ -808,7 +808,8 @@ fn_fail:
#undef FCNAME
#define FCNAME MPIU_QUOTE(FUNCNAME)
/*@
MPI_Ireduce - XXX description here
MPI_Ireduce - Reduces values on all processes to a single value
in a nonblocking way
Input Parameters:
+ sendbuf - address of the send buffer (choice)
......
......@@ -364,7 +364,8 @@ fn_fail:
#undef FCNAME
#define FCNAME MPIU_QUOTE(FUNCNAME)
/*@
MPI_Iscan - XXX description here
MPI_Iscan - Computes the scan (partial reductions) of data on a collection of
processes in a nonblocking way
Input Parameters:
+ sendbuf - starting address of the send buffer (choice)
......
......@@ -592,7 +592,8 @@ fn_fail:
#undef FCNAME
#define FCNAME MPIU_QUOTE(FUNCNAME)
/*@
MPI_Iscatter - XXX description here
MPI_Iscatter - Sends data from one process to all other processes in a
communicator in a nonblocking way
Input Parameters:
+ sendbuf - address of send buffer (significant only at root) (choice)
......
......@@ -163,7 +163,8 @@ fn_fail:
#undef FCNAME
#define FCNAME MPIU_QUOTE(FUNCNAME)
/*@
MPI_Iscatterv - XXX description here
MPI_Iscatterv - Scatters a buffer in parts to all processes in a communicator
in a nonblocking way
Input Parameters:
+ sendbuf - address of send buffer (significant only at root) (choice)
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment