cutlass/docs/unioncutlass_1_1Vector.html
2018-10-26 14:54:58 -07:00

315 lines
18 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Cutlass: cutlass::Vector&lt; Scalar_, kLanes_ &gt; Union Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script><script type="text/javascript" async src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Cutlass
</div>
<div id="projectbrief">CUDA Templates for Linear Algebra Subroutines and Solvers</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacecutlass.html">cutlass</a></li><li class="navelem"><a class="el" href="unioncutlass_1_1Vector.html">Vector</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="unioncutlass_1_1Vector-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">cutlass::Vector&lt; Scalar_, kLanes_ &gt; Union Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="vector_8h_source.html">vector.h</a>&gt;</code></p>
<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:a824f9ab976c8e7f035236af03e5ae839"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom">{ <a class="el" href="unioncutlass_1_1Vector.html#a824f9ab976c8e7f035236af03e5ae839a605c5e987bc7b08d743f29a6524abb27">kLanes</a> = kLanes_
}</td></tr>
<tr class="memdesc:a824f9ab976c8e7f035236af03e5ae839"><td class="mdescLeft">&#160;</td><td class="mdescRight">The number of elements in the vector. <a href="unioncutlass_1_1Vector.html#a824f9ab976c8e7f035236af03e5ae839">More...</a><br /></td></tr>
<tr class="separator:a824f9ab976c8e7f035236af03e5ae839"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abf0c16b6f9cb8439835ebdb271d58763"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom">{ <a class="el" href="unioncutlass_1_1Vector.html#abf0c16b6f9cb8439835ebdb271d58763afaf4b62c6bcafbf961c5570364a0316e">kVectorSize</a> = kLanes * (int)sizeof(Scalar)
}</td></tr>
<tr class="memdesc:abf0c16b6f9cb8439835ebdb271d58763"><td class="mdescLeft">&#160;</td><td class="mdescRight">The size of the vector. <a href="unioncutlass_1_1Vector.html#abf0c16b6f9cb8439835ebdb271d58763">More...</a><br /></td></tr>
<tr class="separator:abf0c16b6f9cb8439835ebdb271d58763"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8e5093e47766af74bc0a429e3f394f05"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"></td></tr>
<tr class="memdesc:a8e5093e47766af74bc0a429e3f394f05"><td class="mdescLeft">&#160;</td><td class="mdescRight">The number of registers needed to store the vector. <a href="unioncutlass_1_1Vector.html#a8e5093e47766af74bc0a429e3f394f05">More...</a><br /></td></tr>
<tr class="separator:a8e5093e47766af74bc0a429e3f394f05"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a56875d7cbf921261e68e1f63212db5bd"><td class="memItemLeft" align="right" valign="top">typedef Scalar_&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="unioncutlass_1_1Vector.html#a56875d7cbf921261e68e1f63212db5bd">Scalar</a></td></tr>
<tr class="memdesc:a56875d7cbf921261e68e1f63212db5bd"><td class="mdescLeft">&#160;</td><td class="mdescRight">The scalar type. <a href="#a56875d7cbf921261e68e1f63212db5bd">More...</a><br /></td></tr>
<tr class="separator:a56875d7cbf921261e68e1f63212db5bd"><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:a69be4f85c1dac371fa6f1c6747724adc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="cutlass_8h.html#a28c2443a142676d3d71effdae1a986b1">CUTLASS_HOST_DEVICE</a> <a class="el" href="unioncutlass_1_1Vector.html#a56875d7cbf921261e68e1f63212db5bd">Scalar</a> const &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="unioncutlass_1_1Vector.html#a69be4f85c1dac371fa6f1c6747724adc">operator[]</a> (uint32_t i) const</td></tr>
<tr class="memdesc:a69be4f85c1dac371fa6f1c6747724adc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Accessor to the ith lane. <a href="#a69be4f85c1dac371fa6f1c6747724adc">More...</a><br /></td></tr>
<tr class="separator:a69be4f85c1dac371fa6f1c6747724adc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abf531676caf85cde1c8df435c1ebe8bb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="cutlass_8h.html#a28c2443a142676d3d71effdae1a986b1">CUTLASS_HOST_DEVICE</a> <a class="el" href="unioncutlass_1_1Vector.html#a56875d7cbf921261e68e1f63212db5bd">Scalar</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="unioncutlass_1_1Vector.html#abf531676caf85cde1c8df435c1ebe8bb">operator[]</a> (uint32_t i)</td></tr>
<tr class="memdesc:abf531676caf85cde1c8df435c1ebe8bb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Accessor to the ith lane. <a href="#abf531676caf85cde1c8df435c1ebe8bb">More...</a><br /></td></tr>
<tr class="separator:abf531676caf85cde1c8df435c1ebe8bb"><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:a9e9352594fcd022526d5b69b6c25c99c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structcutlass_1_1AlignedStruct.html">AlignedStruct</a>&lt; <a class="el" href="unioncutlass_1_1Vector.html#abf0c16b6f9cb8439835ebdb271d58763afaf4b62c6bcafbf961c5570364a0316e">kVectorSize</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="unioncutlass_1_1Vector.html#a9e9352594fcd022526d5b69b6c25c99c">aligned_</a></td></tr>
<tr class="memdesc:a9e9352594fcd022526d5b69b6c25c99c"><td class="mdescLeft">&#160;</td><td class="mdescRight">The aligned storage to make sure we have good alignment. <a href="#a9e9352594fcd022526d5b69b6c25c99c">More...</a><br /></td></tr>
<tr class="separator:a9e9352594fcd022526d5b69b6c25c99c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a091080b4e9db9e89734f44ceb985d78f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="unioncutlass_1_1Vector.html#a56875d7cbf921261e68e1f63212db5bd">Scalar</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="unioncutlass_1_1Vector.html#a091080b4e9db9e89734f44ceb985d78f">scalars</a> [<a class="el" href="unioncutlass_1_1Vector.html#a824f9ab976c8e7f035236af03e5ae839a605c5e987bc7b08d743f29a6524abb27">kLanes</a>]</td></tr>
<tr class="memdesc:a091080b4e9db9e89734f44ceb985d78f"><td class="mdescLeft">&#160;</td><td class="mdescRight">The associated array of scalars. <a href="#a091080b4e9db9e89734f44ceb985d78f">More...</a><br /></td></tr>
<tr class="separator:a091080b4e9db9e89734f44ceb985d78f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a29dab07949206cc1609543ffcefd1e5a"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="unioncutlass_1_1Vector.html#a29dab07949206cc1609543ffcefd1e5a">registers</a> [kRegisters]</td></tr>
<tr class="memdesc:a29dab07949206cc1609543ffcefd1e5a"><td class="mdescLeft">&#160;</td><td class="mdescRight">The data in registers. <a href="#a29dab07949206cc1609543ffcefd1e5a">More...</a><br /></td></tr>
<tr class="separator:a29dab07949206cc1609543ffcefd1e5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Typedef Documentation</h2>
<a id="a56875d7cbf921261e68e1f63212db5bd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a56875d7cbf921261e68e1f63212db5bd">&#9670;&nbsp;</a></span>Scalar</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Scalar_, int kLanes_&gt; </div>
<table class="memname">
<tr>
<td class="memname">typedef Scalar_ <a class="el" href="unioncutlass_1_1Vector.html">cutlass::Vector</a>&lt; Scalar_, kLanes_ &gt;::<a class="el" href="unioncutlass_1_1Vector.html#a56875d7cbf921261e68e1f63212db5bd">Scalar</a></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="a824f9ab976c8e7f035236af03e5ae839"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a824f9ab976c8e7f035236af03e5ae839">&#9670;&nbsp;</a></span>anonymous enum</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Scalar_, int kLanes_&gt; </div>
<table class="memname">
<tr>
<td class="memname">anonymous enum</td>
</tr>
</table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a824f9ab976c8e7f035236af03e5ae839a605c5e987bc7b08d743f29a6524abb27"></a>kLanes&#160;</td><td class="fielddoc"></td></tr>
</table>
</div>
</div>
<a id="abf0c16b6f9cb8439835ebdb271d58763"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abf0c16b6f9cb8439835ebdb271d58763">&#9670;&nbsp;</a></span>anonymous enum</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Scalar_, int kLanes_&gt; </div>
<table class="memname">
<tr>
<td class="memname">anonymous enum</td>
</tr>
</table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="abf0c16b6f9cb8439835ebdb271d58763afaf4b62c6bcafbf961c5570364a0316e"></a>kVectorSize&#160;</td><td class="fielddoc"></td></tr>
</table>
</div>
</div>
<a id="a8e5093e47766af74bc0a429e3f394f05"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8e5093e47766af74bc0a429e3f394f05">&#9670;&nbsp;</a></span>anonymous enum</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Scalar_, int kLanes_&gt; </div>
<table class="memname">
<tr>
<td class="memname">anonymous enum</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a69be4f85c1dac371fa6f1c6747724adc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a69be4f85c1dac371fa6f1c6747724adc">&#9670;&nbsp;</a></span>operator[]() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Scalar_, int kLanes_&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="unioncutlass_1_1Vector.html#a56875d7cbf921261e68e1f63212db5bd">Scalar</a> const&amp; <a class="el" href="unioncutlass_1_1Vector.html">cutlass::Vector</a>&lt; Scalar_, kLanes_ &gt;::operator[] </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>i</em></td><td>)</td>
<td> const</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="abf531676caf85cde1c8df435c1ebe8bb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abf531676caf85cde1c8df435c1ebe8bb">&#9670;&nbsp;</a></span>operator[]() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Scalar_, int kLanes_&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="unioncutlass_1_1Vector.html#a56875d7cbf921261e68e1f63212db5bd">Scalar</a>&amp; <a class="el" href="unioncutlass_1_1Vector.html">cutlass::Vector</a>&lt; Scalar_, kLanes_ &gt;::operator[] </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>i</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>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a9e9352594fcd022526d5b69b6c25c99c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9e9352594fcd022526d5b69b6c25c99c">&#9670;&nbsp;</a></span>aligned_</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Scalar_, int kLanes_&gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structcutlass_1_1AlignedStruct.html">AlignedStruct</a>&lt;<a class="el" href="unioncutlass_1_1Vector.html#abf0c16b6f9cb8439835ebdb271d58763afaf4b62c6bcafbf961c5570364a0316e">kVectorSize</a>&gt; <a class="el" href="unioncutlass_1_1Vector.html">cutlass::Vector</a>&lt; Scalar_, kLanes_ &gt;::aligned_</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a29dab07949206cc1609543ffcefd1e5a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a29dab07949206cc1609543ffcefd1e5a">&#9670;&nbsp;</a></span>registers</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Scalar_, int kLanes_&gt; </div>
<table class="memname">
<tr>
<td class="memname">uint32_t <a class="el" href="unioncutlass_1_1Vector.html">cutlass::Vector</a>&lt; Scalar_, kLanes_ &gt;::registers[kRegisters]</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a091080b4e9db9e89734f44ceb985d78f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a091080b4e9db9e89734f44ceb985d78f">&#9670;&nbsp;</a></span>scalars</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Scalar_, int kLanes_&gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="unioncutlass_1_1Vector.html#a56875d7cbf921261e68e1f63212db5bd">Scalar</a> <a class="el" href="unioncutlass_1_1Vector.html">cutlass::Vector</a>&lt; Scalar_, kLanes_ &gt;::scalars[<a class="el" href="unioncutlass_1_1Vector.html#a824f9ab976c8e7f035236af03e5ae839a605c5e987bc7b08d743f29a6524abb27">kLanes</a>]</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<hr/>The documentation for this union was generated from the following file:<ul>
<li><a class="el" href="vector_8h_source.html">vector.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
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>
</body>
</html>