| <!-- HTML header for doxygen 1.8.15--> |
| <!-- Remember to use version doxygen 1.8.15 +--> |
| <!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.15"/> |
| <meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines --> |
| <title>Compute Library: NEFFT2D 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> |
| <link href="navtree.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="resize.js"></script> |
| <script type="text/javascript" src="navtreedata.js"></script> |
| <script type="text/javascript" src="navtree.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(document).ready(initResizable); |
| /* @license-end */</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="async" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| <link href="stylesheet.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;"> |
| <img alt="Compute Library" src="https://raw.githubusercontent.com/ARM-software/ComputeLibrary/gh-pages/ACL_logo.png" style="max-width: 100%;margin-top: 15px;margin-left: 10px"/> |
| <td style="padding-left: 0.5em;"> |
| <div id="projectname"> |
|  <span id="projectnumber">19.08</span> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.15 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&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&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> |
| </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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(document).ready(function(){initNavTree('classarm__compute_1_1_n_e_f_f_t2_d.xhtml','');}); |
| /* @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"> |
| <iframe src="javascript:void(0)" frameborder="0" |
| name="MSearchResults" id="MSearchResults"> |
| </iframe> |
| </div> |
| |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pub-static-methods">Static Public Member Functions</a> </div> |
| <div class="headertitle"> |
| <div class="title">NEFFT2D Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Basic function to execute two dimensional FFT. |
| <a href="classarm__compute_1_1_n_e_f_f_t2_d.xhtml#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="_n_e_f_f_t2_d_8h_source.xhtml">NEFFT2D.h</a>></code></p> |
| <div class="dynheader"> |
| Collaboration diagram for NEFFT2D:</div> |
| <div class="dyncontent"> |
| <div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1_n_e_f_f_t2_d__coll__graph.svg" width="90" height="112"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe> |
| </div> |
| <center><span class="legend">[<a target="top" href="graph_legend.xhtml">legend</a>]</span></center></div> |
| <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:a01212a054fa3a8003a01d7ff426a1e0a"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_f_f_t2_d.xhtml#a01212a054fa3a8003a01d7ff426a1e0a">NEFFT2D</a> (std::shared_ptr< <a class="el" href="classarm__compute_1_1_i_memory_manager.xhtml">IMemoryManager</a> > memory_manager=nullptr)</td></tr> |
| <tr class="memdesc:a01212a054fa3a8003a01d7ff426a1e0a"><td class="mdescLeft"> </td><td class="mdescRight">Default Constructor. <a href="#a01212a054fa3a8003a01d7ff426a1e0a">More...</a><br /></td></tr> |
| <tr class="separator:a01212a054fa3a8003a01d7ff426a1e0a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4d704db199385825fcc6fa9fbed62924"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_f_f_t2_d.xhtml#a4d704db199385825fcc6fa9fbed62924">configure</a> (const <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *input, <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *output, const <a class="el" href="structarm__compute_1_1_f_f_t2_d_info.xhtml">FFT2DInfo</a> &config)</td></tr> |
| <tr class="memdesc:a4d704db199385825fcc6fa9fbed62924"><td class="mdescLeft"> </td><td class="mdescRight">Initialise the function's source and destinations. <a href="#a4d704db199385825fcc6fa9fbed62924">More...</a><br /></td></tr> |
| <tr class="separator:a4d704db199385825fcc6fa9fbed62924"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad1717410afd0be936c6213a63c8005fb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_f_f_t2_d.xhtml#ad1717410afd0be936c6213a63c8005fb">run</a> () override</td></tr> |
| <tr class="memdesc:ad1717410afd0be936c6213a63c8005fb"><td class="mdescLeft"> </td><td class="mdescRight">Run the kernels contained in the function. <a href="#ad1717410afd0be936c6213a63c8005fb">More...</a><br /></td></tr> |
| <tr class="separator:ad1717410afd0be936c6213a63c8005fb"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header pub_methods_classarm__compute_1_1_i_function"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarm__compute_1_1_i_function')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classarm__compute_1_1_i_function.xhtml">IFunction</a></td></tr> |
| <tr class="memitem:ab921ecc3f3f6ae2b4bd61f3e1998d8c4 inherit pub_methods_classarm__compute_1_1_i_function"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_function.xhtml#ab921ecc3f3f6ae2b4bd61f3e1998d8c4">~IFunction</a> ()=default</td></tr> |
| <tr class="memdesc:ab921ecc3f3f6ae2b4bd61f3e1998d8c4 inherit pub_methods_classarm__compute_1_1_i_function"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="classarm__compute_1_1_i_function.xhtml#ab921ecc3f3f6ae2b4bd61f3e1998d8c4">More...</a><br /></td></tr> |
| <tr class="separator:ab921ecc3f3f6ae2b4bd61f3e1998d8c4 inherit pub_methods_classarm__compute_1_1_i_function"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a820f7291c24155a2980512fae45aac26 inherit pub_methods_classarm__compute_1_1_i_function"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_function.xhtml#a820f7291c24155a2980512fae45aac26">prepare</a> ()</td></tr> |
| <tr class="memdesc:a820f7291c24155a2980512fae45aac26 inherit pub_methods_classarm__compute_1_1_i_function"><td class="mdescLeft"> </td><td class="mdescRight">Prepare the function for executing. <a href="classarm__compute_1_1_i_function.xhtml#a820f7291c24155a2980512fae45aac26">More...</a><br /></td></tr> |
| <tr class="separator:a820f7291c24155a2980512fae45aac26 inherit pub_methods_classarm__compute_1_1_i_function"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a> |
| Static Public Member Functions</h2></td></tr> |
| <tr class="memitem:a7a17cfcf69fe4671b46fffb61c97d9db"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classarm__compute_1_1_status.xhtml">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_f_f_t2_d.xhtml#a7a17cfcf69fe4671b46fffb61c97d9db">validate</a> (const <a class="el" href="classarm__compute_1_1_i_tensor_info.xhtml">ITensorInfo</a> *input, const <a class="el" href="classarm__compute_1_1_i_tensor_info.xhtml">ITensorInfo</a> *output, const <a class="el" href="structarm__compute_1_1_f_f_t2_d_info.xhtml">FFT2DInfo</a> &config)</td></tr> |
| <tr class="memdesc:a7a17cfcf69fe4671b46fffb61c97d9db"><td class="mdescLeft"> </td><td class="mdescRight">Static function to check if given info will lead to a valid configuration of <a class="el" href="classarm__compute_1_1_n_e_f_f_t2_d.xhtml">NEFFT2D</a>. <a href="#a7a17cfcf69fe4671b46fffb61c97d9db">More...</a><br /></td></tr> |
| <tr class="separator:a7a17cfcf69fe4671b46fffb61c97d9db"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Basic function to execute two dimensional FFT. </p> |
| <p>This function calls the following NEON kernels:</p> |
| <ol type="1"> |
| <li><a class="el" href="classarm__compute_1_1_n_e_f_f_t1_d.xhtml">NEFFT1D</a> 1D FFT is performed on the first given axis</li> |
| <li><a class="el" href="classarm__compute_1_1_n_e_f_f_t1_d.xhtml">NEFFT1D</a> 1D FFT is performed on the second given axis </li> |
| </ol> |
| |
| <p class="definition">Definition at line <a class="el" href="_n_e_f_f_t2_d_8h_source.xhtml#l00044">44</a> of file <a class="el" href="_n_e_f_f_t2_d_8h_source.xhtml">NEFFT2D.h</a>.</p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="a01212a054fa3a8003a01d7ff426a1e0a"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a01212a054fa3a8003a01d7ff426a1e0a">◆ </a></span>NEFFT2D()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_f_f_t2_d.xhtml">NEFFT2D</a> </td> |
| <td>(</td> |
| <td class="paramtype">std::shared_ptr< <a class="el" href="classarm__compute_1_1_i_memory_manager.xhtml">IMemoryManager</a> > </td> |
| <td class="paramname"><em>memory_manager</em> = <code>nullptr</code></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Default Constructor. </p> |
| |
| <p class="definition">Definition at line <a class="el" href="_n_e_f_f_t2_d_8cpp_source.xhtml#l00032">32</a> of file <a class="el" href="_n_e_f_f_t2_d_8cpp_source.xhtml">NEFFT2D.cpp</a>.</p> |
| <div class="fragment"><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  : _memory_group(memory_manager), _first_pass_func(memory_manager), _second_pass_func(memory_manager), _first_pass_tensor()</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> {</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> }</div></div><!-- fragment --> |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a4d704db199385825fcc6fa9fbed62924"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a4d704db199385825fcc6fa9fbed62924">◆ </a></span>configure()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void configure </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> * </td> |
| <td class="paramname"><em>input</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> * </td> |
| <td class="paramname"><em>output</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const <a class="el" href="structarm__compute_1_1_f_f_t2_d_info.xhtml">FFT2DInfo</a> & </td> |
| <td class="paramname"><em>config</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Initialise the function's source and destinations. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">input</td><td>Source tensor. Data types supported: F32. </td></tr> |
| <tr><td class="paramdir">[out]</td><td class="paramname">output</td><td>Destination tensor. Data types and data layouts supported: Same as <code>input</code>. </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">config</td><td>FFT related configuration </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p class="definition">Definition at line <a class="el" href="_n_e_f_f_t2_d_8cpp_source.xhtml#l00037">37</a> of file <a class="el" href="_n_e_f_f_t2_d_8cpp_source.xhtml">NEFFT2D.cpp</a>.</p> |
| <div class="fragment"><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> {</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <a class="code" href="_validate_8h.xhtml#a921b705e9e3e0fe928928447869e62a5">ARM_COMPUTE_ERROR_ON_NULLPTR</a>(input, output);</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <a class="code" href="_error_8h.xhtml#a938dcd406ce611ef5345ad2531cdb948">ARM_COMPUTE_ERROR_THROW_ON</a>(<a class="code" href="classarm__compute_1_1_n_e_f_f_t2_d.xhtml#a7a17cfcf69fe4671b46fffb61c97d9db">NEFFT2D::validate</a>(input->info(), output->info(), config));</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="comment">// Setup first pass</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  FFT1DInfo first_pass_config;</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  first_pass_config.axis = config.axes.first;</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  first_pass_config.direction = config.direction;</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  _memory_group.<a class="code" href="classarm__compute_1_1_memory_group_base.xhtml#ac1f67376afb7822f262a0174ef4a3104">manage</a>(&_first_pass_tensor);</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  _first_pass_func.<a class="code" href="classarm__compute_1_1_n_e_f_f_t1_d.xhtml#afa1a519c93fadeba6e6e7f5f37971a25">configure</a>(input, &_first_pass_tensor, first_pass_config);</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="comment">// Setup second pass</span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  FFT1DInfo second_pass_config;</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  second_pass_config.axis = config.axes.second;</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  second_pass_config.direction = config.direction;</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  _second_pass_func.<a class="code" href="classarm__compute_1_1_n_e_f_f_t1_d.xhtml#afa1a519c93fadeba6e6e7f5f37971a25">configure</a>(&_first_pass_tensor, output, second_pass_config);</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  _first_pass_tensor.<a class="code" href="classarm__compute_1_1_tensor.xhtml#adbd0cf83a8e1b335a9bf405a8e5019fa">allocator</a>()-><a class="code" href="classarm__compute_1_1_tensor_allocator.xhtml#a6e509c2a177b0b29e9e2369535094dee">allocate</a>();</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> }</div><div class="ttc" id="_error_8h_xhtml_a938dcd406ce611ef5345ad2531cdb948"><div class="ttname"><a href="_error_8h.xhtml#a938dcd406ce611ef5345ad2531cdb948">ARM_COMPUTE_ERROR_THROW_ON</a></div><div class="ttdeci">#define ARM_COMPUTE_ERROR_THROW_ON(status)</div><div class="ttdef"><b>Definition:</b> <a href="_error_8h_source.xhtml#l00327">Error.h:327</a></div></div> |
| <div class="ttc" id="classarm__compute_1_1_tensor_xhtml_adbd0cf83a8e1b335a9bf405a8e5019fa"><div class="ttname"><a href="classarm__compute_1_1_tensor.xhtml#adbd0cf83a8e1b335a9bf405a8e5019fa">arm_compute::Tensor::allocator</a></div><div class="ttdeci">TensorAllocator * allocator()</div><div class="ttdoc">Return a pointer to the tensor's allocator.</div><div class="ttdef"><b>Definition:</b> <a href="runtime_2_tensor_8cpp_source.xhtml#l00048">Tensor.cpp:48</a></div></div> |
| <div class="ttc" id="classarm__compute_1_1_memory_group_base_xhtml_ac1f67376afb7822f262a0174ef4a3104"><div class="ttname"><a href="classarm__compute_1_1_memory_group_base.xhtml#ac1f67376afb7822f262a0174ef4a3104">arm_compute::MemoryGroupBase::manage</a></div><div class="ttdeci">void manage(TensorType *obj)</div><div class="ttdoc">Sets a object to be managed by the given memory group.</div><div class="ttdef"><b>Definition:</b> <a href="_memory_group_base_8h_source.xhtml#l00102">MemoryGroupBase.h:102</a></div></div> |
| <div class="ttc" id="classarm__compute_1_1_n_e_f_f_t1_d_xhtml_afa1a519c93fadeba6e6e7f5f37971a25"><div class="ttname"><a href="classarm__compute_1_1_n_e_f_f_t1_d.xhtml#afa1a519c93fadeba6e6e7f5f37971a25">arm_compute::NEFFT1D::configure</a></div><div class="ttdeci">void configure(const ITensor *input, ITensor *output, const FFT1DInfo &config)</div><div class="ttdoc">Initialise the function's source and destinations.</div><div class="ttdef"><b>Definition:</b> <a href="_n_e_f_f_t1_d_8cpp_source.xhtml#l00038">NEFFT1D.cpp:38</a></div></div> |
| <div class="ttc" id="classarm__compute_1_1_tensor_allocator_xhtml_a6e509c2a177b0b29e9e2369535094dee"><div class="ttname"><a href="classarm__compute_1_1_tensor_allocator.xhtml#a6e509c2a177b0b29e9e2369535094dee">arm_compute::TensorAllocator::allocate</a></div><div class="ttdeci">void allocate() override</div><div class="ttdoc">Allocate size specified by TensorInfo of CPU memory.</div><div class="ttdef"><b>Definition:</b> <a href="src_2runtime_2_tensor_allocator_8cpp_source.xhtml#l00133">TensorAllocator.cpp:133</a></div></div> |
| <div class="ttc" id="classarm__compute_1_1_n_e_f_f_t2_d_xhtml_a7a17cfcf69fe4671b46fffb61c97d9db"><div class="ttname"><a href="classarm__compute_1_1_n_e_f_f_t2_d.xhtml#a7a17cfcf69fe4671b46fffb61c97d9db">arm_compute::NEFFT2D::validate</a></div><div class="ttdeci">static Status validate(const ITensorInfo *input, const ITensorInfo *output, const FFT2DInfo &config)</div><div class="ttdoc">Static function to check if given info will lead to a valid configuration of NEFFT2D.</div><div class="ttdef"><b>Definition:</b> <a href="_n_e_f_f_t2_d_8cpp_source.xhtml#l00057">NEFFT2D.cpp:57</a></div></div> |
| <div class="ttc" id="_validate_8h_xhtml_a921b705e9e3e0fe928928447869e62a5"><div class="ttname"><a href="_validate_8h.xhtml#a921b705e9e3e0fe928928447869e62a5">ARM_COMPUTE_ERROR_ON_NULLPTR</a></div><div class="ttdeci">#define ARM_COMPUTE_ERROR_ON_NULLPTR(...)</div><div class="ttdef"><b>Definition:</b> <a href="_validate_8h_source.xhtml#l00161">Validate.h:161</a></div></div> |
| </div><!-- fragment --> |
| <p class="reference">References <a class="el" href="src_2runtime_2_tensor_allocator_8cpp_source.xhtml#l00133">TensorAllocator::allocate()</a>, <a class="el" href="runtime_2_tensor_8cpp_source.xhtml#l00048">Tensor::allocator()</a>, <a class="el" href="_validate_8h_source.xhtml#l00161">ARM_COMPUTE_ERROR_ON_NULLPTR</a>, <a class="el" href="_error_8h_source.xhtml#l00327">ARM_COMPUTE_ERROR_THROW_ON</a>, <a class="el" href="_function_descriptors_8h_source.xhtml#l00047">FFT2DInfo::axes</a>, <a class="el" href="_function_descriptors_8h_source.xhtml#l00040">FFT1DInfo::axis</a>, <a class="el" href="_n_e_f_f_t1_d_8cpp_source.xhtml#l00038">NEFFT1D::configure()</a>, <a class="el" href="_function_descriptors_8h_source.xhtml#l00041">FFT1DInfo::direction</a>, <a class="el" href="_function_descriptors_8h_source.xhtml#l00048">FFT2DInfo::direction</a>, <a class="el" href="classarm__compute_1_1_i_tensor.xhtml#a0e95dc1e53c361348314873b168ae237">ITensor::info()</a>, <a class="el" href="_memory_group_base_8h_source.xhtml#l00102">MemoryGroupBase< TensorType >::manage()</a>, and <a class="el" href="_n_e_f_f_t2_d_8cpp_source.xhtml#l00057">NEFFT2D::validate()</a>.</p> |
| |
| <p class="reference">Referenced by <a class="el" href="_n_e_f_f_t_convolution_layer_8cpp_source.xhtml#l00097">NEFFTConvolutionLayer::configure()</a>.</p> |
| |
| </div> |
| </div> |
| <a id="ad1717410afd0be936c6213a63c8005fb"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ad1717410afd0be936c6213a63c8005fb">◆ </a></span>run()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void run </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Run the kernels contained in the function. </p> |
| <p>For NEON kernels:</p><ul> |
| <li>Multi-threading is used for the kernels which are parallelisable.</li> |
| <li>By default std::thread::hardware_concurrency() threads are used.</li> |
| </ul> |
| <dl class="section note"><dt>Note</dt><dd><a class="el" href="classarm__compute_1_1_c_p_p_scheduler.xhtml#ae64eebaa07f4d2da6cc2ba538c3cb095">CPPScheduler::set_num_threads()</a> can be used to manually set the number of threads</dd></dl> |
| <p>For OpenCL kernels:</p><ul> |
| <li>All the kernels are enqueued on the queue associated with <a class="el" href="classarm__compute_1_1_c_l_scheduler.xhtml" title="Provides global access to a CL context and command queue.">CLScheduler</a>.</li> |
| <li>The queue is then flushed.</li> |
| </ul> |
| <dl class="section note"><dt>Note</dt><dd>The function will not block until the kernels are executed. It is the user's responsibility to wait. </dd> |
| <dd> |
| Will call <a class="el" href="classarm__compute_1_1_i_function.xhtml#a820f7291c24155a2980512fae45aac26" title="Prepare the function for executing.">prepare()</a> on first run if hasn't been done </dd></dl> |
| |
| <p>Implements <a class="el" href="classarm__compute_1_1_i_function.xhtml#a18954417d3124a8095783ea13dc6d00b">IFunction</a>.</p> |
| |
| <p class="definition">Definition at line <a class="el" href="_n_e_f_f_t2_d_8cpp_source.xhtml#l00086">86</a> of file <a class="el" href="_n_e_f_f_t2_d_8cpp_source.xhtml">NEFFT2D.cpp</a>.</p> |
| <div class="fragment"><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> {</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  _memory_group.<a class="code" href="classarm__compute_1_1_memory_group_base.xhtml#a8d16047fa6fdcf5f5453056cc0e1daba">acquire</a>();</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> </div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  _first_pass_func.<a class="code" href="classarm__compute_1_1_n_e_f_f_t1_d.xhtml#ad1717410afd0be936c6213a63c8005fb">run</a>();</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  _second_pass_func.<a class="code" href="classarm__compute_1_1_n_e_f_f_t1_d.xhtml#ad1717410afd0be936c6213a63c8005fb">run</a>();</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> </div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  _memory_group.<a class="code" href="classarm__compute_1_1_memory_group_base.xhtml#ad7ed3842c3160ae4b9f51acbf4564438">release</a>();</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> }</div><div class="ttc" id="classarm__compute_1_1_memory_group_base_xhtml_a8d16047fa6fdcf5f5453056cc0e1daba"><div class="ttname"><a href="classarm__compute_1_1_memory_group_base.xhtml#a8d16047fa6fdcf5f5453056cc0e1daba">arm_compute::MemoryGroupBase::acquire</a></div><div class="ttdeci">void acquire() override</div><div class="ttdoc">Acquires backing memory for the whole group.</div><div class="ttdef"><b>Definition:</b> <a href="_memory_group_base_8h_source.xhtml#l00134">MemoryGroupBase.h:134</a></div></div> |
| <div class="ttc" id="classarm__compute_1_1_n_e_f_f_t1_d_xhtml_ad1717410afd0be936c6213a63c8005fb"><div class="ttname"><a href="classarm__compute_1_1_n_e_f_f_t1_d.xhtml#ad1717410afd0be936c6213a63c8005fb">arm_compute::NEFFT1D::run</a></div><div class="ttdeci">void run() override</div><div class="ttdoc">Run the kernels contained in the function.</div><div class="ttdef"><b>Definition:</b> <a href="_n_e_f_f_t1_d_8cpp_source.xhtml#l00127">NEFFT1D.cpp:127</a></div></div> |
| <div class="ttc" id="classarm__compute_1_1_memory_group_base_xhtml_ad7ed3842c3160ae4b9f51acbf4564438"><div class="ttname"><a href="classarm__compute_1_1_memory_group_base.xhtml#ad7ed3842c3160ae4b9f51acbf4564438">arm_compute::MemoryGroupBase::release</a></div><div class="ttdeci">void release() override</div><div class="ttdoc">Releases backing memory of the whole group.</div><div class="ttdef"><b>Definition:</b> <a href="_memory_group_base_8h_source.xhtml#l00145">MemoryGroupBase.h:145</a></div></div> |
| </div><!-- fragment --> |
| <p class="reference">References <a class="el" href="_memory_group_base_8h_source.xhtml#l00134">MemoryGroupBase< TensorType >::acquire()</a>, <a class="el" href="_memory_group_base_8h_source.xhtml#l00145">MemoryGroupBase< TensorType >::release()</a>, and <a class="el" href="_n_e_f_f_t1_d_8cpp_source.xhtml#l00127">NEFFT1D::run()</a>.</p> |
| |
| <p class="reference">Referenced by <a class="el" href="_n_e_f_f_t_convolution_layer_8cpp_source.xhtml#l00296">NEFFTConvolutionLayer::run()</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a7a17cfcf69fe4671b46fffb61c97d9db"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a7a17cfcf69fe4671b46fffb61c97d9db">◆ </a></span>validate()</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="classarm__compute_1_1_status.xhtml">Status</a> validate </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_tensor_info.xhtml">ITensorInfo</a> * </td> |
| <td class="paramname"><em>input</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_tensor_info.xhtml">ITensorInfo</a> * </td> |
| <td class="paramname"><em>output</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const <a class="el" href="structarm__compute_1_1_f_f_t2_d_info.xhtml">FFT2DInfo</a> & </td> |
| <td class="paramname"><em>config</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Static function to check if given info will lead to a valid configuration of <a class="el" href="classarm__compute_1_1_n_e_f_f_t2_d.xhtml">NEFFT2D</a>. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">input</td><td>Source tensor info. Data types supported: F32. </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">output</td><td>Destination tensor info. Data types and data layouts supported: Same as <code>input</code>. </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">config</td><td>FFT related configuration</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>a status </dd></dl> |
| |
| <p class="definition">Definition at line <a class="el" href="_n_e_f_f_t2_d_8cpp_source.xhtml#l00057">57</a> of file <a class="el" href="_n_e_f_f_t2_d_8cpp_source.xhtml">NEFFT2D.cpp</a>.</p> |
| <div class="fragment"><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> {</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <a class="code" href="_validate_8h.xhtml#aff911654521523937ff24372a870b89f">ARM_COMPUTE_RETURN_ERROR_ON_NULLPTR</a>(input, output);</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="comment">// Create intermediate tensor info</span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  TensorInfo first_pass_tensor(input->clone()->set_is_resizable(<span class="keyword">true</span>).reset_padding().set_num_channels(2));</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="comment">// Validate first pass</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  FFT1DInfo first_pass_config;</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  first_pass_config.axis = config.axes.first;</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  first_pass_config.direction = config.direction;</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <a class="code" href="_error_8h.xhtml#a8a1e1c105f0bdaf37db408c7cfcb77a4">ARM_COMPUTE_RETURN_ON_ERROR</a>(<a class="code" href="classarm__compute_1_1_n_e_f_f_t1_d.xhtml#a1df242336d170d76e2d39ecd8c5a43c8">NEFFT1D::validate</a>(input, &first_pass_tensor, first_pass_config));</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="comment">// Validate second pass</span></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  FFT1DInfo second_pass_config;</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  second_pass_config.axis = config.axes.second;</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  second_pass_config.direction = config.direction;</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <a class="code" href="_error_8h.xhtml#a8a1e1c105f0bdaf37db408c7cfcb77a4">ARM_COMPUTE_RETURN_ON_ERROR</a>(<a class="code" href="classarm__compute_1_1_n_e_f_f_t1_d.xhtml#a1df242336d170d76e2d39ecd8c5a43c8">NEFFT1D::validate</a>(&first_pass_tensor, output, second_pass_config));</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> </div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="comment">// Checks performed when output is configured</span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="keywordflow">if</span>((output != <span class="keyword">nullptr</span>) && (output->total_size() != 0))</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  {</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <a class="code" href="_validate_8h.xhtml#a27e4638546c88b8916f967e6e54480a9">ARM_COMPUTE_RETURN_ERROR_ON_MISMATCHING_SHAPES</a>(input, output);</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <a class="code" href="_validate_8h.xhtml#a8f3ff7da485ff7e75dab07baadf5b4bd">ARM_COMPUTE_RETURN_ERROR_ON_MISMATCHING_DATA_TYPES</a>(input, output);</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  }</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> </div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keywordflow">return</span> Status{};</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> }</div><div class="ttc" id="_validate_8h_xhtml_a8f3ff7da485ff7e75dab07baadf5b4bd"><div class="ttname"><a href="_validate_8h.xhtml#a8f3ff7da485ff7e75dab07baadf5b4bd">ARM_COMPUTE_RETURN_ERROR_ON_MISMATCHING_DATA_TYPES</a></div><div class="ttdeci">#define ARM_COMPUTE_RETURN_ERROR_ON_MISMATCHING_DATA_TYPES(...)</div><div class="ttdef"><b>Definition:</b> <a href="_validate_8h_source.xhtml#l00545">Validate.h:545</a></div></div> |
| <div class="ttc" id="_error_8h_xhtml_a8a1e1c105f0bdaf37db408c7cfcb77a4"><div class="ttname"><a href="_error_8h.xhtml#a8a1e1c105f0bdaf37db408c7cfcb77a4">ARM_COMPUTE_RETURN_ON_ERROR</a></div><div class="ttdeci">#define ARM_COMPUTE_RETURN_ON_ERROR(status)</div><div class="ttdoc">Checks if a status contains an error and returns it.</div><div class="ttdef"><b>Definition:</b> <a href="_error_8h_source.xhtml#l00193">Error.h:193</a></div></div> |
| <div class="ttc" id="_validate_8h_xhtml_a27e4638546c88b8916f967e6e54480a9"><div class="ttname"><a href="_validate_8h.xhtml#a27e4638546c88b8916f967e6e54480a9">ARM_COMPUTE_RETURN_ERROR_ON_MISMATCHING_SHAPES</a></div><div class="ttdeci">#define ARM_COMPUTE_RETURN_ERROR_ON_MISMATCHING_SHAPES(...)</div><div class="ttdef"><b>Definition:</b> <a href="_validate_8h_source.xhtml#l00443">Validate.h:443</a></div></div> |
| <div class="ttc" id="_validate_8h_xhtml_aff911654521523937ff24372a870b89f"><div class="ttname"><a href="_validate_8h.xhtml#aff911654521523937ff24372a870b89f">ARM_COMPUTE_RETURN_ERROR_ON_NULLPTR</a></div><div class="ttdeci">#define ARM_COMPUTE_RETURN_ERROR_ON_NULLPTR(...)</div><div class="ttdef"><b>Definition:</b> <a href="_validate_8h_source.xhtml#l00163">Validate.h:163</a></div></div> |
| <div class="ttc" id="classarm__compute_1_1_n_e_f_f_t1_d_xhtml_a1df242336d170d76e2d39ecd8c5a43c8"><div class="ttname"><a href="classarm__compute_1_1_n_e_f_f_t1_d.xhtml#a1df242336d170d76e2d39ecd8c5a43c8">arm_compute::NEFFT1D::validate</a></div><div class="ttdeci">static Status validate(const ITensorInfo *input, const ITensorInfo *output, const FFT1DInfo &config)</div><div class="ttdoc">Static function to check if given info will lead to a valid configuration of NEFFT1D.</div><div class="ttdef"><b>Definition:</b> <a href="_n_e_f_f_t1_d_8cpp_source.xhtml#l00101">NEFFT1D.cpp:101</a></div></div> |
| </div><!-- fragment --> |
| <p class="reference">References <a class="el" href="_validate_8h_source.xhtml#l00545">ARM_COMPUTE_RETURN_ERROR_ON_MISMATCHING_DATA_TYPES</a>, <a class="el" href="_validate_8h_source.xhtml#l00443">ARM_COMPUTE_RETURN_ERROR_ON_MISMATCHING_SHAPES</a>, <a class="el" href="_validate_8h_source.xhtml#l00163">ARM_COMPUTE_RETURN_ERROR_ON_NULLPTR</a>, <a class="el" href="_error_8h_source.xhtml#l00193">ARM_COMPUTE_RETURN_ON_ERROR</a>, <a class="el" href="_function_descriptors_8h_source.xhtml#l00047">FFT2DInfo::axes</a>, <a class="el" href="_function_descriptors_8h_source.xhtml#l00040">FFT1DInfo::axis</a>, <a class="el" href="classarm__compute_1_1misc_1_1_i_cloneable.xhtml#a4d10e5012a872e7f78f2b539b673049d">ICloneable< T >::clone()</a>, <a class="el" href="_function_descriptors_8h_source.xhtml#l00041">FFT1DInfo::direction</a>, <a class="el" href="_function_descriptors_8h_source.xhtml#l00048">FFT2DInfo::direction</a>, <a class="el" href="classarm__compute_1_1_i_tensor_info.xhtml#a18064e0011c3869d884653e9e7c47b66">ITensorInfo::total_size()</a>, and <a class="el" href="_n_e_f_f_t1_d_8cpp_source.xhtml#l00101">NEFFT1D::validate()</a>.</p> |
| |
| <p class="reference">Referenced by <a class="el" href="_n_e_f_f_t2_d_8cpp_source.xhtml#l00037">NEFFT2D::configure()</a>.</p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following files:<ul> |
| <li>arm_compute/runtime/NEON/functions/<a class="el" href="_n_e_f_f_t2_d_8h_source.xhtml">NEFFT2D.h</a></li> |
| <li>src/runtime/NEON/functions/<a class="el" href="_n_e_f_f_t2_d_8cpp_source.xhtml">NEFFT2D.cpp</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="namespacearm__compute.xhtml">arm_compute</a></li><li class="navelem"><a class="el" href="classarm__compute_1_1_n_e_f_f_t2_d.xhtml">NEFFT2D</a></li> |
| <li class="footer">Generated on Mon Sep 2 2019 11:47:36 for Compute Library by |
| <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.15 </li> |
| </ul> |
| </div> |
| </body> |
| </html> |