Updating Doxygen docs

2026-05-13 01:35:45 +00:00 · 2018-10-26 14:54:58 -07:00
parent 74df0331f2
commit b2bc0d3b79
1065 changed files with 12770 additions and 4093 deletions
--- a/docs/structcutlass_1_1TensorRefArray.html
+++ b/docs/structcutlass_1_1TensorRefArray.html
@@ -94,9 +94,6 @@ Classes</h2></td></tr>
 </table><table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
 Public Types</h2></td></tr>
-<tr class="memitem:a066d684240f8a24e1ba621ae3904ec75"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="structcutlass_1_1TensorRefArray.html#a066d684240f8a24e1ba621ae3904ec75">TensorRef</a>&lt; Storage_, Rank_, MapFunc_, StorageRank_, Index_, LongIndex_ &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcutlass_1_1TensorRefArray.html#a066d684240f8a24e1ba621ae3904ec75">TensorRef</a></td></tr>
-<tr class="memdesc:a066d684240f8a24e1ba621ae3904ec75"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classcutlass_1_1TensorRef.html">TensorRef</a> type obtained from the <a class="el" href="structcutlass_1_1TensorRefArray.html">TensorRefArray</a>.  <a href="#a066d684240f8a24e1ba621ae3904ec75">More...</a><br /></td></tr>
-<tr class="separator:a066d684240f8a24e1ba621ae3904ec75"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:ab6a6ed8af1a4b3da33e840409c0a72d8"><td class="memItemLeft" align="right" valign="top">typedef Storage_&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcutlass_1_1TensorRefArray.html#ab6a6ed8af1a4b3da33e840409c0a72d8">Storage</a></td></tr>
 <tr class="memdesc:ab6a6ed8af1a4b3da33e840409c0a72d8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Element pointed to by the <a class="el" href="classcutlass_1_1TensorRef.html">TensorRef</a>.  <a href="#ab6a6ed8af1a4b3da33e840409c0a72d8">More...</a><br /></td></tr>
 <tr class="separator:ab6a6ed8af1a4b3da33e840409c0a72d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -106,15 +103,18 @@ Public Types</h2></td></tr>
 <tr class="memitem:a6220549b72ed8451dbf76466b50a96c0"><td class="memItemLeft" align="right" valign="top">typedef LongIndex_&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcutlass_1_1TensorRefArray.html#a6220549b72ed8451dbf76466b50a96c0">LongIndex</a></td></tr>
 <tr class="memdesc:a6220549b72ed8451dbf76466b50a96c0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Typically, strides in memory can be very large.  <a href="#a6220549b72ed8451dbf76466b50a96c0">More...</a><br /></td></tr>
 <tr class="separator:a6220549b72ed8451dbf76466b50a96c0"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a066d684240f8a24e1ba621ae3904ec75"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="structcutlass_1_1TensorRefArray.html#a066d684240f8a24e1ba621ae3904ec75">TensorRef</a>&lt; Storage_, Rank_, MapFunc_, StorageRank_, Index_, LongIndex_ &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcutlass_1_1TensorRefArray.html#a066d684240f8a24e1ba621ae3904ec75">TensorRef</a></td></tr>
+<tr class="memdesc:a066d684240f8a24e1ba621ae3904ec75"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classcutlass_1_1TensorRef.html">TensorRef</a> type obtained from the <a class="el" href="structcutlass_1_1TensorRefArray.html">TensorRefArray</a>.  <a href="#a066d684240f8a24e1ba621ae3904ec75">More...</a><br /></td></tr>
+<tr class="separator:a066d684240f8a24e1ba621ae3904ec75"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table><table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
 Public Member Functions</h2></td></tr>
-<tr class="memitem:a771ede5f73ec18729cc9a5946cf86109"><td class="memItemLeft" align="right" valign="top"><a class="el" href="cutlass_8h.html#a28c2443a142676d3d71effdae1a986b1">CUTLASS_HOST_DEVICE</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcutlass_1_1TensorRefArray.html#a771ede5f73ec18729cc9a5946cf86109">TensorArrayRef</a> ()</td></tr>
-<tr class="separator:a771ede5f73ec18729cc9a5946cf86109"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:aea35239326dcb23c3c6a18e7b3f92091"><td class="memItemLeft" align="right" valign="top"><a class="el" href="cutlass_8h.html#a28c2443a142676d3d71effdae1a986b1">CUTLASS_HOST_DEVICE</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcutlass_1_1TensorRefArray.html#aea35239326dcb23c3c6a18e7b3f92091">TensorArrayRef</a> (<a class="el" href="structcutlass_1_1TensorRefArray.html#ab6a6ed8af1a4b3da33e840409c0a72d8">Storage</a> **_pointers, <a class="el" href="structcutlass_1_1TensorRefArray.html#a8f4658dd194b305ae4f150cf371869d9">Index</a> _strides[<a class="el" href="structcutlass_1_1TensorRefArray.html#a131bdcf213e3d46672c9b3b34d6bf243">kStorageRank</a> - 1])</td></tr>
-<tr class="separator:aea35239326dcb23c3c6a18e7b3f92091"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a2a95fd42d48c550a45f340b04f9dfe3d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="cutlass_8h.html#a28c2443a142676d3d71effdae1a986b1">CUTLASS_HOST_DEVICE</a> <a class="el" href="structcutlass_1_1TensorRefArray.html#a066d684240f8a24e1ba621ae3904ec75">TensorRef</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcutlass_1_1TensorRefArray.html#a2a95fd42d48c550a45f340b04f9dfe3d">at</a> (<a class="el" href="structcutlass_1_1TensorRefArray.html#a8f4658dd194b305ae4f150cf371869d9">Index</a> idx) const</td></tr>
-<tr class="separator:a2a95fd42d48c550a45f340b04f9dfe3d"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a5b2702b1029db5b5a0b9dddbb5818e3a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="cutlass_8h.html#a28c2443a142676d3d71effdae1a986b1">CUTLASS_HOST_DEVICE</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcutlass_1_1TensorRefArray.html#a5b2702b1029db5b5a0b9dddbb5818e3a">TensorRefArray</a> ()</td></tr>
+<tr class="separator:a5b2702b1029db5b5a0b9dddbb5818e3a"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:acbda10b4e66cce9963c80f40ae4c1140"><td class="memItemLeft" align="right" valign="top"><a class="el" href="cutlass_8h.html#a28c2443a142676d3d71effdae1a986b1">CUTLASS_HOST_DEVICE</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcutlass_1_1TensorRefArray.html#acbda10b4e66cce9963c80f40ae4c1140">TensorRefArray</a> (<a class="el" href="structcutlass_1_1TensorRefArray.html#ab6a6ed8af1a4b3da33e840409c0a72d8">Storage</a> **_pointers, <a class="el" href="structcutlass_1_1TensorRefArray.html#a8f4658dd194b305ae4f150cf371869d9">Index</a> _strides[<a class="el" href="structcutlass_1_1TensorRefArray.html#a131bdcf213e3d46672c9b3b34d6bf243">kStorageRank</a> - 1])</td></tr>
+<tr class="separator:acbda10b4e66cce9963c80f40ae4c1140"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a60763549963465865a2287d018b6b76c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="cutlass_8h.html#a28c2443a142676d3d71effdae1a986b1">CUTLASS_HOST_DEVICE</a> <a class="el" href="structcutlass_1_1TensorRefArray.html#a066d684240f8a24e1ba621ae3904ec75">TensorRef</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcutlass_1_1TensorRefArray.html#a60763549963465865a2287d018b6b76c">at</a> (<a class="el" href="structcutlass_1_1TensorRefArray.html#a8f4658dd194b305ae4f150cf371869d9">Index</a> idx=0) const</td></tr>
+<tr class="separator:a60763549963465865a2287d018b6b76c"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a6b0f0d9cef4a2f3f4a8bf6c192a282db"><td class="memItemLeft" align="right" valign="top"><a class="el" href="cutlass_8h.html#a28c2443a142676d3d71effdae1a986b1">CUTLASS_HOST_DEVICE</a> <a class="el" href="classcutlass_1_1TensorRefArray_1_1ConstIterator.html">ConstIterator</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcutlass_1_1TensorRefArray.html#a6b0f0d9cef4a2f3f4a8bf6c192a282db">begin</a> ()</td></tr>
 <tr class="memdesc:a6b0f0d9cef4a2f3f4a8bf6c192a282db"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns an TesnorRefIterator over the <a class="el" href="classcutlass_1_1TensorRef.html">TensorRef</a> objects in this collection.  <a href="#a6b0f0d9cef4a2f3f4a8bf6c192a282db">More...</a><br /></td></tr>
 <tr class="separator:a6b0f0d9cef4a2f3f4a8bf6c192a282db"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -130,7 +130,7 @@ Public Attributes</h2></td></tr>
 </table><table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
 Static Public Attributes</h2></td></tr>
-<tr class="memitem:a131bdcf213e3d46672c9b3b34d6bf243"><td class="memItemLeft" align="right" valign="top">static int const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcutlass_1_1TensorRefArray.html#a131bdcf213e3d46672c9b3b34d6bf243">kStorageRank</a> = TensorRef::kStorageRank</td></tr>
+<tr class="memitem:a131bdcf213e3d46672c9b3b34d6bf243"><td class="memItemLeft" align="right" valign="top">static int const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcutlass_1_1TensorRefArray.html#a131bdcf213e3d46672c9b3b34d6bf243">kStorageRank</a> = StorageRank_</td></tr>
 <tr class="memdesc:a131bdcf213e3d46672c9b3b34d6bf243"><td class="mdescLeft">&#160;</td><td class="mdescRight">Rank of the stride vector.  <a href="#a131bdcf213e3d46672c9b3b34d6bf243">More...</a><br /></td></tr>
 <tr class="separator:a131bdcf213e3d46672c9b3b34d6bf243"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table>
@@ -204,11 +204,77 @@ template&lt;typename Storage_ , int Rank_, typename MapFunc_  = IdentityTensorMa
      </table>
 </div><div class="memdoc">

+</div>
+</div>
+<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
+<a id="a5b2702b1029db5b5a0b9dddbb5818e3a"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a5b2702b1029db5b5a0b9dddbb5818e3a">&#9670;&nbsp;</a></span>TensorRefArray() <span class="overload">[1/2]</span></h2>
+
+<div class="memitem">
+<div class="memproto">
+<div class="memtemplate">
+template&lt;typename Storage_ , int Rank_, typename MapFunc_  = IdentityTensorMapFunc&lt;Rank_&gt;, int StorageRank_ = MapFunc_::kStorageRank, typename Index_  = int, typename LongIndex_  = long long&gt; </div>
+<table class="mlabels">
+  <tr>
+  <td class="mlabels-left">
+      <table class="memname">
+        <tr>
+          <td class="memname"><a class="el" href="cutlass_8h.html#a28c2443a142676d3d71effdae1a986b1">CUTLASS_HOST_DEVICE</a> <a class="el" href="structcutlass_1_1TensorRefArray.html">cutlass::TensorRefArray</a>&lt; Storage_, Rank_, MapFunc_, StorageRank_, Index_, LongIndex_ &gt;::<a class="el" href="structcutlass_1_1TensorRefArray.html">TensorRefArray</a> </td>
+          <td>(</td>
+          <td class="paramname"></td><td>)</td>
+          <td></td>
+        </tr>
+      </table>
+  </td>
+  <td class="mlabels-right">
+<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
+  </tr>
+</table>
+</div><div class="memdoc">
+
+</div>
+</div>
+<a id="acbda10b4e66cce9963c80f40ae4c1140"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#acbda10b4e66cce9963c80f40ae4c1140">&#9670;&nbsp;</a></span>TensorRefArray() <span class="overload">[2/2]</span></h2>
+
+<div class="memitem">
+<div class="memproto">
+<div class="memtemplate">
+template&lt;typename Storage_ , int Rank_, typename MapFunc_  = IdentityTensorMapFunc&lt;Rank_&gt;, int StorageRank_ = MapFunc_::kStorageRank, typename Index_  = int, typename LongIndex_  = long long&gt; </div>
+<table class="mlabels">
+  <tr>
+  <td class="mlabels-left">
+      <table class="memname">
+        <tr>
+          <td class="memname"><a class="el" href="cutlass_8h.html#a28c2443a142676d3d71effdae1a986b1">CUTLASS_HOST_DEVICE</a> <a class="el" href="structcutlass_1_1TensorRefArray.html">cutlass::TensorRefArray</a>&lt; Storage_, Rank_, MapFunc_, StorageRank_, Index_, LongIndex_ &gt;::<a class="el" href="structcutlass_1_1TensorRefArray.html">TensorRefArray</a> </td>
+          <td>(</td>
+          <td class="paramtype"><a class="el" href="structcutlass_1_1TensorRefArray.html#ab6a6ed8af1a4b3da33e840409c0a72d8">Storage</a> **&#160;</td>
+          <td class="paramname"><em>_pointers</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype"><a class="el" href="structcutlass_1_1TensorRefArray.html#a8f4658dd194b305ae4f150cf371869d9">Index</a>&#160;</td>
+          <td class="paramname"><em>_strides</em>[kStorageRank - 1]&#160;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td>
+        </tr>
+      </table>
+  </td>
+  <td class="mlabels-right">
+<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
+  </tr>
+</table>
+</div><div class="memdoc">
+
 </div>
 </div>
 <h2 class="groupheader">Member Function Documentation</h2>
-<a id="a2a95fd42d48c550a45f340b04f9dfe3d"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#a2a95fd42d48c550a45f340b04f9dfe3d">&#9670;&nbsp;</a></span>at()</h2>
+<a id="a60763549963465865a2287d018b6b76c"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a60763549963465865a2287d018b6b76c">&#9670;&nbsp;</a></span>at()</h2>

 <div class="memitem">
 <div class="memproto">
@@ -222,7 +288,7 @@ template&lt;typename Storage_ , int Rank_, typename MapFunc_  = IdentityTensorMa
          <td class="memname"><a class="el" href="cutlass_8h.html#a28c2443a142676d3d71effdae1a986b1">CUTLASS_HOST_DEVICE</a> <a class="el" href="structcutlass_1_1TensorRefArray.html#a066d684240f8a24e1ba621ae3904ec75">TensorRef</a> <a class="el" href="structcutlass_1_1TensorRefArray.html">cutlass::TensorRefArray</a>&lt; Storage_, Rank_, MapFunc_, StorageRank_, Index_, LongIndex_ &gt;::at </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structcutlass_1_1TensorRefArray.html#a8f4658dd194b305ae4f150cf371869d9">Index</a>&#160;</td>
-          <td class="paramname"><em>idx</em></td><td>)</td>
+          <td class="paramname"><em>idx</em> = <code>0</code></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
@@ -260,71 +326,6 @@ template&lt;typename Storage_ , int Rank_, typename MapFunc_  = IdentityTensorMa
 </table>
 </div><div class="memdoc">

-</div>
-</div>
-<a id="a771ede5f73ec18729cc9a5946cf86109"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#a771ede5f73ec18729cc9a5946cf86109">&#9670;&nbsp;</a></span>TensorArrayRef() <span class="overload">[1/2]</span></h2>
-
-<div class="memitem">
-<div class="memproto">
-<div class="memtemplate">
-template&lt;typename Storage_ , int Rank_, typename MapFunc_  = IdentityTensorMapFunc&lt;Rank_&gt;, int StorageRank_ = MapFunc_::kStorageRank, typename Index_  = int, typename LongIndex_  = long long&gt; </div>
-<table class="mlabels">
-  <tr>
-  <td class="mlabels-left">
-      <table class="memname">
-        <tr>
-          <td class="memname"><a class="el" href="cutlass_8h.html#a28c2443a142676d3d71effdae1a986b1">CUTLASS_HOST_DEVICE</a> <a class="el" href="structcutlass_1_1TensorRefArray.html">cutlass::TensorRefArray</a>&lt; Storage_, Rank_, MapFunc_, StorageRank_, Index_, LongIndex_ &gt;::TensorArrayRef </td>
-          <td>(</td>
-          <td class="paramname"></td><td>)</td>
-          <td></td>
-        </tr>
-      </table>
-  </td>
-  <td class="mlabels-right">
-<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
-  </tr>
-</table>
-</div><div class="memdoc">
-
-</div>
-</div>
-<a id="aea35239326dcb23c3c6a18e7b3f92091"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#aea35239326dcb23c3c6a18e7b3f92091">&#9670;&nbsp;</a></span>TensorArrayRef() <span class="overload">[2/2]</span></h2>
-
-<div class="memitem">
-<div class="memproto">
-<div class="memtemplate">
-template&lt;typename Storage_ , int Rank_, typename MapFunc_  = IdentityTensorMapFunc&lt;Rank_&gt;, int StorageRank_ = MapFunc_::kStorageRank, typename Index_  = int, typename LongIndex_  = long long&gt; </div>
-<table class="mlabels">
-  <tr>
-  <td class="mlabels-left">
-      <table class="memname">
-        <tr>
-          <td class="memname"><a class="el" href="cutlass_8h.html#a28c2443a142676d3d71effdae1a986b1">CUTLASS_HOST_DEVICE</a> <a class="el" href="structcutlass_1_1TensorRefArray.html">cutlass::TensorRefArray</a>&lt; Storage_, Rank_, MapFunc_, StorageRank_, Index_, LongIndex_ &gt;::TensorArrayRef </td>
-          <td>(</td>
-          <td class="paramtype"><a class="el" href="structcutlass_1_1TensorRefArray.html#ab6a6ed8af1a4b3da33e840409c0a72d8">Storage</a> **&#160;</td>
-          <td class="paramname"><em>_pointers</em>, </td>
-        </tr>
-        <tr>
-          <td class="paramkey"></td>
-          <td></td>
-          <td class="paramtype"><a class="el" href="structcutlass_1_1TensorRefArray.html#a8f4658dd194b305ae4f150cf371869d9">Index</a>&#160;</td>
-          <td class="paramname"><em>_strides</em>[kStorageRank - 1]&#160;</td>
-        </tr>
-        <tr>
-          <td></td>
-          <td>)</td>
-          <td></td><td></td>
-        </tr>
-      </table>
-  </td>
-  <td class="mlabels-right">
-<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
-  </tr>
-</table>
-</div><div class="memdoc">
-
 </div>
 </div>
 <h2 class="groupheader">Member Data Documentation</h2>
@@ -340,7 +341,7 @@ template&lt;typename Storage_ , int Rank_, typename MapFunc_  = IdentityTensorMa
  <td class="mlabels-left">
      <table class="memname">
        <tr>
-          <td class="memname">int const <a class="el" href="structcutlass_1_1TensorRefArray.html">cutlass::TensorRefArray</a>&lt; Storage_, Rank_, MapFunc_, StorageRank_, Index_, LongIndex_ &gt;::kStorageRank = TensorRef::kStorageRank</td>
+          <td class="memname">int const <a class="el" href="structcutlass_1_1TensorRefArray.html">cutlass::TensorRefArray</a>&lt; Storage_, Rank_, MapFunc_, StorageRank_, Index_, LongIndex_ &gt;::kStorageRank = StorageRank_</td>
        </tr>
      </table>
  </td>
@@ -390,7 +391,7 @@ template&lt;typename Storage_ , int Rank_, typename MapFunc_  = IdentityTensorMa
 </div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>
-Generated on Wed Sep 19 2018 13:58:51 for Cutlass by &#160;<a href="http://www.doxygen.org/index.html">
+Generated on Fri Oct 26 2018 14:53:35 for Cutlass by &#160;<a href="http://www.doxygen.org/index.html">
 <img class="footer" src="doxygen.png" alt="doxygen"/>
 </a> 1.8.14
 </small></address>