Doc Enable copy to be used with MatrixRef (#1021)

master/classdlaf_1_1common_1_1_index2_d-members.html

@@ -87,14 +87,15 @@
   <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>IndexType</b> typedef (defined in <a class="el" href="classdlaf_1_1common_1_1internal_1_1basic__coords.html">dlaf::common::internal::basic_coords&lt; IndexT &gt;</a>)</td><td class="entry"><a class="el" href="classdlaf_1_1common_1_1internal_1_1basic__coords.html">dlaf::common::internal::basic_coords&lt; IndexT &gt;</a></td><td class="entry"></td></tr>
   <tr><td class="entry"><a class="el" href="classdlaf_1_1common_1_1_index2_d.html#a5f174cc234af20d79923b31d7fa90b19">isIn</a>(const Size2D&lt; IndexT, Tag &gt; &amp;boundary) const noexcept</td><td class="entry"><a class="el" href="classdlaf_1_1common_1_1_index2_d.html">dlaf::common::Index2D&lt; IndexT, Tag &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="classdlaf_1_1common_1_1_index2_d.html#ab230f7ada23f15ffd3b3d0a3921f1685">isInOrOn</a>(const Size2D&lt; IndexT, Tag &gt; &amp;boundary) const noexcept</td><td class="entry"><a class="el" href="classdlaf_1_1common_1_1_index2_d.html">dlaf::common::Index2D&lt; IndexT, Tag &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
-  <tr><td class="entry"><a class="el" href="classdlaf_1_1common_1_1internal_1_1basic__coords.html#a380f1ac07da35bc014bcbfff908eb0a9">isValid</a>() const noexcept</td><td class="entry"><a class="el" href="classdlaf_1_1common_1_1internal_1_1basic__coords.html">dlaf::common::internal::basic_coords&lt; IndexT &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
-  <tr class="even"><td class="entry"><a class="el" href="classdlaf_1_1common_1_1_index2_d.html#ae2e28cf6eab4febd97d6c46d23c6096d">operator!=</a>(const Index2D &amp;rhs) const noexcept</td><td class="entry"><a class="el" href="classdlaf_1_1common_1_1_index2_d.html">dlaf::common::Index2D&lt; IndexT, Tag &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
-  <tr><td class="entry"><a class="el" href="classdlaf_1_1common_1_1internal_1_1basic__coords.html#abf2886043fbe929f1e1f0eff5e20935d">dlaf::common::internal::basic_coords::operator!=</a>(const basic_coords &amp;rhs) const noexcept</td><td class="entry"><a class="el" href="classdlaf_1_1common_1_1internal_1_1basic__coords.html">dlaf::common::internal::basic_coords&lt; IndexT &gt;</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span></td></tr>
-  <tr class="even"><td class="entry"><a class="el" href="classdlaf_1_1common_1_1_index2_d.html#a4724fdad093b5d189c5f5e0b1ac5e305">operator==</a>(const Index2D &amp;rhs) const noexcept</td><td class="entry"><a class="el" href="classdlaf_1_1common_1_1_index2_d.html">dlaf::common::Index2D&lt; IndexT, Tag &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
-  <tr><td class="entry"><a class="el" href="classdlaf_1_1common_1_1internal_1_1basic__coords.html#a95e16def9c322ee963d123635c2c875b">dlaf::common::internal::basic_coords::operator==</a>(const basic_coords &amp;rhs) const noexcept</td><td class="entry"><a class="el" href="classdlaf_1_1common_1_1internal_1_1basic__coords.html">dlaf::common::internal::basic_coords&lt; IndexT &gt;</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span></td></tr>
-  <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>row</b>() const noexcept (defined in <a class="el" href="classdlaf_1_1common_1_1_index2_d.html">dlaf::common::Index2D&lt; IndexT, Tag &gt;</a>)</td><td class="entry"><a class="el" href="classdlaf_1_1common_1_1_index2_d.html">dlaf::common::Index2D&lt; IndexT, Tag &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
-  <tr bgcolor="#f0f0f0"><td class="entry"><b>row_</b> (defined in <a class="el" href="classdlaf_1_1common_1_1internal_1_1basic__coords.html">dlaf::common::internal::basic_coords&lt; IndexT &gt;</a>)</td><td class="entry"><a class="el" href="classdlaf_1_1common_1_1internal_1_1basic__coords.html">dlaf::common::internal::basic_coords&lt; IndexT &gt;</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
-  <tr class="even"><td class="entry"><a class="el" href="classdlaf_1_1common_1_1internal_1_1basic__coords.html#a98f8b3b0cd7b4c1fa62b40b9de0041bb">transpose</a>() noexcept</td><td class="entry"><a class="el" href="classdlaf_1_1common_1_1internal_1_1basic__coords.html">dlaf::common::internal::basic_coords&lt; IndexT &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
+  <tr><td class="entry"><a class="el" href="classdlaf_1_1common_1_1_index2_d.html#a3849d1f8e08889c7f1d7998874fa7be9">isInSub</a>(const Index2D &amp;origin, const Size2D&lt; IndexT, Tag &gt; &amp;sub_boundary) const noexcept</td><td class="entry"><a class="el" href="classdlaf_1_1common_1_1_index2_d.html">dlaf::common::Index2D&lt; IndexT, Tag &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classdlaf_1_1common_1_1internal_1_1basic__coords.html#a380f1ac07da35bc014bcbfff908eb0a9">isValid</a>() const noexcept</td><td class="entry"><a class="el" href="classdlaf_1_1common_1_1internal_1_1basic__coords.html">dlaf::common::internal::basic_coords&lt; IndexT &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
+  <tr><td class="entry"><a class="el" href="classdlaf_1_1common_1_1_index2_d.html#ae2e28cf6eab4febd97d6c46d23c6096d">operator!=</a>(const Index2D &amp;rhs) const noexcept</td><td class="entry"><a class="el" href="classdlaf_1_1common_1_1_index2_d.html">dlaf::common::Index2D&lt; IndexT, Tag &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classdlaf_1_1common_1_1internal_1_1basic__coords.html#abf2886043fbe929f1e1f0eff5e20935d">dlaf::common::internal::basic_coords::operator!=</a>(const basic_coords &amp;rhs) const noexcept</td><td class="entry"><a class="el" href="classdlaf_1_1common_1_1internal_1_1basic__coords.html">dlaf::common::internal::basic_coords&lt; IndexT &gt;</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span></td></tr>
+  <tr><td class="entry"><a class="el" href="classdlaf_1_1common_1_1_index2_d.html#a4724fdad093b5d189c5f5e0b1ac5e305">operator==</a>(const Index2D &amp;rhs) const noexcept</td><td class="entry"><a class="el" href="classdlaf_1_1common_1_1_index2_d.html">dlaf::common::Index2D&lt; IndexT, Tag &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classdlaf_1_1common_1_1internal_1_1basic__coords.html#a95e16def9c322ee963d123635c2c875b">dlaf::common::internal::basic_coords::operator==</a>(const basic_coords &amp;rhs) const noexcept</td><td class="entry"><a class="el" href="classdlaf_1_1common_1_1internal_1_1basic__coords.html">dlaf::common::internal::basic_coords&lt; IndexT &gt;</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span></td></tr>
+  <tr bgcolor="#f0f0f0"><td class="entry"><b>row</b>() const noexcept (defined in <a class="el" href="classdlaf_1_1common_1_1_index2_d.html">dlaf::common::Index2D&lt; IndexT, Tag &gt;</a>)</td><td class="entry"><a class="el" href="classdlaf_1_1common_1_1_index2_d.html">dlaf::common::Index2D&lt; IndexT, Tag &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
+  <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>row_</b> (defined in <a class="el" href="classdlaf_1_1common_1_1internal_1_1basic__coords.html">dlaf::common::internal::basic_coords&lt; IndexT &gt;</a>)</td><td class="entry"><a class="el" href="classdlaf_1_1common_1_1internal_1_1basic__coords.html">dlaf::common::internal::basic_coords&lt; IndexT &gt;</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
+  <tr><td class="entry"><a class="el" href="classdlaf_1_1common_1_1internal_1_1basic__coords.html#a98f8b3b0cd7b4c1fa62b40b9de0041bb">transpose</a>() noexcept</td><td class="entry"><a class="el" href="classdlaf_1_1common_1_1internal_1_1basic__coords.html">dlaf::common::internal::basic_coords&lt; IndexT &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
 </table></div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>

master/classdlaf_1_1common_1_1_index2_d.html

@@ -102,6 +102,8 @@
 <tr class="separator:a5f174cc234af20d79923b31d7fa90b19"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:ab230f7ada23f15ffd3b3d0a3921f1685"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdlaf_1_1common_1_1_index2_d.html#ab230f7ada23f15ffd3b3d0a3921f1685">isInOrOn</a> (const <a class="el" href="classdlaf_1_1common_1_1_size2_d.html">Size2D</a>&lt; IndexT, Tag &gt; &amp;boundary) const noexcept</td></tr>
 <tr class="separator:ab230f7ada23f15ffd3b3d0a3921f1685"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a3849d1f8e08889c7f1d7998874fa7be9"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdlaf_1_1common_1_1_index2_d.html#a3849d1f8e08889c7f1d7998874fa7be9">isInSub</a> (const <a class="el" href="classdlaf_1_1common_1_1_index2_d.html">Index2D</a> &amp;origin, const <a class="el" href="classdlaf_1_1common_1_1_size2_d.html">Size2D</a>&lt; IndexT, Tag &gt; &amp;sub_boundary) const noexcept</td></tr>
+<tr class="separator:a3849d1f8e08889c7f1d7998874fa7be9"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a4724fdad093b5d189c5f5e0b1ac5e305"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdlaf_1_1common_1_1_index2_d.html#a4724fdad093b5d189c5f5e0b1ac5e305">operator==</a> (const <a class="el" href="classdlaf_1_1common_1_1_index2_d.html">Index2D</a> &amp;rhs) const noexcept</td></tr>
 <tr class="separator:a4724fdad093b5d189c5f5e0b1ac5e305"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:ae2e28cf6eab4febd97d6c46d23c6096d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdlaf_1_1common_1_1_index2_d.html#ae2e28cf6eab4febd97d6c46d23c6096d">operator!=</a> (const <a class="el" href="classdlaf_1_1common_1_1_index2_d.html">Index2D</a> &amp;rhs) const noexcept</td></tr>
@@ -374,6 +376,58 @@ <h2 class="memtitle"><span class="permalink"><a href="#ab230f7ada23f15ffd3b3d0a3
 <dd>
 boundary.isValid(). </dd></dl>
 
+</div>
+</div>
+<a id="a3849d1f8e08889c7f1d7998874fa7be9"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a3849d1f8e08889c7f1d7998874fa7be9">&#9670;&nbsp;</a></span>isInSub()</h2>
+
+<div class="memitem">
+<div class="memproto">
+<div class="memtemplate">
+template&lt;typename IndexT , class Tag &gt; </div>
+<table class="mlabels">
+  <tr>
+  <td class="mlabels-left">
+      <table class="memname">
+        <tr>
+          <td class="memname">bool <a class="el" href="classdlaf_1_1common_1_1_index2_d.html">dlaf::common::Index2D</a>&lt; IndexT, Tag &gt;::isInSub </td>
+          <td>(</td>
+          <td class="paramtype">const <a class="el" href="classdlaf_1_1common_1_1_index2_d.html">Index2D</a>&lt; IndexT, Tag &gt; &amp;&#160;</td>
+          <td class="paramname"><em>origin</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">const <a class="el" href="classdlaf_1_1common_1_1_size2_d.html">Size2D</a>&lt; IndexT, Tag &gt; &amp;&#160;</td>
+          <td class="paramname"><em>sub_boundary</em>&#160;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td> const</td>
+        </tr>
+      </table>
+  </td>
+  <td class="mlabels-right">
+<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span>  </td>
+  </tr>
+</table>
+</div><div class="memdoc">
+<p>Check if it is a valid position inside the sub-grid defined by <code>origin</code> and <code>sub_boundary</code>.</p>
+<dl class="params"><dt>Parameters</dt><dd>
+  <table class="params">
+    <tr><td class="paramname">origin</td><td>of the sub-grid </td></tr>
+    <tr><td class="paramname">sub_boundary</td><td>size of the sub-grid </td></tr>
+  </table>
+  </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd>true if the current index is in the sub-range [<code>origin</code>, <code>origin</code> + <code>sub_boundary</code>) </dd></dl>
+<dl class="section pre"><dt>Precondition</dt><dd><a class="el" href="classdlaf_1_1common_1_1internal_1_1basic__coords.html#a380f1ac07da35bc014bcbfff908eb0a9">Index2D.isValid</a>, </dd>
+<dd>
+origin.isValid(), </dd>
+<dd>
+sub_boundary.isValid(). </dd></dl>
+
 </div>
 </div>
 <a id="ae2e28cf6eab4febd97d6c46d23c6096d"></a>

master/copy_8h.html

@@ -80,6 +80,7 @@
 <code>#include &lt;<a class="el" href="copy__tile_8h_source.html">dlaf/matrix/copy_tile.h</a>&gt;</code><br />
 <code>#include &lt;<a class="el" href="index_8h_source.html">dlaf/matrix/index.h</a>&gt;</code><br />
 <code>#include &lt;<a class="el" href="matrix_8h_source.html">dlaf/matrix/matrix.h</a>&gt;</code><br />
+<code>#include &lt;<a class="el" href="matrix__ref_8h_source.html">dlaf/matrix/matrix_ref.h</a>&gt;</code><br />
 <code>#include &lt;<a class="el" href="types_8h_source.html">dlaf/types.h</a>&gt;</code><br />
 <code>#include &lt;<a class="el" href="util__math_8h_source.html">dlaf/util_math.h</a>&gt;</code><br />
 <code>#include &lt;<a class="el" href="util__matrix_8h_source.html">dlaf/util_matrix.h</a>&gt;</code><br />
@@ -99,6 +100,10 @@
 template&lt;class T , Device Source, Device Destination&gt; </td></tr>
 <tr class="memitem:ad10d0589a12343c067f93822fbad6aed"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><b>dlaf::matrix::copy</b> (Matrix&lt; const T, Source &gt; &amp;source, Matrix&lt; T, Destination &gt; &amp;dest)</td></tr>
 <tr class="separator:ad10d0589a12343c067f93822fbad6aed"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:affbbd583380737f78cd8fe5c5ec8697c"><td class="memTemplParams" colspan="2"><a id="affbbd583380737f78cd8fe5c5ec8697c"></a>
+template&lt;class T , Device Source, Device Destination&gt; </td></tr>
+<tr class="memitem:affbbd583380737f78cd8fe5c5ec8697c"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><b>dlaf::matrix::internal::copy</b> (MatrixRef&lt; const T, Source &gt; &amp;src, MatrixRef&lt; T, Destination &gt; &amp;dst)</td></tr>
+<tr class="separator:affbbd583380737f78cd8fe5c5ec8697c"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a4e9f34de930792a328db5561dc67a788"><td class="memTemplParams" colspan="2">template&lt;class T , Device Source, Device Destination&gt; </td></tr>
 <tr class="memitem:a4e9f34de930792a328db5561dc67a788"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="copy_8h.html#a4e9f34de930792a328db5561dc67a788">dlaf::matrix::copy</a> (Matrix&lt; const T, Source &gt; &amp;src, Matrix&lt; T, Destination &gt; &amp;dst, comm::CommunicatorGrid grid)</td></tr>
 <tr class="separator:a4e9f34de930792a328db5561dc67a788"><td class="memSeparator" colspan="2">&#160;</td></tr>