mpi_get_count(3openmpi) [osx man page]

MPI_Get_count(3OpenMPI) 												   MPI_Get_count(3OpenMPI)

NAME

       MPI_Get_count  - Gets the number of top-level elements received.

SYNTAX

C Syntax
       #include <mpi.h>
       int MPI_Get_count(MPI_Status *status, MPI_Datatype datatype,
	    int *count)

Fortran Syntax
       INCLUDE 'mpif.h'
       MPI_GET_COUNT(STATUS, DATATYPE, COUNT, IERROR)
	    INTEGER   STATUS(MPI_STATUS_SIZE), DATATYPE, COUNT, IERROR

C++ Syntax
       #include <mpi.h>
       int Status::Get_count(const Datatype& datatype) const

INPUT PARAMETERS

       status	 Return status of receive operation (status).

       datatype  Datatype of each receive buffer element (handle).

OUTPUT PARAMETERS

       count	 Number of received elements (integer).

       IERROR	 Fortran only: Error status (integer).

DESCRIPTION

       Returns	the number of entries received. (We count entries, each of type datatype, not bytes.) The datatype argument should match the argu-
       ment provided by the receive call that set the status variable. (As explained in Section 3.12.5 in the  MPI-1  Standard,  "Use  of  General
       Datatypes in Communication," MPI_Get_count may, in certain situations, return the value MPI_UNDEFINED.)

       The  datatype  argument	is passed to MPI_Get_count to improve performance. A message might be received without counting the number of ele-
       ments it contains, and the count value is often not needed. Also, this allows the same function to be used after a call to MPI_Probe.

NOTES

       If the size of the datatype is zero, this routine will return a count of zero.  If the amount of data in status is not an exact multiple of
       the size of datatype (so that count would not be integral), a count of MPI_UNDEFINED is returned instead.

ERRORS

       Almost all MPI routines return an error value; C routines as the value of the function and Fortran routines in the last argument. C++ func-
       tions 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.

       Before  the error value is returned, the current MPI error handler is called. 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.

SEE ALSO

       MPI_Get_elements

Open MPI 1.2							  September 2006					   MPI_Get_count(3OpenMPI)

Check Out this Related Man Page

MPI_Get_count(3)							MPI							  MPI_Get_count(3)

NAME

       MPI_Get_count -	Gets the number of "top level" elements

SYNOPSIS

       int MPI_Get_count( MPI_Status *status,  MPI_Datatype datatype, int *count )

INPUT PARAMETERS

       status - return status of receive operation (Status)
       datatype
	      - datatype of each receive buffer element (handle)

OUTPUT PARAMETER

       count  -  number  of  received elements (integer) Notes: If the size of the datatype is zero, this routine will return a count of zero.	If
	      the amount of data in status is not an exact multiple of the size of datatype (so that count would not  be  integral),  a  count	of
	      MPI_UNDEFINED is returned instead.

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.
       MPI_ERR_TYPE
	      - Invalid datatype argument.  May be an uncommitted MPI_Datatype (see MPI_Type_commit ).

LOCATION

       get_count.c

								     7/30/2010							  MPI_Get_count(3)

Linux and UNIX Man Pages

mpi_get_count(3openmpi) [osx man page]

Check Out this Related Man Page