1MPI_Graph_neighbors(3) LAM/MPI MPI_Graph_neighbors(3)
2
6 MPI_Graph_neighbors - Returns the neighbors of a node associated with
7 a graph topology
8
10 #include <mpi.h>
11 int MPI_Graph_neighbors(MPI_Comm comm, int rank,
12 int maxnbrs, int *nbrs)
13
15 comm - communicator with graph topology (handle)
16 rank - rank of process in group of comm (integer)
17 maxnbrs
18 - size of array neighbors (integer)
19
22 nbrs - ranks of processes that are neighbors to specified process
23 (array of integer)
24
27 All MPI routines in Fortran (except for MPI_WTIME and MPI_WTICK ) have
28 an additional argument ierr at the end of the argument list. ierr is
29 an integer and has the same meaning as the return value of the routine
30 in C. In Fortran, MPI routines are subroutines, and are invoked with
31 the call statement.
32 All MPI objects (e.g., MPI_Datatype , MPI_Comm ) are of type INTEGER in
34 Fortran.
35
38 If an error occurs in an MPI function, the current MPI error handler is
39 called to handle it. By default, this error handler aborts the MPI
40 job. The error handler may be changed with MPI_Errhandler_set ; the
41 predefined error handler MPI_ERRORS_RETURN may be used to cause error
42 values to be returned (in C and Fortran; this error handler is less
43 useful in with the C++ MPI bindings. The predefined error handler
44 MPI::ERRORS_THROW_EXCEPTIONS should be used in C++ if the error value
45 needs to be recovered). Note that MPI does not guarantee that an MPI
46 program can continue past an error.
47 All MPI routines (except MPI_Wtime and MPI_Wtick ) return an error
49 value; C routines as the value of the function and Fortran routines in
50 the last argument. The C++ bindings for MPI do not return error val‐
51 ues; instead, error values are communicated by throwing exceptions of
52 type MPI::Exception (but not by default). Exceptions are only thrown
53 if the error value is not MPI::SUCCESS .
54 Note that if the MPI::ERRORS_RETURN handler is set in C++, while MPI
57 functions will return upon an error, there will be no way to recover
58 what the actual error value was.
59 MPI_SUCCESS
60 - No error; MPI routine completed successfully.
61 MPI_ERR_TOPOLOGY
62 - Invalid topology. Either there is no topology associated with
63 this communicator, or it is not the correct type (e.g., MPI_CART
64 when expecting MPI_GRAPH ).
65 MPI_ERR_COMM
66 - Invalid communicator. A common error is to use a null commu‐
67 nicator in a call (not even allowed in MPI_Comm_rank ).
68 MPI_ERR_ARG
69 - Invalid argument. Some argument is invalid and is not identi‐
70 fied by a specific error class. This is typically a NULL
71 pointer or other such error.
72 MPI_ERR_RANK
73 - Invalid source or destination rank. Ranks must be between
74 zero and the size of the communicator minus one; ranks in a
75 receive ( MPI_Recv , MPI_Irecv , MPI_Sendrecv , etc.) may also
76 be MPI_ANY_SOURCE .
77
81 For more information, please see the official MPI Forum web site, which
82 contains the text of both the MPI-1 and MPI-2 standards. These docu‐
83 ments contain detailed information about each MPI function (most of
84 which is not duplicated in these man pages).
85 http://www.mpi-forum.org/
87
91 The LAM Team would like the thank the MPICH Team for the handy program
92 to generate man pages ("doctext" from ftp://ftp.mcs.anl.gov/pub/sow‐
93 ing/sowing.tar.gz ), the initial formatting, and some initial text for
94 most of the MPI-1 man pages.
95
97 graphnbr.c
98LAM/MPI 7.1.2 2/23/2006 MPI_Graph_neighbors(3)