MPI_GROUP_TRANSLATE_RANKS, MPI_Group_translate_ranks

Purpose

Converts task ranks of one group into ranks of another group.

C synopsis

#include <mpi.h>
int MPI_Group_translate_ranks(MPI_Group group1,int n,
    int *ranks1,MPI_Group group2,int *ranks2);

C++ synopsis

#include mpi.h
void MPI::Group::Translate_ranks(const MPI::Group& group1, int n,
                                 const int ranks1[],
                                 const MPI::Group& group2, int ranks2[]);

FORTRAN synopsis

include 'mpif.h' or use mpi
MPI_GROUP_TRANSLATE_RANKS(INTEGER GROUP1, INTEGER N,
    INTEGER RANKS1(*),INTEGER GROUP2,INTEGER RANKS2(*),INTEGER IERROR)

Parameters

group1
     is the first group (handle) (IN)

n
     is an integer that specifies the number of ranks in ranks1 and ranks2
     arrays (IN)

ranks1
     is an array of zero or more valid ranks in group1 (IN)

group2
     is the second group (handle) (IN)

ranks2
     is an array of corresponding ranks in group2. If the task of ranks1(i)
     is not a member of group2, ranks2(i) returns MPI_UNDEFINED. (OUT)

IERROR
     is the FORTRAN return code. It is always the last argument.

Description

This subroutine converts task ranks of one group into ranks of another
group. For example, if you know the ranks of tasks in one group, you can
use this function to find the ranks of tasks in another group.

Errors

Invalid group(s)

Invalid rank count
     n < 0

Invalid rank
     ranks1[i] < 0 or ranks1[i] > = size of group1

MPI not initialized

MPI already finalized

Related information