documentation/classarm__compute_1_1_c_l_scheduler.xhtml

   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">
   4 <head>
   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: CLScheduler 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);
  20 </script>
  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(); });
  26 </script>
  27 <script type="text/x-mathjax-config">
  28   MathJax.Hub.Config({
  29     extensions: ["tex2jax.js"],
  30     jax: ["input/TeX","output/HTML-CSS"],
  31 });
  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" />
  34 </head>
  35 <body>
  36 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  37 <div id="titlearea">
  38 <table cellspacing="0" cellpadding="0">
  39  <tbody>
  40  <tr style="height: 56px;">
  41   <td style="padding-left: 0.5em;">
  42    <div id="projectname">ARM Compute Library
  43    &#160;<span id="projectnumber">17.04</span>
  44    </div>
  45   </td>
  46  </tr>
  47  </tbody>
  48 </table>
  49 </div>
  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');
  54 </script>
  55   <div id="navrow1" class="tabs">
  56     <ul class="tablist">
  57       <li><a href="index.xhtml"><span>Main&#160;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&#160;Structures</span></a></li>
  60       <li><a href="files.xhtml"><span>Files</span></a></li>
  61       <li>
  62         <div id="MSearchBox" class="MSearchBoxInactive">
  63         <span class="left">
  64           <img id="MSearchSelect" src="search/mag_sel.png"
  65                onmouseover="return searchBox.OnSearchSelectShow()"
  66                onmouseout="return searchBox.OnSearchSelectHide()"
  67                alt=""/>
  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>
  74           </span>
  75         </div>
  76       </li>
  77     </ul>
  78   </div>
  79   <div id="navrow2" class="tabs2">
  80     <ul class="tablist">
  81       <li><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
  82       <li><a href="classes.xhtml"><span>Data&#160;Structure&#160;Index</span></a></li>
  83       <li><a href="inherits.xhtml"><span>Class&#160;Hierarchy</span></a></li>
  84       <li><a href="functions.xhtml"><span>Data&#160;Fields</span></a></li>
  85     </ul>
  86   </div>
  87 </div><!-- top -->
  88 <div id="side-nav" class="ui-resizable side-nav-resizable">
  89   <div id="nav-tree">
  90     <div id="nav-tree-contents">
  91       <div id="nav-sync" class="sync"></div>
  92     </div>
  93   </div>
  94   <div id="splitbar" style="-moz-user-select:none;"
  95        class="ui-resizable-handle">
  96   </div>
  97 </div>
  98 <script type="text/javascript">
  99 $(document).ready(function(){initNavTree('classarm__compute_1_1_c_l_scheduler.xhtml','');});
 100 </script>
 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)">
 107 </div>
 108
 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">
 113 </iframe>
 114 </div>
 115
 116 <div class="header">
 117   <div class="summary">
 118 <a href="#pub-methods">Public Member Functions</a> &#124;
 119 <a href="#pub-static-methods">Static Public Member Functions</a>  </div>
 120   <div class="headertitle">
 121 <div class="title">CLScheduler Class Reference</div>  </div>
 122 </div><!--header-->
 123 <div class="contents">
 124
 125 <p>Provides global access to a CL context and command queue.
 126  <a href="classarm__compute_1_1_c_l_scheduler.xhtml#details">More...</a></p>
 127
 128 <p><code>#include &lt;<a class="el" href="_c_l_scheduler_8h_source.xhtml">CLScheduler.h</a>&gt;</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:a19bb5002a62b62e050e89c975f7b9fdf"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_scheduler.xhtml#a19bb5002a62b62e050e89c975f7b9fdf">default_init</a> ()</td></tr>
 133 <tr class="memdesc:a19bb5002a62b62e050e89c975f7b9fdf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialises the context and command queue used by the scheduler to default values and sets a default device and kernel path for the <a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml">CLKernelLibrary</a>.  <a href="#a19bb5002a62b62e050e89c975f7b9fdf">More...</a><br /></td></tr>
 134 <tr class="separator:a19bb5002a62b62e050e89c975f7b9fdf"><td class="memSeparator" colspan="2">&#160;</td></tr>
 135 <tr class="memitem:ae1a643e517f50bf0392fb6516dd7cf67"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_scheduler.xhtml#ae1a643e517f50bf0392fb6516dd7cf67">enqueue</a> (<a class="el" href="classarm__compute_1_1_i_c_l_kernel.xhtml">ICLKernel</a> &amp;kernel, bool flush=true)</td></tr>
 136 <tr class="memdesc:ae1a643e517f50bf0392fb6516dd7cf67"><td class="mdescLeft">&#160;</td><td class="mdescRight">Schedule the execution of the passed kernel if possible.  <a href="#ae1a643e517f50bf0392fb6516dd7cf67">More...</a><br /></td></tr>
 137 <tr class="separator:ae1a643e517f50bf0392fb6516dd7cf67"><td class="memSeparator" colspan="2">&#160;</td></tr>
 138 <tr class="memitem:adbadebed3b89425740901b16b9d5d947"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_scheduler.xhtml#adbadebed3b89425740901b16b9d5d947">init</a> (cl::Context <a class="el" href="classarm__compute_1_1_c_l_scheduler.xhtml#a252f5440564c77d68459f2baa978f86a">context</a>=cl::Context::getDefault(), cl::CommandQueue <a class="el" href="classarm__compute_1_1_c_l_scheduler.xhtml#ad381d1aed28b4b1e1f5a710633934580">queue</a>=cl::CommandQueue::getDefault())</td></tr>
 139 <tr class="memdesc:adbadebed3b89425740901b16b9d5d947"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialises the context and command queue to be used by the scheduler.  <a href="#adbadebed3b89425740901b16b9d5d947">More...</a><br /></td></tr>
 140 <tr class="separator:adbadebed3b89425740901b16b9d5d947"><td class="memSeparator" colspan="2">&#160;</td></tr>
 141 <tr class="memitem:a252f5440564c77d68459f2baa978f86a"><td class="memItemLeft" align="right" valign="top">cl::Context &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_scheduler.xhtml#a252f5440564c77d68459f2baa978f86a">context</a> ()</td></tr>
 142 <tr class="memdesc:a252f5440564c77d68459f2baa978f86a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Accessor for the associated CL context.  <a href="#a252f5440564c77d68459f2baa978f86a">More...</a><br /></td></tr>
 143 <tr class="separator:a252f5440564c77d68459f2baa978f86a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 144 <tr class="memitem:a293edc1bbcbddffb7228ac97917ed107"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_scheduler.xhtml#a293edc1bbcbddffb7228ac97917ed107">set_context</a> (cl::Context <a class="el" href="classarm__compute_1_1_c_l_scheduler.xhtml#a252f5440564c77d68459f2baa978f86a">context</a>)</td></tr>
 145 <tr class="memdesc:a293edc1bbcbddffb7228ac97917ed107"><td class="mdescLeft">&#160;</td><td class="mdescRight">Accessor to set the CL context to be used by the scheduler.  <a href="#a293edc1bbcbddffb7228ac97917ed107">More...</a><br /></td></tr>
 146 <tr class="separator:a293edc1bbcbddffb7228ac97917ed107"><td class="memSeparator" colspan="2">&#160;</td></tr>
 147 <tr class="memitem:ad381d1aed28b4b1e1f5a710633934580"><td class="memItemLeft" align="right" valign="top">cl::CommandQueue &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_scheduler.xhtml#ad381d1aed28b4b1e1f5a710633934580">queue</a> ()</td></tr>
 148 <tr class="memdesc:ad381d1aed28b4b1e1f5a710633934580"><td class="mdescLeft">&#160;</td><td class="mdescRight">Accessor for the associated CL command queue.  <a href="#ad381d1aed28b4b1e1f5a710633934580">More...</a><br /></td></tr>
 149 <tr class="separator:ad381d1aed28b4b1e1f5a710633934580"><td class="memSeparator" colspan="2">&#160;</td></tr>
 150 <tr class="memitem:a9608e5af9f3a199f69ca6aa41b94359a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_scheduler.xhtml#a9608e5af9f3a199f69ca6aa41b94359a">set_queue</a> (cl::CommandQueue <a class="el" href="classarm__compute_1_1_c_l_scheduler.xhtml#ad381d1aed28b4b1e1f5a710633934580">queue</a>)</td></tr>
 151 <tr class="memdesc:a9608e5af9f3a199f69ca6aa41b94359a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Accessor to set the CL command queue to be used by the scheduler.  <a href="#a9608e5af9f3a199f69ca6aa41b94359a">More...</a><br /></td></tr>
 152 <tr class="separator:a9608e5af9f3a199f69ca6aa41b94359a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 153 <tr class="memitem:ad55f80ed3cd8b6c4f247763b747016af"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_scheduler.xhtml#ad55f80ed3cd8b6c4f247763b747016af">sync</a> ()</td></tr>
 154 <tr class="memdesc:ad55f80ed3cd8b6c4f247763b747016af"><td class="mdescLeft">&#160;</td><td class="mdescRight">Blocks until all commands in the associated command queue have finished.  <a href="#ad55f80ed3cd8b6c4f247763b747016af">More...</a><br /></td></tr>
 155 <tr class="separator:ad55f80ed3cd8b6c4f247763b747016af"><td class="memSeparator" colspan="2">&#160;</td></tr>
 156 <tr class="memitem:a6096d26e8e29e1a7f01b0f083fb7e33f"><td class="memItemLeft" align="right" valign="top">cl::Event&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_scheduler.xhtml#a6096d26e8e29e1a7f01b0f083fb7e33f">enqueue_sync_event</a> ()</td></tr>
 157 <tr class="memdesc:a6096d26e8e29e1a7f01b0f083fb7e33f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enqueues a marker into the associated command queue and return the event.  <a href="#a6096d26e8e29e1a7f01b0f083fb7e33f">More...</a><br /></td></tr>
 158 <tr class="separator:a6096d26e8e29e1a7f01b0f083fb7e33f"><td class="memSeparator" colspan="2">&#160;</td></tr>
 159 </table><table class="memberdecls">
 160 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
 161 Static Public Member Functions</h2></td></tr>
 162 <tr class="memitem:a60f9a6836b628a7171914c4afe43b4a7"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classarm__compute_1_1_c_l_scheduler.xhtml">CLScheduler</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_scheduler.xhtml#a60f9a6836b628a7171914c4afe43b4a7">get</a> ()</td></tr>
 163 <tr class="memdesc:a60f9a6836b628a7171914c4afe43b4a7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Access the scheduler singleton.  <a href="#a60f9a6836b628a7171914c4afe43b4a7">More...</a><br /></td></tr>
 164 <tr class="separator:a60f9a6836b628a7171914c4afe43b4a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
 165 </table>
 166 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 167 <div class="textblock"><p>Provides global access to a CL context and command queue. </p>
 168
 169 <p>Definition at line <a class="el" href="_c_l_scheduler_8h_source.xhtml#l00035">35</a> of file <a class="el" href="_c_l_scheduler_8h_source.xhtml">CLScheduler.h</a>.</p>
 170 </div><h2 class="groupheader">Member Function Documentation</h2>
 171 <a class="anchor" id="a252f5440564c77d68459f2baa978f86a"></a>
 172 <div class="memitem">
 173 <div class="memproto">
 174 <table class="mlabels">
 175   <tr>
 176   <td class="mlabels-left">
 177       <table class="memname">
 178         <tr>
 179           <td class="memname">cl::Context&amp; context </td>
 180           <td>(</td>
 181           <td class="paramname"></td><td>)</td>
 182           <td></td>
 183         </tr>
 184       </table>
 185   </td>
 186   <td class="mlabels-right">
 187 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 188   </tr>
 189 </table>
 190 </div><div class="memdoc">
 191
 192 <p>Accessor for the associated CL context. </p>
 193 <dl class="section return"><dt>Returns</dt><dd>A CL context. </dd></dl>
 194
 195 <p>Definition at line <a class="el" href="_c_l_scheduler_8h_source.xhtml#l00077">77</a> of file <a class="el" href="_c_l_scheduler_8h_source.xhtml">CLScheduler.h</a>.</p>
 196
 197 <p>Referenced by <a class="el" href="_c_l_scheduler_8h_source.xhtml#l00067">CLScheduler::init()</a>.</p>
 198 <div class="fragment"><div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;    {</div><div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;        <span class="keywordflow">return</span> _context;</div><div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;    }</div></div><!-- fragment -->
 199 </div>
 200 </div>
 201 <a class="anchor" id="a19bb5002a62b62e050e89c975f7b9fdf"></a>
 202 <div class="memitem">
 203 <div class="memproto">
 204 <table class="mlabels">
 205   <tr>
 206   <td class="mlabels-left">
 207       <table class="memname">
 208         <tr>
 209           <td class="memname">void default_init </td>
 210           <td>(</td>
 211           <td class="paramname"></td><td>)</td>
 212           <td></td>
 213         </tr>
 214       </table>
 215   </td>
 216   <td class="mlabels-right">
 217 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 218   </tr>
 219 </table>
 220 </div><div class="memdoc">
 221
 222 <p>Initialises the context and command queue used by the scheduler to default values and sets a default device and kernel path for the <a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml">CLKernelLibrary</a>. </p>
 223
 224 <p>Definition at line <a class="el" href="_c_l_scheduler_8h_source.xhtml#l00050">50</a> of file <a class="el" href="_c_l_scheduler_8h_source.xhtml">CLScheduler.h</a>.</p>
 225
 226 <p>References <a class="el" href="classarm__compute_1_1_c_l_scheduler.xhtml#ae1a643e517f50bf0392fb6516dd7cf67">CLScheduler::enqueue()</a>, <a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml#aebe2d25607545d31f2b1ace6d60a81da">CLKernelLibrary::get()</a>, <a class="el" href="_c_l_scheduler_8h_source.xhtml#l00067">CLScheduler::init()</a>, and <a class="el" href="_c_l_kernel_library_8h_source.xhtml#l00163">CLKernelLibrary::init()</a>.</p>
 227
 228 <p>Referenced by <a class="el" href="cl__convolution_8cpp_source.xhtml#l00053">main_cl_convolution()</a>, <a class="el" href="cl__events_8cpp_source.xhtml#l00033">main_cl_events()</a>, and <a class="el" href="neoncl__scale__median__gaussian_8cpp_source.xhtml#l00039">main_neoncl_scale_median_gaussian()</a>.</p>
 229 <div class="fragment"><div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;    {</div><div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;        <a class="code" href="classarm__compute_1_1_c_l_kernel_library.xhtml#aebe2d25607545d31f2b1ace6d60a81da">CLKernelLibrary::get</a>().<a class="code" href="classarm__compute_1_1_c_l_kernel_library.xhtml#af353532ea782387df6bcb6d01894f4ae">init</a>(<span class="stringliteral">&quot;./cl_kernels/&quot;</span>, cl::Context::getDefault(), cl::Device::getDefault());</div><div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;        <a class="code" href="classarm__compute_1_1_c_l_scheduler.xhtml#adbadebed3b89425740901b16b9d5d947">init</a>(cl::Context::getDefault(), cl::CommandQueue::getDefault());</div><div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;    }</div><div class="ttc" id="classarm__compute_1_1_c_l_kernel_library_xhtml_af353532ea782387df6bcb6d01894f4ae"><div class="ttname"><a href="classarm__compute_1_1_c_l_kernel_library.xhtml#af353532ea782387df6bcb6d01894f4ae">arm_compute::CLKernelLibrary::init</a></div><div class="ttdeci">void init(std::string kernel_path=&quot;.&quot;, cl::Context context=cl::Context::getDefault(), cl::Device device=cl::Device::getDefault())</div><div class="ttdoc">Initialises the kernel library. </div><div class="ttdef"><b>Definition:</b> <a href="_c_l_kernel_library_8h_source.xhtml#l00163">CLKernelLibrary.h:163</a></div></div>
 230 <div class="ttc" id="classarm__compute_1_1_c_l_kernel_library_xhtml_aebe2d25607545d31f2b1ace6d60a81da"><div class="ttname"><a href="classarm__compute_1_1_c_l_kernel_library.xhtml#aebe2d25607545d31f2b1ace6d60a81da">arm_compute::CLKernelLibrary::get</a></div><div class="ttdeci">static CLKernelLibrary &amp; get()</div><div class="ttdoc">Access the KernelLibrary singleton. </div></div>
 231 <div class="ttc" id="classarm__compute_1_1_c_l_scheduler_xhtml_adbadebed3b89425740901b16b9d5d947"><div class="ttname"><a href="classarm__compute_1_1_c_l_scheduler.xhtml#adbadebed3b89425740901b16b9d5d947">arm_compute::CLScheduler::init</a></div><div class="ttdeci">void init(cl::Context context=cl::Context::getDefault(), cl::CommandQueue queue=cl::CommandQueue::getDefault())</div><div class="ttdoc">Initialises the context and command queue to be used by the scheduler. </div><div class="ttdef"><b>Definition:</b> <a href="_c_l_scheduler_8h_source.xhtml#l00067">CLScheduler.h:67</a></div></div>
 232 </div><!-- fragment -->
 233 </div>
 234 </div>
 235 <a class="anchor" id="ae1a643e517f50bf0392fb6516dd7cf67"></a>
 236 <div class="memitem">
 237 <div class="memproto">
 238       <table class="memname">
 239         <tr>
 240           <td class="memname">void enqueue </td>
 241           <td>(</td>
 242           <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_c_l_kernel.xhtml">ICLKernel</a> &amp;&#160;</td>
 243           <td class="paramname"><em>kernel</em>, </td>
 244         </tr>
 245         <tr>
 246           <td class="paramkey"></td>
 247           <td></td>
 248           <td class="paramtype">bool&#160;</td>
 249           <td class="paramname"><em>flush</em> = <code>true</code>&#160;</td>
 250         </tr>
 251         <tr>
 252           <td></td>
 253           <td>)</td>
 254           <td></td><td></td>
 255         </tr>
 256       </table>
 257 </div><div class="memdoc">
 258
 259 <p>Schedule the execution of the passed kernel if possible. </p>
 260 <dl class="params"><dt>Parameters</dt><dd>
 261   <table class="params">
 262     <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>
 263     <tr><td class="paramdir">[in]</td><td class="paramname">flush</td><td>(Optional) Specifies if the command queue will be flushed after running the kernel. </td></tr>
 264   </table>
 265   </dd>
 266 </dl>
 267
 268 <p>Referenced by <a class="el" href="_c_l_scheduler_8h_source.xhtml#l00050">CLScheduler::default_init()</a>.</p>
 269
 270 </div>
 271 </div>
 272 <a class="anchor" id="a6096d26e8e29e1a7f01b0f083fb7e33f"></a>
 273 <div class="memitem">
 274 <div class="memproto">
 275 <table class="mlabels">
 276   <tr>
 277   <td class="mlabels-left">
 278       <table class="memname">
 279         <tr>
 280           <td class="memname">cl::Event enqueue_sync_event </td>
 281           <td>(</td>
 282           <td class="paramname"></td><td>)</td>
 283           <td></td>
 284         </tr>
 285       </table>
 286   </td>
 287   <td class="mlabels-right">
 288 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 289   </tr>
 290 </table>
 291 </div><div class="memdoc">
 292
 293 <p>Enqueues a marker into the associated command queue and return the event. </p>
 294 <dl class="section return"><dt>Returns</dt><dd>An event that can be waited on to block the executing thread. </dd></dl>
 295
 296 <p>Definition at line <a class="el" href="_c_l_scheduler_8h_source.xhtml#l00119">119</a> of file <a class="el" href="_c_l_scheduler_8h_source.xhtml">CLScheduler.h</a>.</p>
 297
 298 <p>Referenced by <a class="el" href="cl__events_8cpp_source.xhtml#l00033">main_cl_events()</a>.</p>
 299 <div class="fragment"><div class="line"><a name="l00120"></a><span class="lineno">  120</span>&#160;    {</div><div class="line"><a name="l00121"></a><span class="lineno">  121</span>&#160;        cl::Event event;</div><div class="line"><a name="l00122"></a><span class="lineno">  122</span>&#160;        _queue.enqueueMarker(&amp;event);</div><div class="line"><a name="l00123"></a><span class="lineno">  123</span>&#160;</div><div class="line"><a name="l00124"></a><span class="lineno">  124</span>&#160;        <span class="keywordflow">return</span> event;</div><div class="line"><a name="l00125"></a><span class="lineno">  125</span>&#160;    }</div></div><!-- fragment -->
 300 </div>
 301 </div>
 302 <a class="anchor" id="a60f9a6836b628a7171914c4afe43b4a7"></a>
 303 <div class="memitem">
 304 <div class="memproto">
 305 <table class="mlabels">
 306   <tr>
 307   <td class="mlabels-left">
 308       <table class="memname">
 309         <tr>
 310           <td class="memname">static <a class="el" href="classarm__compute_1_1_c_l_scheduler.xhtml">CLScheduler</a>&amp; get </td>
 311           <td>(</td>
 312           <td class="paramname"></td><td>)</td>
 313           <td></td>
 314         </tr>
 315       </table>
 316   </td>
 317   <td class="mlabels-right">
 318 <span class="mlabels"><span class="mlabel">static</span></span>  </td>
 319   </tr>
 320 </table>
 321 </div><div class="memdoc">
 322
 323 <p>Access the scheduler singleton. </p>
 324 <dl class="section return"><dt>Returns</dt><dd>The scheduler </dd></dl>
 325
 326 <p>Referenced by <a class="el" href="cl__convolution_8cpp_source.xhtml#l00053">main_cl_convolution()</a>, <a class="el" href="cl__events_8cpp_source.xhtml#l00033">main_cl_events()</a>, <a class="el" href="neoncl__scale__median__gaussian_8cpp_source.xhtml#l00039">main_neoncl_scale_median_gaussian()</a>, <a class="el" href="_c_l_array_8h_source.xhtml#l00058">CLArray&lt; T &gt;::map()</a>, and <a class="el" href="_c_l_array_8h_source.xhtml#l00068">CLArray&lt; T &gt;::unmap()</a>.</p>
 327
 328 </div>
 329 </div>
 330 <a class="anchor" id="adbadebed3b89425740901b16b9d5d947"></a>
 331 <div class="memitem">
 332 <div class="memproto">
 333 <table class="mlabels">
 334   <tr>
 335   <td class="mlabels-left">
 336       <table class="memname">
 337         <tr>
 338           <td class="memname">void init </td>
 339           <td>(</td>
 340           <td class="paramtype">cl::Context&#160;</td>
 341           <td class="paramname"><em>context</em> = <code>cl::Context::getDefault()</code>, </td>
 342         </tr>
 343         <tr>
 344           <td class="paramkey"></td>
 345           <td></td>
 346           <td class="paramtype">cl::CommandQueue&#160;</td>
 347           <td class="paramname"><em>queue</em> = <code>cl::CommandQueue::getDefault()</code>&#160;</td>
 348         </tr>
 349         <tr>
 350           <td></td>
 351           <td>)</td>
 352           <td></td><td></td>
 353         </tr>
 354       </table>
 355   </td>
 356   <td class="mlabels-right">
 357 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 358   </tr>
 359 </table>
 360 </div><div class="memdoc">
 361
 362 <p>Initialises the context and command queue to be used by the scheduler. </p>
 363 <dl class="params"><dt>Parameters</dt><dd>
 364   <table class="params">
 365     <tr><td class="paramdir">[in]</td><td class="paramname">context</td><td>A CL context. </td></tr>
 366     <tr><td class="paramdir">[in]</td><td class="paramname">queue</td><td>A CL command queue. </td></tr>
 367   </table>
 368   </dd>
 369 </dl>
 370
 371 <p>Definition at line <a class="el" href="_c_l_scheduler_8h_source.xhtml#l00067">67</a> of file <a class="el" href="_c_l_scheduler_8h_source.xhtml">CLScheduler.h</a>.</p>
 372
 373 <p>References <a class="el" href="_c_l_scheduler_8h_source.xhtml#l00077">CLScheduler::context()</a>, and <a class="el" href="_c_l_scheduler_8h_source.xhtml#l00095">CLScheduler::queue()</a>.</p>
 374
 375 <p>Referenced by <a class="el" href="_c_l_scheduler_8h_source.xhtml#l00050">CLScheduler::default_init()</a>.</p>
 376 <div class="fragment"><div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;    {</div><div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;        _context = std::move(<a class="code" href="classarm__compute_1_1_c_l_scheduler.xhtml#a252f5440564c77d68459f2baa978f86a">context</a>);</div><div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;        _queue   = std::move(<a class="code" href="classarm__compute_1_1_c_l_scheduler.xhtml#ad381d1aed28b4b1e1f5a710633934580">queue</a>);</div><div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;    }</div><div class="ttc" id="classarm__compute_1_1_c_l_scheduler_xhtml_ad381d1aed28b4b1e1f5a710633934580"><div class="ttname"><a href="classarm__compute_1_1_c_l_scheduler.xhtml#ad381d1aed28b4b1e1f5a710633934580">arm_compute::CLScheduler::queue</a></div><div class="ttdeci">cl::CommandQueue &amp; queue()</div><div class="ttdoc">Accessor for the associated CL command queue. </div><div class="ttdef"><b>Definition:</b> <a href="_c_l_scheduler_8h_source.xhtml#l00095">CLScheduler.h:95</a></div></div>
 377 <div class="ttc" id="classarm__compute_1_1_c_l_scheduler_xhtml_a252f5440564c77d68459f2baa978f86a"><div class="ttname"><a href="classarm__compute_1_1_c_l_scheduler.xhtml#a252f5440564c77d68459f2baa978f86a">arm_compute::CLScheduler::context</a></div><div class="ttdeci">cl::Context &amp; context()</div><div class="ttdoc">Accessor for the associated CL context. </div><div class="ttdef"><b>Definition:</b> <a href="_c_l_scheduler_8h_source.xhtml#l00077">CLScheduler.h:77</a></div></div>
 378 </div><!-- fragment -->
 379 </div>
 380 </div>
 381 <a class="anchor" id="ad381d1aed28b4b1e1f5a710633934580"></a>
 382 <div class="memitem">
 383 <div class="memproto">
 384 <table class="mlabels">
 385   <tr>
 386   <td class="mlabels-left">
 387       <table class="memname">
 388         <tr>
 389           <td class="memname">cl::CommandQueue&amp; queue </td>
 390           <td>(</td>
 391           <td class="paramname"></td><td>)</td>
 392           <td></td>
 393         </tr>
 394       </table>
 395   </td>
 396   <td class="mlabels-right">
 397 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 398   </tr>
 399 </table>
 400 </div><div class="memdoc">
 401
 402 <p>Accessor for the associated CL command queue. </p>
 403 <dl class="section return"><dt>Returns</dt><dd>A CL command queue. </dd></dl>
 404
 405 <p>Definition at line <a class="el" href="_c_l_scheduler_8h_source.xhtml#l00095">95</a> of file <a class="el" href="_c_l_scheduler_8h_source.xhtml">CLScheduler.h</a>.</p>
 406
 407 <p>Referenced by <a class="el" href="_c_l_scheduler_8h_source.xhtml#l00067">CLScheduler::init()</a>.</p>
 408 <div class="fragment"><div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;    {</div><div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;        <span class="keywordflow">return</span> _queue;</div><div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;    }</div></div><!-- fragment -->
 409 </div>
 410 </div>
 411 <a class="anchor" id="a293edc1bbcbddffb7228ac97917ed107"></a>
 412 <div class="memitem">
 413 <div class="memproto">
 414 <table class="mlabels">
 415   <tr>
 416   <td class="mlabels-left">
 417       <table class="memname">
 418         <tr>
 419           <td class="memname">void set_context </td>
 420           <td>(</td>
 421           <td class="paramtype">cl::Context&#160;</td>
 422           <td class="paramname"><em>context</em></td><td>)</td>
 423           <td></td>
 424         </tr>
 425       </table>
 426   </td>
 427   <td class="mlabels-right">
 428 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 429   </tr>
 430 </table>
 431 </div><div class="memdoc">
 432
 433 <p>Accessor to set the CL context to be used by the scheduler. </p>
 434 <dl class="params"><dt>Parameters</dt><dd>
 435   <table class="params">
 436     <tr><td class="paramdir">[in]</td><td class="paramname">context</td><td>A CL context. </td></tr>
 437   </table>
 438   </dd>
 439 </dl>
 440
 441 <p>Definition at line <a class="el" href="_c_l_scheduler_8h_source.xhtml#l00086">86</a> of file <a class="el" href="_c_l_scheduler_8h_source.xhtml">CLScheduler.h</a>.</p>
 442 <div class="fragment"><div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;    {</div><div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;        _context = std::move(<a class="code" href="classarm__compute_1_1_c_l_scheduler.xhtml#a252f5440564c77d68459f2baa978f86a">context</a>);</div><div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;    }</div><div class="ttc" id="classarm__compute_1_1_c_l_scheduler_xhtml_a252f5440564c77d68459f2baa978f86a"><div class="ttname"><a href="classarm__compute_1_1_c_l_scheduler.xhtml#a252f5440564c77d68459f2baa978f86a">arm_compute::CLScheduler::context</a></div><div class="ttdeci">cl::Context &amp; context()</div><div class="ttdoc">Accessor for the associated CL context. </div><div class="ttdef"><b>Definition:</b> <a href="_c_l_scheduler_8h_source.xhtml#l00077">CLScheduler.h:77</a></div></div>
 443 </div><!-- fragment -->
 444 </div>
 445 </div>
 446 <a class="anchor" id="a9608e5af9f3a199f69ca6aa41b94359a"></a>
 447 <div class="memitem">
 448 <div class="memproto">
 449 <table class="mlabels">
 450   <tr>
 451   <td class="mlabels-left">
 452       <table class="memname">
 453         <tr>
 454           <td class="memname">void set_queue </td>
 455           <td>(</td>
 456           <td class="paramtype">cl::CommandQueue&#160;</td>
 457           <td class="paramname"><em>queue</em></td><td>)</td>
 458           <td></td>
 459         </tr>
 460       </table>
 461   </td>
 462   <td class="mlabels-right">
 463 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 464   </tr>
 465 </table>
 466 </div><div class="memdoc">
 467
 468 <p>Accessor to set the CL command queue to be used by the scheduler. </p>
 469 <dl class="params"><dt>Parameters</dt><dd>
 470   <table class="params">
 471     <tr><td class="paramdir">[in]</td><td class="paramname">queue</td><td>A CL command queue. </td></tr>
 472   </table>
 473   </dd>
 474 </dl>
 475
 476 <p>Definition at line <a class="el" href="_c_l_scheduler_8h_source.xhtml#l00104">104</a> of file <a class="el" href="_c_l_scheduler_8h_source.xhtml">CLScheduler.h</a>.</p>
 477 <div class="fragment"><div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;    {</div><div class="line"><a name="l00106"></a><span class="lineno">  106</span>&#160;        _queue = std::move(<a class="code" href="classarm__compute_1_1_c_l_scheduler.xhtml#ad381d1aed28b4b1e1f5a710633934580">queue</a>);</div><div class="line"><a name="l00107"></a><span class="lineno">  107</span>&#160;    }</div><div class="ttc" id="classarm__compute_1_1_c_l_scheduler_xhtml_ad381d1aed28b4b1e1f5a710633934580"><div class="ttname"><a href="classarm__compute_1_1_c_l_scheduler.xhtml#ad381d1aed28b4b1e1f5a710633934580">arm_compute::CLScheduler::queue</a></div><div class="ttdeci">cl::CommandQueue &amp; queue()</div><div class="ttdoc">Accessor for the associated CL command queue. </div><div class="ttdef"><b>Definition:</b> <a href="_c_l_scheduler_8h_source.xhtml#l00095">CLScheduler.h:95</a></div></div>
 478 </div><!-- fragment -->
 479 </div>
 480 </div>
 481 <a class="anchor" id="ad55f80ed3cd8b6c4f247763b747016af"></a>
 482 <div class="memitem">
 483 <div class="memproto">
 484 <table class="mlabels">
 485   <tr>
 486   <td class="mlabels-left">
 487       <table class="memname">
 488         <tr>
 489           <td class="memname">void sync </td>
 490           <td>(</td>
 491           <td class="paramname"></td><td>)</td>
 492           <td></td>
 493         </tr>
 494       </table>
 495   </td>
 496   <td class="mlabels-right">
 497 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 498   </tr>
 499 </table>
 500 </div><div class="memdoc">
 501
 502 <p>Blocks until all commands in the associated command queue have finished. </p>
 503
 504 <p>Definition at line <a class="el" href="_c_l_scheduler_8h_source.xhtml#l00110">110</a> of file <a class="el" href="_c_l_scheduler_8h_source.xhtml">CLScheduler.h</a>.</p>
 505
 506 <p>Referenced by <a class="el" href="cl__convolution_8cpp_source.xhtml#l00053">main_cl_convolution()</a>, <a class="el" href="cl__events_8cpp_source.xhtml#l00033">main_cl_events()</a>, and <a class="el" href="neoncl__scale__median__gaussian_8cpp_source.xhtml#l00039">main_neoncl_scale_median_gaussian()</a>.</p>
 507 <div class="fragment"><div class="line"><a name="l00111"></a><span class="lineno">  111</span>&#160;    {</div><div class="line"><a name="l00112"></a><span class="lineno">  112</span>&#160;        _queue.finish();</div><div class="line"><a name="l00113"></a><span class="lineno">  113</span>&#160;    }</div></div><!-- fragment -->
 508 </div>
 509 </div>
 510 <hr/>The documentation for this class was generated from the following file:<ul>
 511 <li>arm_compute/runtime/CL/<a class="el" href="_c_l_scheduler_8h_source.xhtml">CLScheduler.h</a></li>
 512 </ul>
 513 </div><!-- contents -->
 514 </div><!-- doc-content -->
 515 <!-- start footer part -->
 516 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 517   <ul>
 518     <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_l_scheduler.xhtml">CLScheduler</a></li>
 519     <li class="footer">Generated on Wed Apr 12 2017 14:26:06 for ARM Compute Library by
 520     <a href="http://www.doxygen.org/index.html">
 521     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
 522   </ul>
 523 </div>
 524 </body>
 525 </html>