MPI_Group_excl function

Article
09/14/2018

A group constructor that is used to define a new group by deleting ranks from an existing group.

Syntax

int MPIAPI MPI_Group_excl(
        MPI_Group         group,
        int               n,
        _In_count_(n) int *ranks,
  _Out_ MPI_Group         *newgroup
);

Parameters

group
The existing group.
n
The number of elements in the ranks parameter.
ranks
The arrays of processes in group that are not to appear in newgroup. The specified ranks must be valid in the existing group. Each element in the array must be distinct. If the array is empty then the new group will be identical to the existing group.
newgroup [out]
A pointer to a handle that represents the new group that is derived from the existing group. The order of the existing group is preserved in the new group.

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_EXCL(GROUP, N, RANKS, NEWGROUP, IERROR)
        INTEGER GROUP, N, RANKS(*), NEWGROUP, IERROR

Remarks

This function creates a new group of processes that is derived by removing specified processes from an existing group while preserving the order of the ranks in the group.

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

Share via