Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
MPI_Sizeof(3)			   Open	MPI			 MPI_Sizeof(3)

NAME
       MPI_Sizeof - Returns the	size, in bytes,	of the given type

SYNTAX
Fortran	Syntax
       USE MPI
       ! or the	older form: INCLUDE 'mpif.h'
       MPI_SIZEOF(X, SIZE, IERROR)
       <type>	 X
       INTEGER	 SIZE, IERROR

INPUT PARAMETER
       X	 A Fortran variable of numeric intrinsic type (choice).

OUTPUT PARAMETERS
       SIZE	 Size of machine representation	of that	type (integer).

       IERROR	 Error status (integer).

DESCRIPTION
       MPI_SIZEOF returns the size (in bytes) of the machine representation of
       the given variable. It is a generic Fortran  type  and  has  a  Fortran
       binding	only.  This routine is similar to the sizeof builtin in	C/C++.
       However,	if given an array argument, it returns the size	 of  the  base
       element,	not the	size of	the whole array.

NOTES
       This function is	not available in C/C++ because it is not necessary.

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 the MPI man page for	a full list of MPI error codes.

3.1.6				 Mar 18, 2020			 MPI_Sizeof(3)

NAME | SYNTAX | Fortran Syntax | INPUT PARAMETER | OUTPUT PARAMETERS | DESCRIPTION | NOTES | ERRORS

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=MPI_Sizeof&sektion=3&manpath=FreeBSD+12.1-RELEASE+and+Ports>

home | help