1 <!-- HTML header for doxygen 1.8.9.1-->
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml">
5 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
6 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
7 <meta name="generator" content="Doxygen 1.8.11"/>
8 <meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines -->
9 <title>Compute Library: OMPScheduler Class Reference</title>
10 <link href="tabs.css" rel="stylesheet" type="text/css"/>
11 <script type="text/javascript" src="jquery.js"></script>
12 <script type="text/javascript" src="dynsections.js"></script>
13 <link href="navtree.css" rel="stylesheet" type="text/css"/>
14 <script type="text/javascript" src="resize.js"></script>
15 <script type="text/javascript" src="navtreedata.js"></script>
16 <script type="text/javascript" src="navtree.js"></script>
17 <script type="text/javascript">
18 $(document).ready(initResizable);
19 $(window).load(resizeHeight);
21 <link href="search/search.css" rel="stylesheet" type="text/css"/>
22 <script type="text/javascript" src="search/searchdata.js"></script>
23 <script type="text/javascript" src="search/search.js"></script>
24 <script type="text/javascript">
25 $(document).ready(function() { init_search(); });
27 <script type="text/x-mathjax-config">
29 extensions: ["tex2jax.js"],
30 jax: ["input/TeX","output/HTML-CSS"],
32 </script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
33 <link href="doxygen.css" rel="stylesheet" type="text/css" />
36 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
38 <table cellspacing="0" cellpadding="0">
40 <tr style="height: 56px;">
41 <td style="padding-left: 0.5em;">
42 <div id="projectname">Compute Library
43  <span id="projectnumber">18.05</span>
50 <!-- end header part -->
51 <!-- Generated by Doxygen 1.8.11 -->
52 <script type="text/javascript">
53 var searchBox = new SearchBox("searchBox", "search",false,'Search');
55 <div id="navrow1" class="tabs">
57 <li><a href="index.xhtml"><span>Main Page</span></a></li>
58 <li><a href="pages.xhtml"><span>Related Pages</span></a></li>
59 <li><a href="namespaces.xhtml"><span>Namespaces</span></a></li>
60 <li class="current"><a href="annotated.xhtml"><span>Data Structures</span></a></li>
61 <li><a href="files.xhtml"><span>Files</span></a></li>
63 <div id="MSearchBox" class="MSearchBoxInactive">
65 <img id="MSearchSelect" src="search/mag_sel.png"
66 onmouseover="return searchBox.OnSearchSelectShow()"
67 onmouseout="return searchBox.OnSearchSelectHide()"
69 <input type="text" id="MSearchField" value="Search" accesskey="S"
70 onfocus="searchBox.OnSearchFieldFocus(true)"
71 onblur="searchBox.OnSearchFieldFocus(false)"
72 onkeyup="searchBox.OnSearchFieldChange(event)"/>
73 </span><span class="right">
74 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
80 <div id="navrow2" class="tabs2">
82 <li><a href="annotated.xhtml"><span>Data Structures</span></a></li>
83 <li><a href="classes.xhtml"><span>Data Structure Index</span></a></li>
84 <li><a href="inherits.xhtml"><span>Class Hierarchy</span></a></li>
85 <li><a href="functions.xhtml"><span>Data Fields</span></a></li>
89 <div id="side-nav" class="ui-resizable side-nav-resizable">
91 <div id="nav-tree-contents">
92 <div id="nav-sync" class="sync"></div>
95 <div id="splitbar" style="-moz-user-select:none;"
96 class="ui-resizable-handle">
99 <script type="text/javascript">
100 $(document).ready(function(){initNavTree('classarm__compute_1_1_o_m_p_scheduler.xhtml','');});
102 <div id="doc-content">
103 <!-- window showing the filter options -->
104 <div id="MSearchSelectWindow"
105 onmouseover="return searchBox.OnSearchSelectShow()"
106 onmouseout="return searchBox.OnSearchSelectHide()"
107 onkeydown="return searchBox.OnSearchSelectKey(event)">
110 <!-- iframe showing the search results (closed by default) -->
111 <div id="MSearchResultsWindow">
112 <iframe src="javascript:void(0)" frameborder="0"
113 name="MSearchResults" id="MSearchResults">
118 <div class="summary">
119 <a href="#pub-methods">Public Member Functions</a> |
120 <a href="#pub-static-methods">Static Public Member Functions</a> </div>
121 <div class="headertitle">
122 <div class="title">OMPScheduler Class Reference</div> </div>
124 <div class="contents">
126 <p>Pool of threads to automatically split a kernel's execution among several threads.
127 <a href="classarm__compute_1_1_o_m_p_scheduler.xhtml#details">More...</a></p>
129 <p><code>#include <<a class="el" href="_o_m_p_scheduler_8h_source.xhtml">OMPScheduler.h</a>></code></p>
130 <div class="dynheader">
131 Collaboration diagram for OMPScheduler:</div>
132 <div class="dyncontent">
133 <div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1_o_m_p_scheduler__coll__graph.svg" width="126" height="112"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
135 <center><span class="legend">[<a target="top" href="graph_legend.xhtml">legend</a>]</span></center></div>
136 <table class="memberdecls">
137 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
138 Public Member Functions</h2></td></tr>
139 <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_o_m_p_scheduler.xhtml#ae64eebaa07f4d2da6cc2ba538c3cb095">set_num_threads</a> (unsigned int <a class="el" href="classarm__compute_1_1_o_m_p_scheduler.xhtml#a0da94220ee1e0f4928aa31ed0d4b30f7">num_threads</a>) override</td></tr>
140 <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>
141 <tr class="separator:ae64eebaa07f4d2da6cc2ba538c3cb095"><td class="memSeparator" colspan="2"> </td></tr>
142 <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_o_m_p_scheduler.xhtml#a0da94220ee1e0f4928aa31ed0d4b30f7">num_threads</a> () const override</td></tr>
143 <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_o_m_p_scheduler.xhtml" title="Pool of threads to automatically split a kernel's execution among several threads. ">OMPScheduler</a> has in its pool. <a href="#a0da94220ee1e0f4928aa31ed0d4b30f7">More...</a><br /></td></tr>
144 <tr class="separator:a0da94220ee1e0f4928aa31ed0d4b30f7"><td class="memSeparator" colspan="2"> </td></tr>
145 <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_o_m_p_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>
146 <tr class="memdesc:aa4fc1e7b1c1d9d42903cfc48351e57ad"><td class="mdescLeft"> </td><td class="mdescRight">Multithread the execution of the passed kernel if possible. <a href="#aa4fc1e7b1c1d9d42903cfc48351e57ad">More...</a><br /></td></tr>
147 <tr class="separator:aa4fc1e7b1c1d9d42903cfc48351e57ad"><td class="memSeparator" colspan="2"> </td></tr>
148 <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>
149 <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>
150 <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>
151 <tr class="separator:a34956db09db14c551e9966c9b66036f9 inherit pub_methods_classarm__compute_1_1_i_scheduler"><td class="memSeparator" colspan="2"> </td></tr>
152 <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>
153 <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>
154 <tr class="separator:a6d209385481644d97e7ca96072b73eb8 inherit pub_methods_classarm__compute_1_1_i_scheduler"><td class="memSeparator" colspan="2"> </td></tr>
155 <tr class="memitem:a95f26c7763b9472437a8da8aa6089c9b inherit pub_methods_classarm__compute_1_1_i_scheduler"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__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#a95f26c7763b9472437a8da8aa6089c9b">cpu_info</a> ()</td></tr>
156 <tr class="memdesc:a95f26c7763b9472437a8da8aa6089c9b inherit pub_methods_classarm__compute_1_1_i_scheduler"><td class="mdescLeft"> </td><td class="mdescRight">Get CPU info. <a href="#a95f26c7763b9472437a8da8aa6089c9b">More...</a><br /></td></tr>
157 <tr class="separator:a95f26c7763b9472437a8da8aa6089c9b inherit pub_methods_classarm__compute_1_1_i_scheduler"><td class="memSeparator" colspan="2"> </td></tr>
158 <tr class="memitem:a6298e3b887acb402fdda318de12428ef inherit pub_methods_classarm__compute_1_1_i_scheduler"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_scheduler.xhtml#a6298e3b887acb402fdda318de12428ef">num_threads_hint</a> () const </td></tr>
159 <tr class="memdesc:a6298e3b887acb402fdda318de12428ef inherit pub_methods_classarm__compute_1_1_i_scheduler"><td class="mdescLeft"> </td><td class="mdescRight">Get a hint for the best possible number of execution threads. <a href="#a6298e3b887acb402fdda318de12428ef">More...</a><br /></td></tr>
160 <tr class="separator:a6298e3b887acb402fdda318de12428ef inherit pub_methods_classarm__compute_1_1_i_scheduler"><td class="memSeparator" colspan="2"> </td></tr>
161 </table><table class="memberdecls">
162 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
163 Static Public Member Functions</h2></td></tr>
164 <tr class="memitem:a9571a5288c1b52189b63f9e1074768e3"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classarm__compute_1_1_o_m_p_scheduler.xhtml">OMPScheduler</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_o_m_p_scheduler.xhtml#a9571a5288c1b52189b63f9e1074768e3">get</a> ()</td></tr>
165 <tr class="memdesc:a9571a5288c1b52189b63f9e1074768e3"><td class="mdescLeft"> </td><td class="mdescRight">Access the scheduler singleton. <a href="#a9571a5288c1b52189b63f9e1074768e3">More...</a><br /></td></tr>
166 <tr class="separator:a9571a5288c1b52189b63f9e1074768e3"><td class="memSeparator" colspan="2"> </td></tr>
168 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
169 <div class="textblock"><p>Pool of threads to automatically split a kernel's execution among several threads. </p>
171 <p>Definition at line <a class="el" href="_o_m_p_scheduler_8h_source.xhtml#l00032">32</a> of file <a class="el" href="_o_m_p_scheduler_8h_source.xhtml">OMPScheduler.h</a>.</p>
172 </div><h2 class="groupheader">Member Function Documentation</h2>
173 <a class="anchor" id="a9571a5288c1b52189b63f9e1074768e3"></a>
174 <div class="memitem">
175 <div class="memproto">
176 <table class="mlabels">
178 <td class="mlabels-left">
179 <table class="memname">
181 <td class="memname">static <a class="el" href="classarm__compute_1_1_o_m_p_scheduler.xhtml">OMPScheduler</a>& get </td>
183 <td class="paramname"></td><td>)</td>
188 <td class="mlabels-right">
189 <span class="mlabels"><span class="mlabel">static</span></span> </td>
192 </div><div class="memdoc">
194 <p>Access the scheduler singleton. </p>
195 <dl class="section return"><dt>Returns</dt><dd>The scheduler </dd></dl>
199 <a class="anchor" id="a0da94220ee1e0f4928aa31ed0d4b30f7"></a>
200 <div class="memitem">
201 <div class="memproto">
202 <table class="mlabels">
204 <td class="mlabels-left">
205 <table class="memname">
207 <td class="memname">unsigned int num_threads </td>
209 <td class="paramname"></td><td>)</td>
214 <td class="mlabels-right">
215 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
218 </div><div class="memdoc">
220 <p>Returns the number of threads that the <a class="el" href="classarm__compute_1_1_o_m_p_scheduler.xhtml" title="Pool of threads to automatically split a kernel's execution among several threads. ">OMPScheduler</a> has in its pool. </p>
221 <dl class="section return"><dt>Returns</dt><dd>Number of threads available in <a class="el" href="classarm__compute_1_1_o_m_p_scheduler.xhtml" title="Pool of threads to automatically split a kernel's execution among several threads. ">OMPScheduler</a>. </dd></dl>
223 <p>Implements <a class="el" href="classarm__compute_1_1_i_scheduler.xhtml#ac24584a63e484123e3756d1b2a1c9e2f">IScheduler</a>.</p>
227 <a class="anchor" id="aa4fc1e7b1c1d9d42903cfc48351e57ad"></a>
228 <div class="memitem">
229 <div class="memproto">
230 <table class="mlabels">
232 <td class="mlabels-left">
233 <table class="memname">
235 <td class="memname">void schedule </td>
237 <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_c_p_p_kernel.xhtml">ICPPKernel</a> * </td>
238 <td class="paramname"><em>kernel</em>, </td>
241 <td class="paramkey"></td>
243 <td class="paramtype">unsigned int </td>
244 <td class="paramname"><em>split_dimension</em> </td>
253 <td class="mlabels-right">
254 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
257 </div><div class="memdoc">
259 <p>Multithread the execution of the passed kernel if possible. </p>
260 <p>The kernel will run on a single thread if any of these conditions is true:</p><ul>
261 <li><a class="el" href="classarm__compute_1_1_i_kernel.xhtml#abfab8f0d4928e1081d9f65b77933e24a" title="Indicates whether or not the kernel is parallelisable. ">ICPPKernel::is_parallelisable()</a> returns false</li>
262 <li>The scheduler has been initialized with only one thread.</li>
264 <dl class="params"><dt>Parameters</dt><dd>
265 <table class="params">
266 <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>
267 <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>
272 <p>Implements <a class="el" href="classarm__compute_1_1_i_scheduler.xhtml#a38e28e556fea6e2024019dbb9c7cc943">IScheduler</a>.</p>
276 <a class="anchor" id="ae64eebaa07f4d2da6cc2ba538c3cb095"></a>
277 <div class="memitem">
278 <div class="memproto">
279 <table class="mlabels">
281 <td class="mlabels-left">
282 <table class="memname">
284 <td class="memname">void set_num_threads </td>
286 <td class="paramtype">unsigned int </td>
287 <td class="paramname"><em>num_threads</em></td><td>)</td>
292 <td class="mlabels-right">
293 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
296 </div><div class="memdoc">
298 <p>Sets the number of threads the scheduler will use to run the kernels. </p>
299 <dl class="params"><dt>Parameters</dt><dd>
300 <table class="params">
301 <tr><td class="paramdir">[in]</td><td class="paramname">num_threads</td><td>If set to 0, then the number returned by omp_get_max_threads() will be used, otherwise the number of threads specified. </td></tr>
306 <p>Implements <a class="el" href="classarm__compute_1_1_i_scheduler.xhtml#a645ac2d9d4144fd0174296de7eb1e1b5">IScheduler</a>.</p>
310 <hr/>The documentation for this class was generated from the following file:<ul>
311 <li>arm_compute/runtime/OMP/<a class="el" href="_o_m_p_scheduler_8h_source.xhtml">OMPScheduler.h</a></li>
313 </div><!-- contents -->
314 </div><!-- doc-content -->
315 <!-- start footer part -->
316 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
318 <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_o_m_p_scheduler.xhtml">OMPScheduler</a></li>
319 <li class="footer">Generated on Wed May 23 2018 11:36:43 for Compute Library by
320 <a href="http://www.doxygen.org/index.html">
321 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>