IBM Books

MPI Programming Guide


Appendix C. MPI subroutine and function summary

Table 16 lists the MPI subroutines and functions

that are available for parallel programming. For descriptions of these subroutines and functions, see IBM Parallel Environment for AIX: MPI Subroutine Reference.

Table 16. MPI subroutines and functions

Subroutine or function name:
C
C++
FORTRAN
Type Description
MPI_Abort
MPI::Comm::Abort
MPI_ABORT
Environment management Forces all tasks of an MPI job to terminate.
MPI_Accumulate
MPI::Win::Accumulate
MPI_ACCUMULATE
One-sided communication Accumulates, according to the specified reduction operation, the contents of the origin buffer to the specified target buffer.
MPI_Add_error_class
MPI::Add_error_class
MPI_ADD_ERROR_CLASS
External interface Creates a new error class and returns the value for it.
MPI_Add_error_code
MPI::Add_error_code
MPI_ADD_ERROR_CODE
External interface Creates a new error code and returns the value for it.
MPI_Add_error_string
MPI::Add_error_string
MPI_ADD_ERROR_STRING
External interface Associates an error string with an error code or class.
MPI_Address
(none)
MPI_ADDRESS
Derived datatype Returns the address of a location in memory.
MPI_Allgather
MPI::Comm::Allgather
MPI_ALLGATHER
Collective communication Collects messages from each task and distributes the resulting message to each.
MPI_Allgatherv
MPI::Comm::Allgatherv
MPI_ALLGATHERV
Collective communication Collects messages from each task and distributes the resulting message to all tasks. Messages can have variable sizes and displacements.
MPI_Alloc_mem
MPI::Alloc_mem
MPI_ALLOC_MEM
Memory allocation Allocates storage and returns a pointer to it.
MPI_Allreduce
MPI::Comm::Allreduce
MPI_ALLREDUCE
Collective communication Applies a reduction operation.
MPI_Alltoall
MPI::Comm::Alltoall
MPI_ALLTOALL
Collective communication Sends a distinct message from each task to every task.
MPI_Alltoallv
MPI::Comm::Alltoallv
MPI_ALLTOALLV
Collective communication Sends a distinct message from each task to every task. Messages can have different sizes and displacements.
MPI_Alltoallw
MPI::Comm::Alltoallw
MPI_ALLTOALLW
Collective communication Sends a distinct message from each task to every task. Messages can have different datatypes, sizes, and displacements.
MPI_Attr_delete
(none)
MPI_ATTR_DELETE
Communicator Removes an attribute value from a communicator.
MPI_Attr_get
(none)
MPI_ATTR_GET
Communicator Retrieves an attribute value from a communicator.
MPI_Attr_put
(none)
MPI_ATTR_PUT
Communicator Associates an attribute value with a communicator.
MPI_Barrier
MPI::Comm::Barrier
MPI_BARRIER
Collective communication Blocks each task until all tasks have called it.
MPI_Bcast
MPI::Comm::Bcast
MPI_BCAST
Collective communication Broadcasts a message from root to all tasks in the group.
MPI_Bsend
MPI::Comm::Bsend
MPI_BSEND
Point-to-point communication Performs a blocking buffered mode send operation.
MPI_Bsend_init
MPI::Comm::Bsend_init
MPI_BSEND_INIT
Point-to-point communication Creates a persistent buffered mode send request.
MPI_Buffer_attach
MPI::Attach_buffer
MPI_BUFFER_ATTACH
Point-to-point communication Provides MPI with a message buffer for sending.
MPI_Buffer_detach
MPI::Detach_buffer
MPI_BUFFER_DETACH
Point-to-point communication Detaches the current buffer.
MPI_Cancel
MPI::Request::Cancel
MPI_CANCEL
Point-to-point communication Marks a nonblocking operation for cancellation.
MPI_Cart_coords
MPI::Cartcomm::Get_coords
MPI_CART_COORDS
Topology Translates task rank in a communicator into cartesian task coordinates.
MPI_Cart_create
MPI::Intracomm::Create_cart
MPI_CART_CREATE
Topology Creates a communicator containing topology information.
MPI_Cart_get
MPI::Cartcomm::Get_topo
MPI_CART_GET
Topology Retrieves cartesian topology information from a communicator.
MPI_Cart_map
MPI::Cartcomm::Map
MPI_CART_MAP
Topology Computes placement of tasks on the physical processor.
MPI_Cart_rank
MPI::Cartcomm::Get_cart_rank
MPI_CART_RANK
Topology Translates task coordinates into a task rank.
MPI_Cart_shift
MPI::Cartcomm::Shift
MPI_CART_SHIFT
Topology Returns shifted source and destination ranks for a task.
MPI_Cart_sub
MPI::Cartcomm::Sub
MPI_CART_SUB
Topology Partitions a cartesian communicator into lower-dimensional subgroups.
MPI_Cartdim_get
MPI::Cartcomm::Get_dim
MPI_CARTDIM_GET
Topology Retrieves the number of cartesian dimensions from a communicator.
MPI_Comm_c2f
(none)
(none)
Conversion function Translates a C communicator handle into a FORTRAN handle to the same communicator.
MPI_Comm_call_errhandler
MPI::Comm::Call_errhandler
MPI_COMM_CALL_ERRHANDLER
External interface Calls the error handler assigned to the communicator with the error code supplied.
(none)
MPI::Comm::Clone
(MPI::Cartcomm::Clone,
MPI::Graphcomm::Clone,
MPI::Intercomm::Clone,
MPI::Intracomm::Clone)
(none)
Communicator Creates a new communicator that is a duplicate of an existing communicator.
MPI_Comm_compare
MPI::Comm::Compare
MPI_COMM_COMPARE
Communicator Compares the groups and contexts of two communicators.
MPI_Comm_create
MPI::Intercomm::Create,
MPI::Intracomm::Create
MPI_COMM_CREATE
Communicator Creates a new communicator with a given group.
MPI_Comm_create_errhandler
MPI::Comm::Create_errhandler
MPI_COMM_CREATE_ERRHANDLER
Communicator Creates an error handler that can be attached to communicators.
MPI_Comm_create_keyval
MPI::Comm::Create_keyval
MPI_COMM_CREATE_KEYVAL
Communicator Generates a new communicator attribute key.
MPI_Comm_delete_attr
MPI::Comm::Delete_attr
MPI_COMM_DELETE_ATTR
Communicator Removes an attribute value from a communicator.
MPI_Comm_dup
MPI::Cartcomm::Dup,
MPI::Graphcomm::Dup,
MPI::Intercomm::Dup,
MPI::Intracomm::Dup
MPI_COMM_DUP
Communicator Creates a new communicator that is a duplicate of an existing communicator.
MPI_Comm_f2c
(none)
(none)
Conversion function Returns a C handle to a communicator.
MPI_Comm_free
MPI::Comm::Free
MPI_COMM_FREE
Communicator Marks a communicator for deallocation.
MPI_Comm_free_keyval
MPI::Comm::Free_keyval
MPI_COMM_FREE_KEYVAL
Communicator Marks a communicator attribute key for deallocation.
MPI_Comm_get_attr
MPI::Comm::Get_attr
MPI_COMM_GET_ATTR
Communicator Retrieves the communicator attribute value identified by the key.
MPI_Comm_get_errhandler
MPI::Comm::Get_errhandler
MPI_COMM_GET_ERRHANDLER
Communicator Retrieves the error handler currently associated with a communicator.
MPI_Comm_get_name
MPI::Comm::Get_name
MPI_COMM_GET_NAME
External interface Returns the name that was last associated with a communicator.
MPI_Comm_group
MPI::Comm::Get_group
MPI_COMM_GROUP
Group management Returns the group handle associated with a communicator.
MPI_Comm_rank
MPI::Comm::Get_rank
MPI_COMM_RANK
Communicator Returns the rank of the local task in the group associated with a communicator.
MPI_Comm_remote_group
MPI::Intercomm::Get_remote_group
MPI_COMM_REMOTE_GROUP
Communicator Returns the handle of the remote group of an intercommunicator.
MPI_Comm_remote_size
MPI::Intercomm::Get_remote_size
MPI_COMM_REMOTE_SIZE
Communicator Returns the size of the remote group of an intercommunicator.
MPI_Comm_set_attr
MPI::Comm::Set_attr
MPI_COMM_SET_ATTR
Communicator Attaches the communicator attribute value to the communicator and associates it with the key.
MPI_Comm_set_errhandler
MPI::Comm::Set_errhandler
MPI_COMM_SET_ERRHANDLER
Communicator Attaches a new error handler to a communicator.
MPI_Comm_set_name
MPI::Comm::Set_name
MPI_COMM_SET_NAME
External interface Associates a name string with a communicator.
MPI_Comm_size
MPI::Comm::Get_size
MPI_COMM_SIZE
Communicator Returns the size of the group associated with a communicator.
MPI_Comm_split
MPI::Intercomm::Split, MPI::Intracomm::Split
MPI_COMM_SPLIT
Communicator Splits a communicator into multiple communicators based on color and key.
MPI_Comm_test_inter
MPI::Comm::Is_inter
MPI_COMM_TEST_INTER
Communicator Returns the type of a communicator (intra- or inter-).
MPI_Dims_create
MPI::Compute_dims
MPI_DIMS_CREATE
Topology Defines a cartesian grid to balance tasks.
MPI_Errhandler_c2f
(none)
(none)
Conversion function Translates a C error handler into a FORTRAN handle to the same error handler.
MPI_Errhandler_create
(none)
MPI_ERRHANDLER_CREATE
Environment management Registers a user-defined error handler.
MPI_Errhandler_f2c
(none)
(none)
Conversion function Returns a C handle to an error handler.
MPI_Errhandler_free
MPI::Errhandler::Free
MPI_ERRHANDLER_FREE
Environment management Marks an error handler for deallocation.
MPI_Errhandler_get
(none)
MPI_ERRHANDLER_GET
Environment management Gets an error handler associated with a communicator.
MPI_Errhandler_set
(none)
MPI_ERRHANDLER_SET
Environment management Associates a new error handler with a communicator.
MPI_Error_class
MPI::Get_error_class
MPI_ERROR_CLASS
Environment management Returns the error class for the corresponding error code.
MPI_Error_string
MPI::Get_error_string
MPI_ERROR_STRING
Environment management Returns the error string for a given error code.
MPI_Exscan
MPI::Intracomm::Exscan
MPI_EXSCAN
Collective communication Performs a prefix reduction on data distributed across the group.
MPI_File_c2f
(none)
(none)
Conversion function Translates a C file handle into a FORTRAN handle to the same file.
MPI_File_call_errhandler
MPI::File::Call_errhandler
MPI_FILE_CALL_ERRHANDLER
External interface Calls the error handler assigned to the file with the error code supplied.
MPI_File_close
MPI::File::Close
MPI_FILE_CLOSE
MPI-IO Closes a file.
MPI_File_create_errhandler
MPI::File::Create_errhandler
MPI_FILE_CREATE_ERRHANDLER
Environment management Registers a user-defined error handler that you can associate with an open file.
MPI_File_delete
MPI::File::Delete
MPI_FILE_DELETE
MPI-IO Deletes a file after pending operations to the file complete.
MPI_File_f2c
(none)
(none)
Conversion function Returns a C handle to a file.
MPI_File_get_amode
MPI::File::Get_amode
MPI_FILE_GET_AMODE
MPI-IO Retrieves the access mode specified when the file was opened.
MPI_File_get_atomicity
MPI::File::Get_atomicity
MPI_FILE_GET_ATOMICITY
MPI-IO Retrieves the current atomicity mode in which the file is accessed.
MPI_File_get_byte_offset
MPI::File::Get_byte_offset
MPI_FILE_GET_BYTE_OFFSET
MPI-IO Allows conversion of an offset.
MPI_File_get_errhandler
MPI::File::Get_errhandler
MPI_FILE_GET_ERRHANDLER
Environment management Retrieves the error handler currently associated with a file handle.
MPI_File_get_group
MPI::File::Get_group
MPI_FILE_GET_GROUP
MPI-IO Retrieves the group of tasks that opened the file.
MPI_File_get_info
MPI::File::Get_info
MPI_FILE_GET_INFO
MPI-IO Returns a new info object identifying the hints associated with a file.
MPI_File_get_position
MPI::File::Get_position
MPI_FILE_GET_POSITION
MPI-IO Returns the current position of the individual file pointer relative to the current file view.
MPI_File_get_position_shared
MPI::File::Get_position_shared
MPI_FILE_GET_POSITION_SHARED
MPI-IO Returns the current position of the shared file pointer relative to the current file view.
MPI_File_get_size
MPI::File::Get_size
MPI_FILE_GET_SIZE
MPI-IO Retrieves the current file size.
MPI_File_get_type_extent
MPI::File::Get_type_extent
MPI_FILE_GET_TYPE_EXTENT
MPI-IO Retrieves the extent of a datatype.
MPI_File_get_view
MPI::File::Get_view
MPI_FILE_GET_VIEW
MPI-IO Retrieves the current file view.
MPI_File_iread
MPI::File::Iread
MPI_FILE_IREAD
MPI-IO Performs a nonblocking read operation.
MPI_File_iread_at
MPI::File::Iread_at
MPI_FILE_IREAD_AT
MPI-IO Performs a nonblocking read operation using an explicit offset.
MPI_File_iread_shared
MPI::File::Iread_shared
MPI_FILE_IREAD_SHARED
MPI-IO Performs a nonblocking read operation using the shared file pointer.
MPI_File_iwrite
MPI::File::Iwrite
MPI_FILE_IWRITE
MPI-IO Performs a nonblocking write operation.
MPI_File_iwrite_at
MPI::File::Iwrite_at
MPI_FILE_IWRITE_AT
MPI-IO Performs a nonblocking write operation using an explicit offset.
MPI_File_iwrite_shared
MPI::File::Iwrite_shared
MPI_FILE_IWRITE_SHARED
MPI-IO Performs a nonblocking write operation using the shared file pointer.
MPI_File_open
MPI::File::Open
MPI_FILE_OPEN
MPI-IO Opens a file.
MPI_File_preallocate
MPI::File::Preallocate
MPI_FILE_PREALLOCATE
MPI-IO Ensures that storage space is allocated for the first size bytes of the file associated with fh.
MPI_File_read
MPI::File::Read
MPI_FILE_READ
MPI-IO Reads from a file.
MPI_File_read_all
MPI::File::Read_all
MPI_FILE_READ_ALL
MPI-IO Reads from a file collectively.
MPI_File_read_all_begin
MPI::File::Read_all_begin
MPI_FILE_READ_ALL_BEGIN
MPI-IO Initiates a split collective read operation from a file.
MPI_File_read_all_end
MPI::File::Read_all_end
MPI_FILE_READ_ALL_END
MPI-IO Completes a split collective read operation from a file.
MPI_File_read_at
MPI::File::Read_at
MPI_FILE_READ_AT
MPI-IO Reads from a file using an explicit offset.
MPI_File_read_at_all
MPI::File::Read_at_all
MPI_FILE_READ_AT_ALL
MPI-IO Reads from a file collectively using an explicit offset.
MPI_File_read_at_all_begin
MPI::File::Read_at_all_begin
MPI_FILE_READ_AT_ALL_BEGIN
MPI-IO Initiates a split collective read operation from a file using an explicit offset.
MPI_File_read_at_all_end
MPI::File::Read_at_all_end
MPI_FILE_READ_AT_ALL_END
MPI-IO Completes a split collective read operation from a file using an explicit offset.
MPI_File_read_ordered
MPI::File::Read_ordered
MPI_FILE_READ_ORDERED
MPI-IO Reads from a file collectively using the shared file pointer.
MPI_File_read_ordered_begin
MPI::File::Read_ordered_begin
MPI_FILE_READ_ORDERED_BEGIN
MPI-IO Initiates a split collective read operation from a file using the shared file pointer.
MPI_File_read_ordered_end
MPI::File::Read_ordered_end
MPI_FILE_READ_ORDERED_END
MPI-IO Completes a split collective read operation from a file using the shared file pointer.
MPI_File_read_shared
MPI::File::Read_shared
MPI_FILE_READ_SHARED
MPI-IO Reads from a file using the shared file pointer.
MPI_File_seek
MPI::File::Seek
MPI_FILE_SEEK
MPI-IO Sets a file pointer.
MPI_File_seek_shared
MPI::File::Seek_shared
MPI_FILE_SEEK_SHARED
MPI-IO Sets a shared file pointer.
MPI_File_set_atomicity
MPI::File::Set_atomicity
MPI_FILE_SET_ATOMICITY
MPI-IO Modifies the current atomicity mode for an opened file.
MPI_File_set_errhandler
MPI::File::Set_errhandler
MPI_FILE_SET_ERRHANDLER
Environment management Associates a new error handler with a file.
MPI_File_set_info
MPI::File::Set_info
MPI_FILE_SET_INFO
MPI-IO Specifies new hints for an open file.
MPI_File_set_size
MPI::File::Set_size
MPI_FILE_SET_SIZE
MPI-IO Expands or truncates an open file.
MPI_File_set_view
MPI::File::Set_view
MPI_FILE_SET_VIEW
MPI-IO Associates a new view with an open file.
MPI_File_sync
MPI::File::Sync
MPI_FILE_SYNC
MPI-IO Commits file updates of an open file to storage device(s).
MPI_File_write
MPI::File::Write
MPI_FILE_WRITE
MPI-IO Writes to a file.
MPI_File_write_all
MPI::File::Write_all
MPI_FILE_WRITE_ALL
MPI-IO Writes to a file collectively.
MPI_File_write_all_begin
MPI::File::Write_all_begin
MPI_FILE_WRITE_ALL_BEGIN
MPI-IO Initiates a split collective write operation to a file.
MPI_File_write_all_end
MPI::File::Write_all_end
MPI_FILE_WRITE_ALL_END
MPI-IO Completes a split collective write operation to a file.
MPI_File_write_at
MPI::File::Write_at
MPI_FILE_WRITE_AT
MPI-IO Performs a blocking write operation using an explicit offset.
MPI_File_write_at_all
MPI::File::Write_at_all
MPI_FILE_WRITE_AT_ALL
MPI-IO Performs a blocking write operation collectively using an explicit offset.
MPI_File_write_at_all_begin
MPI::File::Write_at_all_begin
MPI_FILE_WRITE_AT_ALL_BEGIN
MPI-IO Initiates a split collective write operation to a file using an explicit offset.
MPI_File_write_at_all_end
MPI::File::Write_at_all_end
MPI_FILE_WRITE_AT_ALL_END
MPI-IO Completes a split collective write operation to a file using an explicit offset.
MPI_File_write_ordered
MPI::File::Write_ordered
MPI_FILE_WRITE_ORDERED
MPI-IO Writes to a file collectively using the shared file pointer.
MPI_File_write_ordered_begin
MPI::File::Write_ordered_begin
MPI_FILE_WRITE_ORDERED_BEGIN
MPI-IO Initiates a split collective write operation to a file using the shared file pointer.
MPI_File_write_ordered_end
MPI::File::Write_ordered_end
MPI_FILE_WRITE_ORDERED_END
MPI-IO Completes a split collective write operation to a file using the shared file pointer.
MPI_File_write_shared
MPI::File::Write_shared
MPI_FILE_WRITE_SHARED
MPI-IO Writes to a file using the shared file pointer.
MPI_Finalize
MPI::Finalize
MPI_FINALIZE
Environment management Terminates all MPI processing.
MPI_Finalized
MPI::Is_finalized
MPI_FINALIZED
Environment management Returns true if MPI_FINALIZE has completed.
MPI_Free_mem
MPI::Free_mem
MPI_FREE_MEM
Memory allocation Frees a block of storage.
MPI_Gather
MPI::Comm::Gather
MPI_GATHER
Collective communication Collects individual messages from each task in a group at the root task.
MPI_Gatherv
MPI::Comm::Gatherv
MPI_GATHERV
Collective communication Collects individual messages from each task in comm at the root task. Messages can have different sizes and displacements.
MPI_Get
MPI::Win::Get
MPI_GET
One-sided communication Transfers data from a window at the target task to the origin task.
MPI_Get_address
MPI::Get_address
MPI_GET_ADDRESS
Derived datatype Returns the address of a location in memory.
MPI_Get_count
MPI::Status::Get_count
MPI_GET_COUNT
Point-to-point communication Returns the number of elements in a message.
MPI_Get_elements
MPI::Status::Get_elements
MPI_GET_ELEMENTS
Derived datatype Returns the number of basic elements in a message.
MPI_Get_processor_name
MPI::Get_processor_name
MPI_GET_PROCESSOR_NAME
Environment management Returns the name of the local processor.
MPI_Get_version
MPI::Get_version
MPI_GET_VERSION
Environment management Returns the version of the MPI standard supported.
MPI_Graph_create
MPI::Intracomm::Create_graph
MPI_GRAPH_CREATE
Topology Creates a new communicator containing graph topology information.
MPI_Graph_get
MPI::Graphcomm::Get_topo
MPI_GRAPH_GET
Topology Retrieves graph topology information from a communicator.
MPI_Graph_map
MPI::Graphcomm::Map
MPI_GRAPH_MAP
Topology Computes placement of tasks on the physical processor.
MPI_Graph_neighbors
MPI::Graphcomm::Get_neighbors
MPI_GRAPH_NEIGHBORS
Topology Returns the neighbors of the given task.
MPI_Graph_neighbors_count
MPI::Graphcomm::Get_neighbors_count
MPI_GRAPH_NEIGHBORS_COUNT
Topology Returns the number of neighbors of the given task.
MPI_Graphdims_get
MPI::Graphcomm::Get_dims
MPI_GRAPHDIMS_GET
Topology Retrieves graph topology information from a communicator.
MPI_Grequest_complete
MPI::Grequest::Complete
MPI_GREQUEST_COMPLETE
External interface Marks the generalized request complete.
MPI_Grequest_start
MPI::Grequest::Start
MPI_GREQUEST_START
External interface Initializes a generalized request.
MPI_Group_c2f
(none)
(none)
Conversion function Translates a C group handle into a FORTRAN handle to the same group.
MPI_Group_compare
MPI::Group::Compare
MPI_GROUP_COMPARE
Group management Compares the contents of two task groups.
MPI_Group_difference
MPI::Group::Difference
MPI_GROUP_DIFFERENCE
Group management Creates a new group that is the difference of two existing groups.
MPI_Group_excl
MPI::Group::Excl
MPI_GROUP_EXCL
Group management Removes selected tasks from an existing group to create a new group.
MPI_Group_f2c
(none)
(none)
Conversion function Returns a C handle to a group.
MPI_Group_free
MPI::Group::Free
MPI_GROUP_FREE
Group management Marks a group for deallocation.
MPI_Group_incl
MPI::Group::Incl
MPI_GROUP_INCL
Group management Creates a new group consisting of selected tasks from an existing group.
MPI_Group_intersection
MPI::Group::Intersect
MPI_GROUP_INTERSECTION
Group management Creates a new group that is the intersection of two existing groups.
MPI_Group_range_excl
MPI::Group::Range_excl
MPI_GROUP_RANGE_EXCL
Group management Creates a new group by excluding selected tasks of an existing group.
MPI_Group_range_incl
MPI::Group::Range_incl
MPI_GROUP_RANGE_INCL
Group management Creates a new group consisting of selected ranges of tasks from an existing group.
MPI_Group_rank
MPI::Group::Get_rank
MPI_GROUP_RANK
Group management Returns the rank of the local task with respect to group.
MPI_Group_size
MPI::Group::Get_size
MPI_GROUP_SIZE
Group management Returns the number of tasks in a group.
MPI_Group_translate_ranks
MPI::Group::Translate_ranks
MPI_GROUP_TRANSLATE_RANKS
Group management Converts task ranks of one group into ranks of another group.
MPI_Group_union
MPI::Group::Union
MPI_GROUP_UNION
Group management Creates a new group that is the union of two existing groups.
MPI_Ibsend
MPI::Comm::Ibsend
MPI_IBSEND
Point-to-point communication Nonblocking buffered send.
MPI_Info_c2f
(none)
(none)
Conversion function Translates a C info object handle into a FORTRAN handle to the same info object.
MPI_Info_create
MPI::Info::Create
MPI_INFO_CREATE
Info object Creates a new, empty info object.
MPI_Info_delete
MPI::Info::Delete
MPI_INFO_DELETE
Info object Deletes a (key, value) pair from an info object.
MPI_Info_dup
MPI::Info::Dup
MPI_INFO_DUP
Info object Duplicates an info object.
MPI_Info_f2c
(none)
(none)
Conversion function Returns a C handle to an info object.
MPI_Info_free
MPI::Info::Free
MPI_INFO_FREE
Info object Frees an info object and sets its handle to MPI_INFO_NULL.
MPI_Info_get
MPI::Info::Get
MPI_INFO_GET
Info object Retrieves the value associated with key in an info object.
MPI_Info_get_nkeys
MPI::Info::Get_nkeys
MPI_INFO_GET_NKEYS
Info object Returns the number of keys defined in an info object.
MPI_Info_get_nthkey
MPI::Info::Get_nthkey
MPI_INFO_GET_NTHKEY
Info object Retrieves the nth key defined in an info object.
MPI_Info_get_valuelen
MPI::Info::Get_valuelen
MPI_INFO_GET_VALUELEN
Info object Retrieves the length of the value associated with a key of an info object.
MPI_Info_set
MPI::Info::Set
MPI_INFO_SET
Info object Adds a (key, value) pair to an info object.
MPI_Init
MPI::Init
MPI_INIT
Environment management Initializes MPI.
MPI_Init_thread
MPI::Init_thread
MPI_INIT_THREAD
Environment management Initializes MPI and the MPI threads environment.
MPI_Initialized
MPI::Is_initialized
MPI_INITIALIZED
Environment management Determines if MPI is initialized.
MPI_Intercomm_create
MPI::Intracomm::Create_intercomm
MPI_INTERCOMM_CREATE
Communicator Creates an intercommunicator from two intracommunicators.
MPI_Intercomm_merge
MPI::Intercomm::Merge
MPI_INTERCOMM_MERGE
Communicator Creates an intracommunicator by merging the local and remote groups of an intercommunicator.
MPI_Iprobe
MPI::Comm::Iprobe
MPI_IPROBE
Point-to-point communication Checks to see if a message matching source, tag, and comm has arrived.
MPI_Irecv
MPI::Comm::Irecv
MPI_IRECV
Point-to-point communication Performs a nonblocking receive operation.
MPI_Irsend
MPI::Comm::Irsend
MPI_IRSEND
Point-to-point communication Performs a nonblocking ready send operation.
MPI_Is_thread_main
MPI::Is_thread_main
MPI_IS_THREAD_MAIN
Environment management Determines whether the calling thread is the thread that called MPI_INIT or MPI_INIT_THREAD.
MPI_Isend
MPI::Comm::Isend
MPI_ISEND
Point-to-point communication Performs a nonblocking standard mode send operation.
MPI_Issend
MPI::Comm::Issend
MPI_ISSEND
Point-to-point communication Performs a nonblocking synchronous mode send operation.
MPI_Keyval_create
(none)
MPI_KEYVAL_CREATE
Communicator Generates a new communicator attribute key.
MPI_Keyval_free
(none)
MPI_KEYVAL_FREE
Communicator Marks a communicator attribute key for deallocation.
MPI_Op_c2f
(none)
(none)
Conversion function Translates a C reduction operation handle into a FORTRAN handle to the same operation.
MPI_Op_create
MPI::Op::Init
MPI_OP_CREATE
Collective communication Binds a user-defined reduction operation to an op handle.
MPI_Op_f2c
(none)
(none)
Conversion function Returns a C reduction operation handle to an operation.
MPI_Op_free
MPI::Op::Free
MPI_OP_FREE
Collective communication Marks a user-defined reduction operation for deallocation.
MPI_Pack
MPI::Datatype::Pack
MPI_PACK
Derived datatype Packs the message in the specified send buffer into the specified buffer space.
MPI_Pack_external
MPI::Datatype::Pack_external
MPI_PACK_EXTERNAL
Derived datatype Packs the message in the specified send buffer into the specified buffer space, using the external32 data format.
MPI_Pack_external_size
MPI::Datatype::Pack_external_size
MPI_PACK_EXTERNAL_SIZE
Derived datatype Returns the number of bytes required to hold the data, using the external32 data format.
MPI_Pack_size
MPI::Datatype::Pack_size
MPI_PACK_SIZE
Derived datatype Returns the number of bytes required to hold the data.
MPI_Pcontrol
MPI::Pcontrol
MPI_PCONTROL
Environment management Provides profile control.
MPI_Probe
MPI::Comm::Probe
MPI_PROBE
Point-to-point communication Waits until a message matching source, tag, and comm arrives.
MPI_Put
MPI::Win::Put
MPI_PUT
One-sided communication Transfers data from the origin task to a window at the target task.
MPI_Query_thread
MPI::Query_thread
MPI_QUERY_THREAD
Environment management Returns the current level of threads support.
MPI_Recv
MPI::Comm::Recv
MPI_RECV
Point-to-point communication Performs a blocking receive operation.
MPI_Recv_init
MPI::Comm::Recv_init
MPI_RECV_INIT
Point-to-point communication Creates a persistent receive request.
MPI_Reduce
MPI::Comm::Reduce
MPI_REDUCE
Collective communication Applies a reduction operation to the vector sendbuf over the set of tasks specified by comm and places the result in recvbuf on root.
MPI_Reduce_scatter
MPI::Comm::Reduce_scatter
MPI_REDUCE_SCATTER
Collective communication Applies a reduction operation to the vector sendbuf over the set of tasks specified by comm and scatters the result according to the values in recvcounts.
MPI_Register_datarep
MPI::Register_datarep
MPI_REGISTER_DATAREP
MPI-IO Registers a data representation.
MPI_Request_c2f
(none)
(none)
Conversion function Translates a C request handle into a FORTRAN handle to the same request.
MPI_Request_f2c
(none)
(none)
Conversion function Returns a C handle to a request.
MPI_Request_free
MPI::Request::Free
MPI_REQUEST_FREE
Point-to-point communication Marks a request for deallocation.
MPI_Request_get_status
MPI::Request::Get_status
MPI_REQUEST_GET_STATUS
MPI_STATUS object Accesses the information associated with a request, without freeing the request.
MPI_Rsend
MPI::Comm::Rsend
MPI_RSEND
Point-to-point communication Performs a blocking ready mode send operation.
MPI_Rsend_init
MPI::Comm::Rsend_init
MPI_RSEND_INIT
Point-to-point communication Creates a persistent ready mode send request.
MPI_Scan
MPI::Intracomm::Scan
MPI_SCAN
Collective communication Performs a parallel prefix reduction on data distributed across a group.
MPI_Scatter
MPI::Comm::Scatter
MPI_SCATTER
Collective communication Distributes individual messages from root to each task in comm.
MPI_Scatterv
MPI::Comm::Scatterv
MPI_SCATTERV
Collective communication Distributes individual messages from root to each task in comm. Messages can have different sizes and displacements.
MPI_Send
MPI::Comm::Send
MPI_SEND
Point-to-point communication Blocking standard mode send.
MPI_Send_init
MPI::Comm::Send_init
MPI_SEND_INIT
Point-to-point communication Creates a persistent standard mode send request.
MPI_Sendrecv
MPI::Comm::Sendrecv
MPI_SENDRECV
Point-to-point communication Performs a blocking send and receive operation.
MPI_Sendrecv_replace
MPI::Comm::Sendrecv_replace
MPI_SENDRECV_REPLACE
Point-to-point communication Performs a blocking send and receive operation using a common buffer.
(none)
(none)
MPI_SIZEOF
Derived datatype Returns the size in bytes of the machine representation of the given variable.
MPI_Ssend
MPI::Comm::Ssend
MPI_SSEND
Point-to-point communication Performs a blocking synchronous mode send operation.
MPI_Ssend_init
MPI::Comm::Ssend_init
MPI_SSEND_INIT
Point-to-point communication Creates a persistent synchronous mode send request.
MPI_Start
MPI::Prequest::Start
MPI_START
Point-to-point communication Activates a persistent request operation.
MPI_Startall
MPI::Prequest::Startall
MPI_STARTALL
Point-to-point communication Activates a collection of persistent request operations.
MPI_Status_c2f
(none)
(none)
Conversion function Translates a C status object into a FORTRAN status object.
MPI_Status_f2c
(none)
(none)
Conversion function Converts a FORTRAN status object into a C status object.
MPI_Status_set_cancelled
MPI::Status::Set_cancelled
MPI_STATUS_SET_CANCELLED
External interface Defines cancellation information for a request.
MPI_Status_set_elements
MPI::Status::Set_elements
MPI_STATUS_SET_ELEMENTS
External interface Defines element information for a request.
MPI_Test
MPI::Request::Test
MPI_TEST
Point-to-point communication Checks to see if a nonblocking operation has completed.
MPI_Test_cancelled
MPI::Status::Is_cancelled
MPI_TEST_CANCELLED
Point-to-point communication Tests whether a nonblocking operation was cancelled.
MPI_Testall
MPI::Request::Testall
MPI_TESTALL
Point-to-point communication Tests a collection of nonblocking operations for completion.
MPI_Testany
MPI::Request::Testany
MPI_TESTANY
Point-to-point communication Tests for the completion of any specified nonblocking operation.
MPI_Testsome
MPI::Request::Testsome
MPI_TESTSOME
Point-to-point communication Tests a collection of nonblocking operations for completion.
MPI_Topo_test
MPI::Comm::Get_topology
MPI_TOPO_TEST
Topology Returns the type of virtual topology associated with a communicator.
MPI_Type_c2f
(none)
(none)
Conversion function Translates a C datatype handle into a FORTRAN handle to the same datatype.
MPI_Type_commit
MPI::Datatype::Commit
MPI_TYPE_COMMIT
Derived datatype Makes a datatype ready for use in communication.
MPI_Type_contiguous
MPI::Datatype::Create_contiguous
MPI_TYPE_CONTIGUOUS
Derived datatype Returns a new datatype that represents the concatenation of count instances of oldtype.
MPI_Type_create_darray
MPI::Datatype::Create_darray
MPI_TYPE_CREATE_DARRAY
Derived datatype Generates the datatypes corresponding to an HPF-like distribution of an ndims-dimensional array of oldtype elements onto an ndims-dimensional grid of logical tasks.
MPI_Type_create_f90_complex
MPI::Datatype::Create_f90_complex
MPI_TYPE_CREATE_F90_COMPLEX
Derived datatype Returns a predefined MPI datatype that matches a COMPLEX variable of KIND selected_real_kind(p, r).
MPI_Type_create_f90_integer
MPI::Datatype::Create_f90_integer
MPI_TYPE_CREATE_F90_INTEGER
Derived datatype Returns a predefined MPI datatype that matches an INTEGER variable of KIND selected_integer_kind(r).
MPI_Type_create_f90_real
MPI::Datatype::Create_f90_real
MPI_TYPE_CREATE_F90_REAL
Derived datatype Returns a predefined MPI datatype that matches a REAL variable of KIND selected_real_kind(p, r).
MPI_Type_create_hindexed
MPI::Datatype::Create_hindexed
MPI_TYPE_CREATE_HINDEXED
Derived datatype Returns a new datatype that represents count blocks. Each block is defined by an entry in array_of_blocklengths and array_of_displacements. Displacements are expressed in bytes.
MPI_Type_create_hvector
MPI::Datatype::Create_hvector
MPI_TYPE_CREATE_HVECTOR
Derived datatype Returns a new datatype that represents equally-spaced blocks. The spacing between the start of each block is given in bytes.
MPI_Type_create_indexed_block
MPI::Datatype::Create_indexed_block
MPI_TYPE_CREATE_INDEXED_BLOCK
Derived datatype Returns a new datatype that represents count blocks.
MPI_Type_create_keyval
MPI::Datatype::Create_keyval
MPI_TYPE_CREATE_KEYVAL
Derived datatype Generates a new attribute key for a datatype.
MPI_Type_create_resized
MPI::Datatype::Create_resized
MPI_TYPE_CREATE_RESIZED
Derived datatype Duplicates a datatype and changes the upper bound, lower bound, and extent.
MPI_Type_create_struct
MPI::Datatype::Create_struct
MPI_TYPE_CREATE_STRUCT
Derived datatype Returns a new datatype that represents count blocks. Each block is defined by an entry in array_of_blocklengths, array_of_displacements, and array_of_types. Displacements are expressed in bytes.
MPI_Type_create_subarray
MPI::Datatype::Create_subarray
MPI_TYPE_CREATE_SUBARRAY
Derived datatype Returns a new datatype that represents an ndims-dimensional subarray of an ndims-dimensional array.
MPI_Type_delete_attr
MPI::Datatype::Delete_attr
MPI_TYPE_DELETE_ATTR
Derived datatype Deletes an attribute from a datatype.
MPI_Type_dup
MPI::Datatype::Dup
MPI_TYPE_DUP
Derived datatype Duplicates the existing type with associated key values.
MPI_Type_extent
(none)
MPI_TYPE_EXTENT
Derived datatype Returns the extent of any defined datatype.
MPI_Type_f2c
(none)
(none)
Conversion function Returns a C handle to a datatype.
MPI_Type_free
MPI::Datatype::Free
MPI_TYPE_FREE
Derived datatype Marks a derived datatype for deallocation and sets its handle to MPI_DATATYPE_NULL.
MPI_Type_free_keyval
MPI::Datatype::Free_keyval
MPI_TYPE_FREE_KEYVAL
Derived datatype Frees a datatype key value.
MPI_Type_get_attr
MPI::Datatype::Get_attr
MPI_TYPE_GET_ATTR
Derived datatype Attaches an attribute to a datatype.
MPI_Type_get_contents
MPI::Datatype::Get_contents
MPI_TYPE_GET_CONTENTS
Derived datatype Obtains the arguments used in the creation of the datatype.
MPI_Type_get_envelope
MPI::Datatype::Get_envelope
MPI_TYPE_GET_ENVELOPE
Derived datatype Determines the constructor that was used to create the datatype.
MPI_Type_get_extent
MPI::Datatype::Get_extent
MPI_TYPE_GET_EXTENT
Derived datatype Returns the lower bound and the extent of any defined datatype.
MPI_Type_get_name
MPI::Datatype::Get_name
MPI_TYPE_GET_NAME
External interface Returns the name that was last associated with a datatype.
MPI_Type_get_true_extent
MPI::Datatype::Get_true_extent
MPI_TYPE_GET_TRUE_EXTENT
Derived datatype Returns the true extent of any defined datatype.
MPI_Type_hindexed
(none)
MPI_TYPE_HINDEXED
Derived datatype Returns a new datatype that represents count distinct blocks with offsets expressed in bytes.
MPI_Type_hvector
(none)
MPI_TYPE_HVECTOR
Derived datatype Returns a new datatype of count blocks with stride expressed in bytes.
MPI_Type_indexed
MPI::Datatype::Create_indexed
MPI_TYPE_INDEXED
Derived datatype Returns a new datatype that represents count blocks with stride in terms of defining type.
MPI_Type_lb
(none)
MPI_TYPE_LB
Derived datatype Returns the lower bound of a datatype.
MPI_Type_match_size
MPI::Datatype::Match_size
MPI_TYPE_CREATE_MATCH_SIZE
Derived datatype Returns a reference (handle) to one of the predefined named datatypes, not a duplicate.
MPI_Type_set_attr
MPI::Datatype::Set_attr
MPI_TYPE_SET_ATTR
Derived datatype Attaches the datatype attribute value to the datatype and associates it with the key.
MPI_Type_set_name
MPI::Datatype::Set_name
MPI_TYPE_SET_NAME
External interface Associates a name string with a datatype.
MPI_Type_size
MPI::Datatype::Get_size
MPI_TYPE_SIZE
Derived datatype Returns the number of bytes represented by any defined datatype.
MPI_Type_struct
(none)
MPI_TYPE_STRUCT
Derived datatype Returns a new datatype that represents count blocks, each with a distinct format and offset.
MPI_Type_ub
(none)
MPI_TYPE_UB
Derived datatype Returns the upper bound of a datatype.
MPI_Type_vector
MPI::Datatype::Create_vector
MPI_TYPE_VECTOR
Derived datatype Returns a new datatype that represents equally-spaced blocks of replicated data.
MPI_Unpack
MPI::Datatype::Unpack
MPI_UNPACK
Derived datatype Unpacks the message into the specified receive buffer from the specified packed buffer.
MPI_Unpack_external
MPI::Datatype::Unpack_external
MPI_UNPACK_EXTERNAL
Derived datatype Unpacks the message into the specified receive buffer from the specified packed buffer, using the external32 data format.
MPI_Wait
MPI::Request::Wait
MPI_WAIT
Point-to-point communication Waits for a nonblocking operation to complete.
MPI_Waitall
MPI::Request::Waitall
MPI_WAITALL
Point-to-point communication Waits for a collection of nonblocking operations to complete.
MPI_Waitany
MPI::Request::Waitany
MPI_WAITANY
Point-to-point communication Waits for any specified nonblocking operation to complete.
MPI_Waitsome
MPI::Request::Waitsome
MPI_WAITSOME
Point-to-point communication Waits for at least one of a list of nonblocking operations to complete.
MPI_Win_c2f
(none)
(none)
Conversion function Translates a C window handle into a FORTRAN handle to the same window.
MPI_Win_call_errhandler
MPI::Win::Call_errhandler
MPI_WIN_CALL_ERRHANDLER
External interface Calls the error handler assigned to the window with the error code supplied.
MPI_Win_complete
MPI::Win::Complete
MPI_WIN_COMPLETE
One-sided communication Completes an RMA access epoch on a window object.
MPI_Win_create
MPI::Win::Create
MPI_WIN_CREATE
One-sided communication Allows each task in an intracommunicator group to specify a "window" in its memory that is made accessible to accesses by remote tasks.
MPI_Win_create_errhandler
MPI::Win::Create_errhandler
MPI_WIN_CREATE_ERRHANDLER
One-sided communication Creates an error handler that can be attached to windows.
MPI_Win_create_keyval
MPI::Win::Create_keyval
MPI_WIN_CREATE_KEYVAL
One-sided communication Generates a new window attribute key.
MPI_Win_delete_attr
MPI::Win::Delete_attr
MPI_WIN_DELETE_ATTR
One-sided communication Deletes an attribute from a window.
MPI_Win_f2c
(none)
(none)
Conversion function Returns a C handle to a window.
MPI_Win_fence
MPI::Win::Fence
MPI_WIN_FENCE
One-sided communication Synchronizes RMA calls on a window.
MPI_Win_free
MPI::Win::Free
MPI_WIN_FREE
One-sided communication Frees the window object and returns a null handle (equal to MPI_WIN_NULL).
MPI_Win_free_keyval
MPI::Win::Free_keyval
MPI_WIN_FREE_KEYVAL
One-sided communication Marks a window attribute key for deallocation.
MPI_Win_get_attr
MPI::Win::Get_attr
MPI_WIN_GET_ATTR
One-sided communication Retrieves the window attribute value identified by the key.
MPI_Win_get_errhandler
MPI::Win::Get_errhandler
MPI_WIN_GET_ERRHANDLER
One-sided communication Retrieves the error handler currently associated with a window.
MPI_Win_get_group
MPI::Win::Get_group
MPI_WIN_GET_GROUP
One-sided communication Returns a duplicate of the group of the communicator used to create a window.
MPI_Win_get_name
MPI::Win::Get_name
MPI_WIN_GET_NAME
External interface Returns the name that was last associated with a window.
MPI_Win_lock
MPI::Win::Lock
MPI_WIN_LOCK
One-sided communication Starts an RMA access epoch at the target task.
MPI_Win_post
MPI::Win::Post
MPI_WIN_POST
One-sided communication Starts an RMA exposure epoch for a local window.
MPI_Win_set_attr
MPI::Win::Set_attr
MPI_WIN_SET_ATTR
One-sided communication Attaches the window attribute value to the window and associates it with the key.
MPI_Win_set_errhandler
MPI::Win::Set_errhandler
MPI_WIN_SET_ERRHANDLER
One-sided communication Attaches a new error handler to a window.
MPI_Win_set_name
MPI::Win::Set_name
MPI_WIN_SET_NAME
External interface Associates a name string with a window.
MPI_Win_start
MPI::Win::Start
MPI_WIN_START
One-sided communication Starts an RMA access epoch for a window object.
MPI_Win_test
MPI::Win::Test
MPI_WIN_TEST
One-sided communication Tries to complete an RMA exposure epoch.
MPI_Win_unlock
MPI::Win::Unlock
MPI_WIN_UNLOCK
One-sided communication Completes an RMA access epoch at the target task.
MPI_Win_wait
MPI::Win::Wait
MPI_WIN_WAIT
One-sided communication Completes an RMA exposure epoch.
MPI_Wtick
MPI::Wtick
MPI_WTICK
Environment management Returns the resolution of MPI_WTIME in seconds.
MPI_Wtime
MPI::Wtime
MPI_WTIME
Environment management Returns the current value of time as a floating-point value.


[ Top of Page | Previous Page | Next Page | Table of Contents | Index ]