MPI_Group_intersection(3)

1MPI_Group_intersection(3)           LAM/MPI          MPI_Group_intersection(3)
2
3
4

NAME

6       MPI_Group_intersection  -   Produces a group as the intersection of two
7       existing groups
8

SYNOPSIS

10       #include <mpi.h>
11       int MPI_Group_intersection(MPI_Group g1, MPI_Group g2,
12                                MPI_Group *pgi)
13

INPUT PARAMETERS

15       g1     - first group (handle)
16       g2     - second group (handle)
17
18

OUTPUT PARAMETER

20       pgi    - intersection group (handle)
21
22

NOTES

24       When a group  is  no  longer  being  used,  it  should  be  freed  with
25       MPI_Group_free .
26
27
28

NOTES FOR FORTRAN

30       All  MPI routines in Fortran (except for MPI_WTIME and MPI_WTICK ) have
31       an additional argument ierr at the end of the argument list.   ierr  is
32       an  integer and has the same meaning as the return value of the routine
33       in C.  In Fortran, MPI routines are subroutines, and are  invoked  with
34       the call statement.
35
36       All MPI objects (e.g., MPI_Datatype , MPI_Comm ) are of type INTEGER in
37       Fortran.
38
39

ERRORS

41       If an error occurs in an MPI function, the current MPI error handler is
42       called  to  handle  it.   By default, this error handler aborts the MPI
43       job.  The error handler may be changed with  MPI_Errhandler_set  ;  the
44       predefined  error  handler MPI_ERRORS_RETURN may be used to cause error
45       values to be returned (in C and Fortran; this  error  handler  is  less
46       useful  in  with  the  C++  MPI bindings.  The predefined error handler
47       MPI::ERRORS_THROW_EXCEPTIONS should be used in C++ if the  error  value
48       needs  to  be recovered).  Note that MPI does not guarantee that an MPI
49       program can continue past an error.
50
51       All MPI routines (except MPI_Wtime and  MPI_Wtick  )  return  an  error
52       value;  C routines as the value of the function and Fortran routines in
53       the last argument.  The C++ bindings for MPI do not return  error  val‐
54       ues;  instead,  error values are communicated by throwing exceptions of
55       type MPI::Exception (but not by default).  Exceptions are  only  thrown
56       if the error value is not MPI::SUCCESS .
57
58
59       Note  that  if  the MPI::ERRORS_RETURN handler is set in C++, while MPI
60       functions will return upon an error, there will be no  way  to  recover
61       what the actual error value was.
62       MPI_SUCCESS
63              - No error; MPI routine completed successfully.
64       MPI_ERR_GROUP
65              - Null group passed to function.
66       MPI_ERR_OTHER
67              - This error is returned when some part of the LAM/MPI implemen‐
68              tation is unable to acquire memory.
69       MPI_ERR_ARG
70              - Invalid argument.  Some argument is invalid and is not identi‐
71              fied  by  a  specific  error  class.   This  is typically a NULL
72              pointer or other such error.
73
74

MORE INFORMATION

80       For more information, please see the official MPI Forum web site, which
81       contains  the  text of both the MPI-1 and MPI-2 standards.  These docu‐
82       ments contain detailed information about each  MPI  function  (most  of
83       which is not duplicated in these man pages).
84
85       http://www.mpi-forum.org/
86
87
88

ACKNOWLEDGEMENTS

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

LOCATION

96       ginter.c
97
98
99
100LAM/MPI 7.1.2                      2/23/2006         MPI_Group_intersection(3)