Edit

Share via


MPI_Group_translate_ranks function

Determines the relative numbering of the same processes in two different groups.

Syntax

int MPIAPI MPI_Group_translate_ranks(
        MPI_Group         group1,
        int               n,
        _In_count_(n) int *ranks1,
        MPI_Group         group2,
  _Out_ int               *ranks2
);

Parameters

  • group1
    The first group.

  • n
    The number or ranks in the ranks1 and ranks2 parameter arrays.

  • ranks1
    Zero or more valid ranks in the first group.

    Note

    The MPI_PROC_NULL constant is valid for this parameter. The corresponding rank that is returned in the ranks2 parameter is also MPI_PROC_NULL.

     

  • group2
    The second group.

  • ranks2 [out]
    On return, points to the corresponding ranks in the second group. The value MPI_UNDEFINED indicates that a process is in the first group, but not the second.

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_GROUP_TRANSLATE_RANKS( GROUP1, N, RANKS1, GROUP2, RANKS2, IERROR)
        INTEGER GROUP1, N, RANKS1(*), GROUP2, RANKS2(*), 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 Group Functions

MPI_Group_incl