<html> <head> <link rel="stylesheet" href="style.css" type="text/css"> <meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type"> <link rel="Start" href="index.html"> <link title="Index of types" rel=Appendix href="index_types.html"> <link title="Index of exceptions" rel=Appendix href="index_exceptions.html"> <link title="Index of values" rel=Appendix href="index_values.html"> <link title="Index of modules" rel=Appendix href="index_modules.html"> <link title="Mpi" rel="Chapter" href="Mpi.html"><title>Index of values</title> </head> <body> <div class="navbar"> <a class="up" href="index.html" title="Index">Up</a> </div> <h1>Index of values</h1> <table> <tr><td align="left"><br>A</td></tr> <tr><td><a href="Mpi.html#VALallgather">allgather</a> [<a href="Mpi.html">Mpi</a>]</td> <td></td></tr> <tr><td><a href="Mpi.html#VALallgather_float">allgather_float</a> [<a href="Mpi.html">Mpi</a>]</td> <td></td></tr> <tr><td><a href="Mpi.html#VALallgather_float_array">allgather_float_array</a> [<a href="Mpi.html">Mpi</a>]</td> <td><div class="info"> The <code class="code">Mpi.allgather*</code> functions behave like the corresponding <code class="code">Mpi.gather*</code> functions, except that the result of the gather operation is available at all nodes, not only at the root node. </div> </td></tr> <tr><td><a href="Mpi.html#VALallgather_int">allgather_int</a> [<a href="Mpi.html">Mpi</a>]</td> <td></td></tr> <tr><td><a href="Mpi.html#VALallgather_int_array">allgather_int_array</a> [<a href="Mpi.html">Mpi</a>]</td> <td></td></tr> <tr><td><a href="Mpi.html#VALallreduce_float">allreduce_float</a> [<a href="Mpi.html">Mpi</a>]</td> <td></td></tr> <tr><td><a href="Mpi.html#VALallreduce_float_array">allreduce_float_array</a> [<a href="Mpi.html">Mpi</a>]</td> <td><div class="info"> The <code class="code">Mpi.allreduce_*</code> operations are similar to the corresponding <code class="code">Mpi.reduce_*</code> operations, except that the result of the reduction is made available at all nodes. </div> </td></tr> <tr><td><a href="Mpi.html#VALallreduce_int">allreduce_int</a> [<a href="Mpi.html">Mpi</a>]</td> <td></td></tr> <tr><td><a href="Mpi.html#VALallreduce_int_array">allreduce_int_array</a> [<a href="Mpi.html">Mpi</a>]</td> <td></td></tr> <tr><td><a href="Mpi.html#VALany_source">any_source</a> [<a href="Mpi.html">Mpi</a>]</td> <td><div class="info"> The special values of the <code class="code">tag</code> and <code class="code">src</code> arguments of <code class="code">Mpi.receive</code>, <code class="code">Mpi.receive_status</code> and <code class="code">Mpi.probe</code>, indicating that any message tag is acceptable (for <code class="code">Mpi.any_tag</code>) or any message source is acceptable (for <code class="code">Mpi.any_source</code>). </div> </td></tr> <tr><td><a href="Mpi.html#VALany_tag">any_tag</a> [<a href="Mpi.html">Mpi</a>]</td> <td></td></tr> <tr><td align="left"><br>B</td></tr> <tr><td><a href="Mpi.html#VALbarrier">barrier</a> [<a href="Mpi.html">Mpi</a>]</td> <td><div class="info"> <code class="code">Mpi.barrier comm</code> suspends the calling process until all nodes in communicator <code class="code">comm</code> are executing <code class="code">Mpi.barrier comm</code>. </div> </td></tr> <tr><td><a href="Mpi.html#VALbroadcast">broadcast</a> [<a href="Mpi.html">Mpi</a>]</td> <td><div class="info"> <code class="code">Mpi.broadcast d root comm</code> broadcasts data <code class="code">d</code> from node with rank <code class="code">root</code> in <code class="code">comm</code> to all other nodes in <code class="code">comm</code>. </div> </td></tr> <tr><td><a href="Mpi.html#VALbroadcast_float">broadcast_float</a> [<a href="Mpi.html">Mpi</a>]</td> <td></td></tr> <tr><td><a href="Mpi.html#VALbroadcast_float_array">broadcast_float_array</a> [<a href="Mpi.html">Mpi</a>]</td> <td><div class="info"> Specialized versions of <code class="code">Mpi.broadcast</code> for integers, floats, arrays of integers and arrays of floats. </div> </td></tr> <tr><td><a href="Mpi.html#VALbroadcast_int">broadcast_int</a> [<a href="Mpi.html">Mpi</a>]</td> <td></td></tr> <tr><td><a href="Mpi.html#VALbroadcast_int_array">broadcast_int_array</a> [<a href="Mpi.html">Mpi</a>]</td> <td></td></tr> <tr><td><a href="Mpi.html#VALbroadcast_opt">broadcast_opt</a> [<a href="Mpi.html">Mpi</a>]</td> <td><div class="info"> Same as <code class="code">Mpi.broadcast</code>, except that the data (first argument) is provided as an option type. </div> </td></tr> <tr><td align="left"><br>C</td></tr> <tr><td><a href="Mpi.html#VALcart_coords">cart_coords</a> [<a href="Mpi.html">Mpi</a>]</td> <td><div class="info"> The inverse operation of <code class="code">Mpi.cart_rank</code>. </div> </td></tr> <tr><td><a href="Mpi.html#VALcart_create">cart_create</a> [<a href="Mpi.html">Mpi</a>]</td> <td><div class="info"> <code class="code">Mpi.cart_create comm dims periodic reorder</code> embeds a cartesian topology (multi-dimensional grid) on the nodes of communicator <code class="code">comm</code>, and return a new communicator with that information attached. </div> </td></tr> <tr><td><a href="Mpi.html#VALcart_rank">cart_rank</a> [<a href="Mpi.html">Mpi</a>]</td> <td><div class="info"> <code class="code">Mpi.cart_rank comm coords</code> return the rank of the node in the cartesian topology <code class="code">comm</code> that is at coordinates <code class="code">coords</code>. </div> </td></tr> <tr><td><a href="Mpi.html#VALcolor_none">color_none</a> [<a href="Mpi.html">Mpi</a>]</td> <td><div class="info"> In <code class="code">Mpi.comm_split</code>, a node can pass <code class="code">Mpi.color_none</code> as the <code class="code">col</code> argument to indicate that it does not want to be part of any of the new communicators. </div> </td></tr> <tr><td><a href="Mpi.html#VALcomm_compare">comm_compare</a> [<a href="Mpi.html">Mpi</a>]</td> <td><div class="info"> Compare two communicators and return <code class="code">true</code> if they are the same, <code class="code">false</code> otherwise. </div> </td></tr> <tr><td><a href="Mpi.html#VALcomm_create">comm_create</a> [<a href="Mpi.html">Mpi</a>]</td> <td><div class="info"> <code class="code">Mpi.comm_create comm group</code> creates a communicator whose nodes are those described in <code class="code">group</code>. </div> </td></tr> <tr><td><a href="Mpi.html#VALcomm_group">comm_group</a> [<a href="Mpi.html">Mpi</a>]</td> <td><div class="info"> <code class="code">Mpi.comm_group comm</code> returns the group of all nodes belonging to the communicator <code class="code">comm</code>, with the same ranks as in <code class="code">comm</code>. </div> </td></tr> <tr><td><a href="Mpi.html#VALcomm_rank">comm_rank</a> [<a href="Mpi.html">Mpi</a>]</td> <td><div class="info"> Return the rank of the calling node in the given communicator. </div> </td></tr> <tr><td><a href="Mpi.html#VALcomm_size">comm_size</a> [<a href="Mpi.html">Mpi</a>]</td> <td><div class="info"> Return the size (number of nodes) in the given communicator. </div> </td></tr> <tr><td><a href="Mpi.html#VALcomm_split">comm_split</a> [<a href="Mpi.html">Mpi</a>]</td> <td><div class="info"> <code class="code">Mpi.comm_split comm col key</code> splits the communicator into several communicators based on the values of <code class="code">col</code> and <code class="code">key</code> at every node. </div> </td></tr> <tr><td><a href="Mpi.html#VALcomm_world">comm_world</a> [<a href="Mpi.html">Mpi</a>]</td> <td><div class="info"> The global communicator. </div> </td></tr> <tr><td align="left"><br>D</td></tr> <tr><td><a href="Mpi.html#VALdims_create">dims_create</a> [<a href="Mpi.html">Mpi</a>]</td> <td><div class="info"> <code class="code">Mpi.dims_create numnodes hints</code> helps determining a suitable <code class="code">dims</code> argument to <code class="code">Mpi.cart_create</code> given a number of nodes <code class="code">numnodes</code>, the number of dimensions required, and optional constraints. </div> </td></tr> <tr><td align="left"><br>G</td></tr> <tr><td><a href="Mpi.html#VALgather">gather</a> [<a href="Mpi.html">Mpi</a>]</td> <td><div class="info"> <code class="code">Mpi.gather d root comm</code> gathers the values of the <code class="code">d</code> argument at all nodes onto node <code class="code">root</code>, and returns those values as an array. </div> </td></tr> <tr><td><a href="Mpi.html#VALgather_float">gather_float</a> [<a href="Mpi.html">Mpi</a>]</td> <td><div class="info"> Specialized versions of <code class="code">Mpi.gather</code> for integers and floats. </div> </td></tr> <tr><td><a href="Mpi.html#VALgather_float_array">gather_float_array</a> [<a href="Mpi.html">Mpi</a>]</td> <td><div class="info"> Specialized versions of <code class="code">Mpi.gather</code> for arrays of integers and arrays of floats. </div> </td></tr> <tr><td><a href="Mpi.html#VALgather_int">gather_int</a> [<a href="Mpi.html">Mpi</a>]</td> <td></td></tr> <tr><td><a href="Mpi.html#VALgather_int_array">gather_int_array</a> [<a href="Mpi.html">Mpi</a>]</td> <td></td></tr> <tr><td><a href="Mpi.html#VALgroup_difference">group_difference</a> [<a href="Mpi.html">Mpi</a>]</td> <td><div class="info"> Union, intersection and set difference over groups. </div> </td></tr> <tr><td><a href="Mpi.html#VALgroup_excl">group_excl</a> [<a href="Mpi.html">Mpi</a>]</td> <td><div class="info"> <code class="code">Mpi.group_excl group ranks</code> returns the subset of <code class="code">group</code> containing the nodes whose ranks are not given in the array <code class="code">ranks</code>. </div> </td></tr> <tr><td><a href="Mpi.html#VALgroup_incl">group_incl</a> [<a href="Mpi.html">Mpi</a>]</td> <td><div class="info"> <code class="code">Mpi.group_incl group ranks</code> returns the subset of <code class="code">group</code> containing the nodes whose ranks are given in the array <code class="code">ranks</code>. </div> </td></tr> <tr><td><a href="Mpi.html#VALgroup_intersection">group_intersection</a> [<a href="Mpi.html">Mpi</a>]</td> <td></td></tr> <tr><td><a href="Mpi.html#VALgroup_range_excl">group_range_excl</a> [<a href="Mpi.html">Mpi</a>]</td> <td><div class="info"> <code class="code">Mpi.group_range_excl group ranges</code> returns the subset of <code class="code">group</code> containing the nodes whose ranks do not belong to the ranges listed in <code class="code">ranges</code>. </div> </td></tr> <tr><td><a href="Mpi.html#VALgroup_range_incl">group_range_incl</a> [<a href="Mpi.html">Mpi</a>]</td> <td><div class="info"> <code class="code">Mpi.group_range_incl group ranges</code> returns the subset of <code class="code">group</code> containing the nodes whose ranks belong to the ranges listed in <code class="code">ranges</code>. </div> </td></tr> <tr><td><a href="Mpi.html#VALgroup_rank">group_rank</a> [<a href="Mpi.html">Mpi</a>]</td> <td><div class="info"> Return the rank of the calling node in the given group. </div> </td></tr> <tr><td><a href="Mpi.html#VALgroup_size">group_size</a> [<a href="Mpi.html">Mpi</a>]</td> <td><div class="info"> Return the size (number of nodes) in the given group. </div> </td></tr> <tr><td><a href="Mpi.html#VALgroup_translate_ranks">group_translate_ranks</a> [<a href="Mpi.html">Mpi</a>]</td> <td><div class="info"> <code class="code">Mpi.group_translate_ranks g1 ranks g2</code> translates the ranks of a number of nodes from one group to another. </div> </td></tr> <tr><td><a href="Mpi.html#VALgroup_union">group_union</a> [<a href="Mpi.html">Mpi</a>]</td> <td></td></tr> <tr><td align="left"><br>P</td></tr> <tr><td><a href="Mpi.html#VALprobe">probe</a> [<a href="Mpi.html">Mpi</a>]</td> <td><div class="info"> <code class="code">Mpi.probe src tag comm</code> blocks until a message is available on communicator <code class="code">comm</code>, with source and tag matching the <code class="code">src</code> and <code class="code">tag</code> arguments as described in <code class="code">Mpi.receive</code>. </div> </td></tr> <tr><td align="left"><br>R</td></tr> <tr><td><a href="Mpi.html#VALreceive">receive</a> [<a href="Mpi.html">Mpi</a>]</td> <td><div class="info"> <code class="code">Mpi.receive src tag comm</code> blocks until a message is available, and returns the data contained in that message. </div> </td></tr> <tr><td><a href="Mpi.html#VALreceive_float">receive_float</a> [<a href="Mpi.html">Mpi</a>]</td> <td></td></tr> <tr><td><a href="Mpi.html#VALreceive_float_array">receive_float_array</a> [<a href="Mpi.html">Mpi</a>]</td> <td><div class="info"> Specialized versions of <code class="code">Mpi.send</code> and <code class="code">Mpi.receive</code> for communicating integers, floating-point numbers, arrays of integers, and arrays of floating-point numbers. </div> </td></tr> <tr><td><a href="Mpi.html#VALreceive_int">receive_int</a> [<a href="Mpi.html">Mpi</a>]</td> <td></td></tr> <tr><td><a href="Mpi.html#VALreceive_int_array">receive_int_array</a> [<a href="Mpi.html">Mpi</a>]</td> <td></td></tr> <tr><td><a href="Mpi.html#VALreceive_status">receive_status</a> [<a href="Mpi.html">Mpi</a>]</td> <td><div class="info"> Same as <code class="code">Mpi.receive</code>, but returns a triple <code class="code">(d, src, tag)</code> where <code class="code">d</code> is the data associated with the message, <code class="code">src</code> the rank of the node that sent the message, and <code class="code">tag</code> the actual tag attached to the message. </div> </td></tr> <tr><td><a href="Mpi.html#VALreduce_float">reduce_float</a> [<a href="Mpi.html">Mpi</a>]</td> <td><div class="info"> <code class="code">Mpi.reduce_int d op root comm</code> computes the value of <code class="code">d0 op d1 op ... op dN</code>, where <code class="code">d0 ... dN</code> are the values of the <code class="code">d</code> argument at every node in <code class="code">comm</code>. </div> </td></tr> <tr><td><a href="Mpi.html#VALreduce_float_array">reduce_float_array</a> [<a href="Mpi.html">Mpi</a>]</td> <td><div class="info"> <code class="code">Mpi.reduce_int_array d res op root comm</code> computes <code class="code">Array.length d</code> reductions by operation <code class="code">op</code> simultaneously. </div> </td></tr> <tr><td><a href="Mpi.html#VALreduce_int">reduce_int</a> [<a href="Mpi.html">Mpi</a>]</td> <td></td></tr> <tr><td><a href="Mpi.html#VALreduce_int_array">reduce_int_array</a> [<a href="Mpi.html">Mpi</a>]</td> <td></td></tr> <tr><td align="left"><br>S</td></tr> <tr><td><a href="Mpi.html#VALscan_float">scan_float</a> [<a href="Mpi.html">Mpi</a>]</td> <td><div class="info"> <code class="code">Mpi.scan_int d res op comm</code> performs a scan operation over the integers <code class="code">d</code> at every node. </div> </td></tr> <tr><td><a href="Mpi.html#VALscan_float_array">scan_float_array</a> [<a href="Mpi.html">Mpi</a>]</td> <td><div class="info"> Same as <code class="code">Mpi.scan_int</code> and <code class="code">Mpi.scan_float</code>, but perform several scanning operations on the elements of the input array (first argument). </div> </td></tr> <tr><td><a href="Mpi.html#VALscan_int">scan_int</a> [<a href="Mpi.html">Mpi</a>]</td> <td></td></tr> <tr><td><a href="Mpi.html#VALscan_int_array">scan_int_array</a> [<a href="Mpi.html">Mpi</a>]</td> <td></td></tr> <tr><td><a href="Mpi.html#VALscatter">scatter</a> [<a href="Mpi.html">Mpi</a>]</td> <td><div class="info"> <code class="code">Mpi.scatter a root comm</code> scatters the elements of array <code class="code">a</code> from node <code class="code">root</code> to all nodes in <code class="code">comm</code>. </div> </td></tr> <tr><td><a href="Mpi.html#VALscatter_float">scatter_float</a> [<a href="Mpi.html">Mpi</a>]</td> <td><div class="info"> Specialized versions of <code class="code">Mpi.scatter</code> for integers and floats. </div> </td></tr> <tr><td><a href="Mpi.html#VALscatter_float_array">scatter_float_array</a> [<a href="Mpi.html">Mpi</a>]</td> <td><div class="info"> Specialized versions of <code class="code">Mpi.scatter</code> for arrays of integers and arrays of floats. </div> </td></tr> <tr><td><a href="Mpi.html#VALscatter_int">scatter_int</a> [<a href="Mpi.html">Mpi</a>]</td> <td></td></tr> <tr><td><a href="Mpi.html#VALscatter_int_array">scatter_int_array</a> [<a href="Mpi.html">Mpi</a>]</td> <td></td></tr> <tr><td><a href="Mpi.html#VALsend">send</a> [<a href="Mpi.html">Mpi</a>]</td> <td><div class="info"> <code class="code">Mpi.send d dst tag comm</code> sends a message containing data <code class="code">d</code> to the node that has rank <code class="code">dst</code> in communicator <code class="code">comm</code>. </div> </td></tr> <tr><td><a href="Mpi.html#VALsend_float">send_float</a> [<a href="Mpi.html">Mpi</a>]</td> <td></td></tr> <tr><td><a href="Mpi.html#VALsend_float_array">send_float_array</a> [<a href="Mpi.html">Mpi</a>]</td> <td></td></tr> <tr><td><a href="Mpi.html#VALsend_int">send_int</a> [<a href="Mpi.html">Mpi</a>]</td> <td></td></tr> <tr><td><a href="Mpi.html#VALsend_int_array">send_int_array</a> [<a href="Mpi.html">Mpi</a>]</td> <td></td></tr> <tr><td align="left"><br>W</td></tr> <tr><td><a href="Mpi.html#VALwtime">wtime</a> [<a href="Mpi.html">Mpi</a>]</td> <td><div class="info"> Return the wall-clock time elapsed at the calling node since the beginning of the program execution. </div> </td></tr> </table> </body> </html>