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

View File

@@ -125,6 +125,9 @@ Public Types</h2></td></tr>
<tr class="memitem:aaa5d98b72576478ba04e4ad554faa827"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="structcutlass_1_1TileIteratorBase.html#ab49ff66953031a8cfcfa11ddc092025c">Base::Index</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcutlass_1_1TileLoadIterator.html#aaa5d98b72576478ba04e4ad554faa827">Index</a></td></tr>
<tr class="memdesc:aaa5d98b72576478ba04e4ad554faa827"><td class="mdescLeft">&#160;</td><td class="mdescRight">Index type. <a href="#aaa5d98b72576478ba04e4ad554faa827">More...</a><br /></td></tr>
<tr class="separator:aaa5d98b72576478ba04e4ad554faa827"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6cdf9b87147f51f85c973ab435f58339"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="structcutlass_1_1TileIteratorBase.html#ad2967c7bb5c6c5eacdea285a63040d94">Base::LongIndex</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcutlass_1_1TileLoadIterator.html#a6cdf9b87147f51f85c973ab435f58339">LongIndex</a></td></tr>
<tr class="memdesc:a6cdf9b87147f51f85c973ab435f58339"><td class="mdescLeft">&#160;</td><td class="mdescRight">Index type. <a href="#a6cdf9b87147f51f85c973ab435f58339">More...</a><br /></td></tr>
<tr class="separator:a6cdf9b87147f51f85c973ab435f58339"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeb6cc0e2990c06c83b789b579a03b15f"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="structcutlass_1_1TileIteratorBase.html#ae50ca325a827bdf1d1bfab3ba6e204c1">Base::Skew</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcutlass_1_1TileLoadIterator.html#aeb6cc0e2990c06c83b789b579a03b15f">Skew</a></td></tr>
<tr class="memdesc:aeb6cc0e2990c06c83b789b579a03b15f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Skew quantity. <a href="#aeb6cc0e2990c06c83b789b579a03b15f">More...</a><br /></td></tr>
<tr class="separator:aeb6cc0e2990c06c83b789b579a03b15f"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -183,6 +186,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 Skew_&#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>
@@ -263,9 +269,9 @@ Public Member Functions</h2></td></tr>
<tr class="memitem:a723041057b1e8212e075959a22c0c120"><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_1TileLoadIterator.html">TileLoadIterator</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcutlass_1_1TileLoadIterator.html#a723041057b1e8212e075959a22c0c120">operator+=</a> (<a class="el" href="structcutlass_1_1Coord.html">Coord</a>&lt; 3 &gt; const &amp;offset)</td></tr>
<tr class="memdesc:a723041057b1e8212e075959a22c0c120"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds a vector offset to the iterator. <a href="#a723041057b1e8212e075959a22c0c120">More...</a><br /></td></tr>
<tr class="separator:a723041057b1e8212e075959a22c0c120"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad65b7a0a5b4f42c590642ef7b269f232"><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_1TileLoadIterator.html#ad65b7a0a5b4f42c590642ef7b269f232">add_pointer_offset</a> (<a class="el" href="structcutlass_1_1TileIteratorBase.html#ab49ff66953031a8cfcfa11ddc092025c">Index</a> offset)</td></tr>
<tr class="memdesc:ad65b7a0a5b4f42c590642ef7b269f232"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds a raw offset to the pointer. <a href="#ad65b7a0a5b4f42c590642ef7b269f232">More...</a><br /></td></tr>
<tr class="separator:ad65b7a0a5b4f42c590642ef7b269f232"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a32ee7fa7f55ca99bc871edfb08efd6fc"><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_1TileLoadIterator.html#a32ee7fa7f55ca99bc871edfb08efd6fc">add_pointer_offset</a> (<a class="el" href="structcutlass_1_1TileIteratorBase.html#ad2967c7bb5c6c5eacdea285a63040d94">LongIndex</a> offset)</td></tr>
<tr class="memdesc:a32ee7fa7f55ca99bc871edfb08efd6fc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds a raw offset to the pointer. <a href="#a32ee7fa7f55ca99bc871edfb08efd6fc">More...</a><br /></td></tr>
<tr class="separator:a32ee7fa7f55ca99bc871edfb08efd6fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a31a021d6c099e8027fa9bcb5fdc21c11"><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_1TileIteratorBase.html#ab49ff66953031a8cfcfa11ddc092025c">Index</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcutlass_1_1TileLoadIterator.html#a31a021d6c099e8027fa9bcb5fdc21c11">stride_advance</a> (void)</td></tr>
<tr class="separator:a31a021d6c099e8027fa9bcb5fdc21c11"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4d437597ae736c581a9ba0764f9d955f"><td class="memTemplParams" colspan="2">template&lt;typename Fragment , typename PredicateIterator &gt; </td></tr>
@@ -519,6 +525,22 @@ template&lt;typename Traits_, typename Scalar_, IteratorAdvance::Kind Advance_ =
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a6cdf9b87147f51f85c973ab435f58339"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6cdf9b87147f51f85c973ab435f58339">&#9670;&nbsp;</a></span>LongIndex</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Traits_, typename Scalar_, IteratorAdvance::Kind Advance_ = IteratorAdvance::kH, MemorySpace::Kind MemorySpace = MemorySpace::kGeneric, typename Index_ = int, typename FragmentElement_ = Scalar_, FragmentElementType::Kind FragmentElementType_ = FragmentElementType::kScalar, typename Skew_ = Shape&lt;0, 0, 0, 0&gt;&gt; </div>
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="structcutlass_1_1TileIteratorBase.html#ad2967c7bb5c6c5eacdea285a63040d94">Base::LongIndex</a> <a class="el" href="structcutlass_1_1TileLoadIterator.html">cutlass::TileLoadIterator</a>&lt; Traits_, Scalar_, Advance_, <a class="el" href="structcutlass_1_1MemorySpace.html">MemorySpace</a>, Index_, FragmentElement_, FragmentElementType_, Skew_ &gt;::<a class="el" href="structcutlass_1_1TileIteratorBase.html#ad2967c7bb5c6c5eacdea285a63040d94">LongIndex</a></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a39acc5c35c8db019a3aeef79e8005b7f"></a>
@@ -808,8 +830,8 @@ template&lt;typename Traits_, typename Scalar_, IteratorAdvance::Kind Advance_ =
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ad65b7a0a5b4f42c590642ef7b269f232"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad65b7a0a5b4f42c590642ef7b269f232">&#9670;&nbsp;</a></span>add_pointer_offset()</h2>
<a id="a32ee7fa7f55ca99bc871edfb08efd6fc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a32ee7fa7f55ca99bc871edfb08efd6fc">&#9670;&nbsp;</a></span>add_pointer_offset()</h2>
<div class="memitem">
<div class="memproto">
@@ -822,7 +844,7 @@ template&lt;typename Traits_, typename Scalar_, IteratorAdvance::Kind Advance_ =
<tr>
<td class="memname"><a class="el" href="cutlass_8h.html#a28c2443a142676d3d71effdae1a986b1">CUTLASS_HOST_DEVICE</a> void <a class="el" href="structcutlass_1_1TileLoadIterator.html">cutlass::TileLoadIterator</a>&lt; Traits_, Scalar_, Advance_, <a class="el" href="structcutlass_1_1MemorySpace.html">MemorySpace</a>, Index_, FragmentElement_, FragmentElementType_, Skew_ &gt;::add_pointer_offset </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structcutlass_1_1TileIteratorBase.html#ab49ff66953031a8cfcfa11ddc092025c">Index</a>&#160;</td>
<td class="paramtype"><a class="el" href="structcutlass_1_1TileIteratorBase.html#ad2967c7bb5c6c5eacdea285a63040d94">LongIndex</a>&#160;</td>
<td class="paramname"><em>offset</em></td><td>)</td>
<td></td>
</tr>
@@ -1506,7 +1528,7 @@ template&lt;typename Traits_, typename Scalar_, IteratorAdvance::Kind Advance_ =
</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>