Skip to content

Commit

Permalink
refactor distributed_grid and local_grid, add documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
rabauke committed Oct 3, 2021
1 parent f4c0add commit c52ef1a
Show file tree
Hide file tree
Showing 301 changed files with 6,110 additions and 3,027 deletions.
9 changes: 5 additions & 4 deletions docs/html/annotated.html
Original file line number Diff line number Diff line change
Expand Up @@ -121,8 +121,9 @@
<tr id="row_0_14_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_0_14_" class="arrow" onclick="toggleFolder('0_14_')">&#9658;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classmpl_1_1distributed__graph__communicator.html" target="_self">distributed_graph_communicator</a></td><td class="desc">Communicator with general graph topology </td></tr>
<tr id="row_0_14_0_" class="even" style="display:none;"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classmpl_1_1distributed__graph__communicator_1_1neighbours__set.html" target="_self">neighbours_set</a></td><td class="desc">Set of edges, pairs of nodes represented by non-negative integers </td></tr>
<tr id="row_0_14_1_" class="even" style="display:none;"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classmpl_1_1distributed__graph__communicator_1_1rank__weight__pair.html" target="_self">rank_weight_pair</a></td><td class="desc">Pair of rank and weight </td></tr>
<tr id="row_0_15_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_0_15_" class="arrow" onclick="toggleFolder('0_15_')">&#9658;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classmpl_1_1distributed__grid.html" target="_self">distributed_grid</a></td><td class="desc"></td></tr>
<tr id="row_0_15_0_" style="display:none;"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classmpl_1_1distributed__grid_1_1sizes.html" target="_self">sizes</a></td><td class="desc"></td></tr>
<tr id="row_0_15_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_0_15_" class="arrow" onclick="toggleFolder('0_15_')">&#9658;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classmpl_1_1distributed__grid.html" target="_self">distributed_grid</a></td><td class="desc">Local portion of a distributed data grid including local overlap data </td></tr>
<tr id="row_0_15_0_" style="display:none;"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classmpl_1_1distributed__grid_1_1dimensions.html" target="_self">dimensions</a></td><td class="desc">Characterizes the dimensionality, total size and overlap of a distributed data grid </td></tr>
<tr id="row_0_15_1_" style="display:none;"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classmpl_1_1distributed__grid_1_1size__overlap__pair.html" target="_self">size_overlap_pair</a></td><td class="desc">Pair of grid size and overlap size </td></tr>
<tr id="row_0_16_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classmpl_1_1empty__layout.html" target="_self">empty_layout</a></td><td class="desc">Layout with zero elements </td></tr>
<tr id="row_0_17_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classmpl_1_1error.html" target="_self">error</a></td><td class="desc">Base class for all MPL exception classes that will be thrown in case of run-time errors </td></tr>
<tr id="row_0_18_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_0_18_" class="arrow" onclick="toggleFolder('0_18_')">&#9658;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classmpl_1_1graph__communicator.html" target="_self">graph_communicator</a></td><td class="desc">Communicator with general graph topology </td></tr>
Expand Down Expand Up @@ -158,8 +159,8 @@
<tr id="row_0_35_0_" style="display:none;"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classmpl_1_1iterator__layout_1_1parameter.html" target="_self">parameter</a></td><td class="desc">Class representing the parameters to characterize an iterator layout </td></tr>
<tr id="row_0_36_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classmpl_1_1layout.html" target="_self">layout</a></td><td class="desc">Base class for a family of classes that describe where objects are located in memory when several objects of the same type T are exchanged in a single message </td></tr>
<tr id="row_0_37_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classmpl_1_1layouts.html" target="_self">layouts</a></td><td class="desc">Container for storing layouts </td></tr>
<tr id="row_0_38_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_0_38_" class="arrow" onclick="toggleFolder('0_38_')">&#9658;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classmpl_1_1local__grid.html" target="_self">local_grid</a></td><td class="desc"></td></tr>
<tr id="row_0_38_0_" class="even" style="display:none;"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classmpl_1_1local__grid_1_1sizes.html" target="_self">sizes</a></td><td class="desc"></td></tr>
<tr id="row_0_38_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_0_38_" class="arrow" onclick="toggleFolder('0_38_')">&#9658;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classmpl_1_1local__grid.html" target="_self">local_grid</a></td><td class="desc">Data grid </td></tr>
<tr id="row_0_38_0_" class="even" style="display:none;"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classmpl_1_1local__grid_1_1dimensions.html" target="_self">dimensions</a></td><td class="desc">Characterizes the dimensionality and the total size of a local data grid </td></tr>
<tr id="row_0_39_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structmpl_1_1logical__and.html" target="_self">logical_and</a></td><td class="desc">Function object for calculating the logical conjunction of two values in reduction operations as <a class="el" href="classmpl_1_1communicator.html#a20c2142532726d3a3f25e4eb3293fd4c" title="Performs a reduction operation over all processes.">communicator::reduce</a> </td></tr>
<tr id="row_0_40_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structmpl_1_1logical__or.html" target="_self">logical_or</a></td><td class="desc">Function object for calculating the logical (inclusive) disjunction of two values in reduction operations as <a class="el" href="classmpl_1_1communicator.html#a20c2142532726d3a3f25e4eb3293fd4c" title="Performs a reduction operation over all processes.">communicator::reduce</a> </td></tr>
<tr id="row_0_41_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structmpl_1_1logical__xor.html" target="_self">logical_xor</a></td><td class="desc">Function object for calculating the logical exclusive disjunction of two values in reduction operations as <a class="el" href="classmpl_1_1communicator.html#a20c2142532726d3a3f25e4eb3293fd4c" title="Performs a reduction operation over all processes.">communicator::reduce</a> </td></tr>
Expand Down
4 changes: 2 additions & 2 deletions docs/html/classes.html
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@
<dd><a class="el" href="classmpl_1_1cartesian__communicator.html">cartesian_communicator</a> (<a class="el" href="namespacempl.html">mpl</a>)</dd><dd><a class="el" href="classmpl_1_1communicator_1_1comm__collective__tag.html">communicator::comm_collective_tag</a> (<a class="el" href="namespacempl.html">mpl</a>)</dd><dd><a class="el" href="classmpl_1_1communicator.html">communicator</a> (<a class="el" href="namespacempl.html">mpl</a>)</dd><dd><a class="el" href="classmpl_1_1cartesian__communicator_1_1dimensions_1_1const__iterator.html">cartesian_communicator::dimensions::const_iterator</a> (<a class="el" href="namespacempl.html">mpl</a>)</dd><dd><a class="el" href="classmpl_1_1contiguous__layout.html">contiguous_layout</a> (<a class="el" href="namespacempl.html">mpl</a>)</dd><dd><a class="el" href="classmpl_1_1contiguous__layouts.html">contiguous_layouts</a> (<a class="el" href="namespacempl.html">mpl</a>)</dd></dl>
<dl class="classindex odd">
<dt class="alphachar"><a id="letter_D" name="letter_D">D</a></dt>
<dd><a class="el" href="classmpl_1_1group_1_1difference__tag.html">group::difference_tag</a> (<a class="el" href="namespacempl.html">mpl</a>)</dd><dd><a class="el" href="classmpl_1_1cartesian__communicator_1_1dimensions_1_1dimension__periodicity__proxy.html">cartesian_communicator::dimensions::dimension_periodicity_proxy</a> (<a class="el" href="namespacempl.html">mpl</a>)</dd><dd><a class="el" href="classmpl_1_1cartesian__communicator_1_1dimensions.html">cartesian_communicator::dimensions</a> (<a class="el" href="namespacempl.html">mpl</a>)</dd><dd><a class="el" href="classmpl_1_1displacements.html">displacements</a> (<a class="el" href="namespacempl.html">mpl</a>)</dd><dd><a class="el" href="classmpl_1_1distributed__graph__communicator.html">distributed_graph_communicator</a> (<a class="el" href="namespacempl.html">mpl</a>)</dd><dd><a class="el" href="classmpl_1_1distributed__grid.html">distributed_grid</a> (<a class="el" href="namespacempl.html">mpl</a>)</dd></dl>
<dd><a class="el" href="classmpl_1_1group_1_1difference__tag.html">group::difference_tag</a> (<a class="el" href="namespacempl.html">mpl</a>)</dd><dd><a class="el" href="classmpl_1_1cartesian__communicator_1_1dimensions_1_1dimension__periodicity__proxy.html">cartesian_communicator::dimensions::dimension_periodicity_proxy</a> (<a class="el" href="namespacempl.html">mpl</a>)</dd><dd><a class="el" href="classmpl_1_1cartesian__communicator_1_1dimensions.html">cartesian_communicator::dimensions</a> (<a class="el" href="namespacempl.html">mpl</a>)</dd><dd><a class="el" href="classmpl_1_1distributed__grid_1_1dimensions.html">distributed_grid::dimensions</a> (<a class="el" href="namespacempl.html">mpl</a>)</dd><dd><a class="el" href="classmpl_1_1local__grid_1_1dimensions.html">local_grid::dimensions</a> (<a class="el" href="namespacempl.html">mpl</a>)</dd><dd><a class="el" href="classmpl_1_1displacements.html">displacements</a> (<a class="el" href="namespacempl.html">mpl</a>)</dd><dd><a class="el" href="classmpl_1_1distributed__graph__communicator.html">distributed_graph_communicator</a> (<a class="el" href="namespacempl.html">mpl</a>)</dd><dd><a class="el" href="classmpl_1_1distributed__grid.html">distributed_grid</a> (<a class="el" href="namespacempl.html">mpl</a>)</dd></dl>
<dl class="classindex even">
<dt class="alphachar"><a id="letter_E" name="letter_E">E</a></dt>
<dd><a class="el" href="classmpl_1_1graph__communicator_1_1edge__set.html">graph_communicator::edge_set</a> (<a class="el" href="namespacempl.html">mpl</a>)</dd><dd><a class="el" href="classmpl_1_1empty__layout.html">empty_layout</a> (<a class="el" href="namespacempl.html">mpl</a>)</dd><dd><a class="el" href="classmpl_1_1error.html">error</a> (<a class="el" href="namespacempl.html">mpl</a>)</dd><dd><a class="el" href="classmpl_1_1group_1_1exclude__tag.html">group::exclude_tag</a> (<a class="el" href="namespacempl.html">mpl</a>)</dd></dl>
Expand Down Expand Up @@ -132,7 +132,7 @@
<dd><a class="el" href="classmpl_1_1distributed__graph__communicator_1_1rank__weight__pair.html">distributed_graph_communicator::rank_weight_pair</a> (<a class="el" href="namespacempl.html">mpl</a>)</dd><dd><a class="el" href="classmpl_1_1ranks.html">ranks</a> (<a class="el" href="namespacempl.html">mpl</a>)</dd><dd><a class="el" href="classmpl_1_1impl_1_1request.html">request</a> (<a class="el" href="namespacempl_1_1impl.html">mpl::impl</a>)</dd><dd><a class="el" href="classmpl_1_1impl_1_1request__pool.html">request_pool</a> (<a class="el" href="namespacempl_1_1impl.html">mpl::impl</a>)</dd></dl>
<dl class="classindex even">
<dt class="alphachar"><a id="letter_S" name="letter_S">S</a></dt>
<dd><a class="el" href="structmpl_1_1shift__ranks.html">shift_ranks</a> (<a class="el" href="namespacempl.html">mpl</a>)</dd><dd><a class="el" href="classmpl_1_1distributed__grid_1_1sizes.html">distributed_grid::sizes</a> (<a class="el" href="namespacempl.html">mpl</a>)</dd><dd><a class="el" href="classmpl_1_1local__grid_1_1sizes.html">local_grid::sizes</a> (<a class="el" href="namespacempl.html">mpl</a>)</dd><dd><a class="el" href="classmpl_1_1communicator_1_1split__shared__memory__tag.html">communicator::split_shared_memory_tag</a> (<a class="el" href="namespacempl.html">mpl</a>)</dd><dd><a class="el" href="classmpl_1_1communicator_1_1split__tag.html">communicator::split_tag</a> (<a class="el" href="namespacempl.html">mpl</a>)</dd><dd><a class="el" href="classmpl_1_1status__t.html">status_t</a> (<a class="el" href="namespacempl.html">mpl</a>)</dd><dd><a class="el" href="classmpl_1_1strided__vector__layout.html">strided_vector_layout</a> (<a class="el" href="namespacempl.html">mpl</a>)</dd><dd><a class="el" href="classmpl_1_1struct__builder.html">struct_builder</a> (<a class="el" href="namespacempl.html">mpl</a>)</dd><dd><a class="el" href="classmpl_1_1struct__builder_3_01std_1_1array_3_01_t_00_01_n_01_4_01_4.html">struct_builder&lt; std::array&lt; T, N &gt; &gt;</a> (<a class="el" href="namespacempl.html">mpl</a>)</dd><dd><a class="el" href="classmpl_1_1struct__builder_3_01std_1_1pair_3_01_t1_00_01_t2_01_4_01_4.html">struct_builder&lt; std::pair&lt; T1, T2 &gt; &gt;</a> (<a class="el" href="namespacempl.html">mpl</a>)</dd><dd><a class="el" href="classmpl_1_1struct__builder_3_01std_1_1tuple_3_01_ts_8_8_8_01_4_01_4.html">struct_builder&lt; std::tuple&lt; Ts... &gt; &gt;</a> (<a class="el" href="namespacempl.html">mpl</a>)</dd><dd><a class="el" href="classmpl_1_1struct__builder_3_01_t_0f_n0_0e_4.html">struct_builder&lt; T[N0]&gt;</a> (<a class="el" href="namespacempl.html">mpl</a>)</dd><dd><a class="el" href="classmpl_1_1struct__builder_3_01_t_0f_n0_0e_0f_n1_0e_4.html">struct_builder&lt; T[N0][N1]&gt;</a> (<a class="el" href="namespacempl.html">mpl</a>)</dd><dd><a class="el" href="classmpl_1_1struct__builder_3_01_t_0f_n0_0e_0f_n1_0e_0f_n2_0e_4.html">struct_builder&lt; T[N0][N1][N2]&gt;</a> (<a class="el" href="namespacempl.html">mpl</a>)</dd><dd><a class="el" href="classmpl_1_1struct__builder_3_01_t_0f_n0_0e_0f_n1_0e_0f_n2_0e_0f_n3_0e_4.html">struct_builder&lt; T[N0][N1][N2][N3]&gt;</a> (<a class="el" href="namespacempl.html">mpl</a>)</dd><dd><a class="el" href="classmpl_1_1struct__layout.html">struct_layout</a> (<a class="el" href="namespacempl.html">mpl</a>)</dd><dd><a class="el" href="classmpl_1_1subarray__layout.html">subarray_layout</a> (<a class="el" href="namespacempl.html">mpl</a>)</dd></dl>
<dd><a class="el" href="structmpl_1_1shift__ranks.html">shift_ranks</a> (<a class="el" href="namespacempl.html">mpl</a>)</dd><dd><a class="el" href="classmpl_1_1distributed__grid_1_1size__overlap__pair.html">distributed_grid::size_overlap_pair</a> (<a class="el" href="namespacempl.html">mpl</a>)</dd><dd><a class="el" href="classmpl_1_1communicator_1_1split__shared__memory__tag.html">communicator::split_shared_memory_tag</a> (<a class="el" href="namespacempl.html">mpl</a>)</dd><dd><a class="el" href="classmpl_1_1communicator_1_1split__tag.html">communicator::split_tag</a> (<a class="el" href="namespacempl.html">mpl</a>)</dd><dd><a class="el" href="classmpl_1_1status__t.html">status_t</a> (<a class="el" href="namespacempl.html">mpl</a>)</dd><dd><a class="el" href="classmpl_1_1strided__vector__layout.html">strided_vector_layout</a> (<a class="el" href="namespacempl.html">mpl</a>)</dd><dd><a class="el" href="classmpl_1_1struct__builder.html">struct_builder</a> (<a class="el" href="namespacempl.html">mpl</a>)</dd><dd><a class="el" href="classmpl_1_1struct__builder_3_01std_1_1array_3_01_t_00_01_n_01_4_01_4.html">struct_builder&lt; std::array&lt; T, N &gt; &gt;</a> (<a class="el" href="namespacempl.html">mpl</a>)</dd><dd><a class="el" href="classmpl_1_1struct__builder_3_01std_1_1pair_3_01_t1_00_01_t2_01_4_01_4.html">struct_builder&lt; std::pair&lt; T1, T2 &gt; &gt;</a> (<a class="el" href="namespacempl.html">mpl</a>)</dd><dd><a class="el" href="classmpl_1_1struct__builder_3_01std_1_1tuple_3_01_ts_8_8_8_01_4_01_4.html">struct_builder&lt; std::tuple&lt; Ts... &gt; &gt;</a> (<a class="el" href="namespacempl.html">mpl</a>)</dd><dd><a class="el" href="classmpl_1_1struct__builder_3_01_t_0f_n0_0e_4.html">struct_builder&lt; T[N0]&gt;</a> (<a class="el" href="namespacempl.html">mpl</a>)</dd><dd><a class="el" href="classmpl_1_1struct__builder_3_01_t_0f_n0_0e_0f_n1_0e_4.html">struct_builder&lt; T[N0][N1]&gt;</a> (<a class="el" href="namespacempl.html">mpl</a>)</dd><dd><a class="el" href="classmpl_1_1struct__builder_3_01_t_0f_n0_0e_0f_n1_0e_0f_n2_0e_4.html">struct_builder&lt; T[N0][N1][N2]&gt;</a> (<a class="el" href="namespacempl.html">mpl</a>)</dd><dd><a class="el" href="classmpl_1_1struct__builder_3_01_t_0f_n0_0e_0f_n1_0e_0f_n2_0e_0f_n3_0e_4.html">struct_builder&lt; T[N0][N1][N2][N3]&gt;</a> (<a class="el" href="namespacempl.html">mpl</a>)</dd><dd><a class="el" href="classmpl_1_1struct__layout.html">struct_layout</a> (<a class="el" href="namespacempl.html">mpl</a>)</dd><dd><a class="el" href="classmpl_1_1subarray__layout.html">subarray_layout</a> (<a class="el" href="namespacempl.html">mpl</a>)</dd></dl>
<dl class="classindex odd">
<dt class="alphachar"><a id="letter_T" name="letter_T">T</a></dt>
<dd><a class="el" href="classmpl_1_1tag__t.html">tag_t</a> (<a class="el" href="namespacempl.html">mpl</a>)</dd><dd><a class="el" href="classmpl_1_1impl_1_1topology__communicator.html">topology_communicator</a> (<a class="el" href="namespacempl_1_1impl.html">mpl::impl</a>)</dd><dd><a class="el" href="structstd_1_1tuple__element_3_01_n_00_01mpl_1_1cartesian__communicator_1_1dimensions_1_1dimension__periodicity__proxy_01_4.html">tuple_element&lt; N, mpl::cartesian_communicator::dimensions::dimension_periodicity_proxy &gt;</a> (<a class="el" href="namespacestd.html">std</a>)</dd><dd><a class="el" href="structstd_1_1tuple__size_3_01mpl_1_1cartesian__communicator_1_1dimensions_1_1dimension__periodicity__proxy_01_4.html">tuple_size&lt; mpl::cartesian_communicator::dimensions::dimension_periodicity_proxy &gt;</a> (<a class="el" href="namespacestd.html">std</a>)</dd></dl>
Expand Down
Loading

0 comments on commit c52ef1a

Please sign in to comment.