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
50b9530af5
mlx/docs/build/html/classpocketfft_1_1detail_1_1arr__info.html
Awni Hannun 6269c69d0e docs update
2025-06-04 01:01:50 +00:00

358 lines
18 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.10.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MLX: pocketfft::detail::arr_info Class 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>
<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.10.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" 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');
$(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">
<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_1arr__info.html">arr_info</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classpocketfft_1_1detail_1_1arr__info-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">pocketfft::detail::arr_info Class 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>
<div class="dynheader">
Inheritance diagram for pocketfft::detail::arr_info:</div>
<div class="dyncontent">
<div class="center">
<img src="classpocketfft_1_1detail_1_1arr__info.png" usemap="#pocketfft::detail::arr_5Finfo_map" alt=""/>
<map id="pocketfft::detail::arr_5Finfo_map" name="pocketfft::detail::arr_5Finfo_map">
<area href="classpocketfft_1_1detail_1_1cndarr.html" alt="pocketfft::detail::cndarr&lt; T &gt;" shape="rect" coords="0,56,171,80"/>
<area href="classpocketfft_1_1detail_1_1ndarr.html" alt="pocketfft::detail::ndarr&lt; T &gt;" shape="rect" coords="0,112,171,136"/>
</map>
</div></div>
<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:a0dbddb7d86ca306159fc9ef9a453b21e" id="r_a0dbddb7d86ca306159fc9ef9a453b21e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0dbddb7d86ca306159fc9ef9a453b21e">arr_info</a> (<a class="el" href="structpocketfft_1_1detail_1_1cmplx.html">const</a> <a class="el" href="namespacepocketfft_1_1detail.html#a885ee37fcf564a268a5c8ca9ea8603e1">shape_t</a> &amp;shape_, <a class="el" href="structpocketfft_1_1detail_1_1cmplx.html">const</a> <a class="el" href="namespacepocketfft_1_1detail.html#afb987c919e9424a996d0fc8b3c23cc84">stride_t</a> &amp;<a class="el" href="structpocketfft_1_1detail_1_1cmplx.html">stride_</a>)</td></tr>
<tr class="separator:a0dbddb7d86ca306159fc9ef9a453b21e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac608c8af2a59a28a0012e308be7ee414" id="r_ac608c8af2a59a28a0012e308be7ee414"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac608c8af2a59a28a0012e308be7ee414">ndim</a> () <a class="el" href="structpocketfft_1_1detail_1_1cmplx.html">const</a></td></tr>
<tr class="separator:ac608c8af2a59a28a0012e308be7ee414"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a003a7106f7fa59a3c55ac1f0116313a5" id="r_a003a7106f7fa59a3c55ac1f0116313a5"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a003a7106f7fa59a3c55ac1f0116313a5">size</a> () <a class="el" href="structpocketfft_1_1detail_1_1cmplx.html">const</a></td></tr>
<tr class="separator:a003a7106f7fa59a3c55ac1f0116313a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:accada8146cb8d3ab7facb4c1e3413ec0" id="r_accada8146cb8d3ab7facb4c1e3413ec0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structpocketfft_1_1detail_1_1cmplx.html">const</a> <a class="el" href="namespacepocketfft_1_1detail.html#a885ee37fcf564a268a5c8ca9ea8603e1">shape_t</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#accada8146cb8d3ab7facb4c1e3413ec0">shape</a> () <a class="el" href="structpocketfft_1_1detail_1_1cmplx.html">const</a></td></tr>
<tr class="separator:accada8146cb8d3ab7facb4c1e3413ec0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac601c660c64a4c252aa8be4ae7dfa7a8" id="r_ac601c660c64a4c252aa8be4ae7dfa7a8"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac601c660c64a4c252aa8be4ae7dfa7a8">shape</a> (size_t i) <a class="el" href="structpocketfft_1_1detail_1_1cmplx.html">const</a></td></tr>
<tr class="separator:ac601c660c64a4c252aa8be4ae7dfa7a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9d10aa83a1117e75d36f7396b8c2a093" id="r_a9d10aa83a1117e75d36f7396b8c2a093"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structpocketfft_1_1detail_1_1cmplx.html">const</a> <a class="el" href="namespacepocketfft_1_1detail.html#afb987c919e9424a996d0fc8b3c23cc84">stride_t</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a9d10aa83a1117e75d36f7396b8c2a093">stride</a> () <a class="el" href="structpocketfft_1_1detail_1_1cmplx.html">const</a></td></tr>
<tr class="separator:a9d10aa83a1117e75d36f7396b8c2a093"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac1f6a9bd6703eceef6003f5f6315d39b" id="r_ac1f6a9bd6703eceef6003f5f6315d39b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structpocketfft_1_1detail_1_1cmplx.html">const</a> ptrdiff_t &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac1f6a9bd6703eceef6003f5f6315d39b">stride</a> (size_t i) <a class="el" href="structpocketfft_1_1detail_1_1cmplx.html">const</a></td></tr>
<tr class="separator:ac1f6a9bd6703eceef6003f5f6315d39b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-attribs" name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a2467e9e01de1ba4d7cd28c1af783da8d" id="r_a2467e9e01de1ba4d7cd28c1af783da8d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacepocketfft_1_1detail.html#a885ee37fcf564a268a5c8ca9ea8603e1">shape_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a2467e9e01de1ba4d7cd28c1af783da8d">shp</a></td></tr>
<tr class="separator:a2467e9e01de1ba4d7cd28c1af783da8d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abe1f7b92501b4e0e5a38fd26294ac5a4" id="r_abe1f7b92501b4e0e5a38fd26294ac5a4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacepocketfft_1_1detail.html#afb987c919e9424a996d0fc8b3c23cc84">stride_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#abe1f7b92501b4e0e5a38fd26294ac5a4">str</a></td></tr>
<tr class="separator:abe1f7b92501b4e0e5a38fd26294ac5a4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a0dbddb7d86ca306159fc9ef9a453b21e" name="a0dbddb7d86ca306159fc9ef9a453b21e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0dbddb7d86ca306159fc9ef9a453b21e">&#9670;&#160;</a></span>arr_info()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">pocketfft::detail::arr_info::arr_info </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structpocketfft_1_1detail_1_1cmplx.html">const</a> <a class="el" href="namespacepocketfft_1_1detail.html#a885ee37fcf564a268a5c8ca9ea8603e1">shape_t</a> &amp;</td> <td class="paramname"><span class="paramname"><em>shape_</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structpocketfft_1_1detail_1_1cmplx.html">const</a> <a class="el" href="namespacepocketfft_1_1detail.html#afb987c919e9424a996d0fc8b3c23cc84">stride_t</a> &amp;</td> <td class="paramname"><span class="paramname"><em>stride_</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="ac608c8af2a59a28a0012e308be7ee414" name="ac608c8af2a59a28a0012e308be7ee414"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac608c8af2a59a28a0012e308be7ee414">&#9670;&#160;</a></span>ndim()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">size_t pocketfft::detail::arr_info::ndim </td>
<td>(</td>
<td class="paramname"><span class="paramname"></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="accada8146cb8d3ab7facb4c1e3413ec0" name="accada8146cb8d3ab7facb4c1e3413ec0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#accada8146cb8d3ab7facb4c1e3413ec0">&#9670;&#160;</a></span>shape() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structpocketfft_1_1detail_1_1cmplx.html">const</a> <a class="el" href="namespacepocketfft_1_1detail.html#a885ee37fcf564a268a5c8ca9ea8603e1">shape_t</a> &amp; pocketfft::detail::arr_info::shape </td>
<td>(</td>
<td class="paramname"><span class="paramname"></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="ac601c660c64a4c252aa8be4ae7dfa7a8" name="ac601c660c64a4c252aa8be4ae7dfa7a8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac601c660c64a4c252aa8be4ae7dfa7a8">&#9670;&#160;</a></span>shape() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">size_t pocketfft::detail::arr_info::shape </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="a003a7106f7fa59a3c55ac1f0116313a5" name="a003a7106f7fa59a3c55ac1f0116313a5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a003a7106f7fa59a3c55ac1f0116313a5">&#9670;&#160;</a></span>size()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">size_t pocketfft::detail::arr_info::size </td>
<td>(</td>
<td class="paramname"><span class="paramname"></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="a9d10aa83a1117e75d36f7396b8c2a093" name="a9d10aa83a1117e75d36f7396b8c2a093"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9d10aa83a1117e75d36f7396b8c2a093">&#9670;&#160;</a></span>stride() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structpocketfft_1_1detail_1_1cmplx.html">const</a> <a class="el" href="namespacepocketfft_1_1detail.html#afb987c919e9424a996d0fc8b3c23cc84">stride_t</a> &amp; pocketfft::detail::arr_info::stride </td>
<td>(</td>
<td class="paramname"><span class="paramname"></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="ac1f6a9bd6703eceef6003f5f6315d39b" name="ac1f6a9bd6703eceef6003f5f6315d39b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac1f6a9bd6703eceef6003f5f6315d39b">&#9670;&#160;</a></span>stride() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structpocketfft_1_1detail_1_1cmplx.html">const</a> ptrdiff_t &amp; pocketfft::detail::arr_info::stride </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>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a2467e9e01de1ba4d7cd28c1af783da8d" name="a2467e9e01de1ba4d7cd28c1af783da8d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2467e9e01de1ba4d7cd28c1af783da8d">&#9670;&#160;</a></span>shp</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespacepocketfft_1_1detail.html#a885ee37fcf564a268a5c8ca9ea8603e1">shape_t</a> pocketfft::detail::arr_info::shp</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="abe1f7b92501b4e0e5a38fd26294ac5a4" name="abe1f7b92501b4e0e5a38fd26294ac5a4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abe1f7b92501b4e0e5a38fd26294ac5a4">&#9670;&#160;</a></span>str</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespacepocketfft_1_1detail.html#afb987c919e9424a996d0fc8b3c23cc84">stride_t</a> pocketfft::detail::arr_info::str</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</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.10.0
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink