3.2. Naming Conventions

PreviousUpNext
Up: MPI Terms and Conventions Next: Procedure Specification Previous: Document Notation

In many cases MPI names for C functions are of the form MPI_Class_action_subset. This convention originated with MPI-1. Since MPI-2 an attempt has been made to standardize the names of MPI functions according to the following rules.

    1. In C and the Fortran mpi_f08 module, all routines associated with a particular type of MPI object should be of the form MPI_Class_action_subset or, if no subset exists, of the form MPI_Class_action. In the Fortran mpi module and (deprecated) mpif.h file, all routines associated with a particular type of MPI object should be of the form MPI_CLASS_ACTION_SUBSET or, if no subset exists, of the form MPI_CLASS_ACTION.


    2. If the routine is not associated with a class, the name should be of the form MPI_Action_subset or MPI_ACTION_SUBSET in C and Fortran.


    3. The names of certain actions have been standardized. In particular, create creates a new object, get retrieves information about an object, set sets this information, delete deletes information, is asks whether or not an object has a certain property.

C and Fortran names for some MPI functions (that were defined during the MPI-1 process) violate these rules in several cases. The most common exceptions are the omission of the Class name from the routine and the omission of the Action where one can be inferred.


PreviousUpNext
Up: MPI Terms and Conventions Next: Procedure Specification Previous: Document Notation


Return to MPI-4.1 Standard Index
Return to MPI Forum Home Page

(Unofficial) MPI-4.1 of November 2, 2023
HTML Generated on November 19, 2023