---
name: "MPI_Group_compare"
section: "3"
platform: "linux"
package: "openmpi"
version: "5.0.11-1"
release: "Arch Linux 2026-11-01"
platforms: ["linux"]
url: "https://new.carta.tech/MPI_Group_compare"
---

# MPI\_Group\_compare(3)

*MPI\_Group\_compare* — Compares two groups.

## SYNTAX

### C Syntax

```
#include <mpi.h>
int MPI_Group_compare(MPI_Group group1, MPI_Group group2,
    int *result)
```

### Fortran Syntax

```
USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_GROUP_COMPARE(GROUP1, GROUP2, RESULT, IERROR)
    INTEGER GROUP1, GROUP2, RESULT, IERROR
```

### Fortran 2008 Syntax

```
USE mpi_f08
MPI_Group_compare(group1, group2, result, ierror)
    TYPE(MPI_Group), INTENT(IN) :: group1, group2
    INTEGER, INTENT(OUT) :: result
    INTEGER, OPTIONAL, INTENT(OUT) :: ierror
```

## INPUT PARAMETERS

- •

  **group1** : First group (handle).

- •

  **group2** : Second group (handle).

## OUTPUT PARAMETERS

- •

  - **result**

    Integer which is MPI\_IDENT if the order and members of the two groups are the same, MPI\_SIMILAR if only the members are the same, and MPI\_UNEQUAL otherwise.

- •

  **ierror** : Fortran only: Error status (integer).

## DESCRIPTION

MPI\_IDENT results if the group members and group order is exactly the same in both groups. This happens for instance if **group1** and **group2** are the same handle. MPI\_SIMILAR results if the group members are the same but the order is different. MPI\_UNEQUAL results otherwise.

## ERRORS

Almost all MPI routines return an error value; C routines as the return result of the function and Fortran routines in the last argument.

Before the error value is returned, the current MPI error handler associated with the communication object (e.g., communicator, window, file) is called. If no communication object is associated with the MPI call, then the call is considered attached to MPI\_COMM\_SELF and will call the associated MPI error handler. When MPI\_COMM\_SELF is not initialized (i.e., before *MPI\_Init*/*MPI\_Init\_thread*, after *MPI\_Finalize*, or when using the Sessions Model exclusively) the error raises the initial error handler. The initial error handler can be changed by calling *MPI\_Comm\_set\_errhandler* on MPI\_COMM\_SELF when using the World model, or the mpi\_initial\_errhandler CLI argument to mpiexec or info key to *MPI\_Comm\_spawn*/*MPI\_Comm\_spawn\_multiple*. If no other appropriate error handler has been set, then the MPI\_ERRORS\_RETURN error handler is called for MPI I/O functions and the MPI\_ERRORS\_ABORT error handler is called for all other MPI functions.

Open MPI includes three predefined error handlers that can be used:

- •

  **MPI\_ERRORS\_ARE\_FATAL** Causes the program to abort all connected MPI processes.

- •

  **MPI\_ERRORS\_ABORT** An error handler that can be invoked on a communicator, window, file, or session. When called on a communicator, it acts as if *MPI\_Abort* was called on that communicator. If called on a window or file, acts as if *MPI\_Abort* was called on a communicator containing the group of processes in the corresponding window or file. If called on a session, aborts only the local process.

- •

  **MPI\_ERRORS\_RETURN** Returns an error code to the application.

MPI applications can also implement their own error handlers by calling:

- •

  *MPI\_Comm\_create\_errhandler* then *MPI\_Comm\_set\_errhandler*

- •

  *MPI\_File\_create\_errhandler* then *MPI\_File\_set\_errhandler*

- •

  *MPI\_Session\_create\_errhandler* then *MPI\_Session\_set\_errhandler* or at *MPI\_Session\_init*

- •

  *MPI\_Win\_create\_errhandler* then *MPI\_Win\_set\_errhandler*

Note that MPI does not guarantee that an MPI program can continue past an error.

See the *MPI man page* for a full list of *MPI error codes*.

See the Error Handling section of the MPI-3.1 standard for more information.

## COPYRIGHT

2003-2026, The Open MPI Community