documentation/classarm__compute_1_1_c_l_build_options.xhtml

   1 <!-- HTML header for doxygen 1.8.9.1-->
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml">
   4 <head>
   5 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   6 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
   7 <meta name="generator" content="Doxygen 1.8.11"/>
   8 <meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines -->
   9 <title>Compute Library: CLBuildOptions Class Reference</title>
  10 <link href="tabs.css" rel="stylesheet" type="text/css"/>
  11 <script type="text/javascript" src="jquery.js"></script>
  12 <script type="text/javascript" src="dynsections.js"></script>
  13 <link href="navtree.css" rel="stylesheet" type="text/css"/>
  14 <script type="text/javascript" src="resize.js"></script>
  15 <script type="text/javascript" src="navtreedata.js"></script>
  16 <script type="text/javascript" src="navtree.js"></script>
  17 <script type="text/javascript">
  18   $(document).ready(initResizable);
  19   $(window).load(resizeHeight);
  20 </script>
  21 <link href="search/search.css" rel="stylesheet" type="text/css"/>
  22 <script type="text/javascript" src="search/searchdata.js"></script>
  23 <script type="text/javascript" src="search/search.js"></script>
  24 <script type="text/javascript">
  25   $(document).ready(function() { init_search(); });
  26 </script>
  27 <script type="text/x-mathjax-config">
  28   MathJax.Hub.Config({
  29     extensions: ["tex2jax.js"],
  30     jax: ["input/TeX","output/HTML-CSS"],
  31 });
  32 </script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
  33 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  34 </head>
  35 <body>
  36 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  37 <div id="titlearea">
  38 <table cellspacing="0" cellpadding="0">
  39  <tbody>
  40  <tr style="height: 56px;">
  41   <td style="padding-left: 0.5em;">
  42    <div id="projectname">Compute Library
  43    &#160;<span id="projectnumber">18.05</span>
  44    </div>
  45   </td>
  46  </tr>
  47  </tbody>
  48 </table>
  49 </div>
  50 <!-- end header part -->
  51 <!-- Generated by Doxygen 1.8.11 -->
  52 <script type="text/javascript">
  53 var searchBox = new SearchBox("searchBox", "search",false,'Search');
  54 </script>
  55   <div id="navrow1" class="tabs">
  56     <ul class="tablist">
  57       <li><a href="index.xhtml"><span>Main&#160;Page</span></a></li>
  58       <li><a href="pages.xhtml"><span>Related&#160;Pages</span></a></li>
  59       <li><a href="namespaces.xhtml"><span>Namespaces</span></a></li>
  60       <li class="current"><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
  61       <li><a href="files.xhtml"><span>Files</span></a></li>
  62       <li>
  63         <div id="MSearchBox" class="MSearchBoxInactive">
  64         <span class="left">
  65           <img id="MSearchSelect" src="search/mag_sel.png"
  66                onmouseover="return searchBox.OnSearchSelectShow()"
  67                onmouseout="return searchBox.OnSearchSelectHide()"
  68                alt=""/>
  69           <input type="text" id="MSearchField" value="Search" accesskey="S"
  70                onfocus="searchBox.OnSearchFieldFocus(true)"
  71                onblur="searchBox.OnSearchFieldFocus(false)"
  72                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  73           </span><span class="right">
  74             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  75           </span>
  76         </div>
  77       </li>
  78     </ul>
  79   </div>
  80   <div id="navrow2" class="tabs2">
  81     <ul class="tablist">
  82       <li><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
  83       <li><a href="classes.xhtml"><span>Data&#160;Structure&#160;Index</span></a></li>
  84       <li><a href="inherits.xhtml"><span>Class&#160;Hierarchy</span></a></li>
  85       <li><a href="functions.xhtml"><span>Data&#160;Fields</span></a></li>
  86     </ul>
  87   </div>
  88 </div><!-- top -->
  89 <div id="side-nav" class="ui-resizable side-nav-resizable">
  90   <div id="nav-tree">
  91     <div id="nav-tree-contents">
  92       <div id="nav-sync" class="sync"></div>
  93     </div>
  94   </div>
  95   <div id="splitbar" style="-moz-user-select:none;"
  96        class="ui-resizable-handle">
  97   </div>
  98 </div>
  99 <script type="text/javascript">
 100 $(document).ready(function(){initNavTree('classarm__compute_1_1_c_l_build_options.xhtml','');});
 101 </script>
 102 <div id="doc-content">
 103 <!-- window showing the filter options -->
 104 <div id="MSearchSelectWindow"
 105      onmouseover="return searchBox.OnSearchSelectShow()"
 106      onmouseout="return searchBox.OnSearchSelectHide()"
 107      onkeydown="return searchBox.OnSearchSelectKey(event)">
 108 </div>
 109
 110 <!-- iframe showing the search results (closed by default) -->
 111 <div id="MSearchResultsWindow">
 112 <iframe src="javascript:void(0)" frameborder="0"
 113         name="MSearchResults" id="MSearchResults">
 114 </iframe>
 115 </div>
 116
 117 <div class="header">
 118   <div class="summary">
 119 <a href="#pub-methods">Public Member Functions</a>  </div>
 120   <div class="headertitle">
 121 <div class="title">CLBuildOptions Class Reference</div>  </div>
 122 </div><!--header-->
 123 <div class="contents">
 124
 125 <p>Build options.
 126  <a href="classarm__compute_1_1_c_l_build_options.xhtml#details">More...</a></p>
 127
 128 <p><code>#include &lt;<a class="el" href="_c_l_kernel_library_8h_source.xhtml">CLKernelLibrary.h</a>&gt;</code></p>
 129 <table class="memberdecls">
 130 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
 131 Public Member Functions</h2></td></tr>
 132 <tr class="memitem:af889744e64b496ba5dc1ef57f9918f79"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_build_options.xhtml#af889744e64b496ba5dc1ef57f9918f79">CLBuildOptions</a> ()</td></tr>
 133 <tr class="memdesc:af889744e64b496ba5dc1ef57f9918f79"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor.  <a href="#af889744e64b496ba5dc1ef57f9918f79">More...</a><br /></td></tr>
 134 <tr class="separator:af889744e64b496ba5dc1ef57f9918f79"><td class="memSeparator" colspan="2">&#160;</td></tr>
 135 <tr class="memitem:a3e2b80ff5463b7d2017de847f5c32a30"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_build_options.xhtml#a3e2b80ff5463b7d2017de847f5c32a30">add_option</a> (std::string option)</td></tr>
 136 <tr class="memdesc:a3e2b80ff5463b7d2017de847f5c32a30"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds option to the existing build option list.  <a href="#a3e2b80ff5463b7d2017de847f5c32a30">More...</a><br /></td></tr>
 137 <tr class="separator:a3e2b80ff5463b7d2017de847f5c32a30"><td class="memSeparator" colspan="2">&#160;</td></tr>
 138 <tr class="memitem:a95b46e69297fad10b27a1baa000f92cc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_build_options.xhtml#a95b46e69297fad10b27a1baa000f92cc">add_option_if</a> (bool cond, std::string option)</td></tr>
 139 <tr class="memdesc:a95b46e69297fad10b27a1baa000f92cc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds option if a given condition is true;.  <a href="#a95b46e69297fad10b27a1baa000f92cc">More...</a><br /></td></tr>
 140 <tr class="separator:a95b46e69297fad10b27a1baa000f92cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
 141 <tr class="memitem:a9b58a8c8bf638904a0b5f62b2bfcf96a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_build_options.xhtml#a9b58a8c8bf638904a0b5f62b2bfcf96a">add_option_if_else</a> (bool cond, std::string option_true, std::string option_false)</td></tr>
 142 <tr class="memdesc:a9b58a8c8bf638904a0b5f62b2bfcf96a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds first option if condition is true else the second one.  <a href="#a9b58a8c8bf638904a0b5f62b2bfcf96a">More...</a><br /></td></tr>
 143 <tr class="separator:a9b58a8c8bf638904a0b5f62b2bfcf96a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 144 <tr class="memitem:a58abf0792821f6f1d6271570aa27dd84"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_build_options.xhtml#a58abf0792821f6f1d6271570aa27dd84">add_options</a> (const StringSet &amp;<a class="el" href="classarm__compute_1_1_c_l_build_options.xhtml#aa8653d4327df885173a41982fa0f777a">options</a>)</td></tr>
 145 <tr class="memdesc:a58abf0792821f6f1d6271570aa27dd84"><td class="mdescLeft">&#160;</td><td class="mdescRight">Appends given build options to the current's objects options.  <a href="#a58abf0792821f6f1d6271570aa27dd84">More...</a><br /></td></tr>
 146 <tr class="separator:a58abf0792821f6f1d6271570aa27dd84"><td class="memSeparator" colspan="2">&#160;</td></tr>
 147 <tr class="memitem:a504e7a51a86c19f1f529f739f50729f2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_build_options.xhtml#a504e7a51a86c19f1f529f739f50729f2">add_options_if</a> (bool cond, const StringSet &amp;<a class="el" href="classarm__compute_1_1_c_l_build_options.xhtml#aa8653d4327df885173a41982fa0f777a">options</a>)</td></tr>
 148 <tr class="memdesc:a504e7a51a86c19f1f529f739f50729f2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Appends given build options to the current's objects options if a given condition is true.  <a href="#a504e7a51a86c19f1f529f739f50729f2">More...</a><br /></td></tr>
 149 <tr class="separator:a504e7a51a86c19f1f529f739f50729f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
 150 <tr class="memitem:aa8653d4327df885173a41982fa0f777a"><td class="memItemLeft" align="right" valign="top">const StringSet &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_build_options.xhtml#aa8653d4327df885173a41982fa0f777a">options</a> () const </td></tr>
 151 <tr class="memdesc:aa8653d4327df885173a41982fa0f777a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the current options list set.  <a href="#aa8653d4327df885173a41982fa0f777a">More...</a><br /></td></tr>
 152 <tr class="separator:aa8653d4327df885173a41982fa0f777a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 153 </table>
 154 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 155 <div class="textblock"><p>Build options. </p>
 156
 157 <p>Definition at line <a class="el" href="_c_l_kernel_library_8h_source.xhtml#l00037">37</a> of file <a class="el" href="_c_l_kernel_library_8h_source.xhtml">CLKernelLibrary.h</a>.</p>
 158 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 159 <a class="anchor" id="af889744e64b496ba5dc1ef57f9918f79"></a>
 160 <div class="memitem">
 161 <div class="memproto">
 162       <table class="memname">
 163         <tr>
 164           <td class="memname"><a class="el" href="classarm__compute_1_1_c_l_build_options.xhtml">CLBuildOptions</a> </td>
 165           <td>(</td>
 166           <td class="paramname"></td><td>)</td>
 167           <td></td>
 168         </tr>
 169       </table>
 170 </div><div class="memdoc">
 171
 172 <p>Default constructor. </p>
 173
 174 </div>
 175 </div>
 176 <h2 class="groupheader">Member Function Documentation</h2>
 177 <a class="anchor" id="a3e2b80ff5463b7d2017de847f5c32a30"></a>
 178 <div class="memitem">
 179 <div class="memproto">
 180       <table class="memname">
 181         <tr>
 182           <td class="memname">void add_option </td>
 183           <td>(</td>
 184           <td class="paramtype">std::string&#160;</td>
 185           <td class="paramname"><em>option</em></td><td>)</td>
 186           <td></td>
 187         </tr>
 188       </table>
 189 </div><div class="memdoc">
 190
 191 <p>Adds option to the existing build option list. </p>
 192 <dl class="params"><dt>Parameters</dt><dd>
 193   <table class="params">
 194     <tr><td class="paramdir">[in]</td><td class="paramname">option</td><td>Option to add </td></tr>
 195   </table>
 196   </dd>
 197 </dl>
 198
 199 </div>
 200 </div>
 201 <a class="anchor" id="a95b46e69297fad10b27a1baa000f92cc"></a>
 202 <div class="memitem">
 203 <div class="memproto">
 204       <table class="memname">
 205         <tr>
 206           <td class="memname">void add_option_if </td>
 207           <td>(</td>
 208           <td class="paramtype">bool&#160;</td>
 209           <td class="paramname"><em>cond</em>, </td>
 210         </tr>
 211         <tr>
 212           <td class="paramkey"></td>
 213           <td></td>
 214           <td class="paramtype">std::string&#160;</td>
 215           <td class="paramname"><em>option</em>&#160;</td>
 216         </tr>
 217         <tr>
 218           <td></td>
 219           <td>)</td>
 220           <td></td><td></td>
 221         </tr>
 222       </table>
 223 </div><div class="memdoc">
 224
 225 <p>Adds option if a given condition is true;. </p>
 226 <dl class="params"><dt>Parameters</dt><dd>
 227   <table class="params">
 228     <tr><td class="paramdir">[in]</td><td class="paramname">cond</td><td>Condition to check </td></tr>
 229     <tr><td class="paramdir">[in]</td><td class="paramname">option</td><td>Option to add if condition is true </td></tr>
 230   </table>
 231   </dd>
 232 </dl>
 233
 234 </div>
 235 </div>
 236 <a class="anchor" id="a9b58a8c8bf638904a0b5f62b2bfcf96a"></a>
 237 <div class="memitem">
 238 <div class="memproto">
 239       <table class="memname">
 240         <tr>
 241           <td class="memname">void add_option_if_else </td>
 242           <td>(</td>
 243           <td class="paramtype">bool&#160;</td>
 244           <td class="paramname"><em>cond</em>, </td>
 245         </tr>
 246         <tr>
 247           <td class="paramkey"></td>
 248           <td></td>
 249           <td class="paramtype">std::string&#160;</td>
 250           <td class="paramname"><em>option_true</em>, </td>
 251         </tr>
 252         <tr>
 253           <td class="paramkey"></td>
 254           <td></td>
 255           <td class="paramtype">std::string&#160;</td>
 256           <td class="paramname"><em>option_false</em>&#160;</td>
 257         </tr>
 258         <tr>
 259           <td></td>
 260           <td>)</td>
 261           <td></td><td></td>
 262         </tr>
 263       </table>
 264 </div><div class="memdoc">
 265
 266 <p>Adds first option if condition is true else the second one. </p>
 267 <dl class="params"><dt>Parameters</dt><dd>
 268   <table class="params">
 269     <tr><td class="paramdir">[in]</td><td class="paramname">cond</td><td>Condition to check </td></tr>
 270     <tr><td class="paramdir">[in]</td><td class="paramname">option_true</td><td>Option to add if condition is true </td></tr>
 271     <tr><td class="paramdir">[in]</td><td class="paramname">option_false</td><td>Option to add if condition is false </td></tr>
 272   </table>
 273   </dd>
 274 </dl>
 275
 276 </div>
 277 </div>
 278 <a class="anchor" id="a58abf0792821f6f1d6271570aa27dd84"></a>
 279 <div class="memitem">
 280 <div class="memproto">
 281       <table class="memname">
 282         <tr>
 283           <td class="memname">void add_options </td>
 284           <td>(</td>
 285           <td class="paramtype">const StringSet &amp;&#160;</td>
 286           <td class="paramname"><em>options</em></td><td>)</td>
 287           <td></td>
 288         </tr>
 289       </table>
 290 </div><div class="memdoc">
 291
 292 <p>Appends given build options to the current's objects options. </p>
 293 <dl class="params"><dt>Parameters</dt><dd>
 294   <table class="params">
 295     <tr><td class="paramdir">[in]</td><td class="paramname">options</td><td>Build options to append </td></tr>
 296   </table>
 297   </dd>
 298 </dl>
 299
 300 </div>
 301 </div>
 302 <a class="anchor" id="a504e7a51a86c19f1f529f739f50729f2"></a>
 303 <div class="memitem">
 304 <div class="memproto">
 305       <table class="memname">
 306         <tr>
 307           <td class="memname">void add_options_if </td>
 308           <td>(</td>
 309           <td class="paramtype">bool&#160;</td>
 310           <td class="paramname"><em>cond</em>, </td>
 311         </tr>
 312         <tr>
 313           <td class="paramkey"></td>
 314           <td></td>
 315           <td class="paramtype">const StringSet &amp;&#160;</td>
 316           <td class="paramname"><em>options</em>&#160;</td>
 317         </tr>
 318         <tr>
 319           <td></td>
 320           <td>)</td>
 321           <td></td><td></td>
 322         </tr>
 323       </table>
 324 </div><div class="memdoc">
 325
 326 <p>Appends given build options to the current's objects options if a given condition is true. </p>
 327 <dl class="params"><dt>Parameters</dt><dd>
 328   <table class="params">
 329     <tr><td class="paramdir">[in]</td><td class="paramname">cond</td><td>Condition to check </td></tr>
 330     <tr><td class="paramdir">[in]</td><td class="paramname">options</td><td>Option to add if condition is true </td></tr>
 331   </table>
 332   </dd>
 333 </dl>
 334
 335 </div>
 336 </div>
 337 <a class="anchor" id="aa8653d4327df885173a41982fa0f777a"></a>
 338 <div class="memitem">
 339 <div class="memproto">
 340       <table class="memname">
 341         <tr>
 342           <td class="memname">const StringSet&amp; options </td>
 343           <td>(</td>
 344           <td class="paramname"></td><td>)</td>
 345           <td> const</td>
 346         </tr>
 347       </table>
 348 </div><div class="memdoc">
 349
 350 <p>Gets the current options list set. </p>
 351 <dl class="section return"><dt>Returns</dt><dd>Build options set </dd></dl>
 352
 353 </div>
 354 </div>
 355 <hr/>The documentation for this class was generated from the following file:<ul>
 356 <li>arm_compute/core/CL/<a class="el" href="_c_l_kernel_library_8h_source.xhtml">CLKernelLibrary.h</a></li>
 357 </ul>
 358 </div><!-- contents -->
 359 </div><!-- doc-content -->
 360 <!-- start footer part -->
 361 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 362   <ul>
 363     <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_build_options.xhtml">CLBuildOptions</a></li>
 364     <li class="footer">Generated on Wed May 23 2018 11:36:40 for Compute Library by
 365     <a href="http://www.doxygen.org/index.html">
 366     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
 367   </ul>
 368 </div>
 369 </body>
 370 </html>