zhangyiss/mlx
1
0
Fork 0
mirror of https://github.com/ml-explore/mlx.git synced 2025-06-26 02:33:21 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity
c7080f89ca
mlx/docs/build/html/classpocketfft_1_1detail_1_1arr.html
CircleCI Docs c7080f89ca rebase
2025-06-04 01:01:55 +00:00

423 lines
19 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.13.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MLX: pocketfft::detail::arr&lt; T &gt; Class 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>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.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/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { init_search(); });
/* @license-end */
</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 id="projectrow">
<td id="projectalign">
<div id="projectname">MLX
</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.13.2 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('classpocketfft_1_1detail_1_1arr.html',''); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
<!-- 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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classpocketfft_1_1detail_1_1arr-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">pocketfft::detail::arr&lt; T &gt; Class Template Reference</div></div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="pocketfft_8h_source.html">pocketfft.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a961a24410638b35129cd6b81850d2a42" id="r_a961a24410638b35129cd6b81850d2a42"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a961a24410638b35129cd6b81850d2a42">arr</a> ()</td></tr>
<tr class="separator:a961a24410638b35129cd6b81850d2a42"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a04f832b780a4453fdf3b69bf75b182bd" id="r_a04f832b780a4453fdf3b69bf75b182bd"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a04f832b780a4453fdf3b69bf75b182bd">arr</a> (size_t n)</td></tr>
<tr class="separator:a04f832b780a4453fdf3b69bf75b182bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0cd8fb4a588a74d428a7349d38b477d0" id="r_a0cd8fb4a588a74d428a7349d38b477d0"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0cd8fb4a588a74d428a7349d38b477d0">arr</a> (<a class="el" href="classpocketfft_1_1detail_1_1arr.html">arr</a> &amp;&amp;other)</td></tr>
<tr class="separator:a0cd8fb4a588a74d428a7349d38b477d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8519487ee7fa95d3937a8352dd289b56" id="r_a8519487ee7fa95d3937a8352dd289b56"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8519487ee7fa95d3937a8352dd289b56">~arr</a> ()</td></tr>
<tr class="separator:a8519487ee7fa95d3937a8352dd289b56"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8d73baaefa02dff8714e4398c83917e0" id="r_a8d73baaefa02dff8714e4398c83917e0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8d73baaefa02dff8714e4398c83917e0">resize</a> (size_t n)</td></tr>
<tr class="separator:a8d73baaefa02dff8714e4398c83917e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aea0bd899b19e03f54dfd6c188727061a" id="r_aea0bd899b19e03f54dfd6c188727061a"><td class="memItemLeft" align="right" valign="top">T &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aea0bd899b19e03f54dfd6c188727061a">operator[]</a> (size_t idx)</td></tr>
<tr class="separator:aea0bd899b19e03f54dfd6c188727061a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a99c54f96bc79c7cdd8925c1663462842" id="r_a99c54f96bc79c7cdd8925c1663462842"><td class="memItemLeft" align="right" valign="top">const T &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a99c54f96bc79c7cdd8925c1663462842">operator[]</a> (size_t idx) const</td></tr>
<tr class="separator:a99c54f96bc79c7cdd8925c1663462842"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aec0f2191b4663b4187aab92454c34de8" id="r_aec0f2191b4663b4187aab92454c34de8"><td class="memItemLeft" align="right" valign="top">T *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aec0f2191b4663b4187aab92454c34de8">data</a> ()</td></tr>
<tr class="separator:aec0f2191b4663b4187aab92454c34de8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac82daa17e9f991072b012343f9d7c182" id="r_ac82daa17e9f991072b012343f9d7c182"><td class="memItemLeft" align="right" valign="top">const T *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac82daa17e9f991072b012343f9d7c182">data</a> () const</td></tr>
<tr class="separator:ac82daa17e9f991072b012343f9d7c182"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a95bca00060957f540ff25b69632c6952" id="r_a95bca00060957f540ff25b69632c6952"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a95bca00060957f540ff25b69632c6952">size</a> () const</td></tr>
<tr class="separator:a95bca00060957f540ff25b69632c6952"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a961a24410638b35129cd6b81850d2a42" name="a961a24410638b35129cd6b81850d2a42"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a961a24410638b35129cd6b81850d2a42">&#9670;&#160;</a></span>arr() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classpocketfft_1_1detail_1_1arr.html">pocketfft::detail::arr</a>&lt; T &gt;::arr </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a04f832b780a4453fdf3b69bf75b182bd" name="a04f832b780a4453fdf3b69bf75b182bd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a04f832b780a4453fdf3b69bf75b182bd">&#9670;&#160;</a></span>arr() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classpocketfft_1_1detail_1_1arr.html">pocketfft::detail::arr</a>&lt; T &gt;::arr </td>
<td>(</td>
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>n</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a0cd8fb4a588a74d428a7349d38b477d0" name="a0cd8fb4a588a74d428a7349d38b477d0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0cd8fb4a588a74d428a7349d38b477d0">&#9670;&#160;</a></span>arr() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classpocketfft_1_1detail_1_1arr.html">pocketfft::detail::arr</a>&lt; T &gt;::arr </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classpocketfft_1_1detail_1_1arr.html">arr</a>&lt; T &gt; &amp;&amp;</td> <td class="paramname"><span class="paramname"><em>other</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a8519487ee7fa95d3937a8352dd289b56" name="a8519487ee7fa95d3937a8352dd289b56"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8519487ee7fa95d3937a8352dd289b56">&#9670;&#160;</a></span>~arr()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classpocketfft_1_1detail_1_1arr.html">pocketfft::detail::arr</a>&lt; T &gt;::~<a class="el" href="classpocketfft_1_1detail_1_1arr.html">arr</a> </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="aec0f2191b4663b4187aab92454c34de8" name="aec0f2191b4663b4187aab92454c34de8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aec0f2191b4663b4187aab92454c34de8">&#9670;&#160;</a></span>data() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">T * <a class="el" href="classpocketfft_1_1detail_1_1arr.html">pocketfft::detail::arr</a>&lt; T &gt;::data </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ac82daa17e9f991072b012343f9d7c182" name="ac82daa17e9f991072b012343f9d7c182"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac82daa17e9f991072b012343f9d7c182">&#9670;&#160;</a></span>data() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const T * <a class="el" href="classpocketfft_1_1detail_1_1arr.html">pocketfft::detail::arr</a>&lt; T &gt;::data </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="aea0bd899b19e03f54dfd6c188727061a" name="aea0bd899b19e03f54dfd6c188727061a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aea0bd899b19e03f54dfd6c188727061a">&#9670;&#160;</a></span>operator[]() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">T &amp; <a class="el" href="classpocketfft_1_1detail_1_1arr.html">pocketfft::detail::arr</a>&lt; T &gt;::operator[] </td>
<td>(</td>
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>idx</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a99c54f96bc79c7cdd8925c1663462842" name="a99c54f96bc79c7cdd8925c1663462842"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a99c54f96bc79c7cdd8925c1663462842">&#9670;&#160;</a></span>operator[]() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const T &amp; <a class="el" href="classpocketfft_1_1detail_1_1arr.html">pocketfft::detail::arr</a>&lt; T &gt;::operator[] </td>
<td>(</td>
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>idx</em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a8d73baaefa02dff8714e4398c83917e0" name="a8d73baaefa02dff8714e4398c83917e0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8d73baaefa02dff8714e4398c83917e0">&#9670;&#160;</a></span>resize()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classpocketfft_1_1detail_1_1arr.html">pocketfft::detail::arr</a>&lt; T &gt;::resize </td>
<td>(</td>
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>n</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a95bca00060957f540ff25b69632c6952" name="a95bca00060957f540ff25b69632c6952"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a95bca00060957f540ff25b69632c6952">&#9670;&#160;</a></span>size()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">size_t <a class="el" href="classpocketfft_1_1detail_1_1arr.html">pocketfft::detail::arr</a>&lt; T &gt;::size </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>mlx/3rdparty/<a class="el" href="pocketfft_8h_source.html">pocketfft.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespacepocketfft.html">pocketfft</a></li><li class="navelem"><a class="el" href="namespacepocketfft_1_1detail.html">detail</a></li><li class="navelem"><a class="el" href="classpocketfft_1_1detail_1_1arr.html">arr</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.13.2 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink