zhangyiss/mlx
1
0
Fork 0
mirror of https://github.com/ml-explore/mlx.git synced 2025-06-25 18:11:15 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity
e5e2ffe503
mlx/docs/build/html/classpocketfft_1_1detail_1_1multi__iter.html
CircleCI Docs fe6b3ed02c rebase
2025-06-04 01:01:52 +00:00

452 lines
20 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.12.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MLX: pocketfft::detail::multi_iter&lt; N &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="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>
<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>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.12.0 -->
<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>
<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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search',false);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){ initResizable(false); });
/* @license-end */
</script>
<!-- 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 id="nav-path" class="navpath">
<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_1multi__iter.html">multi_iter</a></li> </ul>
</div>
</div><!-- top -->
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classpocketfft_1_1detail_1_1multi__iter-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">pocketfft::detail::multi_iter&lt; N &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:a9be43bb18840202da6d17988fccc64b9" id="r_a9be43bb18840202da6d17988fccc64b9"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a9be43bb18840202da6d17988fccc64b9">multi_iter</a> (const <a class="el" href="classpocketfft_1_1detail_1_1arr__info.html">arr_info</a> &amp;iarr_, const <a class="el" href="classpocketfft_1_1detail_1_1arr__info.html">arr_info</a> &amp;oarr_, size_t idim_)</td></tr>
<tr class="separator:a9be43bb18840202da6d17988fccc64b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5ddcc0666125b3cb6c0d62b30befdd2c" id="r_a5ddcc0666125b3cb6c0d62b30befdd2c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5ddcc0666125b3cb6c0d62b30befdd2c">advance</a> (size_t n)</td></tr>
<tr class="separator:a5ddcc0666125b3cb6c0d62b30befdd2c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad33360d4a8ab8e6d72efadc6f9cb5bfa" id="r_ad33360d4a8ab8e6d72efadc6f9cb5bfa"><td class="memItemLeft" align="right" valign="top">ptrdiff_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad33360d4a8ab8e6d72efadc6f9cb5bfa">iofs</a> (size_t i) const</td></tr>
<tr class="separator:ad33360d4a8ab8e6d72efadc6f9cb5bfa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a97462d97bdca6419d8d2f37c2031fe83" id="r_a97462d97bdca6419d8d2f37c2031fe83"><td class="memItemLeft" align="right" valign="top">ptrdiff_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a97462d97bdca6419d8d2f37c2031fe83">iofs</a> (size_t j, size_t i) const</td></tr>
<tr class="separator:a97462d97bdca6419d8d2f37c2031fe83"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aae63e67caac095d474ddd32daa5ffa34" id="r_aae63e67caac095d474ddd32daa5ffa34"><td class="memItemLeft" align="right" valign="top">ptrdiff_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aae63e67caac095d474ddd32daa5ffa34">oofs</a> (size_t i) const</td></tr>
<tr class="separator:aae63e67caac095d474ddd32daa5ffa34"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9236047e7419e5d21379cbf95eb3a78e" id="r_a9236047e7419e5d21379cbf95eb3a78e"><td class="memItemLeft" align="right" valign="top">ptrdiff_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a9236047e7419e5d21379cbf95eb3a78e">oofs</a> (size_t j, size_t i) const</td></tr>
<tr class="separator:a9236047e7419e5d21379cbf95eb3a78e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5318b79d934cddf109dff7bf96a330c8" id="r_a5318b79d934cddf109dff7bf96a330c8"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5318b79d934cddf109dff7bf96a330c8">length_in</a> () const</td></tr>
<tr class="separator:a5318b79d934cddf109dff7bf96a330c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a93cd515d07cd479138a35da9df66bd41" id="r_a93cd515d07cd479138a35da9df66bd41"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a93cd515d07cd479138a35da9df66bd41">length_out</a> () const</td></tr>
<tr class="separator:a93cd515d07cd479138a35da9df66bd41"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac947f03b1cfcb63436a7e61ff020a88c" id="r_ac947f03b1cfcb63436a7e61ff020a88c"><td class="memItemLeft" align="right" valign="top">ptrdiff_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac947f03b1cfcb63436a7e61ff020a88c">stride_in</a> () const</td></tr>
<tr class="separator:ac947f03b1cfcb63436a7e61ff020a88c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a81d71a13bf0b85e556fbb9834167ecc7" id="r_a81d71a13bf0b85e556fbb9834167ecc7"><td class="memItemLeft" align="right" valign="top">ptrdiff_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a81d71a13bf0b85e556fbb9834167ecc7">stride_out</a> () const</td></tr>
<tr class="separator:a81d71a13bf0b85e556fbb9834167ecc7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a034d12f842df90e6471dffd3fa6ba4bd" id="r_a034d12f842df90e6471dffd3fa6ba4bd"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a034d12f842df90e6471dffd3fa6ba4bd">remaining</a> () const</td></tr>
<tr class="separator:a034d12f842df90e6471dffd3fa6ba4bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a9be43bb18840202da6d17988fccc64b9" name="a9be43bb18840202da6d17988fccc64b9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9be43bb18840202da6d17988fccc64b9">&#9670;&#160;</a></span>multi_iter()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;size_t N&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_1multi__iter.html">pocketfft::detail::multi_iter</a>&lt; N &gt;::multi_iter </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classpocketfft_1_1detail_1_1arr__info.html">arr_info</a> &amp;</td> <td class="paramname"><span class="paramname"><em>iarr_</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classpocketfft_1_1detail_1_1arr__info.html">arr_info</a> &amp;</td> <td class="paramname"><span class="paramname"><em>oarr_</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>idim_</em></span>&#160;)</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 Function Documentation</h2>
<a id="a5ddcc0666125b3cb6c0d62b30befdd2c" name="a5ddcc0666125b3cb6c0d62b30befdd2c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5ddcc0666125b3cb6c0d62b30befdd2c">&#9670;&#160;</a></span>advance()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;size_t N&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_1multi__iter.html">pocketfft::detail::multi_iter</a>&lt; N &gt;::advance </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</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ad33360d4a8ab8e6d72efadc6f9cb5bfa" name="ad33360d4a8ab8e6d72efadc6f9cb5bfa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad33360d4a8ab8e6d72efadc6f9cb5bfa">&#9670;&#160;</a></span>iofs() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;size_t N&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ptrdiff_t <a class="el" href="classpocketfft_1_1detail_1_1multi__iter.html">pocketfft::detail::multi_iter</a>&lt; N &gt;::iofs </td>
<td>(</td>
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>i</em></span></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="a97462d97bdca6419d8d2f37c2031fe83" name="a97462d97bdca6419d8d2f37c2031fe83"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a97462d97bdca6419d8d2f37c2031fe83">&#9670;&#160;</a></span>iofs() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;size_t N&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ptrdiff_t <a class="el" href="classpocketfft_1_1detail_1_1multi__iter.html">pocketfft::detail::multi_iter</a>&lt; N &gt;::iofs </td>
<td>(</td>
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>j</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>i</em></span>&#160;) 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="a5318b79d934cddf109dff7bf96a330c8" name="a5318b79d934cddf109dff7bf96a330c8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5318b79d934cddf109dff7bf96a330c8">&#9670;&#160;</a></span>length_in()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;size_t N&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_1multi__iter.html">pocketfft::detail::multi_iter</a>&lt; N &gt;::length_in </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</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a93cd515d07cd479138a35da9df66bd41" name="a93cd515d07cd479138a35da9df66bd41"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a93cd515d07cd479138a35da9df66bd41">&#9670;&#160;</a></span>length_out()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;size_t N&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_1multi__iter.html">pocketfft::detail::multi_iter</a>&lt; N &gt;::length_out </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</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="aae63e67caac095d474ddd32daa5ffa34" name="aae63e67caac095d474ddd32daa5ffa34"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aae63e67caac095d474ddd32daa5ffa34">&#9670;&#160;</a></span>oofs() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;size_t N&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ptrdiff_t <a class="el" href="classpocketfft_1_1detail_1_1multi__iter.html">pocketfft::detail::multi_iter</a>&lt; N &gt;::oofs </td>
<td>(</td>
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>i</em></span></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="a9236047e7419e5d21379cbf95eb3a78e" name="a9236047e7419e5d21379cbf95eb3a78e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9236047e7419e5d21379cbf95eb3a78e">&#9670;&#160;</a></span>oofs() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;size_t N&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ptrdiff_t <a class="el" href="classpocketfft_1_1detail_1_1multi__iter.html">pocketfft::detail::multi_iter</a>&lt; N &gt;::oofs </td>
<td>(</td>
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>j</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>i</em></span>&#160;) 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="a034d12f842df90e6471dffd3fa6ba4bd" name="a034d12f842df90e6471dffd3fa6ba4bd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a034d12f842df90e6471dffd3fa6ba4bd">&#9670;&#160;</a></span>remaining()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;size_t N&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_1multi__iter.html">pocketfft::detail::multi_iter</a>&lt; N &gt;::remaining </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</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ac947f03b1cfcb63436a7e61ff020a88c" name="ac947f03b1cfcb63436a7e61ff020a88c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac947f03b1cfcb63436a7e61ff020a88c">&#9670;&#160;</a></span>stride_in()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;size_t N&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ptrdiff_t <a class="el" href="classpocketfft_1_1detail_1_1multi__iter.html">pocketfft::detail::multi_iter</a>&lt; N &gt;::stride_in </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</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a81d71a13bf0b85e556fbb9834167ecc7" name="a81d71a13bf0b85e556fbb9834167ecc7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a81d71a13bf0b85e556fbb9834167ecc7">&#9670;&#160;</a></span>stride_out()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;size_t N&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ptrdiff_t <a class="el" href="classpocketfft_1_1detail_1_1multi__iter.html">pocketfft::detail::multi_iter</a>&lt; N &gt;::stride_out </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</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 -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0
</small></address>
</div><!-- doc-content -->
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink