mpi_group_translate_ranks(3) [debian man page]

MPI_Group_translate_ranks(3)						MPI					      MPI_Group_translate_ranks(3)

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, 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

       group2 - group2 (handle)

OUTPUT PARAMETER

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

	      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 guarentee 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.

LOCATION

       group_translate_ranks.c

								     5/25/2011					      MPI_Group_translate_ranks(3)

MPI_Group_translate_ranks(3)					      LAM/MPI					      MPI_Group_translate_ranks(3)

NAME

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

SYNOPSIS

       #include <mpi.h>
       int MPI_Group_translate_ranks(MPI_Group g1, int n,
		int *r1, MPI_Group g2, int *r2)

INPUT PARAMETERS

       g1     - group1 (handle)
       n      - number of ranks in r1 and r2 arrays (integer)
       r1     - array of zero or more valid ranks in g1

       g2     - group2 (handle)

OUTPUT PARAMETER

       r2     - array of corresponding ranks in g2 , MPI_UNDEFINED when no correspondence exists.

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

       If an error occurs in an MPI function, the current MPI error handler is called to handle it.  By default, this error handler aborts the MPI
       job.  The error handler may be changed with MPI_Errhandler_set ; the predefined error handler MPI_ERRORS_RETURN may be used to cause  error
       values  to  be  returned  (in  C and Fortran; this error handler is less useful in with the C++ MPI bindings.  The predefined error handler
       MPI::ERRORS_THROW_EXCEPTIONS should be used in C++ if the error value needs to be recovered).  Note that MPI does not guarantee that an MPI
       program can continue past an error.

       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.  The C++ bindings for MPI do not return error values; instead, error values are communicated by throwing  exceptions	of
       type MPI::Exception (but not by default).  Exceptions are only thrown if the error value is not MPI::SUCCESS
	.

       Note  that  if the MPI::ERRORS_RETURN handler is set in C++, while MPI functions will return upon an error, there will be no way to recover
       what the actual error value was.
       MPI_SUCCESS
	      - No error; MPI routine completed successfully.
       MPI_ERR_GROUP
	      - Null group passed to function.
       MPI_ERR_ARG
	      - Invalid argument.  Some argument is invalid and is not identified by a specific error class.  This is typically a NULL pointer	or
	      other such error.
       MPI_ERR_RANK
	      -  Invalid  source or destination rank.  Ranks must be between zero and the size of the communicator minus one; ranks in a receive (
	      MPI_Recv , MPI_Irecv , MPI_Sendrecv , etc.) may also be MPI_ANY_SOURCE
	       .

MORE INFORMATION

       For more information, please see the official MPI Forum web site, which contains the text of both the MPI-1  and  MPI-2	standards.   These
       documents contain detailed information about each MPI function (most of which is not duplicated in these man pages).

       http://www.mpi-forum.org/

ACKNOWLEDGEMENTS

       The LAM Team would like the thank the MPICH Team for the handy program to generate man pages ("doctext" from ftp://ftp.mcs.anl.gov/pub/sow-
       ing/sowing.tar.gz ), the initial formatting, and some initial text for most of the MPI-1 man pages.

LOCATION

       gtranks.c

LAM
/MPI 6.5.8							    11/10/2002					      MPI_Group_translate_ranks(3)