Man page - mpi_type_get_value_index(3)

Packages contains this manual

Package:  mpich-doc
apt-get install mpich-doc

Documentations in package:
• mpich-doc
• mpich

Manual

MPI_Type_get_value_index

NAME
SYNOPSIS
INPUT PARAMETERS
OUTPUT PARAMETERS
THREAD AND INTERRUPT SAFETY
NOTES FOR FORTRAN
ERRORS

---

NAME

MPI_Type_get_value_index - returns a handle to a predefined datatype suitable for the use with MPI_MINLOC and MPI_MAXLOC if such a predefined type exists

SYNOPSIS

int MPI_Type_get_value_index(MPI_Datatype value_type, MPI_Datatype index_type,
MPI_Datatype *pair_type)

INPUT PARAMETERS

value_type

- datatype of the value in pair (handle)

index_type

- datatype of the index in pair (handle)

OUTPUT PARAMETERS

pair_type

- datatype of the value-index pair (handle)

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 guarantee 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_ARG

- Invalid argument. Some argument is invalid and is not identified by a specific error class (e.g., MPI_ERR_RANK ).

MPI_ERR_TYPE

- Invalid datatype argument. Additionally, this error can occur if an uncommitted MPI_Datatype (see MPI_Type_commit ) is used in a communication call.

MPI_ERR_OTHER

- Other error; use MPI_Error_string to get more information about this error code.

---