| <!-- 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.6"/> |
| <meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines --> |
| <title>Compute Library: CLKernelLibrary 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="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/search.js"></script> |
| <script type="text/javascript"> |
| $(document).ready(function() { searchBox.OnSelectItem(0); }); |
| </script> |
| <script type="text/x-mathjax-config"> |
| MathJax.Hub.Config({ |
| extensions: ["tex2jax.js"], |
| jax: ["input/TeX","output/HTML-CSS"], |
| }); |
| </script><script 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">17.09</span> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.6 --> |
| <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_kernel_library.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)"> |
| <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> |
| |
| <!-- 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">CLKernelLibrary Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p><a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml" title="CLKernelLibrary class. ">CLKernelLibrary</a> class. |
| <a href="classarm__compute_1_1_c_l_kernel_library.xhtml#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="_c_l_kernel_library_8h_source.xhtml">CLKernelLibrary.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:a670869004281695200784de4648a4e1b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml#a670869004281695200784de4648a4e1b">CLKernelLibrary</a> (const <a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml">CLKernelLibrary</a> &)=delete</td></tr> |
| <tr class="memdesc:a670869004281695200784de4648a4e1b"><td class="mdescLeft"> </td><td class="mdescRight">Prevent instances of this class from being copied. <a href="#a670869004281695200784de4648a4e1b">More...</a><br/></td></tr> |
| <tr class="separator:a670869004281695200784de4648a4e1b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a54fb81956f9fb1c25b279e34e1e7d966"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml">CLKernelLibrary</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml#a54fb81956f9fb1c25b279e34e1e7d966">operator=</a> (const <a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml">CLKernelLibrary</a> &)=delete</td></tr> |
| <tr class="memdesc:a54fb81956f9fb1c25b279e34e1e7d966"><td class="mdescLeft"> </td><td class="mdescRight">Prevent instances of this class from being copied. <a href="#a54fb81956f9fb1c25b279e34e1e7d966">More...</a><br/></td></tr> |
| <tr class="separator:a54fb81956f9fb1c25b279e34e1e7d966"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af353532ea782387df6bcb6d01894f4ae"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml#af353532ea782387df6bcb6d01894f4ae">init</a> (std::string kernel_path=".", cl::Context context=cl::Context::getDefault(), cl::Device device=cl::Device::getDefault())</td></tr> |
| <tr class="memdesc:af353532ea782387df6bcb6d01894f4ae"><td class="mdescLeft"> </td><td class="mdescRight">Initialises the kernel library. <a href="#af353532ea782387df6bcb6d01894f4ae">More...</a><br/></td></tr> |
| <tr class="separator:af353532ea782387df6bcb6d01894f4ae"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a66a558a56f5d0dcd6305c405ebc38cc2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml#a66a558a56f5d0dcd6305c405ebc38cc2">set_kernel_path</a> (const std::string &kernel_path)</td></tr> |
| <tr class="memdesc:a66a558a56f5d0dcd6305c405ebc38cc2"><td class="mdescLeft"> </td><td class="mdescRight">Sets the path that the kernels reside in. <a href="#a66a558a56f5d0dcd6305c405ebc38cc2">More...</a><br/></td></tr> |
| <tr class="separator:a66a558a56f5d0dcd6305c405ebc38cc2"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad7395c158d8e31b9af211b9bc1f65a08"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml#ad7395c158d8e31b9af211b9bc1f65a08">get_kernel_path</a> ()</td></tr> |
| <tr class="memdesc:ad7395c158d8e31b9af211b9bc1f65a08"><td class="mdescLeft"> </td><td class="mdescRight">Gets the path that the kernels reside in. <a href="#ad7395c158d8e31b9af211b9bc1f65a08">More...</a><br/></td></tr> |
| <tr class="separator:ad7395c158d8e31b9af211b9bc1f65a08"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a44e90c4fa1204a708499ece56d4c82f0"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml#a44e90c4fa1204a708499ece56d4c82f0">get_program_source</a> (const std::string &program_name)</td></tr> |
| <tr class="memdesc:a44e90c4fa1204a708499ece56d4c82f0"><td class="mdescLeft"> </td><td class="mdescRight">Gets the source of the selected program. <a href="#a44e90c4fa1204a708499ece56d4c82f0">More...</a><br/></td></tr> |
| <tr class="separator:a44e90c4fa1204a708499ece56d4c82f0"><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_kernel_library.xhtml#a293edc1bbcbddffb7228ac97917ed107">set_context</a> (cl::Context context)</td></tr> |
| <tr class="memdesc:a293edc1bbcbddffb7228ac97917ed107"><td class="mdescLeft"> </td><td class="mdescRight">Sets the CL context used to create programs. <a href="#a293edc1bbcbddffb7228ac97917ed107">More...</a><br/></td></tr> |
| <tr class="separator:a293edc1bbcbddffb7228ac97917ed107"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5a6865d04c8d3348860f3cb8100fdb97"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml#a5a6865d04c8d3348860f3cb8100fdb97">set_device</a> (cl::Device device)</td></tr> |
| <tr class="memdesc:a5a6865d04c8d3348860f3cb8100fdb97"><td class="mdescLeft"> </td><td class="mdescRight">Sets the CL device for which the programs are created. <a href="#a5a6865d04c8d3348860f3cb8100fdb97">More...</a><br/></td></tr> |
| <tr class="separator:a5a6865d04c8d3348860f3cb8100fdb97"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a07b37240bd1f09e36cf119dced79f9c4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_kernel.xhtml">Kernel</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml#a07b37240bd1f09e36cf119dced79f9c4">create_kernel</a> (const std::string &kernel_name, const StringSet &build_options_set={}) const </td></tr> |
| <tr class="memdesc:a07b37240bd1f09e36cf119dced79f9c4"><td class="mdescLeft"> </td><td class="mdescRight">Creates a kernel from the kernel library. <a href="#a07b37240bd1f09e36cf119dced79f9c4">More...</a><br/></td></tr> |
| <tr class="separator:a07b37240bd1f09e36cf119dced79f9c4"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7c0b2aa80e920344936e8e7dbaa73e43"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml#a7c0b2aa80e920344936e8e7dbaa73e43">save_binary</a> ()</td></tr> |
| <tr class="memdesc:a7c0b2aa80e920344936e8e7dbaa73e43"><td class="mdescLeft"> </td><td class="mdescRight">Serializes and saves programs to a binary. <a href="#a7c0b2aa80e920344936e8e7dbaa73e43">More...</a><br/></td></tr> |
| <tr class="separator:a7c0b2aa80e920344936e8e7dbaa73e43"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a389a543ae040ca6bf6b57fd6215f154b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml#a389a543ae040ca6bf6b57fd6215f154b">load_binary</a> ()</td></tr> |
| <tr class="memdesc:a389a543ae040ca6bf6b57fd6215f154b"><td class="mdescLeft"> </td><td class="mdescRight">Load serialized binary with all the programs. <a href="#a389a543ae040ca6bf6b57fd6215f154b">More...</a><br/></td></tr> |
| <tr class="separator:a389a543ae040ca6bf6b57fd6215f154b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a69db47516e8f80b6c29c9c3fd5da1e60"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml#a69db47516e8f80b6c29c9c3fd5da1e60">max_local_workgroup_size</a> ()</td></tr> |
| <tr class="memdesc:a69db47516e8f80b6c29c9c3fd5da1e60"><td class="mdescLeft"> </td><td class="mdescRight">Find the maximum number of local work items in a workgroup can be supported by the device. <a href="#a69db47516e8f80b6c29c9c3fd5da1e60">More...</a><br/></td></tr> |
| <tr class="separator:a69db47516e8f80b6c29c9c3fd5da1e60"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5a02c8fbe0324dbb3703feb09cc4da8d"><td class="memItemLeft" align="right" valign="top">cl::NDRange </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml#a5a02c8fbe0324dbb3703feb09cc4da8d">default_ndrange</a> ()</td></tr> |
| <tr class="memdesc:a5a02c8fbe0324dbb3703feb09cc4da8d"><td class="mdescLeft"> </td><td class="mdescRight">Return the default NDRange that is suitable for the device. <a href="#a5a02c8fbe0324dbb3703feb09cc4da8d">More...</a><br/></td></tr> |
| <tr class="separator:a5a02c8fbe0324dbb3703feb09cc4da8d"><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:aebe2d25607545d31f2b1ace6d60a81da"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml">CLKernelLibrary</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml#aebe2d25607545d31f2b1ace6d60a81da">get</a> ()</td></tr> |
| <tr class="memdesc:aebe2d25607545d31f2b1ace6d60a81da"><td class="mdescLeft"> </td><td class="mdescRight">Access the KernelLibrary singleton. <a href="#aebe2d25607545d31f2b1ace6d60a81da">More...</a><br/></td></tr> |
| <tr class="separator:aebe2d25607545d31f2b1ace6d60a81da"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p><a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml" title="CLKernelLibrary class. ">CLKernelLibrary</a> class. </p> |
| |
| <p>Definition at line <a class="el" href="_c_l_kernel_library_8h_source.xhtml#l00140">140</a> of file <a class="el" href="_c_l_kernel_library_8h_source.xhtml">CLKernelLibrary.h</a>.</p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a class="anchor" id="a670869004281695200784de4648a4e1b"></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="classarm__compute_1_1_c_l_kernel_library.xhtml">CLKernelLibrary</a> </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml">CLKernelLibrary</a> & </td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">delete</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Prevent instances of this class from being copied. </p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="a07b37240bd1f09e36cf119dced79f9c4"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classarm__compute_1_1_kernel.xhtml">Kernel</a> create_kernel </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>kernel_name</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const StringSet & </td> |
| <td class="paramname"><em>build_options_set</em> = <code>{}</code> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Creates a kernel from the kernel library. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">kernel_name</td><td><a class="el" href="classarm__compute_1_1_kernel.xhtml" title="Kernel class. ">Kernel</a> name. </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">build_options_set</td><td><a class="el" href="classarm__compute_1_1_kernel.xhtml" title="Kernel class. ">Kernel</a> build options as a set.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>The created kernel. </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a5a02c8fbe0324dbb3703feb09cc4da8d"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">cl::NDRange default_ndrange </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Return the default NDRange that is suitable for the device. </p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="aebe2d25607545d31f2b1ace6d60a81da"></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_kernel_library.xhtml">CLKernelLibrary</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 KernelLibrary singleton. </p> |
| <dl class="section return"><dt>Returns</dt><dd>The KernelLibrary instance. </dd></dl> |
| |
| <p>Referenced by <a class="el" href="_c_l_scheduler_8h_source.xhtml#l00061">CLScheduler::default_init()</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ad7395c158d8e31b9af211b9bc1f65a08"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::string get_kernel_path </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>Gets the path that the kernels reside in. </p> |
| |
| <p>Definition at line <a class="el" href="_c_l_kernel_library_8h_source.xhtml#l00181">181</a> of file <a class="el" href="_c_l_kernel_library_8h_source.xhtml">CLKernelLibrary.h</a>.</p> |
| <div class="fragment"><div class="line"><a name="l00182"></a><span class="lineno"> 182</span>  {</div> |
| <div class="line"><a name="l00183"></a><span class="lineno"> 183</span>  <span class="keywordflow">return</span> _kernel_path;</div> |
| <div class="line"><a name="l00184"></a><span class="lineno"> 184</span>  };</div> |
| </div><!-- fragment --> |
| </div> |
| </div> |
| <a class="anchor" id="a44e90c4fa1204a708499ece56d4c82f0"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::string get_program_source </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>program_name</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Gets the source of the selected program. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">program_name</td><td><a class="el" href="classarm__compute_1_1_program.xhtml" title="Program class. ">Program</a> name. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="af353532ea782387df6bcb6d01894f4ae"></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">std::string </td> |
| <td class="paramname"><em>kernel_path</em> = <code>"."</code>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></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::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 kernel library. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">kernel_path</td><td>(Optional) Path of the directory from which kernel sources are loaded. </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">context</td><td>(Optional) CL context used to create programs. </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">device</td><td>(Optional) CL device for which the programs are created. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Definition at line <a class="el" href="_c_l_kernel_library_8h_source.xhtml#l00163">163</a> of file <a class="el" href="_c_l_kernel_library_8h_source.xhtml">CLKernelLibrary.h</a>.</p> |
| |
| <p>References <a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml#a69db47516e8f80b6c29c9c3fd5da1e60">CLKernelLibrary::max_local_workgroup_size()</a>.</p> |
| |
| <p>Referenced by <a class="el" href="_c_l_scheduler_8h_source.xhtml#l00061">CLScheduler::default_init()</a>.</p> |
| <div class="fragment"><div class="line"><a name="l00164"></a><span class="lineno"> 164</span>  {</div> |
| <div class="line"><a name="l00165"></a><span class="lineno"> 165</span>  _kernel_path = std::move(kernel_path);</div> |
| <div class="line"><a name="l00166"></a><span class="lineno"> 166</span>  _context = std::move(context);</div> |
| <div class="line"><a name="l00167"></a><span class="lineno"> 167</span>  _device = std::move(device);</div> |
| <div class="line"><a name="l00168"></a><span class="lineno"> 168</span>  _max_workgroup_size = 0;</div> |
| <div class="line"><a name="l00169"></a><span class="lineno"> 169</span>  <a class="code" href="classarm__compute_1_1_c_l_kernel_library.xhtml#a69db47516e8f80b6c29c9c3fd5da1e60">max_local_workgroup_size</a>();</div> |
| <div class="line"><a name="l00170"></a><span class="lineno"> 170</span>  }</div> |
| <div class="ttc" id="classarm__compute_1_1_c_l_kernel_library_xhtml_a69db47516e8f80b6c29c9c3fd5da1e60"><div class="ttname"><a href="classarm__compute_1_1_c_l_kernel_library.xhtml#a69db47516e8f80b6c29c9c3fd5da1e60">arm_compute::CLKernelLibrary::max_local_workgroup_size</a></div><div class="ttdeci">size_t max_local_workgroup_size()</div><div class="ttdoc">Find the maximum number of local work items in a workgroup can be supported by the device...</div></div> |
| </div><!-- fragment --> |
| </div> |
| </div> |
| <a class="anchor" id="a389a543ae040ca6bf6b57fd6215f154b"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void load_binary </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Load serialized binary with all the programs. </p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a69db47516e8f80b6c29c9c3fd5da1e60"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">size_t max_local_workgroup_size </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Find the maximum number of local work items in a workgroup can be supported by the device. </p> |
| |
| <p>Referenced by <a class="el" href="_c_l_kernel_library_8h_source.xhtml#l00163">CLKernelLibrary::init()</a>, <a class="el" href="_c_l_kernel_library_8h_source.xhtml#l00197">CLKernelLibrary::set_context()</a>, and <a class="el" href="_c_l_kernel_library_8h_source.xhtml#l00219">CLKernelLibrary::set_device()</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a54fb81956f9fb1c25b279e34e1e7d966"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const <a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml">CLKernelLibrary</a>& operator= </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml">CLKernelLibrary</a> & </td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">delete</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Prevent instances of this class from being copied. </p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a7c0b2aa80e920344936e8e7dbaa73e43"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void save_binary </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Serializes and saves programs to a binary. </p> |
| |
| </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>Sets the CL context used to create programs. </p> |
| <dl class="section note"><dt>Note</dt><dd>Setting the context also resets the device to the first one available in the new context.</dd></dl> |
| <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_kernel_library_8h_source.xhtml#l00197">197</a> of file <a class="el" href="_c_l_kernel_library_8h_source.xhtml">CLKernelLibrary.h</a>.</p> |
| |
| <p>References <a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml#a69db47516e8f80b6c29c9c3fd5da1e60">CLKernelLibrary::max_local_workgroup_size()</a>.</p> |
| <div class="fragment"><div class="line"><a name="l00198"></a><span class="lineno"> 198</span>  {</div> |
| <div class="line"><a name="l00199"></a><span class="lineno"> 199</span>  _context = std::move(context);</div> |
| <div class="line"><a name="l00200"></a><span class="lineno"> 200</span> </div> |
| <div class="line"><a name="l00201"></a><span class="lineno"> 201</span>  <span class="keyword">const</span> <span class="keyword">auto</span> cl_devices = _context.getInfo<CL_CONTEXT_DEVICES>();</div> |
| <div class="line"><a name="l00202"></a><span class="lineno"> 202</span> </div> |
| <div class="line"><a name="l00203"></a><span class="lineno"> 203</span>  <span class="keywordflow">if</span>(cl_devices.empty())</div> |
| <div class="line"><a name="l00204"></a><span class="lineno"> 204</span>  {</div> |
| <div class="line"><a name="l00205"></a><span class="lineno"> 205</span>  _device = cl::Device();</div> |
| <div class="line"><a name="l00206"></a><span class="lineno"> 206</span>  }</div> |
| <div class="line"><a name="l00207"></a><span class="lineno"> 207</span>  <span class="keywordflow">else</span></div> |
| <div class="line"><a name="l00208"></a><span class="lineno"> 208</span>  {</div> |
| <div class="line"><a name="l00209"></a><span class="lineno"> 209</span>  _device = cl_devices[0];</div> |
| <div class="line"><a name="l00210"></a><span class="lineno"> 210</span>  }</div> |
| <div class="line"><a name="l00211"></a><span class="lineno"> 211</span> </div> |
| <div class="line"><a name="l00212"></a><span class="lineno"> 212</span>  _max_workgroup_size = 0;</div> |
| <div class="line"><a name="l00213"></a><span class="lineno"> 213</span>  <a class="code" href="classarm__compute_1_1_c_l_kernel_library.xhtml#a69db47516e8f80b6c29c9c3fd5da1e60">max_local_workgroup_size</a>();</div> |
| <div class="line"><a name="l00214"></a><span class="lineno"> 214</span>  };</div> |
| <div class="ttc" id="classarm__compute_1_1_c_l_kernel_library_xhtml_a69db47516e8f80b6c29c9c3fd5da1e60"><div class="ttname"><a href="classarm__compute_1_1_c_l_kernel_library.xhtml#a69db47516e8f80b6c29c9c3fd5da1e60">arm_compute::CLKernelLibrary::max_local_workgroup_size</a></div><div class="ttdeci">size_t max_local_workgroup_size()</div><div class="ttdoc">Find the maximum number of local work items in a workgroup can be supported by the device...</div></div> |
| </div><!-- fragment --> |
| </div> |
| </div> |
| <a class="anchor" id="a5a6865d04c8d3348860f3cb8100fdb97"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void set_device </td> |
| <td>(</td> |
| <td class="paramtype">cl::Device </td> |
| <td class="paramname"><em>device</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>Sets the CL device for which the programs are created. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <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_kernel_library_8h_source.xhtml#l00219">219</a> of file <a class="el" href="_c_l_kernel_library_8h_source.xhtml">CLKernelLibrary.h</a>.</p> |
| |
| <p>References <a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml#a69db47516e8f80b6c29c9c3fd5da1e60">CLKernelLibrary::max_local_workgroup_size()</a>.</p> |
| <div class="fragment"><div class="line"><a name="l00220"></a><span class="lineno"> 220</span>  {</div> |
| <div class="line"><a name="l00221"></a><span class="lineno"> 221</span>  _device = std::move(device);</div> |
| <div class="line"><a name="l00222"></a><span class="lineno"> 222</span>  _max_workgroup_size = 0;</div> |
| <div class="line"><a name="l00223"></a><span class="lineno"> 223</span>  <a class="code" href="classarm__compute_1_1_c_l_kernel_library.xhtml#a69db47516e8f80b6c29c9c3fd5da1e60">max_local_workgroup_size</a>();</div> |
| <div class="line"><a name="l00224"></a><span class="lineno"> 224</span>  };</div> |
| <div class="ttc" id="classarm__compute_1_1_c_l_kernel_library_xhtml_a69db47516e8f80b6c29c9c3fd5da1e60"><div class="ttname"><a href="classarm__compute_1_1_c_l_kernel_library.xhtml#a69db47516e8f80b6c29c9c3fd5da1e60">arm_compute::CLKernelLibrary::max_local_workgroup_size</a></div><div class="ttdeci">size_t max_local_workgroup_size()</div><div class="ttdoc">Find the maximum number of local work items in a workgroup can be supported by the device...</div></div> |
| </div><!-- fragment --> |
| </div> |
| </div> |
| <a class="anchor" id="a66a558a56f5d0dcd6305c405ebc38cc2"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void set_kernel_path </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>kernel_path</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>Sets the path that the kernels reside in. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">kernel_path</td><td>Path of the kernel. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Definition at line <a class="el" href="_c_l_kernel_library_8h_source.xhtml#l00175">175</a> of file <a class="el" href="_c_l_kernel_library_8h_source.xhtml">CLKernelLibrary.h</a>.</p> |
| <div class="fragment"><div class="line"><a name="l00176"></a><span class="lineno"> 176</span>  {</div> |
| <div class="line"><a name="l00177"></a><span class="lineno"> 177</span>  _kernel_path = kernel_path;</div> |
| <div class="line"><a name="l00178"></a><span class="lineno"> 178</span>  };</div> |
| </div><!-- fragment --> |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>arm_compute/core/CL/<a class="el" href="_c_l_kernel_library_8h_source.xhtml">CLKernelLibrary.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_kernel_library.xhtml">CLKernelLibrary</a></li> |
| <li class="footer">Generated on Thu Sep 28 2017 14:37:55 for Compute Library by |
| <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li> |
| </ul> |
| </div> |
| </body> |
| </html> |
