| <!-- HTML header for doxygen 1.8.15--> |
| <!-- Remember to use version doxygen 1.8.15 +--> |
| <!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.15"/> |
| <meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines --> |
| <title>Compute Library: EnumOption< T > Class Template 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"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(document).ready(initResizable); |
| /* @license-end */</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/x-mathjax-config"> |
| MathJax.Hub.Config({ |
| extensions: ["tex2jax.js"], |
| jax: ["input/TeX","output/HTML-CSS"], |
| }); |
| </script><script type="text/javascript" async="async" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| <link href="stylesheet.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;"> |
| <img alt="Compute Library" src="https://raw.githubusercontent.com/ARM-software/ComputeLibrary/gh-pages/ACL_logo.png" style="max-width: 100%;margin-top: 15px;margin-left: 10px"/> |
| <td style="padding-left: 0.5em;"> |
| <div id="projectname"> |
|  <span id="projectnumber">19.08</span> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.15 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| /* @license-end */ |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| /* @license-end */</script> |
| <div id="main-nav"></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"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(document).ready(function(){initNavTree('classarm__compute_1_1utils_1_1_enum_option.xhtml','');}); |
| /* @license-end */ |
| </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> </div> |
| <div class="headertitle"> |
| <div class="title">EnumOption< T > Class Template Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Implementation of a simple option that accepts a value from a fixed set. |
| <a href="classarm__compute_1_1utils_1_1_enum_option.xhtml#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="_enum_option_8h_source.xhtml">EnumOption.h</a>></code></p> |
| <div class="dynheader"> |
| Collaboration diagram for EnumOption< T >:</div> |
| <div class="dyncontent"> |
| <div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1utils_1_1_enum_option__coll__graph.svg" width="156" height="187"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe> |
| </div> |
| <center><span class="legend">[<a target="top" href="graph_legend.xhtml">legend</a>]</span></center></div> |
| <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:a4acdb5a6b659c4041bc8cc6581c72e60"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1utils_1_1_enum_option.xhtml#a4acdb5a6b659c4041bc8cc6581c72e60">EnumOption</a> (std::string <a class="el" href="classarm__compute_1_1utils_1_1_option.xhtml#a1d89c28bd42ba9a52da008bb69367171">name</a>, std::set< T > allowed_values)</td></tr> |
| <tr class="memdesc:a4acdb5a6b659c4041bc8cc6581c72e60"><td class="mdescLeft"> </td><td class="mdescRight">Construct option with allowed values. <a href="#a4acdb5a6b659c4041bc8cc6581c72e60">More...</a><br /></td></tr> |
| <tr class="separator:a4acdb5a6b659c4041bc8cc6581c72e60"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aaeb5fadb98a067c61c4d456b5c9a4f80"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1utils_1_1_enum_option.xhtml#aaeb5fadb98a067c61c4d456b5c9a4f80">EnumOption</a> (std::string <a class="el" href="classarm__compute_1_1utils_1_1_option.xhtml#a1d89c28bd42ba9a52da008bb69367171">name</a>, std::set< T > allowed_values, T default_value)</td></tr> |
| <tr class="memdesc:aaeb5fadb98a067c61c4d456b5c9a4f80"><td class="mdescLeft"> </td><td class="mdescRight">Construct option with allowed values, a fixed number of accepted values and default values for the option. <a href="#aaeb5fadb98a067c61c4d456b5c9a4f80">More...</a><br /></td></tr> |
| <tr class="separator:aaeb5fadb98a067c61c4d456b5c9a4f80"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aba9622f1f4bc66fcba246f30d4175a4f"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1utils_1_1_enum_option.xhtml#aba9622f1f4bc66fcba246f30d4175a4f">parse</a> (std::string <a class="el" href="classarm__compute_1_1utils_1_1_enum_option.xhtml#ab5d906b55180c260032ce43d6c5d4d06">value</a>) override</td></tr> |
| <tr class="memdesc:aba9622f1f4bc66fcba246f30d4175a4f"><td class="mdescLeft"> </td><td class="mdescRight">Parses the given string. <a href="#aba9622f1f4bc66fcba246f30d4175a4f">More...</a><br /></td></tr> |
| <tr class="separator:aba9622f1f4bc66fcba246f30d4175a4f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae6038fe1a77c4b08a678530410f41efa"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1utils_1_1_enum_option.xhtml#ae6038fe1a77c4b08a678530410f41efa">help</a> () const override</td></tr> |
| <tr class="memdesc:ae6038fe1a77c4b08a678530410f41efa"><td class="mdescLeft"> </td><td class="mdescRight">Help message for the option. <a href="#ae6038fe1a77c4b08a678530410f41efa">More...</a><br /></td></tr> |
| <tr class="separator:ae6038fe1a77c4b08a678530410f41efa"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab5d906b55180c260032ce43d6c5d4d06"><td class="memItemLeft" align="right" valign="top">const T & </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1utils_1_1_enum_option.xhtml#ab5d906b55180c260032ce43d6c5d4d06">value</a> () const</td></tr> |
| <tr class="memdesc:ab5d906b55180c260032ce43d6c5d4d06"><td class="mdescLeft"> </td><td class="mdescRight">Get the selected value. <a href="#ab5d906b55180c260032ce43d6c5d4d06">More...</a><br /></td></tr> |
| <tr class="separator:ab5d906b55180c260032ce43d6c5d4d06"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header pub_methods_classarm__compute_1_1utils_1_1_simple_option"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarm__compute_1_1utils_1_1_simple_option')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classarm__compute_1_1utils_1_1_simple_option.xhtml">SimpleOption< T ></a></td></tr> |
| <tr class="memitem:a53b7b0b7aee13285e6d841dc184c054b inherit pub_methods_classarm__compute_1_1utils_1_1_simple_option"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1utils_1_1_simple_option.xhtml#a53b7b0b7aee13285e6d841dc184c054b">SimpleOption</a> (std::string <a class="el" href="classarm__compute_1_1utils_1_1_option.xhtml#a1d89c28bd42ba9a52da008bb69367171">name</a>, T default_value)</td></tr> |
| <tr class="memdesc:a53b7b0b7aee13285e6d841dc184c054b inherit pub_methods_classarm__compute_1_1utils_1_1_simple_option"><td class="mdescLeft"> </td><td class="mdescRight">Construct the option with the given default value. <a href="classarm__compute_1_1utils_1_1_simple_option.xhtml#a53b7b0b7aee13285e6d841dc184c054b">More...</a><br /></td></tr> |
| <tr class="separator:a53b7b0b7aee13285e6d841dc184c054b inherit pub_methods_classarm__compute_1_1utils_1_1_simple_option"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aba9622f1f4bc66fcba246f30d4175a4f inherit pub_methods_classarm__compute_1_1utils_1_1_simple_option"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1utils_1_1_simple_option.xhtml#aba9622f1f4bc66fcba246f30d4175a4f">parse</a> (std::string <a class="el" href="classarm__compute_1_1utils_1_1_simple_option.xhtml#ab5d906b55180c260032ce43d6c5d4d06">value</a>) override</td></tr> |
| <tr class="memdesc:aba9622f1f4bc66fcba246f30d4175a4f inherit pub_methods_classarm__compute_1_1utils_1_1_simple_option"><td class="mdescLeft"> </td><td class="mdescRight">Parses the given string. <a href="classarm__compute_1_1utils_1_1_simple_option.xhtml#aba9622f1f4bc66fcba246f30d4175a4f">More...</a><br /></td></tr> |
| <tr class="separator:aba9622f1f4bc66fcba246f30d4175a4f inherit pub_methods_classarm__compute_1_1utils_1_1_simple_option"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae6038fe1a77c4b08a678530410f41efa inherit pub_methods_classarm__compute_1_1utils_1_1_simple_option"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1utils_1_1_simple_option.xhtml#ae6038fe1a77c4b08a678530410f41efa">help</a> () const override</td></tr> |
| <tr class="memdesc:ae6038fe1a77c4b08a678530410f41efa inherit pub_methods_classarm__compute_1_1utils_1_1_simple_option"><td class="mdescLeft"> </td><td class="mdescRight">Help message for the option. <a href="classarm__compute_1_1utils_1_1_simple_option.xhtml#ae6038fe1a77c4b08a678530410f41efa">More...</a><br /></td></tr> |
| <tr class="separator:ae6038fe1a77c4b08a678530410f41efa inherit pub_methods_classarm__compute_1_1utils_1_1_simple_option"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab5d906b55180c260032ce43d6c5d4d06 inherit pub_methods_classarm__compute_1_1utils_1_1_simple_option"><td class="memItemLeft" align="right" valign="top">const T & </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1utils_1_1_simple_option.xhtml#ab5d906b55180c260032ce43d6c5d4d06">value</a> () const</td></tr> |
| <tr class="memdesc:ab5d906b55180c260032ce43d6c5d4d06 inherit pub_methods_classarm__compute_1_1utils_1_1_simple_option"><td class="mdescLeft"> </td><td class="mdescRight">Get the option value. <a href="classarm__compute_1_1utils_1_1_simple_option.xhtml#ab5d906b55180c260032ce43d6c5d4d06">More...</a><br /></td></tr> |
| <tr class="separator:ab5d906b55180c260032ce43d6c5d4d06 inherit pub_methods_classarm__compute_1_1utils_1_1_simple_option"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:afeee88c6cc79c347f803741da7f325f0 inherit pub_methods_classarm__compute_1_1utils_1_1_simple_option"><td class="memTemplParams" colspan="2">template<> </td></tr> |
| <tr class="memitem:afeee88c6cc79c347f803741da7f325f0 inherit pub_methods_classarm__compute_1_1utils_1_1_simple_option"><td class="memTemplItemLeft" align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1utils_1_1_simple_option.xhtml#afeee88c6cc79c347f803741da7f325f0">parse</a> (std::string <a class="el" href="classarm__compute_1_1utils_1_1_simple_option.xhtml#ab5d906b55180c260032ce43d6c5d4d06">value</a>)</td></tr> |
| <tr class="memdesc:afeee88c6cc79c347f803741da7f325f0 inherit pub_methods_classarm__compute_1_1utils_1_1_simple_option"><td class="mdescLeft"> </td><td class="mdescRight">Parses the given string. <a href="classarm__compute_1_1utils_1_1_simple_option.xhtml#afeee88c6cc79c347f803741da7f325f0">More...</a><br /></td></tr> |
| <tr class="separator:afeee88c6cc79c347f803741da7f325f0 inherit pub_methods_classarm__compute_1_1utils_1_1_simple_option"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8432d7cd1d4ea8732a64e9df51147cbf inherit pub_methods_classarm__compute_1_1utils_1_1_simple_option"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1utils_1_1_simple_option.xhtml#a8432d7cd1d4ea8732a64e9df51147cbf">Option</a> (std::string <a class="el" href="classarm__compute_1_1utils_1_1_option.xhtml#a1d89c28bd42ba9a52da008bb69367171">name</a>)</td></tr> |
| <tr class="memdesc:a8432d7cd1d4ea8732a64e9df51147cbf inherit pub_methods_classarm__compute_1_1utils_1_1_simple_option"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="classarm__compute_1_1utils_1_1_simple_option.xhtml#a8432d7cd1d4ea8732a64e9df51147cbf">More...</a><br /></td></tr> |
| <tr class="separator:a8432d7cd1d4ea8732a64e9df51147cbf inherit pub_methods_classarm__compute_1_1utils_1_1_simple_option"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6340a62771cbbb113fccaf3425f2ae48 inherit pub_methods_classarm__compute_1_1utils_1_1_simple_option"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1utils_1_1_simple_option.xhtml#a6340a62771cbbb113fccaf3425f2ae48">Option</a> (std::string <a class="el" href="classarm__compute_1_1utils_1_1_option.xhtml#a1d89c28bd42ba9a52da008bb69367171">name</a>, bool <a class="el" href="classarm__compute_1_1utils_1_1_option.xhtml#ae5fcbfe1e97213aae098a4c0dc48ffe5">is_required</a>, bool <a class="el" href="classarm__compute_1_1utils_1_1_option.xhtml#a8d75095e0ce4d0cc3ed6bc4733664a74">is_set</a>)</td></tr> |
| <tr class="memdesc:a6340a62771cbbb113fccaf3425f2ae48 inherit pub_methods_classarm__compute_1_1utils_1_1_simple_option"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="classarm__compute_1_1utils_1_1_simple_option.xhtml#a6340a62771cbbb113fccaf3425f2ae48">More...</a><br /></td></tr> |
| <tr class="separator:a6340a62771cbbb113fccaf3425f2ae48 inherit pub_methods_classarm__compute_1_1utils_1_1_simple_option"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header pub_methods_classarm__compute_1_1utils_1_1_option"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarm__compute_1_1utils_1_1_option')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classarm__compute_1_1utils_1_1_option.xhtml">Option</a></td></tr> |
| <tr class="memitem:a8432d7cd1d4ea8732a64e9df51147cbf inherit pub_methods_classarm__compute_1_1utils_1_1_option"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1utils_1_1_option.xhtml#a8432d7cd1d4ea8732a64e9df51147cbf">Option</a> (std::string <a class="el" href="classarm__compute_1_1utils_1_1_option.xhtml#a1d89c28bd42ba9a52da008bb69367171">name</a>)</td></tr> |
| <tr class="memdesc:a8432d7cd1d4ea8732a64e9df51147cbf inherit pub_methods_classarm__compute_1_1utils_1_1_option"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="classarm__compute_1_1utils_1_1_option.xhtml#a8432d7cd1d4ea8732a64e9df51147cbf">More...</a><br /></td></tr> |
| <tr class="separator:a8432d7cd1d4ea8732a64e9df51147cbf inherit pub_methods_classarm__compute_1_1utils_1_1_option"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6340a62771cbbb113fccaf3425f2ae48 inherit pub_methods_classarm__compute_1_1utils_1_1_option"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1utils_1_1_option.xhtml#a6340a62771cbbb113fccaf3425f2ae48">Option</a> (std::string <a class="el" href="classarm__compute_1_1utils_1_1_option.xhtml#a1d89c28bd42ba9a52da008bb69367171">name</a>, bool <a class="el" href="classarm__compute_1_1utils_1_1_option.xhtml#ae5fcbfe1e97213aae098a4c0dc48ffe5">is_required</a>, bool <a class="el" href="classarm__compute_1_1utils_1_1_option.xhtml#a8d75095e0ce4d0cc3ed6bc4733664a74">is_set</a>)</td></tr> |
| <tr class="memdesc:a6340a62771cbbb113fccaf3425f2ae48 inherit pub_methods_classarm__compute_1_1utils_1_1_option"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="classarm__compute_1_1utils_1_1_option.xhtml#a6340a62771cbbb113fccaf3425f2ae48">More...</a><br /></td></tr> |
| <tr class="separator:a6340a62771cbbb113fccaf3425f2ae48 inherit pub_methods_classarm__compute_1_1utils_1_1_option"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af340fed9faa9f79d3bf2e385c50d1ca0 inherit pub_methods_classarm__compute_1_1utils_1_1_option"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1utils_1_1_option.xhtml#af340fed9faa9f79d3bf2e385c50d1ca0">~Option</a> ()=default</td></tr> |
| <tr class="memdesc:af340fed9faa9f79d3bf2e385c50d1ca0 inherit pub_methods_classarm__compute_1_1utils_1_1_option"><td class="mdescLeft"> </td><td class="mdescRight">Default destructor. <a href="classarm__compute_1_1utils_1_1_option.xhtml#af340fed9faa9f79d3bf2e385c50d1ca0">More...</a><br /></td></tr> |
| <tr class="separator:af340fed9faa9f79d3bf2e385c50d1ca0 inherit pub_methods_classarm__compute_1_1utils_1_1_option"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1d89c28bd42ba9a52da008bb69367171 inherit pub_methods_classarm__compute_1_1utils_1_1_option"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1utils_1_1_option.xhtml#a1d89c28bd42ba9a52da008bb69367171">name</a> () const</td></tr> |
| <tr class="memdesc:a1d89c28bd42ba9a52da008bb69367171 inherit pub_methods_classarm__compute_1_1utils_1_1_option"><td class="mdescLeft"> </td><td class="mdescRight">Name of the option. <a href="classarm__compute_1_1utils_1_1_option.xhtml#a1d89c28bd42ba9a52da008bb69367171">More...</a><br /></td></tr> |
| <tr class="separator:a1d89c28bd42ba9a52da008bb69367171 inherit pub_methods_classarm__compute_1_1utils_1_1_option"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a564afafa4220cd36afbe388fcd24549b inherit pub_methods_classarm__compute_1_1utils_1_1_option"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1utils_1_1_option.xhtml#a564afafa4220cd36afbe388fcd24549b">set_required</a> (bool <a class="el" href="classarm__compute_1_1utils_1_1_option.xhtml#ae5fcbfe1e97213aae098a4c0dc48ffe5">is_required</a>)</td></tr> |
| <tr class="memdesc:a564afafa4220cd36afbe388fcd24549b inherit pub_methods_classarm__compute_1_1utils_1_1_option"><td class="mdescLeft"> </td><td class="mdescRight">Set whether the option is required. <a href="classarm__compute_1_1utils_1_1_option.xhtml#a564afafa4220cd36afbe388fcd24549b">More...</a><br /></td></tr> |
| <tr class="separator:a564afafa4220cd36afbe388fcd24549b inherit pub_methods_classarm__compute_1_1utils_1_1_option"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a48a2672f362eeed9a3e93403f4d3de37 inherit pub_methods_classarm__compute_1_1utils_1_1_option"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1utils_1_1_option.xhtml#a48a2672f362eeed9a3e93403f4d3de37">set_help</a> (std::string <a class="el" href="classarm__compute_1_1utils_1_1_option.xhtml#a6d472b4309f5558f94258fabeff3474e">help</a>)</td></tr> |
| <tr class="memdesc:a48a2672f362eeed9a3e93403f4d3de37 inherit pub_methods_classarm__compute_1_1utils_1_1_option"><td class="mdescLeft"> </td><td class="mdescRight">Set the help message for the option. <a href="classarm__compute_1_1utils_1_1_option.xhtml#a48a2672f362eeed9a3e93403f4d3de37">More...</a><br /></td></tr> |
| <tr class="separator:a48a2672f362eeed9a3e93403f4d3de37 inherit pub_methods_classarm__compute_1_1utils_1_1_option"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae5fcbfe1e97213aae098a4c0dc48ffe5 inherit pub_methods_classarm__compute_1_1utils_1_1_option"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1utils_1_1_option.xhtml#ae5fcbfe1e97213aae098a4c0dc48ffe5">is_required</a> () const</td></tr> |
| <tr class="memdesc:ae5fcbfe1e97213aae098a4c0dc48ffe5 inherit pub_methods_classarm__compute_1_1utils_1_1_option"><td class="mdescLeft"> </td><td class="mdescRight">Is the option required? <a href="classarm__compute_1_1utils_1_1_option.xhtml#ae5fcbfe1e97213aae098a4c0dc48ffe5">More...</a><br /></td></tr> |
| <tr class="separator:ae5fcbfe1e97213aae098a4c0dc48ffe5 inherit pub_methods_classarm__compute_1_1utils_1_1_option"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8d75095e0ce4d0cc3ed6bc4733664a74 inherit pub_methods_classarm__compute_1_1utils_1_1_option"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1utils_1_1_option.xhtml#a8d75095e0ce4d0cc3ed6bc4733664a74">is_set</a> () const</td></tr> |
| <tr class="memdesc:a8d75095e0ce4d0cc3ed6bc4733664a74 inherit pub_methods_classarm__compute_1_1utils_1_1_option"><td class="mdescLeft"> </td><td class="mdescRight">Has a value been assigned to the option? <a href="classarm__compute_1_1utils_1_1_option.xhtml#a8d75095e0ce4d0cc3ed6bc4733664a74">More...</a><br /></td></tr> |
| <tr class="separator:a8d75095e0ce4d0cc3ed6bc4733664a74 inherit pub_methods_classarm__compute_1_1utils_1_1_option"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><h3>template<typename T><br /> |
| class arm_compute::utils::EnumOption< T ></h3> |
| |
| <p>Implementation of a simple option that accepts a value from a fixed set. </p> |
| |
| <p class="definition">Definition at line <a class="el" href="_enum_option_8h_source.xhtml#l00040">40</a> of file <a class="el" href="_enum_option_8h_source.xhtml">EnumOption.h</a>.</p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="a4acdb5a6b659c4041bc8cc6581c72e60"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a4acdb5a6b659c4041bc8cc6581c72e60">◆ </a></span>EnumOption() <span class="overload">[1/2]</span></h2> |
| |
| <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_1utils_1_1_enum_option.xhtml">EnumOption</a> </td> |
| <td>(</td> |
| <td class="paramtype">std::string </td> |
| <td class="paramname"><em>name</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">std::set< T > </td> |
| <td class="paramname"><em>allowed_values</em> </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>Construct option with allowed values. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>Name of the option. </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">allowed_values</td><td>Set of allowed values for the option. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p class="definition">Definition at line <a class="el" href="_enum_option_8h_source.xhtml#l00072">72</a> of file <a class="el" href="_enum_option_8h_source.xhtml">EnumOption.h</a>.</p> |
| <div class="fragment"><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  : SimpleOption<T>{ std::move(<a class="code" href="classarm__compute_1_1utils_1_1_option.xhtml#a1d89c28bd42ba9a52da008bb69367171">name</a>) }, _allowed_values{ std::move(allowed_values) }</div><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> }</div><div class="ttc" id="classarm__compute_1_1utils_1_1_option_xhtml_a1d89c28bd42ba9a52da008bb69367171"><div class="ttname"><a href="classarm__compute_1_1utils_1_1_option.xhtml#a1d89c28bd42ba9a52da008bb69367171">arm_compute::utils::Option::name</a></div><div class="ttdeci">std::string name() const</div><div class="ttdoc">Name of the option.</div><div class="ttdef"><b>Definition:</b> <a href="_option_8h_source.xhtml#l00115">Option.h:115</a></div></div> |
| </div><!-- fragment --> |
| </div> |
| </div> |
| <a id="aaeb5fadb98a067c61c4d456b5c9a4f80"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aaeb5fadb98a067c61c4d456b5c9a4f80">◆ </a></span>EnumOption() <span class="overload">[2/2]</span></h2> |
| |
| <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_1utils_1_1_enum_option.xhtml">EnumOption</a> </td> |
| <td>(</td> |
| <td class="paramtype">std::string </td> |
| <td class="paramname"><em>name</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">std::set< T > </td> |
| <td class="paramname"><em>allowed_values</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">T </td> |
| <td class="paramname"><em>default_value</em> </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>Construct option with allowed values, a fixed number of accepted values and default values for the option. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>Name of the option. </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">allowed_values</td><td>Set of allowed values for the option. </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">default_value</td><td>Default value. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p class="definition">Definition at line <a class="el" href="_enum_option_8h_source.xhtml#l00078">78</a> of file <a class="el" href="_enum_option_8h_source.xhtml">EnumOption.h</a>.</p> |
| <div class="fragment"><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  : SimpleOption<T>{ std::move(<a class="code" href="classarm__compute_1_1utils_1_1_option.xhtml#a1d89c28bd42ba9a52da008bb69367171">name</a>), std::move(default_value) }, _allowed_values{ std::move(allowed_values) }</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> {</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> }</div><div class="ttc" id="classarm__compute_1_1utils_1_1_option_xhtml_a1d89c28bd42ba9a52da008bb69367171"><div class="ttname"><a href="classarm__compute_1_1utils_1_1_option.xhtml#a1d89c28bd42ba9a52da008bb69367171">arm_compute::utils::Option::name</a></div><div class="ttdeci">std::string name() const</div><div class="ttdoc">Name of the option.</div><div class="ttdef"><b>Definition:</b> <a href="_option_8h_source.xhtml#l00115">Option.h:115</a></div></div> |
| </div><!-- fragment --> |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="ae6038fe1a77c4b08a678530410f41efa"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ae6038fe1a77c4b08a678530410f41efa">◆ </a></span>help()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::string help </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">override</span><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Help message for the option. </p> |
| <dl class="section return"><dt>Returns</dt><dd>String representing the help message for the specific subclass. </dd></dl> |
| |
| <p>Implements <a class="el" href="classarm__compute_1_1utils_1_1_option.xhtml#a6d472b4309f5558f94258fabeff3474e">Option</a>.</p> |
| |
| <p class="definition">Definition at line <a class="el" href="_enum_option_8h_source.xhtml#l00114">114</a> of file <a class="el" href="_enum_option_8h_source.xhtml">EnumOption.h</a>.</p> |
| <div class="fragment"><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> {</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  std::stringstream msg;</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  msg << <span class="stringliteral">"--"</span> + this-><a class="code" href="classarm__compute_1_1utils_1_1_option.xhtml#a1d89c28bd42ba9a52da008bb69367171">name</a>() + <span class="stringliteral">"={"</span>;</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span> </div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  <span class="keywordflow">for</span>(<span class="keyword">const</span> <span class="keyword">auto</span> &<a class="code" href="classarm__compute_1_1utils_1_1_enum_option.xhtml#ab5d906b55180c260032ce43d6c5d4d06">value</a> : _allowed_values)</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  {</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  msg << <a class="code" href="classarm__compute_1_1utils_1_1_enum_option.xhtml#ab5d906b55180c260032ce43d6c5d4d06">value</a> << <span class="stringliteral">","</span>;</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  }</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> </div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  msg << <span class="stringliteral">"} - "</span> << this->_help;</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span> </div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  <span class="keywordflow">return</span> msg.str();</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span> }</div><div class="ttc" id="classarm__compute_1_1utils_1_1_option_xhtml_a1d89c28bd42ba9a52da008bb69367171"><div class="ttname"><a href="classarm__compute_1_1utils_1_1_option.xhtml#a1d89c28bd42ba9a52da008bb69367171">arm_compute::utils::Option::name</a></div><div class="ttdeci">std::string name() const</div><div class="ttdoc">Name of the option.</div><div class="ttdef"><b>Definition:</b> <a href="_option_8h_source.xhtml#l00115">Option.h:115</a></div></div> |
| <div class="ttc" id="classarm__compute_1_1utils_1_1_enum_option_xhtml_ab5d906b55180c260032ce43d6c5d4d06"><div class="ttname"><a href="classarm__compute_1_1utils_1_1_enum_option.xhtml#ab5d906b55180c260032ce43d6c5d4d06">arm_compute::utils::EnumOption::value</a></div><div class="ttdeci">const T & value() const</div><div class="ttdoc">Get the selected value.</div><div class="ttdef"><b>Definition:</b> <a href="_enum_option_8h_source.xhtml#l00130">EnumOption.h:130</a></div></div> |
| </div><!-- fragment --> |
| </div> |
| </div> |
| <a id="aba9622f1f4bc66fcba246f30d4175a4f"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aba9622f1f4bc66fcba246f30d4175a4f">◆ </a></span>parse()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool parse </td> |
| <td>(</td> |
| <td class="paramtype">std::string </td> |
| <td class="paramname"><em>value</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Parses the given string. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>String representation as passed on the command line.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>True if the value could be parsed by the specific subclass. </dd></dl> |
| |
| <p>Implements <a class="el" href="classarm__compute_1_1utils_1_1_option.xhtml#a1adbcecf58804b109b928dd852bc29ef">Option</a>.</p> |
| |
| <p class="definition">Definition at line <a class="el" href="_enum_option_8h_source.xhtml#l00084">84</a> of file <a class="el" href="_enum_option_8h_source.xhtml">EnumOption.h</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">try</span></div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  {</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  std::stringstream stream{ <a class="code" href="classarm__compute_1_1utils_1_1_enum_option.xhtml#ab5d906b55180c260032ce43d6c5d4d06">value</a> };</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  T typed_value{};</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> </div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  stream >> typed_value;</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> </div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="keywordflow">if</span>(!stream.fail())</div><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>  <span class="keywordflow">if</span>(_allowed_values.count(typed_value) == 0)</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  {</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="keywordflow">return</span> <span class="keyword">false</span>;</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  }</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> </div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  this->_value = std::move(typed_value);</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  this->_is_set = <span class="keyword">true</span>;</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <span class="keywordflow">return</span> <span class="keyword">true</span>;</div><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> </div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="keywordflow">return</span> <span class="keyword">false</span>;</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  }</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  <span class="keywordflow">catch</span>(<span class="keyword">const</span> std::invalid_argument &)</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  {</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  <span class="keywordflow">return</span> <span class="keyword">false</span>;</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  }</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> }</div><div class="ttc" id="classarm__compute_1_1utils_1_1_enum_option_xhtml_ab5d906b55180c260032ce43d6c5d4d06"><div class="ttname"><a href="classarm__compute_1_1utils_1_1_enum_option.xhtml#ab5d906b55180c260032ce43d6c5d4d06">arm_compute::utils::EnumOption::value</a></div><div class="ttdeci">const T & value() const</div><div class="ttdoc">Get the selected value.</div><div class="ttdef"><b>Definition:</b> <a href="_enum_option_8h_source.xhtml#l00130">EnumOption.h:130</a></div></div> |
| </div><!-- fragment --> |
| </div> |
| </div> |
| <a id="ab5d906b55180c260032ce43d6c5d4d06"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ab5d906b55180c260032ce43d6c5d4d06">◆ </a></span>value()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const T & value </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 selected value. </p> |
| <dl class="section return"><dt>Returns</dt><dd>get the selected enum value. </dd></dl> |
| |
| <p class="definition">Definition at line <a class="el" href="_enum_option_8h_source.xhtml#l00130">130</a> of file <a class="el" href="_enum_option_8h_source.xhtml">EnumOption.h</a>.</p> |
| <div class="fragment"><div class="line"><a name="l00131"></a><span class="lineno"> 131</span> {</div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  <span class="keywordflow">return</span> this->_value;</div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span> }</div></div><!-- fragment --> |
| <p class="reference">Referenced by <a class="el" href="_common_graph_options_8cpp_source.xhtml#l00183">arm_compute::utils::consume_common_graph_parameters()</a>, <a class="el" href="_common_options_8cpp_source.xhtml#l00098">CommonOptions::create_printers()</a>, and <a class="el" href="main_8cpp_source.xhtml#l00090">main()</a>.</p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>utils/command_line/<a class="el" href="_enum_option_8h_source.xhtml">EnumOption.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="namespacearm__compute_1_1utils.xhtml">utils</a></li><li class="navelem"><a class="el" href="classarm__compute_1_1utils_1_1_enum_option.xhtml">EnumOption</a></li> |
| <li class="footer">Generated on Mon Sep 2 2019 11:47:42 for Compute Library by |
| <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.15 </li> |
| </ul> |
| </div> |
| </body> |
| </html> |
