Doc: Add miniapps as tests (#1112)

master/classdlaf_1_1comm_1_1_communicator_grid-members.html

@@ -107,6 +107,7 @@
   <tr class="odd"><td class="entry"><a class="el" href="classdlaf_1_1comm_1_1_communicator_grid.html#ae87532767e713755b513490a3d934de1">rowCommunicator</a>() noexcept</td><td class="entry"><a class="el" href="classdlaf_1_1comm_1_1_communicator_grid.html">dlaf::comm::CommunicatorGrid</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="classdlaf_1_1comm_1_1_communicator_grid.html#a9307e8d79bffad58211c317c92c7dc77">size</a>() const noexcept</td><td class="entry"><a class="el" href="classdlaf_1_1comm_1_1_communicator_grid.html">dlaf::comm::CommunicatorGrid</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
   <tr bgcolor="#f0f0f0" class="odd"><td class="entry"><b>subCommunicator</b>(Coord cr) noexcept (defined in <a class="el" href="classdlaf_1_1comm_1_1_communicator_grid.html">dlaf::comm::CommunicatorGrid</a>)</td><td class="entry"><a class="el" href="classdlaf_1_1comm_1_1_communicator_grid.html">dlaf::comm::CommunicatorGrid</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classdlaf_1_1comm_1_1_communicator_grid.html#a5d81da35f8c4683dcdfbd9091d7d8f7e">wait_all_communicators</a>()</td><td class="entry"><a class="el" href="classdlaf_1_1comm_1_1_communicator_grid.html">dlaf::comm::CommunicatorGrid</a></td><td class="entry"></td></tr>
 </table></div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>

master/classdlaf_1_1comm_1_1_communicator_grid.html

@@ -138,6 +138,8 @@
 <tr class="memitem:a2e96476e0456683e12a6e1fdffc110ac" id="r_a2e96476e0456683e12a6e1fdffc110ac"><td class="memTemplParams" colspan="2">template&lt;Coord C&gt; </td></tr>
 <tr class="memitem:a2e96476e0456683e12a6e1fdffc110ac"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classdlaf_1_1comm_1_1_communicator_pipeline.html">CommunicatorPipeline</a>&lt; coord_to_communicator_type(C)&gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classdlaf_1_1comm_1_1_communicator_grid.html#a2e96476e0456683e12a6e1fdffc110ac">communicator_pipeline</a> ()</td></tr>
 <tr class="separator:a2e96476e0456683e12a6e1fdffc110ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a5d81da35f8c4683dcdfbd9091d7d8f7e" id="r_a5d81da35f8c4683dcdfbd9091d7d8f7e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdlaf_1_1comm_1_1_communicator_grid.html#a5d81da35f8c4683dcdfbd9091d7d8f7e">wait_all_communicators</a> ()</td></tr>
+<tr class="separator:a5d81da35f8c4683dcdfbd9091d7d8f7e"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table><table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-types" name="pro-types"></a>
 Protected Types</h2></td></tr>
@@ -456,6 +458,25 @@ <h2 class="memtitle"><span class="permalink"><a href="#ae87532767e713755b513490a
 </div><div class="memdoc">
 <p>Return a <a class="el" href="classdlaf_1_1comm_1_1_communicator.html">Communicator</a> grouping all ranks in the row (that includes the current process). </p>
 
+</div>
+</div>
+<a id="a5d81da35f8c4683dcdfbd9091d7d8f7e" name="a5d81da35f8c4683dcdfbd9091d7d8f7e"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a5d81da35f8c4683dcdfbd9091d7d8f7e">&#9670;&#160;</a></span>wait_all_communicators()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void dlaf::comm::CommunicatorGrid::wait_all_communicators </td>
+          <td>(</td>
+          <td class="paramname"></td><td>)</td>
+          <td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>Synchronization barrier for all communicators in the grid</p>
+<p>This function returns when all communications on the communicators in the grid have completed. </p>
+
 </div>
 </div>
 <hr/>The documentation for this class was generated from the following file:<ul>

master/communicator__grid_8h_source.html

@@ -203,38 +203,41 @@
 <div class="line"><a id="l00132" name="l00132"></a><span class="lineno">  132</span>  }</div>
 </div>
 <div class="line"><a id="l00133" name="l00133"></a><span class="lineno">  133</span> </div>
-<div class="foldopen" id="foldopen00135" data-start="{" data-end="};">
-<div class="line"><a id="l00135" name="l00135"></a><span class="lineno"><a class="line" href="classdlaf_1_1comm_1_1_communicator_grid.html#a70a861c0ca6ace054b23b76cca22b932">  135</a></span>  <span class="keyword">friend</span> std::ostream&amp; <a class="code hl_friend" href="classdlaf_1_1comm_1_1_communicator_grid.html#a70a861c0ca6ace054b23b76cca22b932">operator&lt;&lt;</a>(std::ostream&amp; out, <span class="keyword">const</span> <a class="code hl_class" href="classdlaf_1_1comm_1_1_communicator_grid.html">CommunicatorGrid</a>&amp; grid) {</div>
-<div class="line"><a id="l00136" name="l00136"></a><span class="lineno">  136</span>    <span class="keywordflow">return</span> out &lt;&lt; <span class="stringliteral">&quot;position=&quot;</span> &lt;&lt; grid.position_ &lt;&lt; <span class="stringliteral">&quot;, size=&quot;</span> &lt;&lt; grid.grid_size_;</div>
-<div class="line"><a id="l00137" name="l00137"></a><span class="lineno">  137</span>  }</div>
-</div>
+<div class="line"><a id="l00137" name="l00137"></a><span class="lineno"><a class="line" href="classdlaf_1_1comm_1_1_communicator_grid.html#a5d81da35f8c4683dcdfbd9091d7d8f7e">  137</a></span>  <span class="keywordtype">void</span> <a class="code hl_function" href="classdlaf_1_1comm_1_1_communicator_grid.html#a5d81da35f8c4683dcdfbd9091d7d8f7e">wait_all_communicators</a>();</div>
 <div class="line"><a id="l00138" name="l00138"></a><span class="lineno">  138</span> </div>
-<div class="line"><a id="l00139" name="l00139"></a><span class="lineno">  139</span><span class="keyword">protected</span>:</div>
-<div class="line"><a id="l00140" name="l00140"></a><span class="lineno">  140</span>  <a class="code hl_class" href="classdlaf_1_1comm_1_1_communicator.html">Communicator</a> full_;</div>
-<div class="line"><a id="l00141" name="l00141"></a><span class="lineno">  141</span>  <a class="code hl_class" href="classdlaf_1_1comm_1_1_communicator.html">Communicator</a> row_;</div>
-<div class="line"><a id="l00142" name="l00142"></a><span class="lineno">  142</span>  <a class="code hl_class" href="classdlaf_1_1comm_1_1_communicator.html">Communicator</a> col_;</div>
+<div class="foldopen" id="foldopen00140" data-start="{" data-end="};">
+<div class="line"><a id="l00140" name="l00140"></a><span class="lineno"><a class="line" href="classdlaf_1_1comm_1_1_communicator_grid.html#a70a861c0ca6ace054b23b76cca22b932">  140</a></span>  <span class="keyword">friend</span> std::ostream&amp; <a class="code hl_friend" href="classdlaf_1_1comm_1_1_communicator_grid.html#a70a861c0ca6ace054b23b76cca22b932">operator&lt;&lt;</a>(std::ostream&amp; out, <span class="keyword">const</span> <a class="code hl_class" href="classdlaf_1_1comm_1_1_communicator_grid.html">CommunicatorGrid</a>&amp; grid) {</div>
+<div class="line"><a id="l00141" name="l00141"></a><span class="lineno">  141</span>    <span class="keywordflow">return</span> out &lt;&lt; <span class="stringliteral">&quot;position=&quot;</span> &lt;&lt; grid.position_ &lt;&lt; <span class="stringliteral">&quot;, size=&quot;</span> &lt;&lt; grid.grid_size_;</div>
+<div class="line"><a id="l00142" name="l00142"></a><span class="lineno">  142</span>  }</div>
+</div>
 <div class="line"><a id="l00143" name="l00143"></a><span class="lineno">  143</span> </div>
-<div class="line"><a id="l00144" name="l00144"></a><span class="lineno">  144</span>  <span class="keyword">template</span> &lt;CommunicatorType CT&gt;</div>
-<div class="line"><a id="l00145" name="l00145"></a><span class="lineno">  145</span>  <span class="keyword">using </span>RoundRobinPipeline = <a class="code hl_class" href="classdlaf_1_1common_1_1_round_robin.html">dlaf::common::RoundRobin&lt;CommunicatorPipeline&lt;CT&gt;</a>&gt;;</div>
-<div class="line"><a id="l00146" name="l00146"></a><span class="lineno">  146</span> </div>
-<div class="line"><a id="l00147" name="l00147"></a><span class="lineno">  147</span>  RoundRobinPipeline&lt;CommunicatorType::Full&gt; full_pipelines_;</div>
-<div class="line"><a id="l00148" name="l00148"></a><span class="lineno">  148</span>  RoundRobinPipeline&lt;CommunicatorType::Row&gt; row_pipelines_;</div>
-<div class="line"><a id="l00149" name="l00149"></a><span class="lineno">  149</span>  RoundRobinPipeline&lt;CommunicatorType::Col&gt; col_pipelines_;</div>
-<div class="line"><a id="l00150" name="l00150"></a><span class="lineno">  150</span> </div>
-<div class="line"><a id="l00151" name="l00151"></a><span class="lineno">  151</span>  <a class="code hl_class" href="classdlaf_1_1common_1_1_index2_d.html">Index2D</a> position_;</div>
-<div class="line"><a id="l00152" name="l00152"></a><span class="lineno">  152</span>  <a class="code hl_class" href="classdlaf_1_1common_1_1_size2_d.html">Size2D</a> grid_size_ = <a class="code hl_class" href="classdlaf_1_1common_1_1_size2_d.html">Size2D</a>(0, 0);</div>
-<div class="line"><a id="l00153" name="l00153"></a><span class="lineno">  153</span>};</div>
+<div class="line"><a id="l00144" name="l00144"></a><span class="lineno">  144</span><span class="keyword">protected</span>:</div>
+<div class="line"><a id="l00145" name="l00145"></a><span class="lineno">  145</span>  <a class="code hl_class" href="classdlaf_1_1comm_1_1_communicator.html">Communicator</a> full_;</div>
+<div class="line"><a id="l00146" name="l00146"></a><span class="lineno">  146</span>  <a class="code hl_class" href="classdlaf_1_1comm_1_1_communicator.html">Communicator</a> row_;</div>
+<div class="line"><a id="l00147" name="l00147"></a><span class="lineno">  147</span>  <a class="code hl_class" href="classdlaf_1_1comm_1_1_communicator.html">Communicator</a> col_;</div>
+<div class="line"><a id="l00148" name="l00148"></a><span class="lineno">  148</span> </div>
+<div class="line"><a id="l00149" name="l00149"></a><span class="lineno">  149</span>  <span class="keyword">template</span> &lt;CommunicatorType CT&gt;</div>
+<div class="line"><a id="l00150" name="l00150"></a><span class="lineno">  150</span>  <span class="keyword">using </span>RoundRobinPipeline = <a class="code hl_class" href="classdlaf_1_1common_1_1_round_robin.html">dlaf::common::RoundRobin&lt;CommunicatorPipeline&lt;CT&gt;</a>&gt;;</div>
+<div class="line"><a id="l00151" name="l00151"></a><span class="lineno">  151</span> </div>
+<div class="line"><a id="l00152" name="l00152"></a><span class="lineno">  152</span>  RoundRobinPipeline&lt;CommunicatorType::Full&gt; full_pipelines_;</div>
+<div class="line"><a id="l00153" name="l00153"></a><span class="lineno">  153</span>  RoundRobinPipeline&lt;CommunicatorType::Row&gt; row_pipelines_;</div>
+<div class="line"><a id="l00154" name="l00154"></a><span class="lineno">  154</span>  RoundRobinPipeline&lt;CommunicatorType::Col&gt; col_pipelines_;</div>
+<div class="line"><a id="l00155" name="l00155"></a><span class="lineno">  155</span> </div>
+<div class="line"><a id="l00156" name="l00156"></a><span class="lineno">  156</span>  <a class="code hl_class" href="classdlaf_1_1common_1_1_index2_d.html">Index2D</a> position_;</div>
+<div class="line"><a id="l00157" name="l00157"></a><span class="lineno">  157</span>  <a class="code hl_class" href="classdlaf_1_1common_1_1_size2_d.html">Size2D</a> grid_size_ = <a class="code hl_class" href="classdlaf_1_1common_1_1_size2_d.html">Size2D</a>(0, 0);</div>
+<div class="line"><a id="l00158" name="l00158"></a><span class="lineno">  158</span>};</div>
 </div>
-<div class="line"><a id="l00154" name="l00154"></a><span class="lineno">  154</span> </div>
-<div class="line"><a id="l00155" name="l00155"></a><span class="lineno">  155</span>}  <span class="comment">// namespace comm</span></div>
-<div class="line"><a id="l00156" name="l00156"></a><span class="lineno">  156</span>}  <span class="comment">// namespace dlaf</span></div>
+<div class="line"><a id="l00159" name="l00159"></a><span class="lineno">  159</span> </div>
+<div class="line"><a id="l00160" name="l00160"></a><span class="lineno">  160</span>}  <span class="comment">// namespace comm</span></div>
+<div class="line"><a id="l00161" name="l00161"></a><span class="lineno">  161</span>}  <span class="comment">// namespace dlaf</span></div>
 <div class="ttc" id="aclassdlaf_1_1comm_1_1_communicator_grid_html"><div class="ttname"><a href="classdlaf_1_1comm_1_1_communicator_grid.html">dlaf::comm::CommunicatorGrid</a></div><div class="ttdef"><b>Definition</b> communicator_grid.h:37</div></div>
 <div class="ttc" id="aclassdlaf_1_1comm_1_1_communicator_grid_html_a0df3ddebd78d8c5fcaa6f46b70cf3fae"><div class="ttname"><a href="classdlaf_1_1comm_1_1_communicator_grid.html#a0df3ddebd78d8c5fcaa6f46b70cf3fae">dlaf::comm::CommunicatorGrid::CommunicatorGrid</a></div><div class="ttdeci">CommunicatorGrid(Communicator comm, const std::array&lt; IndexT_MPI, 2 &gt; &amp;size, common::Ordering ordering, std::size_t npipelines=getTuneParameters().communicator_grid_num_pipelines)</div><div class="ttdef"><b>Definition</b> communicator_grid.h:48</div></div>
 <div class="ttc" id="aclassdlaf_1_1comm_1_1_communicator_grid_html_a2e96476e0456683e12a6e1fdffc110ac"><div class="ttname"><a href="classdlaf_1_1comm_1_1_communicator_grid.html#a2e96476e0456683e12a6e1fdffc110ac">dlaf::comm::CommunicatorGrid::communicator_pipeline</a></div><div class="ttdeci">CommunicatorPipeline&lt; coord_to_communicator_type(C)&gt; communicator_pipeline()</div><div class="ttdef"><b>Definition</b> communicator_grid.h:127</div></div>
 <div class="ttc" id="aclassdlaf_1_1comm_1_1_communicator_grid_html_a45574d05dd3cfb3d40d198cdf10b169e"><div class="ttname"><a href="classdlaf_1_1comm_1_1_communicator_grid.html#a45574d05dd3cfb3d40d198cdf10b169e">dlaf::comm::CommunicatorGrid::rank</a></div><div class="ttdeci">Index2D rank() const noexcept</div><div class="ttdef"><b>Definition</b> communicator_grid.h:74</div></div>
 <div class="ttc" id="aclassdlaf_1_1comm_1_1_communicator_grid_html_a5590521bfb7b83e627159904eb069a1f"><div class="ttname"><a href="classdlaf_1_1comm_1_1_communicator_grid.html#a5590521bfb7b83e627159904eb069a1f">dlaf::comm::CommunicatorGrid::colCommunicator</a></div><div class="ttdeci">Communicator &amp; colCommunicator() noexcept</div><div class="ttdef"><b>Definition</b> communicator_grid.h:96</div></div>
 <div class="ttc" id="aclassdlaf_1_1comm_1_1_communicator_grid_html_a57ef425200bdfb1dd15ca66ae080d210"><div class="ttname"><a href="classdlaf_1_1comm_1_1_communicator_grid.html#a57ef425200bdfb1dd15ca66ae080d210">dlaf::comm::CommunicatorGrid::row_communicator_pipeline</a></div><div class="ttdeci">CommunicatorPipeline&lt; CommunicatorType::Row &gt; row_communicator_pipeline()</div><div class="ttdef"><b>Definition</b> communicator_grid.h:114</div></div>
-<div class="ttc" id="aclassdlaf_1_1comm_1_1_communicator_grid_html_a70a861c0ca6ace054b23b76cca22b932"><div class="ttname"><a href="classdlaf_1_1comm_1_1_communicator_grid.html#a70a861c0ca6ace054b23b76cca22b932">dlaf::comm::CommunicatorGrid::operator&lt;&lt;</a></div><div class="ttdeci">friend std::ostream &amp; operator&lt;&lt;(std::ostream &amp;out, const CommunicatorGrid &amp;grid)</div><div class="ttdoc">Prints information about the CommunicationGrid.</div><div class="ttdef"><b>Definition</b> communicator_grid.h:135</div></div>
+<div class="ttc" id="aclassdlaf_1_1comm_1_1_communicator_grid_html_a5d81da35f8c4683dcdfbd9091d7d8f7e"><div class="ttname"><a href="classdlaf_1_1comm_1_1_communicator_grid.html#a5d81da35f8c4683dcdfbd9091d7d8f7e">dlaf::comm::CommunicatorGrid::wait_all_communicators</a></div><div class="ttdeci">void wait_all_communicators()</div></div>
+<div class="ttc" id="aclassdlaf_1_1comm_1_1_communicator_grid_html_a70a861c0ca6ace054b23b76cca22b932"><div class="ttname"><a href="classdlaf_1_1comm_1_1_communicator_grid.html#a70a861c0ca6ace054b23b76cca22b932">dlaf::comm::CommunicatorGrid::operator&lt;&lt;</a></div><div class="ttdeci">friend std::ostream &amp; operator&lt;&lt;(std::ostream &amp;out, const CommunicatorGrid &amp;grid)</div><div class="ttdoc">Prints information about the CommunicationGrid.</div><div class="ttdef"><b>Definition</b> communicator_grid.h:140</div></div>
 <div class="ttc" id="aclassdlaf_1_1comm_1_1_communicator_grid_html_a9307e8d79bffad58211c317c92c7dc77"><div class="ttname"><a href="classdlaf_1_1comm_1_1_communicator_grid.html#a9307e8d79bffad58211c317c92c7dc77">dlaf::comm::CommunicatorGrid::size</a></div><div class="ttdeci">Size2D size() const noexcept</div><div class="ttdoc">Return the number of rows in the grid.</div><div class="ttdef"><b>Definition</b> communicator_grid.h:79</div></div>
 <div class="ttc" id="aclassdlaf_1_1comm_1_1_communicator_grid_html_a9efa29f203caf3ff4d5cdb83386b73e3"><div class="ttname"><a href="classdlaf_1_1comm_1_1_communicator_grid.html#a9efa29f203caf3ff4d5cdb83386b73e3">dlaf::comm::CommunicatorGrid::CommunicatorGrid</a></div><div class="ttdeci">CommunicatorGrid(Communicator comm, IndexT_MPI rows, IndexT_MPI cols, common::Ordering ordering, std::size_t npipelines=getTuneParameters().communicator_grid_num_pipelines)</div></div>
 <div class="ttc" id="aclassdlaf_1_1comm_1_1_communicator_grid_html_aa14622db356b247aad0e0f460a281822"><div class="ttname"><a href="classdlaf_1_1comm_1_1_communicator_grid.html#aa14622db356b247aad0e0f460a281822">dlaf::comm::CommunicatorGrid::full_communicator_pipeline</a></div><div class="ttdeci">CommunicatorPipeline&lt; CommunicatorType::Full &gt; full_communicator_pipeline()</div><div class="ttdoc">Return a pipeline to a Communicator grouping all ranks in the grid.</div><div class="ttdef"><b>Definition</b> communicator_grid.h:108</div></div>

master/functions_func_w.html

@@ -72,6 +72,7 @@
 <div class="textblock">Here is a list of all documented functions with links to the class documentation for each member:</div>
 
 <h3><a id="index_w" name="index_w"></a>- w -</h3><ul>
+<li>wait_all_communicators()&#160;:&#160;<a class="el" href="classdlaf_1_1comm_1_1_communicator_grid.html#a5d81da35f8c4683dcdfbd9091d7d8f7e">dlaf::comm::CommunicatorGrid</a></li>
 <li>waitLocalTiles()&#160;:&#160;<a class="el" href="classdlaf_1_1matrix_1_1_matrix_3_01const_01_t_00_01_d_01_4.html#abffc73bf079f7f7c23af3fca4dec329f">dlaf::matrix::Matrix&lt; const T, D &gt;</a></li>
 </ul>
 </div><!-- contents -->

master/functions_w.html

@@ -72,6 +72,7 @@
 <div class="textblock">Here is a list of all documented class members with links to the class documentation for each member:</div>
 
 <h3><a id="index_w" name="index_w"></a>- w -</h3><ul>
+<li>wait_all_communicators()&#160;:&#160;<a class="el" href="classdlaf_1_1comm_1_1_communicator_grid.html#a5d81da35f8c4683dcdfbd9091d7d8f7e">dlaf::comm::CommunicatorGrid</a></li>
 <li>waitLocalTiles()&#160;:&#160;<a class="el" href="classdlaf_1_1matrix_1_1_matrix_3_01const_01_t_00_01_d_01_4.html#abffc73bf079f7f7c23af3fca4dec329f">dlaf::matrix::Matrix&lt; const T, D &gt;</a></li>
 </ul>
 </div><!-- contents -->