Updating Doxygen docs

This commit is contained in:
Andrew Kerr
2018-10-26 14:54:58 -07:00
parent 74df0331f2
commit b2bc0d3b79
1065 changed files with 12770 additions and 4093 deletions
@@ -124,6 +124,9 @@ Public Types</h2></td></tr>
<tr class="memitem:a7c46d6eb83b43e099d53784bb2a09f02"><td class="memItemLeft" align="right" valign="top">typedef LoadIterator::Index&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcutlass_1_1gemm_1_1GlobalLoadStream.html#a7c46d6eb83b43e099d53784bb2a09f02">Index</a></td></tr>
<tr class="memdesc:a7c46d6eb83b43e099d53784bb2a09f02"><td class="mdescLeft">&#160;</td><td class="mdescRight">The index. <a href="#a7c46d6eb83b43e099d53784bb2a09f02">More...</a><br /></td></tr>
<tr class="separator:a7c46d6eb83b43e099d53784bb2a09f02"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae033a49a784964e75a5c1b6135b21e47"><td class="memItemLeft" align="right" valign="top">typedef LoadIterator::LongIndex&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcutlass_1_1gemm_1_1GlobalLoadStream.html#ae033a49a784964e75a5c1b6135b21e47">LongIndex</a></td></tr>
<tr class="memdesc:ae033a49a784964e75a5c1b6135b21e47"><td class="mdescLeft">&#160;</td><td class="mdescRight">The index. <a href="#ae033a49a784964e75a5c1b6135b21e47">More...</a><br /></td></tr>
<tr class="separator:ae033a49a784964e75a5c1b6135b21e47"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a260543a618fb187c2da40c9f630925ec"><td class="memItemLeft" align="right" valign="top">typedef LoadIterator::Tile&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcutlass_1_1gemm_1_1GlobalLoadStream.html#a260543a618fb187c2da40c9f630925ec">Tile</a></td></tr>
<tr class="memdesc:a260543a618fb187c2da40c9f630925ec"><td class="mdescLeft">&#160;</td><td class="mdescRight">The tile. <a href="#a260543a618fb187c2da40c9f630925ec">More...</a><br /></td></tr>
<tr class="separator:a260543a618fb187c2da40c9f630925ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -157,24 +160,27 @@ Public Member Functions</h2></td></tr>
<tr class="memitem:a8e79a153de72eef10d90bfd02b5dd27e"><td class="memItemLeft" align="right" valign="top">CUTLASS_DEVICE <a class="el" href="structcutlass_1_1gemm_1_1GlobalLoadStream.html">GlobalLoadStream</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcutlass_1_1gemm_1_1GlobalLoadStream.html#a8e79a153de72eef10d90bfd02b5dd27e">operator+=</a> (<a class="el" href="structcutlass_1_1Coord.html">Coord</a>&lt; 3 &gt; const &amp;offset)</td></tr>
<tr class="memdesc:a8e79a153de72eef10d90bfd02b5dd27e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds a <a class="el" href="structcutlass_1_1Coord.html">Coord&lt;3&gt;</a> to the underlying global load iterator. <a href="#a8e79a153de72eef10d90bfd02b5dd27e">More...</a><br /></td></tr>
<tr class="separator:a8e79a153de72eef10d90bfd02b5dd27e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aed33be079f056998624015460b4e3836"><td class="memItemLeft" align="right" valign="top">CUTLASS_DEVICE <a class="el" href="structcutlass_1_1gemm_1_1GlobalLoadStream.html">GlobalLoadStream</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcutlass_1_1gemm_1_1GlobalLoadStream.html#aed33be079f056998624015460b4e3836">add_batch_offset</a> (int batch_id)</td></tr>
<tr class="memdesc:aed33be079f056998624015460b4e3836"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds an offset based on batch stride. <a href="#aed33be079f056998624015460b4e3836">More...</a><br /></td></tr>
<tr class="separator:aed33be079f056998624015460b4e3836"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:aa634e3f786d5bf5707b94e522a10a001"><td class="memItemLeft" align="right" valign="top">static CUTLASS_DEVICE <a class="el" href="structcutlass_1_1Coord.html">Coord</a>&lt; 3 &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcutlass_1_1gemm_1_1GlobalLoadStream.html#aa634e3f786d5bf5707b94e522a10a001">project_coordinate</a> (<a class="el" href="structcutlass_1_1Coord.html">Coord</a>&lt; 3 &gt; const &amp;coord, <a class="el" href="structcutlass_1_1gemm_1_1GlobalLoadStream.html#a7c46d6eb83b43e099d53784bb2a09f02">Index</a> d_offset=0)</td></tr>
<tr class="memdesc:aa634e3f786d5bf5707b94e522a10a001"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maps a coordinate in the GEMM's (K, N, M) coordinate system to global memory. <a href="#aa634e3f786d5bf5707b94e522a10a001">More...</a><br /></td></tr>
<tr class="separator:aa634e3f786d5bf5707b94e522a10a001"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a16542631e4a4562cc72aa50f146a9724"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="cutlass_8h.html#a28c2443a142676d3d71effdae1a986b1">CUTLASS_HOST_DEVICE</a> <a class="el" href="structcutlass_1_1Coord.html">Coord</a>&lt; 3 &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcutlass_1_1gemm_1_1GlobalLoadStream.html#a16542631e4a4562cc72aa50f146a9724">project_coordinate</a> (<a class="el" href="structcutlass_1_1Coord.html">Coord</a>&lt; 3 &gt; const &amp;coord, <a class="el" href="structcutlass_1_1gemm_1_1GlobalLoadStream.html#a7c46d6eb83b43e099d53784bb2a09f02">Index</a> d_offset=0)</td></tr>
<tr class="memdesc:a16542631e4a4562cc72aa50f146a9724"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maps a coordinate in the GEMM's (K, N, M) coordinate system to global memory. <a href="#a16542631e4a4562cc72aa50f146a9724">More...</a><br /></td></tr>
<tr class="separator:a16542631e4a4562cc72aa50f146a9724"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:ac8ff1a3e10b25c212cd3cf5ed997fc0e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structcutlass_1_1gemm_1_1GlobalLoadStream_1_1Params.html">Params</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcutlass_1_1gemm_1_1GlobalLoadStream.html#ac8ff1a3e10b25c212cd3cf5ed997fc0e">params</a></td></tr>
<tr class="memdesc:ac8ff1a3e10b25c212cd3cf5ed997fc0e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parameters. <a href="#ac8ff1a3e10b25c212cd3cf5ed997fc0e">More...</a><br /></td></tr>
<tr class="separator:ac8ff1a3e10b25c212cd3cf5ed997fc0e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a386f2f4d2e239075f0fe1489ed7788c1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structcutlass_1_1Coord.html">Coord</a>&lt; 3 &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcutlass_1_1gemm_1_1GlobalLoadStream.html#a386f2f4d2e239075f0fe1489ed7788c1">multiplicand_bounds</a></td></tr>
<tr class="memdesc:a386f2f4d2e239075f0fe1489ed7788c1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Multiplicand bounds. <a href="#a386f2f4d2e239075f0fe1489ed7788c1">More...</a><br /></td></tr>
<tr class="separator:a386f2f4d2e239075f0fe1489ed7788c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a563961c326d2e55f5b8682a30b64a24a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structcutlass_1_1Coord.html">Coord</a>&lt; 3 &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcutlass_1_1gemm_1_1GlobalLoadStream.html#a563961c326d2e55f5b8682a30b64a24a">threadblock_offset</a></td></tr>
<tr class="memdesc:a563961c326d2e55f5b8682a30b64a24a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Threadblock offset. <a href="#a563961c326d2e55f5b8682a30b64a24a">More...</a><br /></td></tr>
<tr class="separator:a563961c326d2e55f5b8682a30b64a24a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a386f2f4d2e239075f0fe1489ed7788c1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structcutlass_1_1Coord.html">Coord</a>&lt; 3 &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcutlass_1_1gemm_1_1GlobalLoadStream.html#a386f2f4d2e239075f0fe1489ed7788c1">multiplicand_bounds</a></td></tr>
<tr class="memdesc:a386f2f4d2e239075f0fe1489ed7788c1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Multiplicand bounds. <a href="#a386f2f4d2e239075f0fe1489ed7788c1">More...</a><br /></td></tr>
<tr class="separator:a386f2f4d2e239075f0fe1489ed7788c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5ef4cc42c7cec73523550e5ea56df88c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structcutlass_1_1gemm_1_1GlobalLoadStream.html#a905c219287a7342b2ddb58b84e413d64">LoadIterator</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcutlass_1_1gemm_1_1GlobalLoadStream.html#a5ef4cc42c7cec73523550e5ea56df88c">load_iterator</a></td></tr>
<tr class="memdesc:a5ef4cc42c7cec73523550e5ea56df88c"><td class="mdescLeft">&#160;</td><td class="mdescRight">The iterator. <a href="#a5ef4cc42c7cec73523550e5ea56df88c">More...</a><br /></td></tr>
<tr class="separator:a5ef4cc42c7cec73523550e5ea56df88c"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -196,7 +202,7 @@ Static Public Attributes</h2></td></tr>
<tr class="memitem:a30113b850dfd3de60f8778bc7a66f700"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="structcutlass_1_1GemmOperand.html#ab209ea3de198efabe8e8707dfe8e0a0c">GemmOperand::Kind</a> const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcutlass_1_1gemm_1_1GlobalLoadStream.html#a30113b850dfd3de60f8778bc7a66f700">kOperand</a> = Operand</td></tr>
<tr class="memdesc:a30113b850dfd3de60f8778bc7a66f700"><td class="mdescLeft">&#160;</td><td class="mdescRight">Indicates the type of GEMM operand. <a href="#a30113b850dfd3de60f8778bc7a66f700">More...</a><br /></td></tr>
<tr class="separator:a30113b850dfd3de60f8778bc7a66f700"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac29cd1ba94e802762d665c300e22e7db"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="structcutlass_1_1MatrixLayout.html#a97ef07af21b122c1804245b0c7784d2b">MatrixLayout::Kind</a> const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcutlass_1_1gemm_1_1GlobalLoadStream.html#ac29cd1ba94e802762d665c300e22e7db">kLayout</a> = LoadIterator::kLayout</td></tr>
<tr class="memitem:ac29cd1ba94e802762d665c300e22e7db"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="namespacecutlass_1_1MatrixLayout.html#a97ef07af21b122c1804245b0c7784d2b">MatrixLayout::Kind</a> const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcutlass_1_1gemm_1_1GlobalLoadStream.html#ac29cd1ba94e802762d665c300e22e7db">kLayout</a> = LoadIterator::kLayout</td></tr>
<tr class="memdesc:ac29cd1ba94e802762d665c300e22e7db"><td class="mdescLeft">&#160;</td><td class="mdescRight">Make sure the transformed fragment is the same as the store fragment. <a href="#ac29cd1ba94e802762d665c300e22e7db">More...</a><br /></td></tr>
<tr class="separator:ac29cd1ba94e802762d665c300e22e7db"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
@@ -264,6 +270,22 @@ template&lt;GemmOperand::Kind Operand, typename LoadIterator_ , typename StoreIt
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ae033a49a784964e75a5c1b6135b21e47"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae033a49a784964e75a5c1b6135b21e47">&#9670;&nbsp;</a></span>LongIndex</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;GemmOperand::Kind Operand, typename LoadIterator_ , typename StoreIterator_ , typename Transformer_ &gt; </div>
<table class="memname">
<tr>
<td class="memname">typedef LoadIterator::LongIndex <a class="el" href="structcutlass_1_1gemm_1_1GlobalLoadStream.html">cutlass::gemm::GlobalLoadStream</a>&lt; Operand, LoadIterator_, StoreIterator_, Transformer_ &gt;::<a class="el" href="structcutlass_1_1gemm_1_1GlobalLoadStream.html#ae033a49a784964e75a5c1b6135b21e47">LongIndex</a></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ac4452df991f57f9bb0b86dfd380179b2"></a>
@@ -452,6 +474,34 @@ template&lt;GemmOperand::Kind Operand, typename LoadIterator_ , typename StoreIt
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="aed33be079f056998624015460b4e3836"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aed33be079f056998624015460b4e3836">&#9670;&nbsp;</a></span>add_batch_offset()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;GemmOperand::Kind Operand, typename LoadIterator_ , typename StoreIterator_ , typename Transformer_ &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">CUTLASS_DEVICE <a class="el" href="structcutlass_1_1gemm_1_1GlobalLoadStream.html">GlobalLoadStream</a>&amp; <a class="el" href="structcutlass_1_1gemm_1_1GlobalLoadStream.html">cutlass::gemm::GlobalLoadStream</a>&lt; Operand, LoadIterator_, StoreIterator_, Transformer_ &gt;::add_batch_offset </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>batch_id</em></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="ab39c82ac1a8138c4b6d69dab9d48bdbc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab39c82ac1a8138c4b6d69dab9d48bdbc">&#9670;&nbsp;</a></span>commit()</h2>
@@ -572,8 +622,8 @@ template&lt;GemmOperand::Kind Operand, typename LoadIterator_ , typename StoreIt
</div>
</div>
<a id="aa634e3f786d5bf5707b94e522a10a001"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa634e3f786d5bf5707b94e522a10a001">&#9670;&nbsp;</a></span>project_coordinate()</h2>
<a id="a16542631e4a4562cc72aa50f146a9724"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a16542631e4a4562cc72aa50f146a9724">&#9670;&nbsp;</a></span>project_coordinate()</h2>
<div class="memitem">
<div class="memproto">
@@ -584,7 +634,7 @@ template&lt;GemmOperand::Kind Operand, typename LoadIterator_ , typename StoreIt
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static CUTLASS_DEVICE <a class="el" href="structcutlass_1_1Coord.html">Coord</a>&lt;3&gt; <a class="el" href="structcutlass_1_1gemm_1_1GlobalLoadStream.html">cutlass::gemm::GlobalLoadStream</a>&lt; Operand, LoadIterator_, StoreIterator_, Transformer_ &gt;::project_coordinate </td>
<td class="memname">static <a class="el" href="cutlass_8h.html#a28c2443a142676d3d71effdae1a986b1">CUTLASS_HOST_DEVICE</a> <a class="el" href="structcutlass_1_1Coord.html">Coord</a>&lt;3&gt; <a class="el" href="structcutlass_1_1gemm_1_1GlobalLoadStream.html">cutlass::gemm::GlobalLoadStream</a>&lt; Operand, LoadIterator_, StoreIterator_, Transformer_ &gt;::project_coordinate </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structcutlass_1_1Coord.html">Coord</a>&lt; 3 &gt; const &amp;&#160;</td>
<td class="paramname"><em>coord</em>, </td>
@@ -705,7 +755,7 @@ template&lt;GemmOperand::Kind Operand, typename LoadIterator_ , typename StoreIt
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structcutlass_1_1MatrixLayout.html#a97ef07af21b122c1804245b0c7784d2b">MatrixLayout::Kind</a> const <a class="el" href="structcutlass_1_1gemm_1_1GlobalLoadStream.html">cutlass::gemm::GlobalLoadStream</a>&lt; Operand, LoadIterator_, StoreIterator_, Transformer_ &gt;::kLayout = LoadIterator::kLayout</td>
<td class="memname"><a class="el" href="namespacecutlass_1_1MatrixLayout.html#a97ef07af21b122c1804245b0c7784d2b">MatrixLayout::Kind</a> const <a class="el" href="structcutlass_1_1gemm_1_1GlobalLoadStream.html">cutlass::gemm::GlobalLoadStream</a>&lt; Operand, LoadIterator_, StoreIterator_, Transformer_ &gt;::kLayout = LoadIterator::kLayout</td>
</tr>
</table>
</td>
@@ -860,7 +910,7 @@ template&lt;GemmOperand::Kind Operand, typename LoadIterator_ , typename StoreIt
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Sep 19 2018 13:58:52 for Cutlass by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Fri Oct 26 2018 14:53:39 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>