Convert MPI_Bcast.3in to markdown
Signed-off-by: Fangcong Yin (fyin2@nd.edu)
Этот коммит содержится в:
Fangcong-Yin
Fangcong-Yin
родитель
9afcb8e2ab
Коммит
c2ef4af7b6
@ -1,114 +0,0 @@
|
||||
.\" -*- nroff -*-
|
||||
.\" Copyright (c) 2010-2014 Cisco Systems, Inc. All rights reserved.
|
||||
.\" Copyright 2006-2008 Sun Microsystems, Inc.
|
||||
.\" Copyright (c) 1996 Thinking Machines Corporation
|
||||
.\" Copyright (c) 2020 Google, LLC. All rights reserved.
|
||||
.\" $COPYRIGHT$
|
||||
.TH MPI_Bcast 3 "#OMPI_DATE#" "#PACKAGE_VERSION#" "#PACKAGE_NAME#"
|
||||
.SH NAME
|
||||
\fBMPI_Bcast, MPI_Ibcast\fP \- Broadcasts a message from the process with rank \fIroot\fP to all other processes of the group.
|
||||
|
||||
.SH SYNTAX
|
||||
.ft R
|
||||
.SH C Syntax
|
||||
.nf
|
||||
#include <mpi.h>
|
||||
int MPI_Bcast(void \fI*buffer\fP, int\fI count\fP, MPI_Datatype\fI datatype\fP,
|
||||
int\fI root\fP, MPI_Comm\fI comm\fP)
|
||||
|
||||
int MPI_Ibcast(void \fI*buffer\fP, int\fI count\fP, MPI_Datatype\fI datatype\fP,
|
||||
int\fI root\fP, MPI_Comm\fI comm\fP, MPI_Request \fI*request\fP)
|
||||
|
||||
.fi
|
||||
.SH Fortran Syntax
|
||||
.nf
|
||||
USE MPI
|
||||
! or the older form: INCLUDE 'mpif.h'
|
||||
MPI_BCAST(\fIBUFFER\fP,\fI COUNT\fP, \fIDATATYPE\fP,\fI ROOT\fP,\fI COMM\fP,\fI IERROR\fP)
|
||||
<type> \fIBUFFER\fP(*)
|
||||
INTEGER \fICOUNT\fP,\fI DATATYPE\fP,\fI ROOT\fP,\fI COMM\fP,\fI IERROR\fP
|
||||
|
||||
MPI_IBCAST(\fIBUFFER\fP,\fI COUNT\fP, \fIDATATYPE\fP,\fI ROOT\fP,\fI COMM\fP, \fIREQUEST\fP,\fI IERROR\fP)
|
||||
<type> \fIBUFFER\fP(*)
|
||||
INTEGER \fICOUNT\fP,\fI DATATYPE\fP,\fI ROOT\fP,\fI COMM\fP, \fIREQUEST\fP,\fI IERROR\fP
|
||||
|
||||
.fi
|
||||
.SH Fortran 2008 Syntax
|
||||
.nf
|
||||
USE mpi_f08
|
||||
MPI_Bcast(\fIbuffer\fP, \fIcount\fP, \fIdatatype\fP, \fIroot\fP, \fIcomm\fP, \fIierror\fP)
|
||||
TYPE(*), DIMENSION(..) :: \fIbuffer\fP
|
||||
INTEGER, INTENT(IN) :: \fIcount\fP, \fIroot\fP
|
||||
TYPE(MPI_Datatype), INTENT(IN) :: \fIdatatype\fP
|
||||
TYPE(MPI_Comm), INTENT(IN) :: \fIcomm\fP
|
||||
INTEGER, OPTIONAL, INTENT(OUT) :: \fIierror\fP
|
||||
|
||||
MPI_Ibcast(\fIbuffer\fP, \fIcount\fP, \fIdatatype\fP, \fIroot\fP, \fIcomm\fP, \fIrequest\fP, \fIierror\fP)
|
||||
TYPE(*), DIMENSION(..), ASYNCHRONOUS :: \fIbuffer\fP
|
||||
INTEGER, INTENT(IN) :: \fIcount\fP, \fIroot\fP
|
||||
TYPE(MPI_Datatype), INTENT(IN) :: \fIdatatype\fP
|
||||
TYPE(MPI_Comm), INTENT(IN) :: \fIcomm\fP
|
||||
TYPE(MPI_Request), INTENT(OUT) :: \fIrequest\fP
|
||||
INTEGER, OPTIONAL, INTENT(OUT) :: \fIierror\fP
|
||||
|
||||
.fi
|
||||
.SH INPUT/OUTPUT PARAMETERS
|
||||
.ft R
|
||||
.TP 1i
|
||||
buffer
|
||||
Starting address of buffer (choice).
|
||||
.TP 1i
|
||||
count
|
||||
Number of entries in buffer (integer).
|
||||
.TP 1i
|
||||
datatype
|
||||
Data type of buffer (handle).
|
||||
.TP 1i
|
||||
root
|
||||
Rank of broadcast root (integer).
|
||||
.TP 1i
|
||||
comm
|
||||
Communicator (handle).
|
||||
|
||||
.SH OUTPUT PARAMETERS
|
||||
.ft R
|
||||
.TP 1i
|
||||
request
|
||||
Request (handle, non-blocking only).
|
||||
.TP 1i
|
||||
IERROR
|
||||
Fortran only: Error status (integer).
|
||||
|
||||
.SH DESCRIPTION
|
||||
.ft R
|
||||
MPI_Bcast broadcasts a message from the process with rank root to all processes of the group, itself included. It is called by all members of group using the same arguments for comm, root. On return, the contents of root's communication buffer has been copied to all processes.
|
||||
.sp
|
||||
General, derived datatypes are allowed for datatype. The type signature of count, datatype on any process must be equal to the type signature of count, datatype at the root. This implies that the amount of data sent must be equal to the amount received, pairwise between each process and the root. MPI_Bcast and all other data-movement collective routines make this restriction. Distinct type maps between sender and receiver are still allowed.
|
||||
.sp
|
||||
\fBExample:\fR Broadcast 100 ints from process 0 to every process in the group.
|
||||
.nf
|
||||
MPI_Comm comm;
|
||||
int array[100];
|
||||
int root=0;
|
||||
\&...
|
||||
MPI_Bcast( array, 100, MPI_INT, root, comm);
|
||||
.fi
|
||||
.sp
|
||||
As in many of our sample code fragments, we assume that some of the variables (such as comm in the example above) have been assigned appropriate values.
|
||||
.sp
|
||||
.SH WHEN COMMUNICATOR IS AN INTER-COMMUNICATOR
|
||||
.sp
|
||||
When the communicator is an inter-communicator, the root process in the first group broadcasts data to all the processes in the second group. The first group defines the root process. That process uses MPI_ROOT as the value of its \fIroot\fR argument. The remaining processes use MPI_PROC_NULL as the value of their \fIroot\fR argument. All processes in the second group use the rank of that root process in the first group as the value of their \fIroot\fR argument. The receive buffer arguments of the processes in the second group must be consistent with the send buffer argument of the root process in the first group.
|
||||
.sp
|
||||
.SH NOTES
|
||||
This function does not support the in-place option.
|
||||
.sp
|
||||
|
||||
|
||||
|
||||
.SH ERRORS
|
||||
Almost all MPI routines return an error value; C routines as the value of the function and Fortran routines in the last argument.
|
||||
.sp
|
||||
Before the error value is returned, the current MPI error handler is
|
||||
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.
|
||||
|
||||
122
ompi/mpi/man/man3/MPI_Bcast.md
Обычный файл
122
ompi/mpi/man/man3/MPI_Bcast.md
Обычный файл
@ -0,0 +1,122 @@
|
||||
# NAME
|
||||
|
||||
`MPI_Bcast`, `MPI_Ibcast` - Broadcasts a message from the process with
|
||||
rank *root* to all other processes of the group.
|
||||
|
||||
# SYNTAX
|
||||
|
||||
## C Syntax
|
||||
|
||||
```C
|
||||
#include <mpi.h>
|
||||
int MPI_Bcast(void *buffer, int count, MPI_Datatype datatype,
|
||||
int root, MPI_Comm comm)
|
||||
|
||||
int MPI_Ibcast(void *buffer, int count, MPI_Datatype datatype,
|
||||
int root, MPI_Comm comm, MPI_Request *request)
|
||||
```
|
||||
|
||||
## Fortran Syntax
|
||||
|
||||
```Fortran
|
||||
USE MPI
|
||||
! or the older form: INCLUDE 'mpif.h'
|
||||
MPI_BCAST(BUFFER, COUNT, DATATYPE, ROOT, COMM, IERROR)
|
||||
<type> BUFFER(*)
|
||||
INTEGER COUNT, DATATYPE, ROOT, COMM, IERROR
|
||||
|
||||
MPI_IBCAST(BUFFER, COUNT, DATATYPE, ROOT, COMM, REQUEST, IERROR)
|
||||
<type> BUFFER(*)
|
||||
INTEGER COUNT, DATATYPE, ROOT, COMM, REQUEST, IERROR
|
||||
```
|
||||
|
||||
## Fortran 2008 Syntax
|
||||
|
||||
``` Fortran
|
||||
USE mpi_f08
|
||||
MPI_Bcast(buffer, count, datatype, root, comm, ierror)
|
||||
TYPE(*), DIMENSION(..) :: buffer
|
||||
INTEGER, INTENT(IN) :: count, root
|
||||
TYPE(MPI_Datatype), INTENT(IN) :: datatype
|
||||
TYPE(MPI_Comm), INTENT(IN) :: comm
|
||||
INTEGER, OPTIONAL, INTENT(OUT) :: ierror
|
||||
|
||||
MPI_Ibcast(buffer, count, datatype, root, comm, request, ierror)
|
||||
TYPE(*), DIMENSION(..), ASYNCHRONOUS :: buffer
|
||||
INTEGER, INTENT(IN) :: count, root
|
||||
TYPE(MPI_Datatype), INTENT(IN) :: datatype
|
||||
TYPE(MPI_Comm), INTENT(IN) :: comm
|
||||
TYPE(MPI_Request), INTENT(OUT) :: request
|
||||
INTEGER, OPTIONAL, INTENT(OUT) :: ierror
|
||||
```
|
||||
|
||||
# INPUT/OUTPUT PARAMETERS
|
||||
|
||||
* `buffer`: Starting address of buffer (choice).
|
||||
* `count`: Number of entries in buffer (integer).
|
||||
* `datatype`: Data type of buffer (handle).
|
||||
* `root`: Rank of broadcast root (integer).
|
||||
* `comm`: Communicator (handle).
|
||||
|
||||
# OUTPUT PARAMETERS
|
||||
|
||||
* `request`: Request (handle, non-blocking only).
|
||||
* `IERROR`: Fortran only: Error status (integer).
|
||||
|
||||
# DESCRIPTION
|
||||
|
||||
`MPI_Bcast` broadcasts a message from the process with rank root to all
|
||||
processes of the group, itself included. It is called by all members of
|
||||
group using the same arguments for `comm`, `root`. On return, the contents
|
||||
of root's communication buffer has been copied to all processes.
|
||||
|
||||
General, derived datatypes are allowed for datatype. The type signature
|
||||
of count, datatype on any process must be equal to the type signature o f
|
||||
count, datatype at the root. This implies that the amount of data sent
|
||||
must be equal to the amount received, pairwise between each process and
|
||||
the root. `MPI_Bcast` and all other data-movement collective routines make
|
||||
this restriction. Distinct type maps between sender and receiver are
|
||||
still allowed.
|
||||
|
||||
**Example:** Broadcast 100 ints from process 0 to every process in the
|
||||
group.
|
||||
|
||||
```C
|
||||
MPI_Comm comm;
|
||||
int array[100];
|
||||
int root=0;
|
||||
//...
|
||||
MPI_Bcast( array, 100, MPI_INT, root, comm);
|
||||
```
|
||||
|
||||
As in many of our sample code fragments, we assume that some of the
|
||||
variables (such as comm in the example above) have been assigned
|
||||
appropriate values.
|
||||
|
||||
# WHEN COMMUNICATOR IS AN INTER-COMMUNICATOR
|
||||
|
||||
When the communicator is an inter-communicator, the root process in the
|
||||
first group broadcasts data to all the processes in the second group.
|
||||
The first group defines the root process. That process uses `MPI_ROOT` as
|
||||
the value of its `root` argument. The remaining processes use
|
||||
`MPI_PROC_NULL` as the value of their `root` argument. All processes in
|
||||
the second group use the rank of that root process in the first group as
|
||||
the value of their `root` argument. The receive buffer arguments of the
|
||||
processes in the second group must be consistent with the send buffer
|
||||
argument of the root process in the first group.
|
||||
|
||||
# NOTES
|
||||
|
||||
This function does not support the in-place option.
|
||||
|
||||
# ERRORS
|
||||
|
||||
Almost all MPI routines return an error value; C routines as the value
|
||||
of the function and Fortran routines in the last argument.
|
||||
|
||||
Before the error value is returned, the current MPI error handler is
|
||||
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.
|
||||
@ -27,7 +27,8 @@ MD_FILES = \
|
||||
MPI_T_init_thread.3.md \
|
||||
MPI_Status_f2c.3.md \
|
||||
MPI_Status_f082c.3.md \
|
||||
MPI_Status_f082f.3.md
|
||||
MPI_Status_f082f.3.md \
|
||||
MPI_Bcast.md
|
||||
|
||||
TEMPLATE_FILES = \
|
||||
MPI_Abort.3in \
|
||||
@ -56,7 +57,6 @@ TEMPLATE_FILES = \
|
||||
MPI_Attr_put.3in \
|
||||
MPI_Barrier.3in \
|
||||
MPI_Ibarrier.3in \
|
||||
MPI_Bcast.3in \
|
||||
MPI_Ibcast.3in \
|
||||
MPI_Bsend.3in \
|
||||
MPI_Bsend_init.3in \
|
||||
|
||||
Загрузка…
Ссылка в новой задаче
Block a user