source: proiecte/hpl/openmpi_compiled/share/man/man3/MPI_Group_size.3 @ 97

Last change on this file since 97 was 97, checked in by (none), 14 years ago

Adding compiled files

File size: 1.6 KB
Line 
1.\"Copyright 2006-2008 Sun Microsystems, Inc.
2.\" Copyright (c) 1996 Thinking Machines Corporation
3.TH MPI_Group_size 3 "Dec 08, 2009" "1.4" "Open MPI"
4.SH NAME
5\fBMPI_Group_size\fP \- Returns the size of a group.
6
7.SH SYNTAX
8.ft R
9.SH C Syntax
10.nf
11#include <mpi.h>
12int MPI_Group_size(MPI_Group \fIgroup\fP, int \fI*size\fP)
13
14.SH Fortran Syntax
15.nf
16INCLUDE 'mpif.h'
17MPI_GROUP_SIZE(\fIGROUP, SIZE, IERROR\fP)
18        INTEGER \fIGROUP, SIZE, IERROR\fP
19
20.SH C++ Syntax
21.nf
22#include <mpi.h>
23int Group::Get_size() const
24
25.SH INPUT PARAMETERS
26.ft R
27.TP 1i
28group
29Group (handle).
30
31.SH OUTPUT PARAMETERS
32.ft R
33.TP 1i
34size
35Number of processes in the group (integer).
36.ft R
37.TP 1i
38IERROR
39Fortran only: Error status (integer).
40
41.SH DESCRIPTION
42.ft R
43MPI_Group_size returns in \fIsize\fP the number of processes in the group. Thus, if group = MPI_GROUP_EMPTY, then the call will return size = 0. On the other hand, a call with group = MPI_GROUP_NULL is erroneous.
44
45.SH ERRORS
46Almost all MPI routines return an error value; C routines as the value of the function and Fortran routines in the last argument. C++ functions do not return errors. If the default error handler is set to MPI::ERRORS_THROW_EXCEPTIONS, then on error the C++ exception mechanism will be used to throw an MPI:Exception object.
47.sp
48Before the error value is returned, the current MPI error handler is
49called. By default, this error handler aborts the MPI job, except for I/O function errors. The error handler may be changed with MPI_Comm_set_errhandler; 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. 
50
Note: See TracBrowser for help on using the repository browser.