Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

mpi_type_get_attr(3) [debian man page]

MPI_Type_get_attr(3)							MPI						      MPI_Type_get_attr(3)

NAME

       MPI_Type_get_attr -  Retrieves attribute value by key

SYNOPSIS

       int MPI_Type_get_attr(MPI_Datatype type, int type_keyval, void *attribute_val,
			    int *flag)

INPUT PARAMETERS

       type   - datatype to which the attribute is attached (handle)
       type_keyval
	      - key value (integer)

OUTPUT PARAMETERS

       attribute_val
	      - attribute value, unless flag = false
       flag   - false if no attribute is associated with the key (logical)

NOTES

       Attributes  must  be  extracted from the same language as they were inserted in with MPI_Type_set_attr .  The notes for C and Fortran below
       explain why.

NOTES FOR C

       Even though the attr_value arguement is declared as void * , it is really the address of a void pointer.  See the rationale in the standard
       for more details.

THREAD AND INTERRUPT SAFETY

       This  routine  is  thread-safe.	This means that this routine may be safely used by multiple threads without the need for any user-provided
       thread locks.  However, the routine is not interrupt safe.  Typically, this is due to the use of memory allocation routines such as  malloc
       or other non-MPICH runtime routines that are themselves not interrupt-safe.

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_KEYVAL
	      - Invalid keyval
       MPI_ERR_ARG
	      - Invalid argument.  Some argument is invalid and is not identified by a specific error class (e.g., MPI_ERR_RANK ).

LOCATION

       type_get_attr.c

								     7/27/2010						      MPI_Type_get_attr(3)

Check Out this Related Man Page

MPI_Type_set_attr(3)							MPI						      MPI_Type_set_attr(3)

NAME

       MPI_Type_set_attr -  Stores attribute value associated with a key

SYNOPSIS

       int MPI_Type_set_attr(MPI_Datatype type, int type_keyval, void *attribute_val)

INPUT PARAMETERS

       type   - MPI Datatype to which attribute will be attached (handle)
       keyval - key value, as returned by MPI_Type_create_keyval (integer)
       attribute_val
	      - attribute value

NOTES

       The  type  of the attribute value depends on whether C or Fortran is being used.  In C, an attribute value is a pointer ( void * ); in For-
       tran, it is an address-sized integer.

       If an attribute is already present, the delete function (specified when the corresponding keyval was created) will be called.

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 ).
       MPI_ERR_KEYVAL
	      - Invalid keyval

LOCATION

       type_set_attr.c

								     5/20/2010						      MPI_Type_set_attr(3)
Man Page