Blob Blame History Raw
.TH MPI_Dist_graph_neighbors 3 "11/12/2019" " " "MPI"
.SH NAME
MPI_Dist_graph_neighbors \-  Provides adjacency information for a distributed graph topology. 
.SH SYNOPSIS
.nf
int MPI_Dist_graph_neighbors(MPI_Comm comm,
int maxindegree, int sources[], int sourceweights[],
int maxoutdegree, int destinations[], int destweights[])
.fi
.SH INPUT PARAMETERS
.PD 0
.TP
.B comm 
- communicator with distributed graph topology (handle)
.PD 1
.PD 0
.TP
.B maxindegree 
- size of sources and sourceweights arrays (non-negative integer)
.PD 1
.PD 0
.TP
.B maxoutdegree 
- size of destinations and destweights arrays (non-negative integer)
.PD 1

.SH OUTPUT PARAMETERS
.PD 0
.TP
.B sources 
- processes for which the calling process is a destination (array of non-negative integers)
.PD 1
.PD 0
.TP
.B sourceweights 
- weights of the edges into the calling process (array of non-negative integers)
.PD 1
.PD 0
.TP
.B destinations 
- processes for which the calling process is a source (array of non-negative integers)
.PD 1
.PD 0
.TP
.B destweights 
- weights of the edges out of the calling process (array of non-negative integers)
.PD 1

.SH THREAD AND INTERRUPT SAFETY

This routine is thread-safe.  This means that this routine may be
safely used by multiple threads without the need for any user-provided
thread locks.  However, the routine is not interrupt safe.  Typically,
this is due to the use of memory allocation routines such as 
.I malloc
or other non-MPICH runtime routines that are themselves not interrupt-safe.

.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_Comm_set_errhandler
(for communicators),
.I MPI_File_set_errhandler
(for files), and 
.I MPI_Win_set_errhandler
(for
RMA windows).  The MPI-1 routine 
.I MPI_Errhandler_set
may be used but
its use is deprecated.  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; however, MPI implementations will attempt to continue whenever
possible.

.PD 0
.TP
.B MPI_SUCCESS 
- No error; MPI routine completed successfully.
.PD 1