MPI_GROUP_COMPARE(3)
π NAME
MPI_Group_compare β compares two groups, bestie. That's it. That's the whole job. π«Ά
β¨ 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_ β the first group, as a handle. π - _
group2_ β the second group, also a handle. π
π OUTPUT PARAMETERS
- _
result_ β an integer, and honestly it's giving three possible moods:MPI_IDENTif the order and the members of the two groups are the same,MPI_SIMILARif only the members are the same, andMPI_UNEQUALotherwise. β - _
ierror_ β Fortran only, bestie: error status (integer). π
π₯ DESCRIPTION
Okay so here's the tea, and it's so simple it's iconic:
MPI_IDENT results if the group members and the group order are exactly the same in both groups. This happens for instance if group1 and group2 are the same handle. Like, obviously. π
MPI_SIMILAR results if the group members are the same but the order is different. Same girlies, different lineup. π¦
MPI_UNEQUAL results otherwise. That's it. No cap. π
π 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. Keep that in mind, fr fr.
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. Very main character, very dramatic. π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 ifMPI_Abortwas called on that communicator. If called on a window or file, it acts as ifMPI_Abortwas called on a communicator containing the group of processes in the corresponding window or file. If called on a session, it aborts only the local process. πΈMPI_ERRORS_RETURNβ returns an error code to the application. The chill one. β¨
MPI applications can also implement their own error handlers by calling:
MPI_Comm_create_errhandlerthenMPI_Comm_set_errhandlerMPI_File_create_errhandlerthenMPI_File_set_errhandlerMPI_Session_create_errhandlerthenMPI_Session_set_errhandleror atMPI_Session_initMPI_Win_create_errhandlerthenMPI_Win_set_errhandler
β οΈ Note that MPI does not guarantee that an MPI program can continue past an error. Say it with me: no guarantees, bestie. π
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
And that's the whole page, bestie β go compare some groups and slay. πβ¨π
Sep 11, 2026 Β· Open MPI Β· MPI_GROUP_COMPARE(3) β mwah, ily, bye! ππ¦
π¦ where this page comes from
- arch rolling: openmpi 5.0.11-1 Β· BSD-3-Clause AND LicenseRef-MPICH
- π girlified by deepseek-ai/DeepSeek-V4.1-Flash-1017 on : a language model's rewrite of the original, under its terms