Provided by: mpich-doc_4.2.0-5build3_all bug

NAME

       MPI_Group_translate_ranks -  Translates the ranks of processes in one group to those in another group

SYNOPSIS

       int MPI_Group_translate_ranks(MPI_Group group1, int n, const int ranks1[],
       MPI_Group group2, int ranks2[])

INPUT PARAMETERS

       group1 - group1 (handle)
       n      - number of ranks in ranks1 and ranks2 arrays (integer)
       ranks1 - array of zero or more valid ranks in group1 (integer)
       group2 - group2 (handle)

OUTPUT PARAMETERS

       ranks2 - array of corresponding ranks in group2, MPI_UNDEFINED when no correspondence exists. (integer)

              As  a  special  case (see the MPI-2 errata), if the input rank is MPI_PROC_NULL , MPI_PROC_NULL is
              given as the output rank.

THREAD AND INTERRUPT SAFETY

       This routine is thread-safe.  This means that this routine may be safely used by multiple threads without
       the  need  for  any  user-provided thread locks.  However, the routine is not interrupt safe.  Typically,
       this is due to the use of memory allocation routines such as malloc or other non-MPICH  runtime  routines
       that are themselves not interrupt-safe.

NOTES FOR FORTRAN

       All MPI routines in Fortran (except for MPI_WTIME and MPI_WTICK ) have an additional argument ierr at the
       end of the argument list.  ierr is an integer and has the same meaning as the return value of the routine
       in C.  In Fortran, MPI routines are subroutines, and are invoked with the call statement.

       All MPI objects (e.g., MPI_Datatype , MPI_Comm ) are of type INTEGER in Fortran.

ERRORS

       All  MPI routines (except MPI_Wtime and MPI_Wtick ) return an error value; C routines as the value of the
       function and Fortran routines in the last argument.  Before the value is returned, the current MPI  error
       handler  is called.  By default, this error handler aborts the MPI job.  The error handler may be changed
       with   MPI_Comm_set_errhandler   (for   communicators),   MPI_File_set_errhandler   (for   files),    and
       MPI_Win_set_errhandler  (for  RMA windows).  The MPI-1 routine MPI_Errhandler_set may be used but its use
       is deprecated.  The predefined error handler MPI_ERRORS_RETURN may be used to cause error  values  to  be
       returned.   Note that MPI does not guarantee that an MPI program can continue past an error; however, MPI
       implementations will attempt to continue whenever possible.

       MPI_SUCCESS
              - No error; MPI routine completed successfully.
       MPI_ERR_ARG
              - Invalid argument.  Some argument is invalid and is not identified  by  a  specific  error  class
              (e.g., MPI_ERR_RANK ).
       MPI_ERR_GROUP
              - Null or invalid group passed to function.
       MPI_ERR_OTHER
              - Other error; use MPI_Error_string to get more information about this error code.

                                                    2/9/2024                        MPI_Group_translate_ranks(3)