Synopsis

int MPI_Dist_graph_neighbors(MPI_Comm comm, int maxindegree, int sources[],
                             int sourceweights[], int maxoutdegree,
                             int destinations[], int destweights[])

Input Parameters

comm

communicator with distributed graph topology (handle)

maxindegree

size of sources and sourceweights arrays (non-negative integer)

maxoutdegree

size of destinations and destweights arrays (non-negative integer)

Output Parameters

sources

processes for which the calling process is a destination (non-negative integer)

sourceweights

weights of the edges into the calling process (non-negative integer)

destinations

processes for which the calling process is a source (non-negative integer)

destweights

weights of the edges out of the calling process (non-negative integer)

Description

MPI_Dist_graph_neighbors returns adjacency information for a distributed graph topology associated with a communicator.

This operation is local. The sources and destinations arrays are populated with the ranks of incoming and outgoing neighbor processes, and multiply-defined edges are all counted and returned in some order. If MPI_UNWEIGHTED is supplied for sourceweights or destweights, or if the graph was created with MPI_UNWEIGHTED, no weight information is returned in those arrays. If maxindegree or maxoutdegree is smaller than the values returned by MPI_DIST_GRAPH_NEIGHBORS_COUNT, only the first part of the full list is returned. If the communicator was created with MPI_DIST_GRAPH_CREATE_ADJACENT, the order of values in sources and destinations is identical to the input used by the process with the same rank during creation; if created with MPI_DIST_GRAPH_CREATE, the only requirement is that two calls with the same comm return the same sequence of edges.

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 'malloc' or other non-MPICH runtime routines that are themselves not interrupt-safe.

Notes for Fortran

All MPI routines in Fortran (except for 'MPI_WTIME' and 'MPI_WTICK') have an additional argument 'ierr' at the end of the argument list. '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 'call' statement.

All MPI objects (e.g., 'MPI_Datatype', 'MPI_Comm') are of type 'INTEGER' in Fortran.

Errors

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

  • MPI_SUCCESS - No error; MPI routine completed successfully.

  • MPI_ERR_ARG - Invalid argument. Some argument is invalid and is not identified by a specific error class (e.g., 'MPI_ERR_RANK').

  • MPI_ERR_COMM - Invalid communicator. A common error is to use a null communicator in a call (not even allowed in 'MPI_Comm_rank').

  • MPI_ERR_OTHER - Other error; use 'MPI_Error_string' to get more information about this error code.