Man Pages in
lam-mpidoc
Carta.tech
Packages
lam-mpidoc
220
Section 3:
Library calls
MPIL_Comm_gps.3
Lam/mpi-specific function to return the gps information of a given rank from a communicator
MPIL_Comm_id.3
Lam/mpi-specific function to return the context id of the communicator
MPIL_Request_get_name.3
Lam/mpi-specific function to get a string name on an mpi_request
MPIL_Request_set_name.3
Lam/mpi-specific function to set a string name on an mpi_request
MPIL_Signal.3
Lam/mpi-specific function to send a lam signal to a rank in an mpi communicator
MPIL_Trace_off.3
Lam/mpi-specific function to disable run-time tracing
MPIL_Trace_on.3
Lam/mpi-specific function to enable run-time tracing
MPIL_Type_id.3
Lam/mpi-specific function to return the type id of an mpi datatype
MPIO_Request_c2f.3
Translates a c i/o-request handle to a fortran i/o-request handle
MPIO_Request_f2c.3
Translates a fortran i/o-request handle to a c i/o-request handle
MPIO_Test.3
Test the completion of a nonblocking read or write
MPIO_Wait.3
Waits for the completion of a nonblocking read or write
MPI_DUP_FN.3
Built-in mpi function to simple-mindedly copy communicator attributes.
MPI_Info_c2f.3
Convert an info handle from its c representation to its fortran representation
MPI_Info_f2c.3
Convert a info handle from its fortran representation to its c representation
MPI_Request_c2f.3
Convert a request handle from its c representation to its fortran representation
MPI_Status_c2f.3
Convert a status from its c representation to its fortran representation
MPI_Win_Lock.3
Starts an rma access epoch
MPI_Win_Test.3
Test for progress on a window
MPI_Abort.3
Terminates mpi execution environment
MPI_Address.3
Gets the address of a location in memory
MPI_Allgather.3
Gathers data from all tasks and distribute it to all
MPI_Allgatherv.3
Gathers data from all tasks and deliver it to all
MPI_Allreduce.3
Combines values from all processes and distribute the result back to all processes
MPI_Alltoall.3
Sends data from all to all processes
MPI_Alltoallv.3
Sends data from all to all processes, with a displacement
MPI_Attr_delete.3
Deletes communicator attribute value associated with a key
MPI_Attr_get.3
Retrieves communicator attribute value by key
MPI_Attr_put.3
Stores a communicator attribute value associated with a key
MPI_Barrier.3
Blocks until all process have reached this routine.
MPI_Bcast.3
Broadcasts a message from the process with rank "root" to all other processes of the group.
MPI_Bsend.3
Basic send with user-specified buffering
MPI_Bsend_init.3
Builds a handle for a buffered send
MPI_Buffer_attach.3
Attaches a user-defined buffer for sending
MPI_Buffer_detach.3
Removes an existing buffer (for use in mpi_bsend etc)
MPI_Cancel.3
Cancels a communication request
MPI_Cart_coords.3
Determines process coords in cartesian topology given rank in group
MPI_Cart_create.3
Makes a new communicator to which topology information has been attached
MPI_Cart_get.3
Retrieves cartesian topology information associated with a communicator
MPI_Cart_map.3
Maps process to cartesian topology information
MPI_Cart_rank.3
Determines process rank in communicator given cartesian location
MPI_Cart_shift.3
Returns the shifted source and destination ranks, given a shift direction and amount
MPI_Cart_sub.3
Partitions a communicator into subgroups which form lower-dimensional cartesian subgrids
MPI_Cartdim_get.3
Retrieves cartesian topology information associated with a communicator
MPI_Comm_compare.3
Compares two communicators
MPI_Comm_create.3
Creates a new communicator
MPI_Comm_dup.3
Duplicates an existing communicator with all its cached information
MPI_Comm_free.3
Marks the communicator object for deallocation
MPI_Comm_group.3
Accesses the group associated with given communicator
MPI_Comm_rank.3
Determines the rank of the calling process in the communicator
MPI_Comm_remote_group.3
Accesses the remote group associated with the given inter-communicator
MPI_Comm_remote_size.3
Determines the size of the remote group associated with an inter-communictor
MPI_Comm_size.3
Determines the size of the group associated with a communictor
MPI_Comm_split.3
Creates new communicators based on colors and keys
MPI_Comm_test_inter.3
Tests to see if a comm is an inter-communicator
MPI_Dims_create.3
Creates a division of processors in a cartesian grid
MPI_Errhandler_create.3
Creates an mpi-style error handler on a communicator
MPI_Errhandler_free.3
Frees an mpi-style errorhandler
MPI_Errhandler_get.3
Gets the error handler for a communicator
MPI_Errhandler_set.3
Sets the error handler for a communicator
MPI_Error_class.3
Converts an error code into an error class
MPI_Error_string.3
Return a string for a given error code
MPI_File_c2f.3
Translates a c file handle to a fortran file handle
MPI_File_close.3
Closes a file
MPI_File_delete.3
Deletes a file
MPI_File_f2c.3
Translates a fortran file handle to a c file handle
MPI_File_get_amode.3
Returns the file access mode
MPI_File_get_atomicity.3
Returns the atomicity mode
MPI_File_get_byte_offset.3
Returns the absolute byte position in the file corresponding to "offset" etypes relative to the current view
MPI_File_get_errhandler.3
Returns the error handler for a file
MPI_File_get_group.3
Returns the group of processes that opened the file
MPI_File_get_info.3
Returns the hints for a file that are actually being used by mpi
MPI_File_get_position.3
Returns the current position of the individual file pointer in etype units relative to the current view
MPI_File_get_position_shared.3
Returns the current position of the shared file pointer in etype units relative to the current view
MPI_File_get_size.3
Returns the file size
MPI_File_get_type_extent.3
Returns the extent of datatype in the file
MPI_File_get_view.3
Returns the file view
MPI_File_iread.3
Nonblocking read using individual file pointer
MPI_File_iread_at.3
Nonblocking read using explict offset
MPI_File_iread_shared.3
Nonblocking read using shared file pointer
MPI_File_iwrite.3
Nonblocking write using individual file pointer
MPI_File_iwrite_at.3
Nonblocking write using explict offset
MPI_File_iwrite_shared.3
Nonblocking write using shared file pointer
MPI_File_open.3
Opens a file
MPI_File_preallocate.3
Preallocates storage space for a file
MPI_File_read.3
Read using individual file pointer
MPI_File_read_all.3
Collective read using individual file pointer
MPI_File_read_all_begin.3
Begin a split collective read using individual file pointer
MPI_File_read_all_end.3
Complete a split collective read using individual file pointer
MPI_File_read_at.3
Read using explict offset
MPI_File_read_at_all.3
Collective read using explict offset
MPI_File_read_at_all_begin.3
Begin a split collective read using explict offset
MPI_File_read_at_all_end.3
Complete a split collective read using explict offset
MPI_File_read_ordered.3
Collective read using shared file pointer
MPI_File_read_ordered_begin.3
Begin a split collective read using shared file pointer
MPI_File_read_ordered_end.3
Complete a split collective read using shared file pointer
MPI_File_read_shared.3
Read using shared file pointer
MPI_File_seek.3
Updates the individual file pointer
MPI_File_seek_shared.3
Updates the shared file pointer
MPI_File_set_atomicity.3
Sets the atomicity mode
MPI_File_set_errhandler.3
Sets the error handler for a file
MPI_File_set_info.3
Sets new values for the hints associated with a file
MPI_File_set_size.3
Sets the file size
MPI_File_set_view.3
Sets the file view
MPI_File_sync.3
Causes all previous writes to be transferred to the storage device
MPI_File_write.3
Write using individual file pointer
MPI_File_write_all.3
Collective write using individual file pointer
MPI_File_write_all_begin.3
Begin a split collective write using individual file pointer
MPI_File_write_all_end.3
Complete a split collective write using individual file pointer
MPI_File_write_at.3
Write using explict offset
MPI_File_write_at_all.3
Collective write using explict offset
MPI_File_write_at_all_begin.3
Begin a split collective write using explict offset
MPI_File_write_at_all_end.3
Complete a split collective write using explict offset
MPI_File_write_ordered.3
Collective write using shared file pointer
MPI_File_write_ordered_begin.3
Begin a split collective write using shared file pointer
MPI_File_write_ordered_end.3
Complete a split collective write using shared file pointer
MPI_File_write_shared.3
Write using shared file pointer
MPI_Finalize.3
Terminates mpi execution environment
MPI_Finalized.3
Indicates whether mpi_finalize has completed.
MPI_Gather.3
Gathers together values from a group of processes
MPI_Gatherv.3
Gathers into specified locations from all processes in a group
MPI_Get_count.3
Gets the number of "top level" elements
MPI_Get_elements.3
Returns the number of basic elements in a datatype
MPI_Get_processor_name.3
Gets the name of the processor
MPI_Get_version.3
Obtain the version number of mpi that lam/mpi supports
MPI_Graph_create.3
Makes a new communicator to which topology information has been attached
MPI_Graph_get.3
Retrieves graph topology information associated with a communicator
MPI_Graph_map.3
Maps process to graph topology information
MPI_Graph_neighbors.3
Returns the neighbors of a node associated with a graph topology
MPI_Graph_neighbors_count.3
Returns the number of neighbors of a node associated with a graph topology
MPI_Graphdims_get.3
Retrieves graph topology information associated with a communicator
MPI_Group_compare.3
Compares two groups
MPI_Group_difference.3
Makes a group from the difference of two groups
MPI_Group_excl.3
Produces a group by reordering an existing group and taking only unlisted members
MPI_Group_free.3
Frees a group
MPI_Group_incl.3
Produces a group by reordering an existing group and taking only listed members
MPI_Group_intersection.3
Produces a group as the intersection of two existing groups
MPI_Group_range_excl.3
Produces a group by excluding ranges of processes from an existing group
MPI_Group_range_incl.3
Creates a new group from ranges of ranks in an existing group
MPI_Group_rank.3
Returns the rank of this process in the given group
MPI_Group_size.3
Returns the size of a group
MPI_Group_translate_ranks.3
Translates the ranks of processes in one group to those in another group
MPI_Group_union.3
Produces a group by combining two groups
MPI_Ibsend.3
Starts a nonblocking buffered send
MPI_Info_create.3
Create and initialize an empty mpi_info object
MPI_Info_delete.3
Delete a (key, value) pair from an mpi_info object
MPI_Info_dup.3
Duplicate an mpi_info object
MPI_Info_free.3
Free an mpi_info object.
MPI_Info_get.3
Get a (key, value) pair from an mpi_info object
MPI_Info_get_nkeys.3
Returns the number of keys defined on an mpi_info object
MPI_Info_get_nthkey.3
Get a key indexed by integer from an mpi_info object
MPI_Info_get_valuelen.3
Get the length of a value for a given key in an mpi_info object
MPI_Info_set.3
Set a (key, value) pair in an mpi_info object
MPI_Init.3
Initialize the mpi execution environment
MPI_Init_thread.3
Initialize the mpi execution environment
MPI_Initialized.3
Indicates whether mpi_init has been called.
MPI_Intercomm_create.3
Creates an intercommuncator from two intracommunicators
MPI_Intercomm_merge.3
Creates an intracommuncator from an intercommunicator
MPI_Iprobe.3
Nonblocking test for a message
MPI_Irecv.3
Begins a non-blocking receive
MPI_Irsend.3
Starts a nonblocking ready send
MPI_Isend.3
Begins a nonblocking send
MPI_Issend.3
Starts a nonblocking synchronous send
MPI_Keyval_create.3
Generates a new communicator attribute key
MPI_Keyval_free.3
Frees attribute key for communicator cache attribute
MPI_Op_create.3
Creates a user-defined combination function handle
MPI_Op_free.3
Frees a user-defined combination function handle
MPI_Pack.3
Packs a datatype into contiguous memory
MPI_Pack_size.3
Returns the upper bound on the amount of space needed to pack a message
MPI_Pcontrol.3
Controls profiling
MPI_Probe.3
Blocking test for a message
MPI_Recv.3
Basic receive
MPI_Recv_init.3
Builds a handle for a receive
MPI_Reduce.3
Reduces values on all processes to a single value
MPI_Reduce_scatter.3
Combines values and scatters the results
MPI_Request_free.3
Frees a communication request object
MPI_Rsend.3
Basic ready send
MPI_Rsend_init.3
Builds a handle for a ready send
MPI_Scan.3
Computes the scan (partial reductions) of data on a collection of processes
MPI_Scatter.3
Sends data from one task to all other tasks in a group
MPI_Scatterv.3
Scatters a buffer in parts to all tasks in a group
MPI_Send.3
Performs a basic send
MPI_Send_init.3
Builds a handle for a standard send
MPI_Sendrecv.3
Sends and receives a message
MPI_Sendrecv_replace.3
Sends and receives using a single buffer
MPI_Ssend.3
Basic synchronous send
MPI_Ssend_init.3
Builds a handle for a synchronous send
MPI_Start.3
Initiates a communication with a persistent request handle
MPI_Startall.3
Starts a collection of requests
MPI_Test.3
Tests for the completion of a send or receive
MPI_Test_cancelled.3
Tests to see if a request was cancelled
MPI_Testall.3
Tests for the completion of all previously initiated communications
MPI_Testany.3
Tests for completion of any previdously initiated communication
MPI_Testsome.3
Tests for some given communications to complete
MPI_Topo_test.3
Determines the type of topology (if any) associated with a communicator
MPI_Type_commit.3
Commits the datatype
MPI_Type_contiguous.3
Creates a contiguous datatype
MPI_Type_create_darray.3
Create distributed array derived datatype
MPI_Type_create_subarray.3
Create local array derived datatype
MPI_Type_extent.3
Returns the extent of a datatype
MPI_Type_free.3
Frees the datatype
MPI_Type_get_contents.3
Get datatype contents
MPI_Type_get_envelope.3
Get datatype envelope contents
MPI_Type_hindexed.3
Creates an indexed datatype with offsets in bytes
MPI_Type_hvector.3
Creates a vector (strided) datatype with offset in bytes
MPI_Type_indexed.3
Creates an indexed datatype
MPI_Type_lb.3
Returns the lower-bound of a datatype
MPI_Type_size.3
Return the number of bytes occupied by entries in the datatype
MPI_Type_struct.3
Creates a struct datatype
MPI_Type_ub.3
Returns the upper bound of a datatype
MPI_Type_vector.3
Creates a vector (strided) datatype
MPI_Unpack.3
Unpack a datatype into contiguous memory
MPI_Wait.3
Waits for an mpi send or receive to complete
MPI_Waitall.3
Waits for all given communications to complete
MPI_Waitany.3
Waits for any specified send or receive to complete
MPI_Waitsome.3
Waits for some given communications to complete
MPI_Win_call_errhandler.3
Invokes error handler assigned to the window with the error code supplied.
MPI_Win_unlock.3
Completes an rma access epoch started by a call to mpi_win_lock
MPI_Wtick.3
Returns the resolution of mpi_wtime
MPI_Wtime.3
Returns an elapsed time on the calling processor