| <!-- HTML header for doxygen 1.8.9.1--> |
| <!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.6"/> |
| <meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines --> |
| <title>Compute Library: SingleThreadScheduler 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="navtree.js"></script> |
| <script type="text/javascript"> |
| $(document).ready(initResizable); |
| $(window).load(resizeHeight); |
| </script> |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="search/search.js"></script> |
| <script type="text/javascript"> |
| $(document).ready(function() { searchBox.OnSelectItem(0); }); |
| </script> |
| <script type="text/x-mathjax-config"> |
| MathJax.Hub.Config({ |
| extensions: ["tex2jax.js"], |
| jax: ["input/TeX","output/HTML-CSS"], |
| }); |
| </script><script src="http://cdn.mathjax.org/mathjax/latest/MathJax.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 style="height: 56px;"> |
| <td style="padding-left: 0.5em;"> |
| <div id="projectname">Compute Library |
|  <span id="projectnumber">17.10</span> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.6 --> |
| <script type="text/javascript"> |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| </script> |
| <div id="navrow1" class="tabs"> |
| <ul class="tablist"> |
| <li><a href="index.xhtml"><span>Main Page</span></a></li> |
| <li><a href="pages.xhtml"><span>Related Pages</span></a></li> |
| <li><a href="namespaces.xhtml"><span>Namespaces</span></a></li> |
| <li class="current"><a href="annotated.xhtml"><span>Data Structures</span></a></li> |
| <li><a href="files.xhtml"><span>Files</span></a></li> |
| <li> |
| <div id="MSearchBox" class="MSearchBoxInactive"> |
| <span class="left"> |
| <img id="MSearchSelect" src="search/mag_sel.png" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| alt=""/> |
| <input type="text" id="MSearchField" value="Search" accesskey="S" |
| onfocus="searchBox.OnSearchFieldFocus(true)" |
| onblur="searchBox.OnSearchFieldFocus(false)" |
| onkeyup="searchBox.OnSearchFieldChange(event)"/> |
| </span><span class="right"> |
| <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> |
| </span> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div id="navrow2" class="tabs2"> |
| <ul class="tablist"> |
| <li><a href="annotated.xhtml"><span>Data Structures</span></a></li> |
| <li><a href="classes.xhtml"><span>Data Structure Index</span></a></li> |
| <li><a href="inherits.xhtml"><span>Class Hierarchy</span></a></li> |
| <li><a href="functions.xhtml"><span>Data Fields</span></a></li> |
| </ul> |
| </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"> |
| $(document).ready(function(){initNavTree('classarm__compute_1_1_single_thread_scheduler.xhtml','');}); |
| </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)"> |
| <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark"> </span>Pages</a></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">SingleThreadScheduler Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Pool of threads to automatically split a kernel's execution among several threads. |
| <a href="classarm__compute_1_1_single_thread_scheduler.xhtml#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="_single_thread_scheduler_8h_source.xhtml">SingleThreadScheduler.h</a>></code></p> |
| <div class="dynheader"> |
| Collaboration diagram for SingleThreadScheduler:</div> |
| <div class="dyncontent"> |
| <div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1_single_thread_scheduler__coll__graph.svg" width="167" 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:ae64eebaa07f4d2da6cc2ba538c3cb095"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_single_thread_scheduler.xhtml#ae64eebaa07f4d2da6cc2ba538c3cb095">set_num_threads</a> (unsigned int <a class="el" href="classarm__compute_1_1_single_thread_scheduler.xhtml#a0da94220ee1e0f4928aa31ed0d4b30f7">num_threads</a>) override</td></tr> |
| <tr class="memdesc:ae64eebaa07f4d2da6cc2ba538c3cb095"><td class="mdescLeft"> </td><td class="mdescRight">Sets the number of threads the scheduler will use to run the kernels. <a href="#ae64eebaa07f4d2da6cc2ba538c3cb095">More...</a><br/></td></tr> |
| <tr class="separator:ae64eebaa07f4d2da6cc2ba538c3cb095"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a0da94220ee1e0f4928aa31ed0d4b30f7"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_single_thread_scheduler.xhtml#a0da94220ee1e0f4928aa31ed0d4b30f7">num_threads</a> () const override</td></tr> |
| <tr class="memdesc:a0da94220ee1e0f4928aa31ed0d4b30f7"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of threads that the <a class="el" href="classarm__compute_1_1_single_thread_scheduler.xhtml" title="Pool of threads to automatically split a kernel's execution among several threads. ">SingleThreadScheduler</a> has, which is always 1. <a href="#a0da94220ee1e0f4928aa31ed0d4b30f7">More...</a><br/></td></tr> |
| <tr class="separator:a0da94220ee1e0f4928aa31ed0d4b30f7"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa4fc1e7b1c1d9d42903cfc48351e57ad"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_single_thread_scheduler.xhtml#aa4fc1e7b1c1d9d42903cfc48351e57ad">schedule</a> (<a class="el" href="classarm__compute_1_1_i_c_p_p_kernel.xhtml">ICPPKernel</a> *kernel, unsigned int split_dimension) override</td></tr> |
| <tr class="memdesc:aa4fc1e7b1c1d9d42903cfc48351e57ad"><td class="mdescLeft"> </td><td class="mdescRight">Runs the kernel in the same thread as the caller synchronously. <a href="#aa4fc1e7b1c1d9d42903cfc48351e57ad">More...</a><br/></td></tr> |
| <tr class="separator:aa4fc1e7b1c1d9d42903cfc48351e57ad"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header pub_methods_classarm__compute_1_1_i_scheduler"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarm__compute_1_1_i_scheduler')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classarm__compute_1_1_i_scheduler.xhtml">IScheduler</a></td></tr> |
| <tr class="memitem:a34956db09db14c551e9966c9b66036f9 inherit pub_methods_classarm__compute_1_1_i_scheduler"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_scheduler.xhtml#a34956db09db14c551e9966c9b66036f9">IScheduler</a> ()</td></tr> |
| <tr class="memdesc:a34956db09db14c551e9966c9b66036f9 inherit pub_methods_classarm__compute_1_1_i_scheduler"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#a34956db09db14c551e9966c9b66036f9">More...</a><br/></td></tr> |
| <tr class="separator:a34956db09db14c551e9966c9b66036f9 inherit pub_methods_classarm__compute_1_1_i_scheduler"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6d209385481644d97e7ca96072b73eb8 inherit pub_methods_classarm__compute_1_1_i_scheduler"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_scheduler.xhtml#a6d209385481644d97e7ca96072b73eb8">~IScheduler</a> ()=default</td></tr> |
| <tr class="memdesc:a6d209385481644d97e7ca96072b73eb8 inherit pub_methods_classarm__compute_1_1_i_scheduler"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a6d209385481644d97e7ca96072b73eb8">More...</a><br/></td></tr> |
| <tr class="separator:a6d209385481644d97e7ca96072b73eb8 inherit pub_methods_classarm__compute_1_1_i_scheduler"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6a49fcb6640894fb5ec2da99f10a1593 inherit pub_methods_classarm__compute_1_1_i_scheduler"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_scheduler.xhtml#a6a49fcb6640894fb5ec2da99f10a1593">set_target</a> (<a class="el" href="namespacearm__compute.xhtml#a5bc939238e1f14a4c39aaee8186a853d">CPUTarget</a> target)</td></tr> |
| <tr class="memdesc:a6a49fcb6640894fb5ec2da99f10a1593 inherit pub_methods_classarm__compute_1_1_i_scheduler"><td class="mdescLeft"> </td><td class="mdescRight">Sets the target CPU architecture. <a href="#a6a49fcb6640894fb5ec2da99f10a1593">More...</a><br/></td></tr> |
| <tr class="separator:a6a49fcb6640894fb5ec2da99f10a1593 inherit pub_methods_classarm__compute_1_1_i_scheduler"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a671307bb78c1d64435708feead8c04da inherit pub_methods_classarm__compute_1_1_i_scheduler"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structarm__compute_1_1_c_p_u_info.xhtml">CPUInfo</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_scheduler.xhtml#a671307bb78c1d64435708feead8c04da">cpu_info</a> () const </td></tr> |
| <tr class="memdesc:a671307bb78c1d64435708feead8c04da inherit pub_methods_classarm__compute_1_1_i_scheduler"><td class="mdescLeft"> </td><td class="mdescRight">Get CPU info. <a href="#a671307bb78c1d64435708feead8c04da">More...</a><br/></td></tr> |
| <tr class="separator:a671307bb78c1d64435708feead8c04da inherit pub_methods_classarm__compute_1_1_i_scheduler"><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:ad2239fa50e4adfc02e94407d0b846077"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classarm__compute_1_1_single_thread_scheduler.xhtml">SingleThreadScheduler</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_single_thread_scheduler.xhtml#ad2239fa50e4adfc02e94407d0b846077">get</a> ()</td></tr> |
| <tr class="memdesc:ad2239fa50e4adfc02e94407d0b846077"><td class="mdescLeft"> </td><td class="mdescRight">Access the scheduler singleton. <a href="#ad2239fa50e4adfc02e94407d0b846077">More...</a><br/></td></tr> |
| <tr class="separator:ad2239fa50e4adfc02e94407d0b846077"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Pool of threads to automatically split a kernel's execution among several threads. </p> |
| |
| <p>Definition at line <a class="el" href="_single_thread_scheduler_8h_source.xhtml#l00032">32</a> of file <a class="el" href="_single_thread_scheduler_8h_source.xhtml">SingleThreadScheduler.h</a>.</p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="ad2239fa50e4adfc02e94407d0b846077"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static <a class="el" href="classarm__compute_1_1_single_thread_scheduler.xhtml">SingleThreadScheduler</a>& get </td> |
| <td>(</td> |
| <td class="paramname"></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>Access the scheduler singleton. </p> |
| <dl class="section return"><dt>Returns</dt><dd>The scheduler </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a0da94220ee1e0f4928aa31ed0d4b30f7"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">unsigned int num_threads </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">override</span><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns the number of threads that the <a class="el" href="classarm__compute_1_1_single_thread_scheduler.xhtml" title="Pool of threads to automatically split a kernel's execution among several threads. ">SingleThreadScheduler</a> has, which is always 1. </p> |
| <dl class="section return"><dt>Returns</dt><dd>Number of threads available in <a class="el" href="classarm__compute_1_1_single_thread_scheduler.xhtml" title="Pool of threads to automatically split a kernel's execution among several threads. ">SingleThreadScheduler</a>. </dd></dl> |
| |
| <p>Implements <a class="el" href="classarm__compute_1_1_i_scheduler.xhtml#ac24584a63e484123e3756d1b2a1c9e2f">IScheduler</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="aa4fc1e7b1c1d9d42903cfc48351e57ad"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void schedule </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_c_p_p_kernel.xhtml">ICPPKernel</a> * </td> |
| <td class="paramname"><em>kernel</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">unsigned int </td> |
| <td class="paramname"><em>split_dimension</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">override</span><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Runs the kernel in the same thread as the caller synchronously. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">kernel</td><td><a class="el" href="classarm__compute_1_1_kernel.xhtml" title="Kernel class. ">Kernel</a> to execute. </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">split_dimension</td><td>Dimension along which to split the kernel's execution window. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Implements <a class="el" href="classarm__compute_1_1_i_scheduler.xhtml#a38e28e556fea6e2024019dbb9c7cc943">IScheduler</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ae64eebaa07f4d2da6cc2ba538c3cb095"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void set_num_threads </td> |
| <td>(</td> |
| <td class="paramtype">unsigned int </td> |
| <td class="paramname"><em>num_threads</em></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>Sets the number of threads the scheduler will use to run the kernels. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">num_threads</td><td>This is ignored for this scheduler as the number of threads is always one. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Implements <a class="el" href="classarm__compute_1_1_i_scheduler.xhtml#a645ac2d9d4144fd0174296de7eb1e1b5">IScheduler</a>.</p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>arm_compute/runtime/<a class="el" href="_single_thread_scheduler_8h_source.xhtml">SingleThreadScheduler.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_single_thread_scheduler.xhtml">SingleThreadScheduler</a></li> |
| <li class="footer">Generated on Thu Oct 12 2017 14:26:38 for Compute Library by |
| <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li> |
| </ul> |
| </div> |
| </body> |
| </html> |
