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>ARM Compute Library: CPPScheduler 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">ARM Compute Library
43  <span id="projectnumber">17.03.1</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="namespaces.xhtml"><span>Namespaces</span></a></li>
59 <li class="current"><a href="annotated.xhtml"><span>Data Structures</span></a></li>
60 <li><a href="files.xhtml"><span>Files</span></a></li>
62 <div id="MSearchBox" class="MSearchBoxInactive">
64 <img id="MSearchSelect" src="search/mag_sel.png"
65 onmouseover="return searchBox.OnSearchSelectShow()"
66 onmouseout="return searchBox.OnSearchSelectHide()"
68 <input type="text" id="MSearchField" value="Search" accesskey="S"
69 onfocus="searchBox.OnSearchFieldFocus(true)"
70 onblur="searchBox.OnSearchFieldFocus(false)"
71 onkeyup="searchBox.OnSearchFieldChange(event)"/>
72 </span><span class="right">
73 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
79 <div id="navrow2" class="tabs2">
81 <li><a href="annotated.xhtml"><span>Data Structures</span></a></li>
82 <li><a href="classes.xhtml"><span>Data Structure Index</span></a></li>
83 <li><a href="inherits.xhtml"><span>Class Hierarchy</span></a></li>
84 <li><a href="functions.xhtml"><span>Data Fields</span></a></li>
88 <div id="side-nav" class="ui-resizable side-nav-resizable">
90 <div id="nav-tree-contents">
91 <div id="nav-sync" class="sync"></div>
94 <div id="splitbar" style="-moz-user-select:none;"
95 class="ui-resizable-handle">
98 <script type="text/javascript">
99 $(document).ready(function(){initNavTree('classarm__compute_1_1_c_p_p_scheduler.xhtml','');});
101 <div id="doc-content">
102 <!-- window showing the filter options -->
103 <div id="MSearchSelectWindow"
104 onmouseover="return searchBox.OnSearchSelectShow()"
105 onmouseout="return searchBox.OnSearchSelectHide()"
106 onkeydown="return searchBox.OnSearchSelectKey(event)">
109 <!-- iframe showing the search results (closed by default) -->
110 <div id="MSearchResultsWindow">
111 <iframe src="javascript:void(0)" frameborder="0"
112 name="MSearchResults" id="MSearchResults">
117 <div class="summary">
118 <a href="#pub-methods">Public Member Functions</a> |
119 <a href="#pub-static-methods">Static Public Member Functions</a> </div>
120 <div class="headertitle">
121 <div class="title">CPPScheduler Class Reference</div> </div>
123 <div class="contents">
125 <p>Pool of threads to automatically split a kernel's execution among several threads.
126 <a href="classarm__compute_1_1_c_p_p_scheduler.xhtml#details">More...</a></p>
128 <p><code>#include <<a class="el" href="_c_p_p_scheduler_8h_source.xhtml">CPPScheduler.h</a>></code></p>
129 <table class="memberdecls">
130 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
131 Public Member Functions</h2></td></tr>
132 <tr class="memitem:ae9dc1846ff1612778bbac85d46344aef"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_p_p_scheduler.xhtml#ae9dc1846ff1612778bbac85d46344aef">force_number_of_threads</a> (int <a class="el" href="classarm__compute_1_1_c_p_p_scheduler.xhtml#a62815e4265bc472328e1992a499dca0a">num_threads</a>)</td></tr>
133 <tr class="memdesc:ae9dc1846ff1612778bbac85d46344aef"><td class="mdescLeft"> </td><td class="mdescRight">Force the re-creation of the pool of threads to use the specified number of threads. <a href="#ae9dc1846ff1612778bbac85d46344aef">More...</a><br /></td></tr>
134 <tr class="separator:ae9dc1846ff1612778bbac85d46344aef"><td class="memSeparator" colspan="2"> </td></tr>
135 <tr class="memitem:a62815e4265bc472328e1992a499dca0a"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_p_p_scheduler.xhtml#a62815e4265bc472328e1992a499dca0a">num_threads</a> () const </td></tr>
136 <tr class="memdesc:a62815e4265bc472328e1992a499dca0a"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of threads that the <a class="el" href="classarm__compute_1_1_c_p_p_scheduler.xhtml" title="Pool of threads to automatically split a kernel's execution among several threads. ">CPPScheduler</a> has in his pool. <a href="#a62815e4265bc472328e1992a499dca0a">More...</a><br /></td></tr>
137 <tr class="separator:a62815e4265bc472328e1992a499dca0a"><td class="memSeparator" colspan="2"> </td></tr>
138 <tr class="memitem:a2c8fb9f063c63c186213c042080f4e79"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_p_p_scheduler.xhtml#a2c8fb9f063c63c186213c042080f4e79">multithread</a> (<a class="el" href="classarm__compute_1_1_i_c_p_p_kernel.xhtml">ICPPKernel</a> *kernel, size_t split_dimension=1)</td></tr>
139 <tr class="memdesc:a2c8fb9f063c63c186213c042080f4e79"><td class="mdescLeft"> </td><td class="mdescRight">Multithread the execution of the passed kernel if possible. <a href="#a2c8fb9f063c63c186213c042080f4e79">More...</a><br /></td></tr>
140 <tr class="separator:a2c8fb9f063c63c186213c042080f4e79"><td class="memSeparator" colspan="2"> </td></tr>
141 </table><table class="memberdecls">
142 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
143 Static Public Member Functions</h2></td></tr>
144 <tr class="memitem:aace2d80849d3f1c113153053728f2922"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classarm__compute_1_1_c_p_p_scheduler.xhtml">CPPScheduler</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_p_p_scheduler.xhtml#aace2d80849d3f1c113153053728f2922">get</a> ()</td></tr>
145 <tr class="memdesc:aace2d80849d3f1c113153053728f2922"><td class="mdescLeft"> </td><td class="mdescRight">Access the scheduler singleton. <a href="#aace2d80849d3f1c113153053728f2922">More...</a><br /></td></tr>
146 <tr class="separator:aace2d80849d3f1c113153053728f2922"><td class="memSeparator" colspan="2"> </td></tr>
148 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
149 <div class="textblock"><p>Pool of threads to automatically split a kernel's execution among several threads. </p>
151 <p>Definition at line <a class="el" href="_c_p_p_scheduler_8h_source.xhtml#l00036">36</a> of file <a class="el" href="_c_p_p_scheduler_8h_source.xhtml">CPPScheduler.h</a>.</p>
152 </div><h2 class="groupheader">Member Function Documentation</h2>
153 <a class="anchor" id="ae9dc1846ff1612778bbac85d46344aef"></a>
154 <div class="memitem">
155 <div class="memproto">
156 <table class="memname">
158 <td class="memname">void force_number_of_threads </td>
160 <td class="paramtype">int </td>
161 <td class="paramname"><em>num_threads</em></td><td>)</td>
165 </div><div class="memdoc">
167 <p>Force the re-creation of the pool of threads to use the specified number of threads. </p>
168 <dl class="params"><dt>Parameters</dt><dd>
169 <table class="params">
170 <tr><td class="paramdir">[in]</td><td class="paramname">num_threads</td><td>If set to 0, then std::thread::hardware_concurrency() threads will be used, otherwise the number of threads specified. </td></tr>
177 <a class="anchor" id="aace2d80849d3f1c113153053728f2922"></a>
178 <div class="memitem">
179 <div class="memproto">
180 <table class="mlabels">
182 <td class="mlabels-left">
183 <table class="memname">
185 <td class="memname">static <a class="el" href="classarm__compute_1_1_c_p_p_scheduler.xhtml">CPPScheduler</a>& get </td>
187 <td class="paramname"></td><td>)</td>
192 <td class="mlabels-right">
193 <span class="mlabels"><span class="mlabel">static</span></span> </td>
196 </div><div class="memdoc">
198 <p>Access the scheduler singleton. </p>
199 <dl class="section return"><dt>Returns</dt><dd>The scheduler </dd></dl>
203 <a class="anchor" id="a2c8fb9f063c63c186213c042080f4e79"></a>
204 <div class="memitem">
205 <div class="memproto">
206 <table class="memname">
208 <td class="memname">void multithread </td>
210 <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_c_p_p_kernel.xhtml">ICPPKernel</a> * </td>
211 <td class="paramname"><em>kernel</em>, </td>
214 <td class="paramkey"></td>
216 <td class="paramtype">size_t </td>
217 <td class="paramname"><em>split_dimension</em> = <code>1</code> </td>
225 </div><div class="memdoc">
227 <p>Multithread the execution of the passed kernel if possible. </p>
228 <p>The kernel will run on a single thread if any of these conditions is true:</p><ul>
229 <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>
230 <li>The scheduler has been initialized with only one thread.</li>
232 <dl class="params"><dt>Parameters</dt><dd>
233 <table class="params">
234 <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>
235 <tr><td class="paramdir">[in]</td><td class="paramname">split_dimension</td><td>Dimension along which to split the kernel's execution window (By default 1/Y) </td></tr>
240 <p>Referenced by <a class="el" href="_c_p_p_scheduler_8h_source.xhtml#l00052">CPPScheduler::num_threads()</a>.</p>
244 <a class="anchor" id="a62815e4265bc472328e1992a499dca0a"></a>
245 <div class="memitem">
246 <div class="memproto">
247 <table class="mlabels">
249 <td class="mlabels-left">
250 <table class="memname">
252 <td class="memname">int num_threads </td>
254 <td class="paramname"></td><td>)</td>
259 <td class="mlabels-right">
260 <span class="mlabels"><span class="mlabel">inline</span></span> </td>
263 </div><div class="memdoc">
265 <p>Returns the number of threads that the <a class="el" href="classarm__compute_1_1_c_p_p_scheduler.xhtml" title="Pool of threads to automatically split a kernel's execution among several threads. ">CPPScheduler</a> has in his pool. </p>
266 <dl class="section return"><dt>Returns</dt><dd>Number of threads available in <a class="el" href="classarm__compute_1_1_c_p_p_scheduler.xhtml" title="Pool of threads to automatically split a kernel's execution among several threads. ">CPPScheduler</a>. </dd></dl>
268 <p>Definition at line <a class="el" href="_c_p_p_scheduler_8h_source.xhtml#l00052">52</a> of file <a class="el" href="_c_p_p_scheduler_8h_source.xhtml">CPPScheduler.h</a>.</p>
270 <p>References <a class="el" href="classarm__compute_1_1_c_p_p_scheduler.xhtml#a2c8fb9f063c63c186213c042080f4e79">CPPScheduler::multithread()</a>.</p>
271 <div class="fragment"><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  {</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keywordflow">return</span> _num_threads;</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  }</div></div><!-- fragment -->
274 <hr/>The documentation for this class was generated from the following file:<ul>
275 <li>arm_compute/runtime/CPP/<a class="el" href="_c_p_p_scheduler_8h_source.xhtml">CPPScheduler.h</a></li>
277 </div><!-- contents -->
278 </div><!-- doc-content -->
279 <!-- start footer part -->
280 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
282 <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_c_p_p_scheduler.xhtml">CPPScheduler</a></li>
283 <li class="footer">Generated on Fri Mar 24 2017 17:23:50 for ARM Compute Library by
284 <a href="http://www.doxygen.org/index.html">
285 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>