Index of values


A
allgather [Mpi]
allgather_float [Mpi]
allgather_float_array [Mpi]
The Mpi.allgather* functions behave like the corresponding Mpi.gather* functions, except that the result of the gather operation is available at all nodes, not only at the root node.
allgather_int [Mpi]
allgather_int_array [Mpi]
allreduce_float [Mpi]
allreduce_float_array [Mpi]
The Mpi.allreduce_* operations are similar to the corresponding Mpi.reduce_* operations, except that the result of the reduction is made available at all nodes.
allreduce_int [Mpi]
allreduce_int_array [Mpi]
any_source [Mpi]
The special values of the tag and src arguments of Mpi.receive, Mpi.receive_status and Mpi.probe, indicating that any message tag is acceptable (for Mpi.any_tag) or any message source is acceptable (for Mpi.any_source).
any_tag [Mpi]

B
barrier [Mpi]
Mpi.barrier comm suspends the calling process until all nodes in communicator comm are executing Mpi.barrier comm.
broadcast [Mpi]
Mpi.broadcast d root comm broadcasts data d from node with rank root in comm to all other nodes in comm.
broadcast_float [Mpi]
broadcast_float_array [Mpi]
Specialized versions of Mpi.broadcast for integers, floats, arrays of integers and arrays of floats.
broadcast_int [Mpi]
broadcast_int_array [Mpi]
broadcast_opt [Mpi]
Same as Mpi.broadcast, except that the data (first argument) is provided as an option type.

C
cart_coords [Mpi]
The inverse operation of Mpi.cart_rank.
cart_create [Mpi]
Mpi.cart_create comm dims periodic reorder embeds a cartesian topology (multi-dimensional grid) on the nodes of communicator comm, and return a new communicator with that information attached.
cart_rank [Mpi]
Mpi.cart_rank comm coords return the rank of the node in the cartesian topology comm that is at coordinates coords.
color_none [Mpi]
In Mpi.comm_split, a node can pass Mpi.color_none as the col argument to indicate that it does not want to be part of any of the new communicators.
comm_compare [Mpi]
Compare two communicators and return true if they are the same, false otherwise.
comm_create [Mpi]
Mpi.comm_create comm group creates a communicator whose nodes are those described in group.
comm_group [Mpi]
Mpi.comm_group comm returns the group of all nodes belonging to the communicator comm, with the same ranks as in comm.
comm_rank [Mpi]
Return the rank of the calling node in the given communicator.
comm_size [Mpi]
Return the size (number of nodes) in the given communicator.
comm_split [Mpi]
Mpi.comm_split comm col key splits the communicator into several communicators based on the values of col and key at every node.
comm_world [Mpi]
The global communicator.

D
dims_create [Mpi]
Mpi.dims_create numnodes hints helps determining a suitable dims argument to Mpi.cart_create given a number of nodes numnodes, the number of dimensions required, and optional constraints.

G
gather [Mpi]
Mpi.gather d root comm gathers the values of the d argument at all nodes onto node root, and returns those values as an array.
gather_float [Mpi]
Specialized versions of Mpi.gather for integers and floats.
gather_float_array [Mpi]
Specialized versions of Mpi.gather for arrays of integers and arrays of floats.
gather_int [Mpi]
gather_int_array [Mpi]
group_difference [Mpi]
Union, intersection and set difference over groups.
group_excl [Mpi]
Mpi.group_excl group ranks returns the subset of group containing the nodes whose ranks are not given in the array ranks.
group_incl [Mpi]
Mpi.group_incl group ranks returns the subset of group containing the nodes whose ranks are given in the array ranks.
group_intersection [Mpi]
group_range_excl [Mpi]
Mpi.group_range_excl group ranges returns the subset of group containing the nodes whose ranks do not belong to the ranges listed in ranges.
group_range_incl [Mpi]
Mpi.group_range_incl group ranges returns the subset of group containing the nodes whose ranks belong to the ranges listed in ranges.
group_rank [Mpi]
Return the rank of the calling node in the given group.
group_size [Mpi]
Return the size (number of nodes) in the given group.
group_translate_ranks [Mpi]
Mpi.group_translate_ranks g1 ranks g2 translates the ranks of a number of nodes from one group to another.
group_union [Mpi]

P
probe [Mpi]
Mpi.probe src tag comm blocks until a message is available on communicator comm, with source and tag matching the src and tag arguments as described in Mpi.receive.

R
receive [Mpi]
Mpi.receive src tag comm blocks until a message is available, and returns the data contained in that message.
receive_float [Mpi]
receive_float_array [Mpi]
Specialized versions of Mpi.send and Mpi.receive for communicating integers, floating-point numbers, arrays of integers, and arrays of floating-point numbers.
receive_int [Mpi]
receive_int_array [Mpi]
receive_status [Mpi]
Same as Mpi.receive, but returns a triple (d, src, tag) where d is the data associated with the message, src the rank of the node that sent the message, and tag the actual tag attached to the message.
reduce_float [Mpi]
Mpi.reduce_int d op root comm computes the value of d0 op d1 op ... op dN, where d0 ... dN are the values of the d argument at every node in comm.
reduce_float_array [Mpi]
Mpi.reduce_int_array d res op root comm computes Array.length d reductions by operation op simultaneously.
reduce_int [Mpi]
reduce_int_array [Mpi]

S
scan_float [Mpi]
Mpi.scan_int d res op comm performs a scan operation over the integers d at every node.
scan_float_array [Mpi]
Same as Mpi.scan_int and Mpi.scan_float, but perform several scanning operations on the elements of the input array (first argument).
scan_int [Mpi]
scan_int_array [Mpi]
scatter [Mpi]
Mpi.scatter a root comm scatters the elements of array a from node root to all nodes in comm.
scatter_float [Mpi]
Specialized versions of Mpi.scatter for integers and floats.
scatter_float_array [Mpi]
Specialized versions of Mpi.scatter for arrays of integers and arrays of floats.
scatter_int [Mpi]
scatter_int_array [Mpi]
send [Mpi]
Mpi.send d dst tag comm sends a message containing data d to the node that has rank dst in communicator comm.
send_float [Mpi]
send_float_array [Mpi]
send_int [Mpi]
send_int_array [Mpi]

W
wtime [Mpi]
Return the wall-clock time elapsed at the calling node since the beginning of the program execution.