1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72
|
.. _mpi_graph_neighbors_count:
MPI_Graph_neighbors_count
=========================
.. include_body
:ref:`MPI_Graph_neighbors_count` |mdash| Returns the number of neighbors of a node
associated with a graph topology.
SYNTAX
------
C Syntax
^^^^^^^^
.. code-block:: c
#include <mpi.h>
int MPI_Graph_neighbors_count(MPI_Comm comm, int rank,
int *nneighbors)
Fortran Syntax
^^^^^^^^^^^^^^
.. code-block:: fortran
USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_GRAPH_NEIGHBORS_COUNT(COMM, RANK, NNEIGHBORS, IERROR)
INTEGER COMM, RANK, NNEIGHBORS, IERROR
Fortran 2008 Syntax
^^^^^^^^^^^^^^^^^^^
.. code-block:: fortran
USE mpi_f08
MPI_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) :: ierror
INPUT PARAMETERS
----------------
* ``comm`` : Communicator with graph topology (handle).
* ``rank`` : Rank of process in group of comm (integer).
OUTPUT PARAMETERS
-----------------
* ``nneighbors`` : Number of neighbors of specified process (integer).
* ``ierror`` : Fortran only: Error status (integer).
DESCRIPTION
-----------
:ref:`MPI_Graph_neighbors_count` and :ref:`MPI_Graph_neighbors` provide adjacency
information for a general, graph topology. :ref:`MPI_Graph_neighbors_count`
returns the number of neighbors for the process signified by rank.
ERRORS
------
.. include:: ./ERRORS.rst
.. seealso:: :ref:`MPI_Graph_neighbors`
|