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
@@ -122,6 +122,9 @@ Public Types</h2></td></tr>
<tr class="memitem:a56847e834b31b88544093c3df54d299f"><td class="memItemLeft" align="right" valign="top">typedef Index_&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcutlass_1_1gemm_1_1GemmGlobalIteratorCd.html#a56847e834b31b88544093c3df54d299f">Index</a></td></tr>
<tr class="memdesc:a56847e834b31b88544093c3df54d299f"><td class="mdescLeft">&#160;</td><td class="mdescRight">The index. <a href="#a56847e834b31b88544093c3df54d299f">More...</a><br /></td></tr>
<tr class="separator:a56847e834b31b88544093c3df54d299f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af921ea4ba6a83e5db8deb519207e035d"><td class="memItemLeft" align="right" valign="top">typedef long long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcutlass_1_1gemm_1_1GemmGlobalIteratorCd.html#af921ea4ba6a83e5db8deb519207e035d">LongIndex</a></td></tr>
<tr class="memdesc:af921ea4ba6a83e5db8deb519207e035d"><td class="mdescLeft">&#160;</td><td class="mdescRight">The index. <a href="#af921ea4ba6a83e5db8deb519207e035d">More...</a><br /></td></tr>
<tr class="separator:af921ea4ba6a83e5db8deb519207e035d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6d985f8e93be21e56f72ec1400d73df1"><td class="memItemLeft" align="right" valign="top">typedef TileTraits_::ThreadOffset&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcutlass_1_1gemm_1_1GemmGlobalIteratorCd.html#a6d985f8e93be21e56f72ec1400d73df1">ThreadOffset</a></td></tr>
<tr class="memdesc:a6d985f8e93be21e56f72ec1400d73df1"><td class="mdescLeft">&#160;</td><td class="mdescRight">The thread offset. <a href="#a6d985f8e93be21e56f72ec1400d73df1">More...</a><br /></td></tr>
<tr class="separator:a6d985f8e93be21e56f72ec1400d73df1"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -138,6 +141,9 @@ Public Types</h2></td></tr>
<tr class="memitem:ab49ff66953031a8cfcfa11ddc092025c inherit pub_types_structcutlass_1_1TileIteratorBase"><td class="memItemLeft" align="right" valign="top">typedef Index_&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcutlass_1_1TileIteratorBase.html#ab49ff66953031a8cfcfa11ddc092025c">Index</a></td></tr>
<tr class="memdesc:ab49ff66953031a8cfcfa11ddc092025c inherit pub_types_structcutlass_1_1TileIteratorBase"><td class="mdescLeft">&#160;</td><td class="mdescRight">Index type. <a href="structcutlass_1_1TileIteratorBase.html#ab49ff66953031a8cfcfa11ddc092025c">More...</a><br /></td></tr>
<tr class="separator:ab49ff66953031a8cfcfa11ddc092025c inherit pub_types_structcutlass_1_1TileIteratorBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad2967c7bb5c6c5eacdea285a63040d94 inherit pub_types_structcutlass_1_1TileIteratorBase"><td class="memItemLeft" align="right" valign="top">typedef long long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcutlass_1_1TileIteratorBase.html#ad2967c7bb5c6c5eacdea285a63040d94">LongIndex</a></td></tr>
<tr class="memdesc:ad2967c7bb5c6c5eacdea285a63040d94 inherit pub_types_structcutlass_1_1TileIteratorBase"><td class="mdescLeft">&#160;</td><td class="mdescRight">Long index. <a href="structcutlass_1_1TileIteratorBase.html#ad2967c7bb5c6c5eacdea285a63040d94">More...</a><br /></td></tr>
<tr class="separator:ad2967c7bb5c6c5eacdea285a63040d94 inherit pub_types_structcutlass_1_1TileIteratorBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae50ca325a827bdf1d1bfab3ba6e204c1 inherit pub_types_structcutlass_1_1TileIteratorBase"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="structcutlass_1_1Shape.html">Shape</a>&lt; 0, 0, 0, 0 &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcutlass_1_1TileIteratorBase.html#ae50ca325a827bdf1d1bfab3ba6e204c1">Skew</a></td></tr>
<tr class="memdesc:ae50ca325a827bdf1d1bfab3ba6e204c1 inherit pub_types_structcutlass_1_1TileIteratorBase"><td class="mdescLeft">&#160;</td><td class="mdescRight">Skew quantity. <a href="structcutlass_1_1TileIteratorBase.html#ae50ca325a827bdf1d1bfab3ba6e204c1">More...</a><br /></td></tr>
<tr class="separator:ae50ca325a827bdf1d1bfab3ba6e204c1 inherit pub_types_structcutlass_1_1TileIteratorBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -180,9 +186,6 @@ Public Types</h2></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:aeeed9a3582a879d9da77191df88e83ff"><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_1gemm_1_1GemmGlobalIteratorCd.html#aeeed9a3582a879d9da77191df88e83ff">GemmGlobalIteratorCd</a> (<a class="el" href="structcutlass_1_1gemm_1_1GemmGlobalIteratorCd_1_1Params.html">Params</a> const &amp;_params, const <a class="el" href="structcutlass_1_1Coord.html">Coord</a>&lt; 3 &gt; &amp;bounds, const <a class="el" href="structcutlass_1_1Coord.html">Coord</a>&lt; 3 &gt; &amp;block_offset, <a class="el" href="structcutlass_1_1gemm_1_1GemmGlobalIteratorCd.html#a6d985f8e93be21e56f72ec1400d73df1">ThreadOffset</a> thread_offset_func=<a class="el" href="structcutlass_1_1gemm_1_1GemmGlobalIteratorCd.html#a6d985f8e93be21e56f72ec1400d73df1">ThreadOffset</a>())</td></tr>
<tr class="memdesc:aeeed9a3582a879d9da77191df88e83ff"><td class="mdescLeft">&#160;</td><td class="mdescRight">Ctor. <a href="#aeeed9a3582a879d9da77191df88e83ff">More...</a><br /></td></tr>
<tr class="separator:aeeed9a3582a879d9da77191df88e83ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a15d3244546d1c8f4727e84b27a8b7fc6"><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_1gemm_1_1GemmGlobalIteratorCd.html#a15d3244546d1c8f4727e84b27a8b7fc6">GemmGlobalIteratorCd</a> (<a class="el" href="structcutlass_1_1gemm_1_1GemmGlobalIteratorCd_1_1Params.html">Params</a> const &amp;_params, const <a class="el" href="structcutlass_1_1Coord.html">Coord</a>&lt; 3 &gt; &amp;bounds, const <a class="el" href="structcutlass_1_1Coord.html">Coord</a>&lt; 3 &gt; &amp;block, int offset=0, int pred_offset=0, <a class="el" href="structcutlass_1_1gemm_1_1GemmGlobalIteratorCd.html#a6d985f8e93be21e56f72ec1400d73df1">ThreadOffset</a> thread_offset_func=<a class="el" href="structcutlass_1_1gemm_1_1GemmGlobalIteratorCd.html#a6d985f8e93be21e56f72ec1400d73df1">ThreadOffset</a>())</td></tr>
<tr class="memdesc:a15d3244546d1c8f4727e84b27a8b7fc6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Ctor. <a href="#a15d3244546d1c8f4727e84b27a8b7fc6">More...</a><br /></td></tr>
<tr class="separator:a15d3244546d1c8f4727e84b27a8b7fc6"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -213,9 +216,9 @@ Public Member Functions</h2></td></tr>
<tr class="memitem:ab224a0a6ab8ce7fc4e76b06fb7679fa0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="cutlass_8h.html#a28c2443a142676d3d71effdae1a986b1">CUTLASS_HOST_DEVICE</a> bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcutlass_1_1gemm_1_1GemmGlobalIteratorCd.html#ab224a0a6ab8ce7fc4e76b06fb7679fa0">valid</a> (int d, int h, int w, int c) const</td></tr>
<tr class="memdesc:ab224a0a6ab8ce7fc4e76b06fb7679fa0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Test the validity of the. <a href="#ab224a0a6ab8ce7fc4e76b06fb7679fa0">More...</a><br /></td></tr>
<tr class="separator:ab224a0a6ab8ce7fc4e76b06fb7679fa0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8fd617565db6eb9c6fb99de868c389db"><td class="memItemLeft" align="right" valign="top"><a class="el" href="cutlass_8h.html#a28c2443a142676d3d71effdae1a986b1">CUTLASS_HOST_DEVICE</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcutlass_1_1gemm_1_1GemmGlobalIteratorCd.html#a8fd617565db6eb9c6fb99de868c389db">add_pointer_offset</a> (<a class="el" href="structcutlass_1_1gemm_1_1GemmGlobalIteratorCd.html#a56847e834b31b88544093c3df54d299f">Index</a> offset)</td></tr>
<tr class="memdesc:a8fd617565db6eb9c6fb99de868c389db"><td class="mdescLeft">&#160;</td><td class="mdescRight">add pointer offset <a href="#a8fd617565db6eb9c6fb99de868c389db">More...</a><br /></td></tr>
<tr class="separator:a8fd617565db6eb9c6fb99de868c389db"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2b77a4ba996c5cd75e73d4842ac07612"><td class="memItemLeft" align="right" valign="top"><a class="el" href="cutlass_8h.html#a28c2443a142676d3d71effdae1a986b1">CUTLASS_HOST_DEVICE</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcutlass_1_1gemm_1_1GemmGlobalIteratorCd.html#a2b77a4ba996c5cd75e73d4842ac07612">add_pointer_offset</a> (<a class="el" href="structcutlass_1_1gemm_1_1GemmGlobalIteratorCd.html#af921ea4ba6a83e5db8deb519207e035d">LongIndex</a> offset)</td></tr>
<tr class="memdesc:a2b77a4ba996c5cd75e73d4842ac07612"><td class="mdescLeft">&#160;</td><td class="mdescRight">add pointer offset <a href="#a2b77a4ba996c5cd75e73d4842ac07612">More...</a><br /></td></tr>
<tr class="separator:a2b77a4ba996c5cd75e73d4842ac07612"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1a587af6edd528a02679c0decc31cdd1"><td class="memTemplParams" colspan="2">template&lt;typename Fragment &gt; </td></tr>
<tr class="memitem:a1a587af6edd528a02679c0decc31cdd1"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="cutlass_8h.html#a28c2443a142676d3d71effdae1a986b1">CUTLASS_HOST_DEVICE</a> void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structcutlass_1_1gemm_1_1GemmGlobalIteratorCd.html#a1a587af6edd528a02679c0decc31cdd1">load_post_increment</a> (<a class="el" href="structcutlass_1_1TileIteratorBase.html#a9ffa12dcd7ed1e96845e1cd273d9f219">Fragment</a> &amp;fragment)</td></tr>
<tr class="memdesc:a1a587af6edd528a02679c0decc31cdd1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Loads and increments iterator. <a href="#a1a587af6edd528a02679c0decc31cdd1">More...</a><br /></td></tr>
@@ -242,7 +245,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:a27b88818f5b094372bf2c6e090c9148a"><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_1GemmGlobalIteratorCd.html#a27b88818f5b094372bf2c6e090c9148a">kLayout</a> = TileTraits_::kLayout</td></tr>
<tr class="memitem:a27b88818f5b094372bf2c6e090c9148a"><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_1GemmGlobalIteratorCd.html#a27b88818f5b094372bf2c6e090c9148a">kLayout</a> = TileTraits_::kLayout</td></tr>
<tr class="memdesc:a27b88818f5b094372bf2c6e090c9148a"><td class="mdescLeft">&#160;</td><td class="mdescRight">The layout. <a href="#a27b88818f5b094372bf2c6e090c9148a">More...</a><br /></td></tr>
<tr class="separator:a27b88818f5b094372bf2c6e090c9148a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_static_attribs_structcutlass_1_1TileIteratorBase"><td colspan="2" onclick="javascript:toggleInherit('pub_static_attribs_structcutlass_1_1TileIteratorBase')"><img src="closed.png" alt="-"/>&#160;Static Public Attributes inherited from <a class="el" href="structcutlass_1_1TileIteratorBase.html">cutlass::TileIteratorBase&lt; TileTraits_, TileTraits_::Scalar, IteratorAdvance::kH, MemorySpace::kGlobal, Index_ &gt;</a></td></tr>
@@ -300,6 +303,22 @@ template&lt;typename TileTraits_ , typename Index_ = int&gt; </div>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="af921ea4ba6a83e5db8deb519207e035d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af921ea4ba6a83e5db8deb519207e035d">&#9670;&nbsp;</a></span>LongIndex</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TileTraits_ , typename Index_ = int&gt; </div>
<table class="memname">
<tr>
<td class="memname">typedef long long <a class="el" href="structcutlass_1_1gemm_1_1GemmGlobalIteratorCd.html">cutlass::gemm::GemmGlobalIteratorCd</a>&lt; TileTraits_, Index_ &gt;::<a class="el" href="structcutlass_1_1gemm_1_1GemmGlobalIteratorCd.html#af921ea4ba6a83e5db8deb519207e035d">LongIndex</a></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a3abcfa68ae9904a13195d32d6e6c4bc6"></a>
@@ -383,58 +402,8 @@ template&lt;typename TileTraits_ , typename Index_ = int&gt; </div>
</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="aeeed9a3582a879d9da77191df88e83ff"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeeed9a3582a879d9da77191df88e83ff">&#9670;&nbsp;</a></span>GemmGlobalIteratorCd() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TileTraits_ , typename Index_ = int&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_1gemm_1_1GemmGlobalIteratorCd.html">cutlass::gemm::GemmGlobalIteratorCd</a>&lt; TileTraits_, Index_ &gt;::<a class="el" href="structcutlass_1_1gemm_1_1GemmGlobalIteratorCd.html">GemmGlobalIteratorCd</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structcutlass_1_1gemm_1_1GemmGlobalIteratorCd_1_1Params.html">Params</a> const &amp;&#160;</td>
<td class="paramname"><em>_params</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structcutlass_1_1Coord.html">Coord</a>&lt; 3 &gt; &amp;&#160;</td>
<td class="paramname"><em>bounds</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structcutlass_1_1Coord.html">Coord</a>&lt; 3 &gt; &amp;&#160;</td>
<td class="paramname"><em>block_offset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structcutlass_1_1gemm_1_1GemmGlobalIteratorCd.html#a6d985f8e93be21e56f72ec1400d73df1">ThreadOffset</a>&#160;</td>
<td class="paramname"><em>thread_offset_func</em> = <code><a class="el" href="structcutlass_1_1gemm_1_1GemmGlobalIteratorCd.html#a6d985f8e93be21e56f72ec1400d73df1">ThreadOffset</a>()</code>&#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>
<a id="a15d3244546d1c8f4727e84b27a8b7fc6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a15d3244546d1c8f4727e84b27a8b7fc6">&#9670;&nbsp;</a></span>GemmGlobalIteratorCd() <span class="overload">[2/2]</span></h2>
<h2 class="memtitle"><span class="permalink"><a href="#a15d3244546d1c8f4727e84b27a8b7fc6">&#9670;&nbsp;</a></span>GemmGlobalIteratorCd()</h2>
<div class="memitem">
<div class="memproto">
@@ -496,8 +465,8 @@ template&lt;typename TileTraits_ , typename Index_ = int&gt; </div>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a8fd617565db6eb9c6fb99de868c389db"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8fd617565db6eb9c6fb99de868c389db">&#9670;&nbsp;</a></span>add_pointer_offset()</h2>
<a id="a2b77a4ba996c5cd75e73d4842ac07612"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2b77a4ba996c5cd75e73d4842ac07612">&#9670;&nbsp;</a></span>add_pointer_offset()</h2>
<div class="memitem">
<div class="memproto">
@@ -510,7 +479,7 @@ template&lt;typename TileTraits_ , typename Index_ = int&gt; </div>
<tr>
<td class="memname"><a class="el" href="cutlass_8h.html#a28c2443a142676d3d71effdae1a986b1">CUTLASS_HOST_DEVICE</a> void <a class="el" href="structcutlass_1_1gemm_1_1GemmGlobalIteratorCd.html">cutlass::gemm::GemmGlobalIteratorCd</a>&lt; TileTraits_, Index_ &gt;::add_pointer_offset </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structcutlass_1_1gemm_1_1GemmGlobalIteratorCd.html#a56847e834b31b88544093c3df54d299f">Index</a>&#160;</td>
<td class="paramtype"><a class="el" href="structcutlass_1_1gemm_1_1GemmGlobalIteratorCd.html#af921ea4ba6a83e5db8deb519207e035d">LongIndex</a>&#160;</td>
<td class="paramname"><em>offset</em></td><td>)</td>
<td></td>
</tr>
@@ -922,7 +891,7 @@ template&lt;typename TileTraits_ , typename Index_ = int&gt; </div>
<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_1GemmGlobalIteratorCd.html">cutlass::gemm::GemmGlobalIteratorCd</a>&lt; TileTraits_, Index_ &gt;::kLayout = TileTraits_::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_1GemmGlobalIteratorCd.html">cutlass::gemm::GemmGlobalIteratorCd</a>&lt; TileTraits_, Index_ &gt;::kLayout = TileTraits_::kLayout</td>
</tr>
</table>
</td>
@@ -988,7 +957,7 @@ template&lt;typename TileTraits_ , typename Index_ = int&gt; </div>
</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>