| <!-- 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: IBufferManager 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_i_buffer_manager.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> </div> |
| <div class="headertitle"> |
| <div class="title">IBufferManager Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Buffer manager used when reshaping B on the fly. |
| <a href="classarm__compute_1_1_i_buffer_manager.xhtml#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="_n_e_g_e_m_m_interleaved_wrapper_8h_source.xhtml">NEGEMMInterleavedWrapper.h</a>></code></p> |
| <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:aa724f24e6a4209431ca34e44bac30efd"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_buffer_manager.xhtml#aa724f24e6a4209431ca34e44bac30efd">lock_to_reshape_if_needed</a> (unsigned int index)=0</td></tr> |
| <tr class="memdesc:aa724f24e6a4209431ca34e44bac30efd"><td class="mdescLeft"> </td><td class="mdescRight">Lock a buffer for the given index if it's available else return. <a href="#aa724f24e6a4209431ca34e44bac30efd">More...</a><br /></td></tr> |
| <tr class="separator:aa724f24e6a4209431ca34e44bac30efd"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5d04fd48130e6eb9863efd81f0b1e361"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_buffer_manager.xhtml#a5d04fd48130e6eb9863efd81f0b1e361">mark_as_reshaped</a> (unsigned int index)=0</td></tr> |
| <tr class="memdesc:a5d04fd48130e6eb9863efd81f0b1e361"><td class="mdescLeft"> </td><td class="mdescRight">Mark a buffer previously locked as reshaped. <a href="#a5d04fd48130e6eb9863efd81f0b1e361">More...</a><br /></td></tr> |
| <tr class="separator:a5d04fd48130e6eb9863efd81f0b1e361"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a81f45c176c40902f781fd3d9dc9bc8b4"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_buffer_manager.xhtml#a81f45c176c40902f781fd3d9dc9bc8b4">wait_for_reshaping</a> (unsigned int index)=0</td></tr> |
| <tr class="memdesc:a81f45c176c40902f781fd3d9dc9bc8b4"><td class="mdescLeft"> </td><td class="mdescRight">Block until the given buffer is marked as reshaped. <a href="#a81f45c176c40902f781fd3d9dc9bc8b4">More...</a><br /></td></tr> |
| <tr class="separator:a81f45c176c40902f781fd3d9dc9bc8b4"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a69eeef30ae577be80ee40fa9d3274702"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_buffer_manager.xhtml#a69eeef30ae577be80ee40fa9d3274702">mark_as_unused</a> (unsigned int index)=0</td></tr> |
| <tr class="memdesc:a69eeef30ae577be80ee40fa9d3274702"><td class="mdescLeft"> </td><td class="mdescRight">Mark a reshaped buffer as unused. <a href="#a69eeef30ae577be80ee40fa9d3274702">More...</a><br /></td></tr> |
| <tr class="separator:a69eeef30ae577be80ee40fa9d3274702"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad4bcb73f9fec73d00bccf07845c5a16f"><td class="memItemLeft" align="right" valign="top">virtual unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_buffer_manager.xhtml#ad4bcb73f9fec73d00bccf07845c5a16f">num_buffers</a> () const =0</td></tr> |
| <tr class="memdesc:ad4bcb73f9fec73d00bccf07845c5a16f"><td class="mdescLeft"> </td><td class="mdescRight">Number of buffers used internally. <a href="#ad4bcb73f9fec73d00bccf07845c5a16f">More...</a><br /></td></tr> |
| <tr class="separator:ad4bcb73f9fec73d00bccf07845c5a16f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab54ac3ba97d6d0c8ea479539c33b44b5"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_buffer_manager.xhtml#ab54ac3ba97d6d0c8ea479539c33b44b5">~IBufferManager</a> ()=default</td></tr> |
| <tr class="memdesc:ab54ac3ba97d6d0c8ea479539c33b44b5"><td class="mdescLeft"> </td><td class="mdescRight">Default destructor. <a href="#ab54ac3ba97d6d0c8ea479539c33b44b5">More...</a><br /></td></tr> |
| <tr class="separator:ab54ac3ba97d6d0c8ea479539c33b44b5"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Buffer manager used when reshaping B on the fly. </p> |
| <p>The typical workflow is:</p><ul> |
| <li><a class="el" href="classarm__compute_1_1_i_buffer_manager.xhtml#aa724f24e6a4209431ca34e44bac30efd" title="Lock a buffer for the given index if it's available else return.">lock_to_reshape_if_needed()</a></li> |
| <li>If the previous lock was successful: <a class="el" href="classarm__compute_1_1_i_buffer_manager.xhtml#a5d04fd48130e6eb9863efd81f0b1e361" title="Mark a buffer previously locked as reshaped.">mark_as_reshaped()</a></li> |
| <li><a class="el" href="classarm__compute_1_1_i_buffer_manager.xhtml#a81f45c176c40902f781fd3d9dc9bc8b4" title="Block until the given buffer is marked as reshaped.">wait_for_reshaping()</a> wait for the reshaping to be complete</li> |
| <li><a class="el" href="classarm__compute_1_1_i_buffer_manager.xhtml#a69eeef30ae577be80ee40fa9d3274702" title="Mark a reshaped buffer as unused.">mark_as_unused()</a> once the thread is done using this given buffer.</li> |
| </ul> |
| <p>Calls for different indices might be interleaved, however the calls for a given index must always be in that order. </p> |
| |
| <p class="definition">Definition at line <a class="el" href="_n_e_g_e_m_m_interleaved_wrapper_8h_source.xhtml#l00055">55</a> of file <a class="el" href="_n_e_g_e_m_m_interleaved_wrapper_8h_source.xhtml">NEGEMMInterleavedWrapper.h</a>.</p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="ab54ac3ba97d6d0c8ea479539c33b44b5"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ab54ac3ba97d6d0c8ea479539c33b44b5">◆ </a></span>~IBufferManager()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual ~<a class="el" href="classarm__compute_1_1_i_buffer_manager.xhtml">IBufferManager</a> </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">default</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Default destructor. </p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="aa724f24e6a4209431ca34e44bac30efd"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aa724f24e6a4209431ca34e44bac30efd">◆ </a></span>lock_to_reshape_if_needed()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual bool lock_to_reshape_if_needed </td> |
| <td>(</td> |
| <td class="paramtype">unsigned int </td> |
| <td class="paramname"><em>index</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Lock a buffer for the given index if it's available else return. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>Index of the buffer to lock</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>True if the buffer has been successfully locked, false if it's already reshaped / being reshaped. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a5d04fd48130e6eb9863efd81f0b1e361"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a5d04fd48130e6eb9863efd81f0b1e361">◆ </a></span>mark_as_reshaped()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual void mark_as_reshaped </td> |
| <td>(</td> |
| <td class="paramtype">unsigned int </td> |
| <td class="paramname"><em>index</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Mark a buffer previously locked as reshaped. </p> |
| <dl class="section pre"><dt>Precondition</dt><dd>The thread calling this function must have locked the given buffer through <a class="el" href="classarm__compute_1_1_i_buffer_manager.xhtml#aa724f24e6a4209431ca34e44bac30efd" title="Lock a buffer for the given index if it's available else return.">lock_to_reshape_if_needed()</a></dd></dl> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>Index of the buffer to mark as reshaped </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a69eeef30ae577be80ee40fa9d3274702"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a69eeef30ae577be80ee40fa9d3274702">◆ </a></span>mark_as_unused()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual void mark_as_unused </td> |
| <td>(</td> |
| <td class="paramtype">unsigned int </td> |
| <td class="paramname"><em>index</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Mark a reshaped buffer as unused. </p> |
| <p>Once all the users have marked a buffer as unused then it goes back to being free </p> |
| |
| </div> |
| </div> |
| <a id="ad4bcb73f9fec73d00bccf07845c5a16f"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ad4bcb73f9fec73d00bccf07845c5a16f">◆ </a></span>num_buffers()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual unsigned int num_buffers </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Number of buffers used internally. </p> |
| <dl class="section return"><dt>Returns</dt><dd>The number of buffers used by the manager. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a81f45c176c40902f781fd3d9dc9bc8b4"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a81f45c176c40902f781fd3d9dc9bc8b4">◆ </a></span>wait_for_reshaping()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual void wait_for_reshaping </td> |
| <td>(</td> |
| <td class="paramtype">unsigned int </td> |
| <td class="paramname"><em>index</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Block until the given buffer is marked as reshaped. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>Index of the buffer </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>arm_compute/runtime/NEON/functions/assembly/<a class="el" href="_n_e_g_e_m_m_interleaved_wrapper_8h_source.xhtml">NEGEMMInterleavedWrapper.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="namespacearm__compute.xhtml">arm_compute</a></li><li class="navelem"><a class="el" href="classarm__compute_1_1_i_buffer_manager.xhtml">IBufferManager</a></li> |
| <li class="footer">Generated on Mon Sep 2 2019 11:47:35 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> |
