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.6"/>
8 <meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines -->
9 <title>Compute Library: IScheduler 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="navtree.js"></script>
16 <script type="text/javascript">
17 $(document).ready(initResizable);
18 $(window).load(resizeHeight);
20 <link href="search/search.css" rel="stylesheet" type="text/css"/>
21 <script type="text/javascript" src="search/search.js"></script>
22 <script type="text/javascript">
23 $(document).ready(function() { searchBox.OnSelectItem(0); });
25 <script type="text/x-mathjax-config">
27 extensions: ["tex2jax.js"],
28 jax: ["input/TeX","output/HTML-CSS"],
30 </script><script src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
31 <link href="doxygen.css" rel="stylesheet" type="text/css" />
34 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
36 <table cellspacing="0" cellpadding="0">
38 <tr style="height: 56px;">
39 <td style="padding-left: 0.5em;">
40 <div id="projectname">Compute Library
41  <span id="projectnumber">17.10</span>
48 <!-- end header part -->
49 <!-- Generated by Doxygen 1.8.6 -->
50 <script type="text/javascript">
51 var searchBox = new SearchBox("searchBox", "search",false,'Search');
53 <div id="navrow1" class="tabs">
55 <li><a href="index.xhtml"><span>Main Page</span></a></li>
56 <li><a href="pages.xhtml"><span>Related Pages</span></a></li>
57 <li><a href="namespaces.xhtml"><span>Namespaces</span></a></li>
58 <li class="current"><a href="annotated.xhtml"><span>Data Structures</span></a></li>
59 <li><a href="files.xhtml"><span>Files</span></a></li>
61 <div id="MSearchBox" class="MSearchBoxInactive">
63 <img id="MSearchSelect" src="search/mag_sel.png"
64 onmouseover="return searchBox.OnSearchSelectShow()"
65 onmouseout="return searchBox.OnSearchSelectHide()"
67 <input type="text" id="MSearchField" value="Search" accesskey="S"
68 onfocus="searchBox.OnSearchFieldFocus(true)"
69 onblur="searchBox.OnSearchFieldFocus(false)"
70 onkeyup="searchBox.OnSearchFieldChange(event)"/>
71 </span><span class="right">
72 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
78 <div id="navrow2" class="tabs2">
80 <li><a href="annotated.xhtml"><span>Data Structures</span></a></li>
81 <li><a href="classes.xhtml"><span>Data Structure Index</span></a></li>
82 <li><a href="inherits.xhtml"><span>Class Hierarchy</span></a></li>
83 <li><a href="functions.xhtml"><span>Data Fields</span></a></li>
87 <div id="side-nav" class="ui-resizable side-nav-resizable">
89 <div id="nav-tree-contents">
90 <div id="nav-sync" class="sync"></div>
93 <div id="splitbar" style="-moz-user-select:none;"
94 class="ui-resizable-handle">
97 <script type="text/javascript">
98 $(document).ready(function(){initNavTree('classarm__compute_1_1_i_scheduler.xhtml','');});
100 <div id="doc-content">
101 <!-- window showing the filter options -->
102 <div id="MSearchSelectWindow"
103 onmouseover="return searchBox.OnSearchSelectShow()"
104 onmouseout="return searchBox.OnSearchSelectHide()"
105 onkeydown="return searchBox.OnSearchSelectKey(event)">
106 <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>
108 <!-- iframe showing the search results (closed by default) -->
109 <div id="MSearchResultsWindow">
110 <iframe src="javascript:void(0)" frameborder="0"
111 name="MSearchResults" id="MSearchResults">
116 <div class="summary">
117 <a href="#pub-methods">Public Member Functions</a> </div>
118 <div class="headertitle">
119 <div class="title">IScheduler Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
121 <div class="contents">
123 <p><a class="el" href="classarm__compute_1_1_scheduler.xhtml" title="Configurable scheduler which supports multiple multithreading APIs and choosing between different sch...">Scheduler</a> interface to run kernels.
124 <a href="classarm__compute_1_1_i_scheduler.xhtml#details">More...</a></p>
126 <p><code>#include <<a class="el" href="_i_scheduler_8h_source.xhtml">IScheduler.h</a>></code></p>
127 <table class="memberdecls">
128 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
129 Public Member Functions</h2></td></tr>
130 <tr class="memitem:a34956db09db14c551e9966c9b66036f9"><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>
131 <tr class="memdesc:a34956db09db14c551e9966c9b66036f9"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#a34956db09db14c551e9966c9b66036f9">More...</a><br/></td></tr>
132 <tr class="separator:a34956db09db14c551e9966c9b66036f9"><td class="memSeparator" colspan="2"> </td></tr>
133 <tr class="memitem:a6d209385481644d97e7ca96072b73eb8"><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>
134 <tr class="memdesc:a6d209385481644d97e7ca96072b73eb8"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a6d209385481644d97e7ca96072b73eb8">More...</a><br/></td></tr>
135 <tr class="separator:a6d209385481644d97e7ca96072b73eb8"><td class="memSeparator" colspan="2"> </td></tr>
136 <tr class="memitem:a645ac2d9d4144fd0174296de7eb1e1b5"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_scheduler.xhtml#a645ac2d9d4144fd0174296de7eb1e1b5">set_num_threads</a> (unsigned int <a class="el" href="classarm__compute_1_1_i_scheduler.xhtml#ac24584a63e484123e3756d1b2a1c9e2f">num_threads</a>)=0</td></tr>
137 <tr class="memdesc:a645ac2d9d4144fd0174296de7eb1e1b5"><td class="mdescLeft"> </td><td class="mdescRight">Sets the number of threads the scheduler will use to run the kernels. <a href="#a645ac2d9d4144fd0174296de7eb1e1b5">More...</a><br/></td></tr>
138 <tr class="separator:a645ac2d9d4144fd0174296de7eb1e1b5"><td class="memSeparator" colspan="2"> </td></tr>
139 <tr class="memitem:ac24584a63e484123e3756d1b2a1c9e2f"><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_scheduler.xhtml#ac24584a63e484123e3756d1b2a1c9e2f">num_threads</a> () const =0</td></tr>
140 <tr class="memdesc:ac24584a63e484123e3756d1b2a1c9e2f"><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 in his pool. <a href="#ac24584a63e484123e3756d1b2a1c9e2f">More...</a><br/></td></tr>
141 <tr class="separator:ac24584a63e484123e3756d1b2a1c9e2f"><td class="memSeparator" colspan="2"> </td></tr>
142 <tr class="memitem:a38e28e556fea6e2024019dbb9c7cc943"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_scheduler.xhtml#a38e28e556fea6e2024019dbb9c7cc943">schedule</a> (<a class="el" href="classarm__compute_1_1_i_c_p_p_kernel.xhtml">ICPPKernel</a> *kernel, unsigned int split_dimension)=0</td></tr>
143 <tr class="memdesc:a38e28e556fea6e2024019dbb9c7cc943"><td class="mdescLeft"> </td><td class="mdescRight">Runs the kernel in the same thread as the caller synchronously. <a href="#a38e28e556fea6e2024019dbb9c7cc943">More...</a><br/></td></tr>
144 <tr class="separator:a38e28e556fea6e2024019dbb9c7cc943"><td class="memSeparator" colspan="2"> </td></tr>
145 <tr class="memitem:a6a49fcb6640894fb5ec2da99f10a1593"><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>
146 <tr class="memdesc:a6a49fcb6640894fb5ec2da99f10a1593"><td class="mdescLeft"> </td><td class="mdescRight">Sets the target CPU architecture. <a href="#a6a49fcb6640894fb5ec2da99f10a1593">More...</a><br/></td></tr>
147 <tr class="separator:a6a49fcb6640894fb5ec2da99f10a1593"><td class="memSeparator" colspan="2"> </td></tr>
148 <tr class="memitem:a671307bb78c1d64435708feead8c04da"><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>
149 <tr class="memdesc:a671307bb78c1d64435708feead8c04da"><td class="mdescLeft"> </td><td class="mdescRight">Get CPU info. <a href="#a671307bb78c1d64435708feead8c04da">More...</a><br/></td></tr>
150 <tr class="separator:a671307bb78c1d64435708feead8c04da"><td class="memSeparator" colspan="2"> </td></tr>
152 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
153 <div class="textblock"><p><a class="el" href="classarm__compute_1_1_scheduler.xhtml" title="Configurable scheduler which supports multiple multithreading APIs and choosing between different sch...">Scheduler</a> interface to run kernels. </p>
155 <p>Definition at line <a class="el" href="_i_scheduler_8h_source.xhtml#l00034">34</a> of file <a class="el" href="_i_scheduler_8h_source.xhtml">IScheduler.h</a>.</p>
156 </div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
157 <a class="anchor" id="a34956db09db14c551e9966c9b66036f9"></a>
158 <div class="memitem">
159 <div class="memproto">
160 <table class="memname">
162 <td class="memname"><a class="el" href="classarm__compute_1_1_i_scheduler.xhtml">IScheduler</a> </td>
164 <td class="paramname"></td><td>)</td>
168 </div><div class="memdoc">
170 <p>Default constructor. </p>
174 <a class="anchor" id="a6d209385481644d97e7ca96072b73eb8"></a>
175 <div class="memitem">
176 <div class="memproto">
177 <table class="mlabels">
179 <td class="mlabels-left">
180 <table class="memname">
182 <td class="memname">virtual ~<a class="el" href="classarm__compute_1_1_i_scheduler.xhtml">IScheduler</a> </td>
184 <td class="paramname"></td><td>)</td>
189 <td class="mlabels-right">
190 <span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">default</span></span> </td>
193 </div><div class="memdoc">
199 <h2 class="groupheader">Member Function Documentation</h2>
200 <a class="anchor" id="a671307bb78c1d64435708feead8c04da"></a>
201 <div class="memitem">
202 <div class="memproto">
203 <table class="memname">
205 <td class="memname"><a class="el" href="structarm__compute_1_1_c_p_u_info.xhtml">CPUInfo</a> cpu_info </td>
207 <td class="paramname"></td><td>)</td>
211 </div><div class="memdoc">
213 <p>Get CPU info. </p>
214 <dl class="section return"><dt>Returns</dt><dd>CPU info. </dd></dl>
216 <p>Referenced by <a class="el" href="_alex_net_network_8h_source.xhtml#l00057">AlexNetNetwork< ITensorType, TensorType, SubTensorType, arm_compute::test::Accessor, ActivationLayerFunction, ConvolutionLayerFunction, DirectConvolutionLayerFunction, FullyConnectedLayerFunction, NormalizationLayerFunction, PoolingLayerFunction, SoftmaxLayerFunction >::init()</a>.</p>
220 <a class="anchor" id="ac24584a63e484123e3756d1b2a1c9e2f"></a>
221 <div class="memitem">
222 <div class="memproto">
223 <table class="mlabels">
225 <td class="mlabels-left">
226 <table class="memname">
228 <td class="memname">virtual unsigned int num_threads </td>
230 <td class="paramname"></td><td>)</td>
235 <td class="mlabels-right">
236 <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
239 </div><div class="memdoc">
241 <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 in his pool. </p>
242 <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>
244 <p>Implemented in <a class="el" href="classarm__compute_1_1_c_p_p_scheduler.xhtml#a0da94220ee1e0f4928aa31ed0d4b30f7">CPPScheduler</a>, <a class="el" href="classarm__compute_1_1_o_m_p_scheduler.xhtml#a0da94220ee1e0f4928aa31ed0d4b30f7">OMPScheduler</a>, and <a class="el" href="classarm__compute_1_1_single_thread_scheduler.xhtml#a0da94220ee1e0f4928aa31ed0d4b30f7">SingleThreadScheduler</a>.</p>
248 <a class="anchor" id="a38e28e556fea6e2024019dbb9c7cc943"></a>
249 <div class="memitem">
250 <div class="memproto">
251 <table class="mlabels">
253 <td class="mlabels-left">
254 <table class="memname">
256 <td class="memname">virtual void schedule </td>
258 <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_c_p_p_kernel.xhtml">ICPPKernel</a> * </td>
259 <td class="paramname"><em>kernel</em>, </td>
262 <td class="paramkey"></td>
264 <td class="paramtype">unsigned int </td>
265 <td class="paramname"><em>split_dimension</em> </td>
274 <td class="mlabels-right">
275 <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
278 </div><div class="memdoc">
280 <p>Runs the kernel in the same thread as the caller synchronously. </p>
281 <dl class="params"><dt>Parameters</dt><dd>
282 <table class="params">
283 <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>
284 <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>
289 <p>Implemented in <a class="el" href="classarm__compute_1_1_c_p_p_scheduler.xhtml#aa4fc1e7b1c1d9d42903cfc48351e57ad">CPPScheduler</a>, <a class="el" href="classarm__compute_1_1_o_m_p_scheduler.xhtml#aa4fc1e7b1c1d9d42903cfc48351e57ad">OMPScheduler</a>, and <a class="el" href="classarm__compute_1_1_single_thread_scheduler.xhtml#aa4fc1e7b1c1d9d42903cfc48351e57ad">SingleThreadScheduler</a>.</p>
293 <a class="anchor" id="a645ac2d9d4144fd0174296de7eb1e1b5"></a>
294 <div class="memitem">
295 <div class="memproto">
296 <table class="mlabels">
298 <td class="mlabels-left">
299 <table class="memname">
301 <td class="memname">virtual void set_num_threads </td>
303 <td class="paramtype">unsigned int </td>
304 <td class="paramname"><em>num_threads</em></td><td>)</td>
309 <td class="mlabels-right">
310 <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
313 </div><div class="memdoc">
315 <p>Sets the number of threads the scheduler will use to run the kernels. </p>
316 <dl class="params"><dt>Parameters</dt><dd>
317 <table class="params">
318 <tr><td class="paramdir">[in]</td><td class="paramname">num_threads</td><td>If set to 0, then one thread per CPU core available on the system will be used, otherwise the number of threads specified. </td></tr>
323 <p>Implemented in <a class="el" href="classarm__compute_1_1_c_p_p_scheduler.xhtml#ae64eebaa07f4d2da6cc2ba538c3cb095">CPPScheduler</a>, <a class="el" href="classarm__compute_1_1_o_m_p_scheduler.xhtml#ae64eebaa07f4d2da6cc2ba538c3cb095">OMPScheduler</a>, and <a class="el" href="classarm__compute_1_1_single_thread_scheduler.xhtml#ae64eebaa07f4d2da6cc2ba538c3cb095">SingleThreadScheduler</a>.</p>
325 <p>Referenced by <a class="el" href="main_8cpp_source.xhtml#l00059">main()</a>.</p>
329 <a class="anchor" id="a6a49fcb6640894fb5ec2da99f10a1593"></a>
330 <div class="memitem">
331 <div class="memproto">
332 <table class="memname">
334 <td class="memname">void set_target </td>
336 <td class="paramtype"><a class="el" href="namespacearm__compute.xhtml#a5bc939238e1f14a4c39aaee8186a853d">CPUTarget</a> </td>
337 <td class="paramname"><em>target</em></td><td>)</td>
341 </div><div class="memdoc">
343 <p>Sets the target CPU architecture. </p>
344 <dl class="params"><dt>Parameters</dt><dd>
345 <table class="params">
346 <tr><td class="paramdir">[in]</td><td class="paramname">target</td><td>Target CPU. </td></tr>
353 <hr/>The documentation for this class was generated from the following file:<ul>
354 <li>arm_compute/runtime/<a class="el" href="_i_scheduler_8h_source.xhtml">IScheduler.h</a></li>
356 </div><!-- contents -->
357 </div><!-- doc-content -->
358 <!-- start footer part -->
359 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
361 <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_scheduler.xhtml">IScheduler</a></li>
362 <li class="footer">Generated on Thu Oct 12 2017 14:26:37 for Compute Library by
363 <a href="http://www.doxygen.org/index.html">
364 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>