MPI_Dist_graph_neighbors_count function

Obtains adjacency information of the calling process in a distributed graph topology. The information that is obtained by this function, on the number of incoming edges, outgoing edges, and a flag indicating if the distributed graph is weighted, matches the information provided in the call to MPI_Dist_graph_create_adjacent or MPI_Dist_graph_create (by the calling process in the case of MPI_Dist_graph_create_adjacent, or potentially by processes other than the calling process in the case of MPI_Dist_graph_create).

Syntax

int WINAPI MPI_Dist_graph_neighbors_count(
  _In_  MPI_Comm comm,
  _Out_ int      indegree,
  _Out_ int      outdegree,
  _Out_ int      weighted
);

Parameters

  • comm [in]
    The handle of the communicator with the distributed graph topology.

  • indegree [out]
    Number of edges into this process (non-negative integer).

  • outdegree [out]
    Number of edges out of this process (non-negative integer).

  • weighted [out]
    Is false if MPI_UNWEIGHTED was supplied during creation, true otherwise.

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_DIST_GRAPH_NEIGHBORS_COUNT (COMM, INDEGREE, OUTDEGREE, WEIGHTED, IERROR)
        INTEGER COMM, INDEGREE, OUTDEGREE, IERROR
        LOGICAL WEIGHTED

Requirements

Product

Microsoft MPI v6

Header

Mpi.h; Mpif.h

Library

Msmpi.lib

DLL

Msmpi.dll

See also

MPI Process Topology Functions

MPI_Dist_graph_neighbors

MPI_Dist_graph_create

MPI_Dist_graph_create_adjacent