Open MPI logo

MPI_Graph_neighbors_count(3) man page (version 5.0.0rc2)

  |   Home   |   Support   |   FAQ   |  

« Return to documentation listing

Table of Contents

Name

C]MPI_Graph_neighbors_countR] - Returns the number of neighbors of a node associated with a graph topology.

Syntax

C Syntax



C]#include <mpi.h>int MPI_Graph_neighbors_count(MPI_Comm comm, int rank, int *nneighbors)R]Fortran Syntax



C]USE MPI! or the older form: INCLUDE [aq]mpif.h[aq]MPI_GRAPH_NEIGHBORS_COUNT(COMM, RANK, NNEIGHBORS, IERROR) INTEGER COMM, RANK, NNEIGHBORS, IERRORR]Fortran 2008 Syntax



C]USE mpi_f08MPI_Graph_neighbors_count(comm, rank, nneighbors, ierror) TYPE(MPI_Comm), INTENT(IN) :: comm INTEGER, INTENT(IN) :: rank INTEGER, INTENT(OUT) :: nneighbors INTEGER, OPTIONAL, INTENT(OUT) :: ierrorR]Input Parameters

[bu]
C]commR] : Communicator with graph topology (handle).
[bu]
C]rankR] : Rank of process in group of comm (integer).

Output Parameters

[bu]
C]nneighborsR] : Number of neighbors of specified process (integer).
[bu]
C]IERRORR] : Fortran only: Error status (integer).

Description

C]MPI_Graph_neighbors_countR] and C]MPI_Graph_neighborsR] provide adjacency information for a general, graph topology. C]MPI_Graph_neighbors_countR] returns the number of neighbors for the process signified by C]rankR].

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 C]MPI_Comm_set_errhandlerR]; the predefined error handler C]MPI_ERRORS_RETURNR] 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.

See Also

C]MPI_Graph_neighborsR](3)


Table of Contents

« Return to documentation listing