| <!-- 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: arm_compute/runtime/Scheduler.h Source File</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.10</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><a href="annotated.xhtml"><span>Data Structures</span></a></li> |
| <li class="current"><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="files.xhtml"><span>File List</span></a></li> |
| <li><a href="globals.xhtml"><span>Globals</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('_scheduler_8h_source.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="headertitle"> |
| <div class="title">Scheduler.h</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="_scheduler_8h.xhtml">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div> |
| <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Copyright (c) 2017 ARM Limited.</span></div> |
| <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * SPDX-License-Identifier: MIT</span></div> |
| <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * Permission is hereby granted, free of charge, to any person obtaining a copy</span></div> |
| <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * of this software and associated documentation files (the "Software"), to</span></div> |
| <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * deal in the Software without restriction, including without limitation the</span></div> |
| <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or</span></div> |
| <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * sell copies of the Software, and to permit persons to whom the Software is</span></div> |
| <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * furnished to do so, subject to the following conditions:</span></div> |
| <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * The above copyright notice and this permission notice shall be included in all</span></div> |
| <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * copies or substantial portions of the Software.</span></div> |
| <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span></div> |
| <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span></div> |
| <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span></div> |
| <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span></div> |
| <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,</span></div> |
| <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE</span></div> |
| <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> * SOFTWARE.</span></div> |
| <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> */</span></div> |
| <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#ifndef __ARM_COMPUTE_SCHEDULER_H__</span></div> |
| <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor"></span><span class="preprocessor">#define __ARM_COMPUTE_SCHEDULER_H__</span></div> |
| <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor"></span></div> |
| <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include "<a class="code" href="_i_scheduler_8h.xhtml">arm_compute/runtime/IScheduler.h</a>"</span></div> |
| <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include <memory></span></div> |
| <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div> |
| <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">namespace </span>arm_compute</div> |
| <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> {</div> |
| <div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="classarm__compute_1_1_scheduler.xhtml"> 33</a></span> <span class="keyword">class </span><a class="code" href="classarm__compute_1_1_scheduler.xhtml">Scheduler</a></div> |
| <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> {</div> |
| <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">public</span>:</div> |
| <div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="classarm__compute_1_1_scheduler.xhtml#a1d1cfd8ffb84e947f82999c682b666a7"> 36</a></span>  <span class="keyword">enum class</span> <a class="code" href="classarm__compute_1_1_scheduler.xhtml#a1d1cfd8ffb84e947f82999c682b666a7">Type</a></div> |
| <div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  {</div> |
| <div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <a class="code" href="classarm__compute_1_1_scheduler.xhtml#a1d1cfd8ffb84e947f82999c682b666a7aec8e57d71f07e31203035548b79d03c8">ST</a>, <span class="comment">// Single thread.</span></div> |
| <div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <a class="code" href="classarm__compute_1_1_scheduler.xhtml#a1d1cfd8ffb84e947f82999c682b666a7a4c162442ef22c58f6f1e330e6b692c7e">CPP</a>, <span class="comment">// C++11 threads.</span></div> |
| <div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <a class="code" href="classarm__compute_1_1_scheduler.xhtml#a1d1cfd8ffb84e947f82999c682b666a7a6a1f3212967c1a0ff6774f09de77330f">OMP</a>, <span class="comment">// OpenMP.</span></div> |
| <div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <a class="code" href="classarm__compute_1_1_scheduler.xhtml#a1d1cfd8ffb84e947f82999c682b666a7a72baef04098f035e8a320b03ad197818">CUSTOM</a> <span class="comment">// Provided by the user.</span></div> |
| <div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  };</div> |
| <div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classarm__compute_1_1_scheduler.xhtml#aa35fa7aa123444c798c28d4ac8fe7546">set</a>(std::shared_ptr<IScheduler> &scheduler);</div> |
| <div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keyword">static</span> <a class="code" href="classarm__compute_1_1_i_scheduler.xhtml">IScheduler</a> &<span class="keyword">get</span>();</div> |
| <div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classarm__compute_1_1_scheduler.xhtml#aa35fa7aa123444c798c28d4ac8fe7546">set</a>(<a class="code" href="classarm__compute_1_1_scheduler.xhtml#a1d1cfd8ffb84e947f82999c682b666a7">Type</a> t);</div> |
| <div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keyword">static</span> <a class="code" href="classarm__compute_1_1_scheduler.xhtml#a1d1cfd8ffb84e947f82999c682b666a7">Type</a> <a class="code" href="classarm__compute_1_1_scheduler.xhtml#ab394515f710c2aac0f132ecc0b9323d9">get_type</a>();</div> |
| <div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="classarm__compute_1_1_scheduler.xhtml#a48fc7759128070abe76ddecafd90cd0f">is_available</a>(<a class="code" href="classarm__compute_1_1_scheduler.xhtml#a1d1cfd8ffb84e947f82999c682b666a7">Type</a> t);</div> |
| <div class="line"><a name="l00070"></a><span class="lineno"> 70</span> </div> |
| <div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="keyword">private</span>:</div> |
| <div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keyword">static</span> <a class="code" href="classarm__compute_1_1_scheduler.xhtml#a1d1cfd8ffb84e947f82999c682b666a7">Type</a> _scheduler_type;</div> |
| <div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keyword">static</span> std::shared_ptr<IScheduler> _custom_scheduler;</div> |
| <div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <a class="code" href="classarm__compute_1_1_scheduler.xhtml">Scheduler</a>();</div> |
| <div class="line"><a name="l00075"></a><span class="lineno"> 75</span> };</div> |
| <div class="line"><a name="l00076"></a><span class="lineno"> 76</span> }</div> |
| <div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="preprocessor">#endif </span><span class="comment">/* __ARM_COMPUTE_SCHEDULER_H__ */</span><span class="preprocessor"></span></div> |
| <div class="ttc" id="classarm__compute_1_1_scheduler_xhtml_a1d1cfd8ffb84e947f82999c682b666a7"><div class="ttname"><a href="classarm__compute_1_1_scheduler.xhtml#a1d1cfd8ffb84e947f82999c682b666a7">arm_compute::Scheduler::Type</a></div><div class="ttdeci">Type</div><div class="ttdef"><b>Definition:</b> <a href="_scheduler_8h_source.xhtml#l00036">Scheduler.h:36</a></div></div> |
| <div class="ttc" id="classarm__compute_1_1_scheduler_xhtml_ab394515f710c2aac0f132ecc0b9323d9"><div class="ttname"><a href="classarm__compute_1_1_scheduler.xhtml#ab394515f710c2aac0f132ecc0b9323d9">arm_compute::Scheduler::get_type</a></div><div class="ttdeci">static Type get_type()</div><div class="ttdoc">Returns the type of the active scheduler. </div></div> |
| <div class="ttc" id="_i_scheduler_8h_xhtml"><div class="ttname"><a href="_i_scheduler_8h.xhtml">IScheduler.h</a></div></div> |
| <div class="ttc" id="classarm__compute_1_1_i_scheduler_xhtml"><div class="ttname"><a href="classarm__compute_1_1_i_scheduler.xhtml">arm_compute::IScheduler</a></div><div class="ttdoc">Scheduler interface to run kernels. </div><div class="ttdef"><b>Definition:</b> <a href="_i_scheduler_8h_source.xhtml#l00034">IScheduler.h:34</a></div></div> |
| <div class="ttc" id="classarm__compute_1_1_scheduler_xhtml_a1d1cfd8ffb84e947f82999c682b666a7a6a1f3212967c1a0ff6774f09de77330f"><div class="ttname"><a href="classarm__compute_1_1_scheduler.xhtml#a1d1cfd8ffb84e947f82999c682b666a7a6a1f3212967c1a0ff6774f09de77330f">arm_compute::Scheduler::Type::OMP</a></div></div> |
| <div class="ttc" id="classarm__compute_1_1_scheduler_xhtml_a1d1cfd8ffb84e947f82999c682b666a7aec8e57d71f07e31203035548b79d03c8"><div class="ttname"><a href="classarm__compute_1_1_scheduler.xhtml#a1d1cfd8ffb84e947f82999c682b666a7aec8e57d71f07e31203035548b79d03c8">arm_compute::Scheduler::Type::ST</a></div></div> |
| <div class="ttc" id="classarm__compute_1_1_scheduler_xhtml_a48fc7759128070abe76ddecafd90cd0f"><div class="ttname"><a href="classarm__compute_1_1_scheduler.xhtml#a48fc7759128070abe76ddecafd90cd0f">arm_compute::Scheduler::is_available</a></div><div class="ttdeci">static bool is_available(Type t)</div><div class="ttdoc">Returns true if the given scheduler type is supported. </div></div> |
| <div class="ttc" id="classarm__compute_1_1_scheduler_xhtml_a1d1cfd8ffb84e947f82999c682b666a7a72baef04098f035e8a320b03ad197818"><div class="ttname"><a href="classarm__compute_1_1_scheduler.xhtml#a1d1cfd8ffb84e947f82999c682b666a7a72baef04098f035e8a320b03ad197818">arm_compute::Scheduler::Type::CUSTOM</a></div></div> |
| <div class="ttc" id="classarm__compute_1_1_scheduler_xhtml"><div class="ttname"><a href="classarm__compute_1_1_scheduler.xhtml">arm_compute::Scheduler</a></div><div class="ttdoc">Configurable scheduler which supports multiple multithreading APIs and choosing between different sch...</div><div class="ttdef"><b>Definition:</b> <a href="_scheduler_8h_source.xhtml#l00033">Scheduler.h:33</a></div></div> |
| <div class="ttc" id="classarm__compute_1_1_scheduler_xhtml_aa35fa7aa123444c798c28d4ac8fe7546"><div class="ttname"><a href="classarm__compute_1_1_scheduler.xhtml#aa35fa7aa123444c798c28d4ac8fe7546">arm_compute::Scheduler::set</a></div><div class="ttdeci">static void set(std::shared_ptr< IScheduler > &scheduler)</div><div class="ttdoc">Sets the user defined scheduler and makes it the active scheduler. </div></div> |
| <div class="ttc" id="classarm__compute_1_1_scheduler_xhtml_a1d1cfd8ffb84e947f82999c682b666a7a4c162442ef22c58f6f1e330e6b692c7e"><div class="ttname"><a href="classarm__compute_1_1_scheduler.xhtml#a1d1cfd8ffb84e947f82999c682b666a7a4c162442ef22c58f6f1e330e6b692c7e">arm_compute::Scheduler::Type::CPP</a></div></div> |
| </div><!-- fragment --></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="dir_d4d363c0979c7ffda4833df3f93b5668.xhtml">arm_compute</a></li><li class="navelem"><a class="el" href="dir_9464f60aea3c9b524aea6b3ae09a377f.xhtml">runtime</a></li><li class="navelem"><a class="el" href="_scheduler_8h.xhtml">Scheduler.h</a></li> |
| <li class="footer">Generated on Thu Oct 12 2017 14:26:33 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> |