MPI_COMM_COMPARE(3)
π MPI_COMM_COMPARE π
okay bestie, welcome to the Open MPI manual, page MPI_COMM_COMPARE(3). this one is a lil cutie: it's the function that looks at two communicators and tells you "are you two literally the same, or just twins, or cousins, or strangers?" π«Ά
β¨ NAME β¨
MPI_Comm_compare β compares two communicators. that's it. that's the whole job. π
πΈ SYNTAX πΈ
π C Syntax
#include <mpi.h>
int MPI_Comm_compare(MPI_Comm comm1, MPI_Comm comm2, int *result)
π Fortran Syntax
USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_COMM_COMPARE(COMM1, COMM2, RESULT, IERROR)
INTEGER COMM1, COMM2, RESULT, IERROR
π Fortran 2008 Syntax
USE mpi_f08
MPI_Comm_compare(comm1, comm2, result, ierror)
TYPE(MPI_Comm), INTENT(IN) :: comm1, comm2
INTEGER, INTENT(OUT) :: result
INTEGER, OPTIONAL, INTENT(OUT) :: ierror
π¦ INPUT PARAMETERS π¦
comm1β Comm1 (handle). one of the two communicators in the lineup πββοΈcomm2β Comm2 (handle). the other one. the vibes are about to be compared β¨
π OUTPUT PARAMETERS π
resultβ Result of comparison (integer). this is where the verdict lands, and it's gonna be one of the four constants below πierrorβ Fortran only: Error status (integer).
π DESCRIPTION π
okay so here's the tea. MPI_Comm_compare hands you back one of four answers, and each one means something very specific. no cap.
MPI_IDENTresults if and only ifcomm1andcomm2are handles for the same object (identical groups and same contexts). like, actually the same communicator. not twins β the same person. πMPI_CONGRUENTresults if the underlying groups are identical in constituents and rank order; these communicators differ only by context. same squad, same order, different group chat. π«ΆMPI_SIMILARresults if the group members of both communicators are the same but the rank order differs. same people, swapped seats. iconic chaos energy. πMPI_UNEQUALresults otherwise. yeah. we don't know each other like that. π
π₯ ERRORS π₯
ngl bestie, the error section is long but it's important, so we're doing all of it. no skimming. β
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. dramatic, but on purpose π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, acts as ifMPI_Abortwas 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. polite. respectful. we love her. π«Ά
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. like, read that again. fr fr.
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!! πβ¨ this was MPI_COMM_COMPARE(3) from the Open MPI crew, dated Sep 10, 2026. go compare some communicators, you absolute main character. ππ¦ periodt.
π¦ where this page comes from
- ubuntu stonking: openmpi-doc 5.0.10-6 Β· other
- π girlified by deepseek-ai/DeepSeek-V4.1-Flash on : a language model's rewrite of the original, under its terms