mpi_file_get_type_extent(3openmpi) [osx man page]

MPI_File_get_type_extent(3OpenMPI)										MPI_File_get_type_extent(3OpenMPI)

NAME

       MPI_File_get_type_extent - Returns the extent of the data type in a file.

SYNTAX

       C Syntax
	   #include <mpi.h>
	   int MPI_File_get_type_extent(MPI_File fh, MPI_Datatype
		  datatype, MPI_Aint *extent)

       Fortran Syntax (see FORTRAN 77 NOTES)
	   INCLUDE 'mpif.h'
	   MPI_FILE_GET_TYPE_EXTENT(FH, DATATYPE, EXTENT,  IERROR)
		 INTEGER   FH, DATATYPE, IERROR
		 INTEGER(KIND=MPI_ADDRESS_KIND) EXTENT

C++ Syntax
       #include <mpi.h>
       MPI::Aint MPI::File::Get_type_extent(const MPI::Datatype&
	    datatype) const

INPUT PARAMETERS

       fh	 File handle (handle).

       datatype  Data type (handle).

OUTPUT PARAMETERS

       extent	 Data type extent (integer).

       IERROR	 Fortran only: Error status (integer).

DESCRIPTION

       MPI_File_get_type_extent  can  be used to calculate extent for datatype in the file. The extent is the same for all processes accessing the
       file  associated  with  fh.  If	the  current  view  uses  a  user-defined   data   representation,   MPI_File_get_type_extent	uses   the
       dtype_file_extent_fn callback to calculate the extent.

FORTRAN 77 NOTES
       The  MPI standard prescribes portable Fortran syntax for the EXTENT argument only for Fortran 90. FORTRAN 77 users may use the non-portable
       syntax

	    INTEGER*MPI_ADDRESS_KIND EXTENT

       where MPI_ADDRESS_KIND is a constant defined in mpif.h and gives the length of the declared integer in bytes.

NOTES

       If the file data representation is other than "native," care must be taken in constructing etypes and file types. Any of the data-type con-
       structor  functions  may  be  used; however, for those functions that accept displacements in bytes, the displacements must be specified in
       terms of their values in the file for the file data representation being used. MPI will interpret these byte displacements as is; no  scal-
       ing  will  be  done.  The  function MPI_File_get_type_extent can be used to calculate the extents of data types in the file. For etypes and
       file types that are portable data types, MPI will scale any displacements in the data types to match the  file  data  representation.  Data
       types  passed  as arguments to read/write routines specify the data layout in memory; therefore, they must always be constructed using dis-
       placements corresponding to displacements in memory.

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. For MPI I/O function errors, the default error handler is  set
       to  MPI_ERRORS_RETURN. The error handler may be changed with MPI_File_set_errhandler; the predefined error handler MPI_ERRORS_ARE_FATAL may
       be used to make I/O errors fatal. Note that MPI does not guarantee that an MPI program can continue past an error.

Open MPI 1.2							  September 2006				MPI_File_get_type_extent(3OpenMPI)

Check Out this Related Man Page

MPI_Type_set_attr(3OpenMPI)											       MPI_Type_set_attr(3OpenMPI)

NAME

       MPI_Type_set_attr - Sets a key value/attribute pair to a data type.

SYNTAX

C Syntax
       #include <mpi.h>
       int MPI_Type_set_attr(MPI_Datatype type, int type_keyval,
	    void *attribute_val)

Fortran Syntax (see FORTRAN 77 NOTES)
       INCLUDE 'mpif.h'
       MPI_TYPE_SET_ATTR(TYPE, TYPE_KEYVAL, ATTRIBUTE_VAL, IERROR)
	    INTEGER   TYPE, TYPE_KEYVAL, IERROR
	    INTEGER(KIND=MPI_ADDRESS_KIND) ATTRIBUTE_VAL

C++ Syntax
       #include <mpi.h>
       void MPI::Datatype::Set_attr(int type_keyval, const void* attribute_val)

INPUT
/OUTPUT PARAMETER
       type	 Data type to which attribute will be attached (handle).

INPUT PARAMETERS

       type_keyval
		 Key value (integer).

       attribute_val
		 Attribute value.

OUTPUT PARAMETER

       IERROR	 Fortran only: Error status (integer).

DESCRIPTION

       For the given data type, MPI_Type_set_attr sets the key value to the value of the specified attribute.

FORTRAN 77 NOTES
       The  MPI  standard prescribes portable Fortran syntax for the ATTRIBUTE_VAL argument only for Fortran 90. FORTRAN 77 users may use the non-
       portable syntax

	    INTEGER*MPI_ADDRESS_KIND ATTRIBUTE_VAL

       where MPI_ADDRESS_KIND is a constant defined in mpif.h and gives the length of the declared integer in bytes.

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_Type_get_attr

Open MPI 1.2							  September 2006				       MPI_Type_set_attr(3OpenMPI)

Linux and UNIX Man Pages

mpi_file_get_type_extent(3openmpi) [osx man page]

Check Out this Related Man Page