MPI_Graph_neighbors function

  • Article

Returns the neighbors of a node associated with a graph topology.

Syntax

int MPIAPI MPI_Graph_neighbors(
   MPI_Comm                    comm,
   int                         rank,
   int                         maxneighbors,
   _Out_cap_(maxneighbors) int *neighbors
);

Parameters

  • comm
    Communicator with graph topology.

  • rank
    Rank of process in group of comm.

  • maxneighbors
    Size of array neighbors.

  • neighbors
    Ranks of processes that are neighbors to specified process.

Return value

Returns MPI_SUCCESS on success. Otherwise, the return value is an error code.

In Fortran, the return value is stored in the IERROR parameter.

Fortran

    MPI_GRAPH_NEIGHBORS(COMM, RANK, MAXNEIGHBORS, NEIGHBORS, IERROR)
        INTEGER COMM, RANK, MAXNEIGHBORS, NEIGHBORS(*), IERROR

Requirements

Product

HPC Pack 2012 MS-MPI Redistributable Package, HPC Pack 2008 R2 MS-MPI Redistributable Package, HPC Pack 2008 MS-MPI Redistributable Package or HPC Pack 2008 Client Utilities

Header

 Mpi.h; Mpif.h

Library

 Msmpi.lib

DLL

 Msmpi.dll

See also

MPI Process Topology Functions