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

@ -121,6 +121,9 @@ Public Types</h2></td></tr>
<tr class="memitem:aae07fdedeef68abd4e6c099924c70910"><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_1TileStoreIterator.html#aae07fdedeef68abd4e6c099924c70910">Index</a></td></tr>
<tr class="memdesc:aae07fdedeef68abd4e6c099924c70910"><td class="mdescLeft">&#160;</td><td class="mdescRight">Index type. <a href="#aae07fdedeef68abd4e6c099924c70910">More...</a><br /></td></tr>
<tr class="separator:aae07fdedeef68abd4e6c099924c70910"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3543ff8dcabc935d2f2f6646d7cf2d7c"><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_1TileStoreIterator.html#a3543ff8dcabc935d2f2f6646d7cf2d7c">LongIndex</a></td></tr>
<tr class="memdesc:a3543ff8dcabc935d2f2f6646d7cf2d7c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Long index type. <a href="#a3543ff8dcabc935d2f2f6646d7cf2d7c">More...</a><br /></td></tr>
<tr class="separator:a3543ff8dcabc935d2f2f6646d7cf2d7c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a18248da35dc9a0ae2411121bee323085"><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_1TileStoreIterator.html#a18248da35dc9a0ae2411121bee323085">Skew</a></td></tr>
<tr class="memdesc:a18248da35dc9a0ae2411121bee323085"><td class="mdescLeft">&#160;</td><td class="mdescRight">Skew quantity. <a href="#a18248da35dc9a0ae2411121bee323085">More...</a><br /></td></tr>
<tr class="separator:a18248da35dc9a0ae2411121bee323085"><td class="memSeparator" colspan="2">&#160;</td></tr>
@ -179,6 +182,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>
@ -256,9 +262,9 @@ Public Member Functions</h2></td></tr>
<tr class="memitem:a57b284e6cbff892d45e5cfeb0ae1e3ed"><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_1TileStoreIterator.html">TileStoreIterator</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcutlass_1_1TileStoreIterator.html#a57b284e6cbff892d45e5cfeb0ae1e3ed">operator+=</a> (<a class="el" href="structcutlass_1_1Coord.html">Coord</a>&lt; 3 &gt; const &amp;offset)</td></tr>
<tr class="memdesc:a57b284e6cbff892d45e5cfeb0ae1e3ed"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds a vector offset to the iterator. <a href="#a57b284e6cbff892d45e5cfeb0ae1e3ed">More...</a><br /></td></tr>
<tr class="separator:a57b284e6cbff892d45e5cfeb0ae1e3ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa6977ded39ead005b3435f13f0e51116"><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_1TileStoreIterator.html#aa6977ded39ead005b3435f13f0e51116">add_pointer_offset</a> (<a class="el" href="structcutlass_1_1TileIteratorBase.html#ab49ff66953031a8cfcfa11ddc092025c">Index</a> offset)</td></tr>
<tr class="memdesc:aa6977ded39ead005b3435f13f0e51116"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds a raw offset to the pointer. <a href="#aa6977ded39ead005b3435f13f0e51116">More...</a><br /></td></tr>
<tr class="separator:aa6977ded39ead005b3435f13f0e51116"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af41808cb185da06a58ee9a9d593936d0"><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_1TileStoreIterator.html#af41808cb185da06a58ee9a9d593936d0">add_pointer_offset</a> (<a class="el" href="structcutlass_1_1TileIteratorBase.html#ad2967c7bb5c6c5eacdea285a63040d94">LongIndex</a> offset)</td></tr>
<tr class="memdesc:af41808cb185da06a58ee9a9d593936d0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds a raw offset to the pointer. <a href="#af41808cb185da06a58ee9a9d593936d0">More...</a><br /></td></tr>
<tr class="separator:af41808cb185da06a58ee9a9d593936d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1f7c4143443d2bee4a69d1b380576f08"><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_1TileStoreIterator.html#a1f7c4143443d2bee4a69d1b380576f08">store_element</a> (<a class="el" href="structcutlass_1_1TileIteratorBase.html#a24716c07ab1d7834a79d52231a990973">AccessType</a> const &amp;value, int d, int h, int w, int c)</td></tr>
<tr class="memdesc:a1f7c4143443d2bee4a69d1b380576f08"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stores a single fragment element into memory. <a href="#a1f7c4143443d2bee4a69d1b380576f08">More...</a><br /></td></tr>
<tr class="separator:a1f7c4143443d2bee4a69d1b380576f08"><td class="memSeparator" colspan="2">&#160;</td></tr>
@ -532,6 +538,22 @@ template&lt;typename Traits_ , typename Scalar_ , IteratorAdvance::Kind Advance_
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a3543ff8dcabc935d2f2f6646d7cf2d7c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3543ff8dcabc935d2f2f6646d7cf2d7c">&#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_1TileStoreIterator.html">cutlass::TileStoreIterator</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="adc4182adb78e34b7741f297eca86fe35"></a>
@ -795,8 +817,8 @@ template&lt;typename Traits_ , typename Scalar_ , IteratorAdvance::Kind Advance_
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="aa6977ded39ead005b3435f13f0e51116"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa6977ded39ead005b3435f13f0e51116">&#9670;&nbsp;</a></span>add_pointer_offset()</h2>
<a id="af41808cb185da06a58ee9a9d593936d0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af41808cb185da06a58ee9a9d593936d0">&#9670;&nbsp;</a></span>add_pointer_offset()</h2>
<div class="memitem">
<div class="memproto">
@ -809,7 +831,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_1TileStoreIterator.html">cutlass::TileStoreIterator</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>
@ -1661,7 +1683,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>