| <!-- 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.11"/> |
| <meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines --> |
| <title>Compute Library: CLScheduler 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="navtreedata.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/searchdata.js"></script> |
| <script type="text/javascript" src="search/search.js"></script> |
| <script type="text/javascript"> |
| $(document).ready(function() { init_search(); }); |
| </script> |
| <script type="text/x-mathjax-config"> |
| MathJax.Hub.Config({ |
| extensions: ["tex2jax.js"], |
| jax: ["input/TeX","output/HTML-CSS"], |
| }); |
| </script><script type="text/javascript" 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">v17.06</span> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.11 --> |
| <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_c_l_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)"> |
| </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">CLScheduler Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Provides global access to a CL context and command queue. |
| <a href="classarm__compute_1_1_c_l_scheduler.xhtml#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="_c_l_scheduler_8h_source.xhtml">CLScheduler.h</a>></code></p> |
| <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:a19bb5002a62b62e050e89c975f7b9fdf"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_scheduler.xhtml#a19bb5002a62b62e050e89c975f7b9fdf">default_init</a> ()</td></tr> |
| <tr class="memdesc:a19bb5002a62b62e050e89c975f7b9fdf"><td class="mdescLeft"> </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> |
| <tr class="separator:a19bb5002a62b62e050e89c975f7b9fdf"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae1a643e517f50bf0392fb6516dd7cf67"><td class="memItemLeft" align="right" valign="top">void </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> &kernel, bool flush=true)</td></tr> |
| <tr class="memdesc:ae1a643e517f50bf0392fb6516dd7cf67"><td class="mdescLeft"> </td><td class="mdescRight">Schedule the execution of the passed kernel if possible. <a href="#ae1a643e517f50bf0392fb6516dd7cf67">More...</a><br /></td></tr> |
| <tr class="separator:ae1a643e517f50bf0392fb6516dd7cf67"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa9fe2840f11a76e52abed7c5f7440516"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_scheduler.xhtml#aa9fe2840f11a76e52abed7c5f7440516">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(), cl::Device device=cl::Device::getDefault())</td></tr> |
| <tr class="memdesc:aa9fe2840f11a76e52abed7c5f7440516"><td class="mdescLeft"> </td><td class="mdescRight">Initialises the context and command queue to be used by the scheduler. <a href="#aa9fe2840f11a76e52abed7c5f7440516">More...</a><br /></td></tr> |
| <tr class="separator:aa9fe2840f11a76e52abed7c5f7440516"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a252f5440564c77d68459f2baa978f86a"><td class="memItemLeft" align="right" valign="top">cl::Context & </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_scheduler.xhtml#a252f5440564c77d68459f2baa978f86a">context</a> ()</td></tr> |
| <tr class="memdesc:a252f5440564c77d68459f2baa978f86a"><td class="mdescLeft"> </td><td class="mdescRight">Accessor for the associated CL context. <a href="#a252f5440564c77d68459f2baa978f86a">More...</a><br /></td></tr> |
| <tr class="separator:a252f5440564c77d68459f2baa978f86a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a293edc1bbcbddffb7228ac97917ed107"><td class="memItemLeft" align="right" valign="top">void </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> |
| <tr class="memdesc:a293edc1bbcbddffb7228ac97917ed107"><td class="mdescLeft"> </td><td class="mdescRight">Accessor to set the CL context to be used by the scheduler. <a href="#a293edc1bbcbddffb7228ac97917ed107">More...</a><br /></td></tr> |
| <tr class="separator:a293edc1bbcbddffb7228ac97917ed107"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad381d1aed28b4b1e1f5a710633934580"><td class="memItemLeft" align="right" valign="top">cl::CommandQueue & </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_scheduler.xhtml#ad381d1aed28b4b1e1f5a710633934580">queue</a> ()</td></tr> |
| <tr class="memdesc:ad381d1aed28b4b1e1f5a710633934580"><td class="mdescLeft"> </td><td class="mdescRight">Accessor for the associated CL command queue. <a href="#ad381d1aed28b4b1e1f5a710633934580">More...</a><br /></td></tr> |
| <tr class="separator:ad381d1aed28b4b1e1f5a710633934580"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2c3dee98cf8bc85e0c6b5749e038bb68"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacearm__compute.xhtml#a735ac6c2a02e320969625308810444f3">GPUTarget</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_scheduler.xhtml#a2c3dee98cf8bc85e0c6b5749e038bb68">target</a> () const </td></tr> |
| <tr class="memdesc:a2c3dee98cf8bc85e0c6b5749e038bb68"><td class="mdescLeft"> </td><td class="mdescRight">Get the target GPU. <a href="#a2c3dee98cf8bc85e0c6b5749e038bb68">More...</a><br /></td></tr> |
| <tr class="separator:a2c3dee98cf8bc85e0c6b5749e038bb68"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9608e5af9f3a199f69ca6aa41b94359a"><td class="memItemLeft" align="right" valign="top">void </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> |
| <tr class="memdesc:a9608e5af9f3a199f69ca6aa41b94359a"><td class="mdescLeft"> </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> |
| <tr class="separator:a9608e5af9f3a199f69ca6aa41b94359a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad5ba9d34a3a855bf1dd2e36316ff550a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_scheduler.xhtml#ad5ba9d34a3a855bf1dd2e36316ff550a">set_target</a> (<a class="el" href="namespacearm__compute.xhtml#a735ac6c2a02e320969625308810444f3">GPUTarget</a> <a class="el" href="classarm__compute_1_1_c_l_scheduler.xhtml#a2c3dee98cf8bc85e0c6b5749e038bb68">target</a>)</td></tr> |
| <tr class="memdesc:ad5ba9d34a3a855bf1dd2e36316ff550a"><td class="mdescLeft"> </td><td class="mdescRight">Accessor to set target GPU to be used by the scheduler. <a href="#ad5ba9d34a3a855bf1dd2e36316ff550a">More...</a><br /></td></tr> |
| <tr class="separator:ad5ba9d34a3a855bf1dd2e36316ff550a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad55f80ed3cd8b6c4f247763b747016af"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_scheduler.xhtml#ad55f80ed3cd8b6c4f247763b747016af">sync</a> ()</td></tr> |
| <tr class="memdesc:ad55f80ed3cd8b6c4f247763b747016af"><td class="mdescLeft"> </td><td class="mdescRight">Blocks until all commands in the associated command queue have finished. <a href="#ad55f80ed3cd8b6c4f247763b747016af">More...</a><br /></td></tr> |
| <tr class="separator:ad55f80ed3cd8b6c4f247763b747016af"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6096d26e8e29e1a7f01b0f083fb7e33f"><td class="memItemLeft" align="right" valign="top">cl::Event </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> |
| <tr class="memdesc:a6096d26e8e29e1a7f01b0f083fb7e33f"><td class="mdescLeft"> </td><td class="mdescRight">Enqueues a marker into the associated command queue and return the event. <a href="#a6096d26e8e29e1a7f01b0f083fb7e33f">More...</a><br /></td></tr> |
| <tr class="separator:a6096d26e8e29e1a7f01b0f083fb7e33f"><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:a60f9a6836b628a7171914c4afe43b4a7"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classarm__compute_1_1_c_l_scheduler.xhtml">CLScheduler</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_scheduler.xhtml#a60f9a6836b628a7171914c4afe43b4a7">get</a> ()</td></tr> |
| <tr class="memdesc:a60f9a6836b628a7171914c4afe43b4a7"><td class="mdescLeft"> </td><td class="mdescRight">Access the scheduler singleton. <a href="#a60f9a6836b628a7171914c4afe43b4a7">More...</a><br /></td></tr> |
| <tr class="separator:a60f9a6836b628a7171914c4afe43b4a7"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Provides global access to a CL context and command queue. </p> |
| |
| <p>Definition at line <a class="el" href="_c_l_scheduler_8h_source.xhtml#l00039">39</a> of file <a class="el" href="_c_l_scheduler_8h_source.xhtml">CLScheduler.h</a>.</p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="a252f5440564c77d68459f2baa978f86a"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">cl::Context& context </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Accessor for the associated CL context. </p> |
| <dl class="section return"><dt>Returns</dt><dd>A CL context. </dd></dl> |
| |
| <p>Definition at line <a class="el" href="_c_l_scheduler_8h_source.xhtml#l00084">84</a> of file <a class="el" href="_c_l_scheduler_8h_source.xhtml">CLScheduler.h</a>.</p> |
| |
| <p>Referenced by <a class="el" href="_c_l_scheduler_8h_source.xhtml#l00072">CLScheduler::init()</a>.</p> |
| <div class="fragment"><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  {</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="keywordflow">return</span> _context;</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  }</div></div><!-- fragment --> |
| </div> |
| </div> |
| <a class="anchor" id="a19bb5002a62b62e050e89c975f7b9fdf"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void default_init </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <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> |
| |
| <p>Definition at line <a class="el" href="_c_l_scheduler_8h_source.xhtml#l00054">54</a> of file <a class="el" href="_c_l_scheduler_8h_source.xhtml">CLScheduler.h</a>.</p> |
| |
| <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#l00072">CLScheduler::init()</a>, and <a class="el" href="_c_l_kernel_library_8h_source.xhtml#l00163">CLKernelLibrary::init()</a>.</p> |
| |
| <p>Referenced by <a class="el" href="_c_l_fixture_8h_source.xhtml#l00039">CLFixture::CLFixture()</a>, <a class="el" href="benchmark_2main_8cpp_source.xhtml#l00054">main()</a>, <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> |
| <div class="fragment"><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  {</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <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">"./cl_kernels/"</span>, cl::Context::getDefault(), cl::Device::getDefault());</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <a class="code" href="classarm__compute_1_1_c_l_scheduler.xhtml#aa9fe2840f11a76e52abed7c5f7440516">init</a>(cl::Context::getDefault(), cl::CommandQueue::getDefault(), cl::Device::getDefault());</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  }</div><div class="ttc" id="classarm__compute_1_1_c_l_scheduler_xhtml_aa9fe2840f11a76e52abed7c5f7440516"><div class="ttname"><a href="classarm__compute_1_1_c_l_scheduler.xhtml#aa9fe2840f11a76e52abed7c5f7440516">arm_compute::CLScheduler::init</a></div><div class="ttdeci">void init(cl::Context context=cl::Context::getDefault(), cl::CommandQueue queue=cl::CommandQueue::getDefault(), cl::Device device=cl::Device::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#l00072">CLScheduler.h:72</a></div></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=".", 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> |
| <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 & get()</div><div class="ttdoc">Access the KernelLibrary singleton. </div></div> |
| </div><!-- fragment --> |
| </div> |
| </div> |
| <a class="anchor" id="ae1a643e517f50bf0392fb6516dd7cf67"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void enqueue </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_c_l_kernel.xhtml">ICLKernel</a> & </td> |
| <td class="paramname"><em>kernel</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>flush</em> = <code>true</code> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Schedule the execution of the passed kernel if possible. </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">flush</td><td>(Optional) Specifies if the command queue will be flushed after running the kernel. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Referenced by <a class="el" href="_c_l_scheduler_8h_source.xhtml#l00054">CLScheduler::default_init()</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a6096d26e8e29e1a7f01b0f083fb7e33f"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">cl::Event enqueue_sync_event </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Enqueues a marker into the associated command queue and return the event. </p> |
| <dl class="section return"><dt>Returns</dt><dd>An event that can be waited on to block the executing thread. </dd></dl> |
| |
| <p>Definition at line <a class="el" href="_c_l_scheduler_8h_source.xhtml#l00144">144</a> of file <a class="el" href="_c_l_scheduler_8h_source.xhtml">CLScheduler.h</a>.</p> |
| |
| <p>Referenced by <a class="el" href="cl__events_8cpp_source.xhtml#l00033">main_cl_events()</a>.</p> |
| <div class="fragment"><div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  {</div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span>  cl::Event event;</div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span>  _queue.enqueueMarker(&event);</div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span> </div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  <span class="keywordflow">return</span> event;</div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  }</div></div><!-- fragment --> |
| </div> |
| </div> |
| <a class="anchor" id="a60f9a6836b628a7171914c4afe43b4a7"></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_c_l_scheduler.xhtml">CLScheduler</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> |
| |
| <p>Referenced by <a class="el" href="_c_l_fixture_8h_source.xhtml#l00039">CLFixture::CLFixture()</a>, <a class="el" href="benchmark_2main_8cpp_source.xhtml#l00054">main()</a>, <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< T >::map()</a>, and <a class="el" href="_c_l_array_8h_source.xhtml#l00068">CLArray< T >::unmap()</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="aa9fe2840f11a76e52abed7c5f7440516"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void init </td> |
| <td>(</td> |
| <td class="paramtype">cl::Context </td> |
| <td class="paramname"><em>context</em> = <code>cl::Context::getDefault()</code>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">cl::CommandQueue </td> |
| <td class="paramname"><em>queue</em> = <code>cl::CommandQueue::getDefault()</code>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">cl::Device </td> |
| <td class="paramname"><em>device</em> = <code>cl::Device::getDefault()</code> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Initialises the context and command queue to be used by the scheduler. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">context</td><td>A CL context. </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">queue</td><td>A CL command queue. </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">device</td><td>A CL device. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Definition at line <a class="el" href="_c_l_scheduler_8h_source.xhtml#l00072">72</a> of file <a class="el" href="_c_l_scheduler_8h_source.xhtml">CLScheduler.h</a>.</p> |
| |
| <p>References <a class="el" href="_c_l_scheduler_8h_source.xhtml#l00084">CLScheduler::context()</a>, <a class="el" href="namespacearm__compute.xhtml#a9d0143bdde8255313aae6ac020dd629c">arm_compute::get_target_from_device()</a>, and <a class="el" href="_c_l_scheduler_8h_source.xhtml#l00102">CLScheduler::queue()</a>.</p> |
| |
| <p>Referenced by <a class="el" href="_c_l_scheduler_8h_source.xhtml#l00054">CLScheduler::default_init()</a>.</p> |
| <div class="fragment"><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  {</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  _context = std::move(<a class="code" href="classarm__compute_1_1_c_l_scheduler.xhtml#a252f5440564c77d68459f2baa978f86a">context</a>);</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  _queue = std::move(<a class="code" href="classarm__compute_1_1_c_l_scheduler.xhtml#ad381d1aed28b4b1e1f5a710633934580">queue</a>);</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  _target = <a class="code" href="namespacearm__compute.xhtml#a9d0143bdde8255313aae6ac020dd629c">get_target_from_device</a>(device);</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  }</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 & 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#l00102">CLScheduler.h:102</a></div></div> |
| <div class="ttc" id="namespacearm__compute_xhtml_a9d0143bdde8255313aae6ac020dd629c"><div class="ttname"><a href="namespacearm__compute.xhtml#a9d0143bdde8255313aae6ac020dd629c">arm_compute::get_target_from_device</a></div><div class="ttdeci">GPUTarget get_target_from_device(cl::Device &device)</div><div class="ttdoc">Helper function to get the GPU target from CL device. </div></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 & 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#l00084">CLScheduler.h:84</a></div></div> |
| </div><!-- fragment --> |
| </div> |
| </div> |
| <a class="anchor" id="ad381d1aed28b4b1e1f5a710633934580"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">cl::CommandQueue& queue </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Accessor for the associated CL command queue. </p> |
| <dl class="section return"><dt>Returns</dt><dd>A CL command queue. </dd></dl> |
| |
| <p>Definition at line <a class="el" href="_c_l_scheduler_8h_source.xhtml#l00102">102</a> of file <a class="el" href="_c_l_scheduler_8h_source.xhtml">CLScheduler.h</a>.</p> |
| |
| <p>Referenced by <a class="el" href="_c_l_scheduler_8h_source.xhtml#l00072">CLScheduler::init()</a>.</p> |
| <div class="fragment"><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  {</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <span class="keywordflow">return</span> _queue;</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  }</div></div><!-- fragment --> |
| </div> |
| </div> |
| <a class="anchor" id="a293edc1bbcbddffb7228ac97917ed107"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void set_context </td> |
| <td>(</td> |
| <td class="paramtype">cl::Context </td> |
| <td class="paramname"><em>context</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Accessor to set the CL context to be used by the scheduler. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">context</td><td>A CL context. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Definition at line <a class="el" href="_c_l_scheduler_8h_source.xhtml#l00093">93</a> of file <a class="el" href="_c_l_scheduler_8h_source.xhtml">CLScheduler.h</a>.</p> |
| <div class="fragment"><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  {</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  _context = std::move(<a class="code" href="classarm__compute_1_1_c_l_scheduler.xhtml#a252f5440564c77d68459f2baa978f86a">context</a>);</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  }</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 & 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#l00084">CLScheduler.h:84</a></div></div> |
| </div><!-- fragment --> |
| </div> |
| </div> |
| <a class="anchor" id="a9608e5af9f3a199f69ca6aa41b94359a"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void set_queue </td> |
| <td>(</td> |
| <td class="paramtype">cl::CommandQueue </td> |
| <td class="paramname"><em>queue</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Accessor to set the CL command queue to be used by the scheduler. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">queue</td><td>A CL command queue. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Definition at line <a class="el" href="_c_l_scheduler_8h_source.xhtml#l00120">120</a> of file <a class="el" href="_c_l_scheduler_8h_source.xhtml">CLScheduler.h</a>.</p> |
| <div class="fragment"><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  {</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  _queue = std::move(<a class="code" href="classarm__compute_1_1_c_l_scheduler.xhtml#ad381d1aed28b4b1e1f5a710633934580">queue</a>);</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  }</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 & 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#l00102">CLScheduler.h:102</a></div></div> |
| </div><!-- fragment --> |
| </div> |
| </div> |
| <a class="anchor" id="ad5ba9d34a3a855bf1dd2e36316ff550a"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void set_target </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="namespacearm__compute.xhtml#a735ac6c2a02e320969625308810444f3">GPUTarget</a> </td> |
| <td class="paramname"><em>target</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Accessor to set target GPU to be used by the scheduler. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">target</td><td>The target GPU. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Definition at line <a class="el" href="_c_l_scheduler_8h_source.xhtml#l00129">129</a> of file <a class="el" href="_c_l_scheduler_8h_source.xhtml">CLScheduler.h</a>.</p> |
| |
| <p>References <a class="el" href="_c_l_scheduler_8h_source.xhtml#l00111">CLScheduler::target()</a>.</p> |
| <div class="fragment"><div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  {</div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  _target = <a class="code" href="classarm__compute_1_1_c_l_scheduler.xhtml#a2c3dee98cf8bc85e0c6b5749e038bb68">target</a>;</div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  }</div><div class="ttc" id="classarm__compute_1_1_c_l_scheduler_xhtml_a2c3dee98cf8bc85e0c6b5749e038bb68"><div class="ttname"><a href="classarm__compute_1_1_c_l_scheduler.xhtml#a2c3dee98cf8bc85e0c6b5749e038bb68">arm_compute::CLScheduler::target</a></div><div class="ttdeci">GPUTarget target() const </div><div class="ttdoc">Get the target GPU. </div><div class="ttdef"><b>Definition:</b> <a href="_c_l_scheduler_8h_source.xhtml#l00111">CLScheduler.h:111</a></div></div> |
| </div><!-- fragment --> |
| </div> |
| </div> |
| <a class="anchor" id="ad55f80ed3cd8b6c4f247763b747016af"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void sync </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Blocks until all commands in the associated command queue have finished. </p> |
| |
| <p>Definition at line <a class="el" href="_c_l_scheduler_8h_source.xhtml#l00135">135</a> of file <a class="el" href="_c_l_scheduler_8h_source.xhtml">CLScheduler.h</a>.</p> |
| |
| <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> |
| <div class="fragment"><div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  {</div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  _queue.finish();</div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  }</div></div><!-- fragment --> |
| </div> |
| </div> |
| <a class="anchor" id="a2c3dee98cf8bc85e0c6b5749e038bb68"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="namespacearm__compute.xhtml#a735ac6c2a02e320969625308810444f3">GPUTarget</a> target </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">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get the target GPU. </p> |
| <dl class="section return"><dt>Returns</dt><dd>The target GPU. </dd></dl> |
| |
| <p>Definition at line <a class="el" href="_c_l_scheduler_8h_source.xhtml#l00111">111</a> of file <a class="el" href="_c_l_scheduler_8h_source.xhtml">CLScheduler.h</a>.</p> |
| |
| <p>Referenced by <a class="el" href="_c_l_scheduler_8h_source.xhtml#l00129">CLScheduler::set_target()</a>.</p> |
| <div class="fragment"><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  {</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  <span class="keywordflow">return</span> _target;</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  }</div></div><!-- fragment --> |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>arm_compute/runtime/CL/<a class="el" href="_c_l_scheduler_8h_source.xhtml">CLScheduler.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_c_l_scheduler.xhtml">CLScheduler</a></li> |
| <li class="footer">Generated on Fri Jun 23 2017 15:44:35 for Compute Library by |
| <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li> |
| </ul> |
| </div> |
| </body> |
| </html> |
