diff options
| author | Jim Flynn <jim.flynn@arm.com> | 2020-03-19 17:03:14 +0000 |
|---|---|---|
| committer | Jim Flynn <jim.flynn@arm.com> | 2020-03-19 17:03:14 +0000 |
| commit | 0e2bab81442ee6cc2b94e4f7881ed0c5c6af65e7 (patch) | |
| tree | b0af08b5a0b74149fca422151127ac6310385399 /Documentation/classarmnn_1_1_optional_base.html | |
| parent | 8c3259fa007d43fcc5ea56fe6928526dbe79f3c0 (diff) | |
| download | armnn-0e2bab81442ee6cc2b94e4f7881ed0c5c6af65e7.tar.gz | |
Creating gh-pages documentation for ArmNN
Signed-off-by: Jim Flynn <jim.flynn@arm.com>
Diffstat (limited to 'Documentation/classarmnn_1_1_optional_base.html')
| -rw-r--r-- | Documentation/classarmnn_1_1_optional_base.html | 291 |
1 files changed, 291 insertions, 0 deletions
diff --git a/Documentation/classarmnn_1_1_optional_base.html b/Documentation/classarmnn_1_1_optional_base.html new file mode 100644 index 0000000000..250e56ecd6 --- /dev/null +++ b/Documentation/classarmnn_1_1_optional_base.html @@ -0,0 +1,291 @@ +<!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.13"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>ArmNN: OptionalBase Class Reference</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="dynsections.js"></script> +<link href="navtree.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="resize.js"></script> +<script type="text/javascript" src="navtreedata.js"></script> +<script type="text/javascript" src="navtree.js"></script> +<script type="text/javascript"> + $(document).ready(initResizable); +</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> +<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 id="projectalign" style="padding-left: 0.5em;"> + <div id="projectname">ArmNN +  <span id="projectnumber">NotReleased</span> + </div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.13 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> +<script type="text/javascript" src="menudata.js"></script> +<script type="text/javascript" src="menu.js"></script> +<script type="text/javascript"> +$(function() { + initMenu('',true,false,'search.php','Search'); + $(document).ready(function() { init_search(); }); +}); +</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"> +$(document).ready(function(){initNavTree('classarmnn_1_1_optional_base.html','');}); +</script> +<div id="doc-content"> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +</div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<div class="header"> + <div class="summary"> +<a href="#pub-methods">Public Member Functions</a> | +<a href="#pro-methods">Protected Member Functions</a> | +<a href="#pro-attribs">Protected Attributes</a> | +<a href="classarmnn_1_1_optional_base-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">OptionalBase Class Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p><code>#include <<a class="el" href="_optional_8hpp_source.html">Optional.hpp</a>></code></p> +<div class="dynheader"> +Inheritance diagram for OptionalBase:</div> +<div class="dyncontent"> + <div class="center"> + <img src="classarmnn_1_1_optional_base.png" usemap="#OptionalBase_map" alt=""/> + <map id="OptionalBase_map" name="OptionalBase_map"> +<area href="classarmnn_1_1_optional_reference_switch.html" alt="OptionalReferenceSwitch< IsReference, T >" shape="rect" coords="953,56,1896,80"/> +<area href="classarmnn_1_1_optional_reference_switch_3_01true_00_01_t_01_4.html" alt="OptionalReferenceSwitch< true, T >" shape="rect" coords="953,112,1896,136"/> +<area href="classarmnn_1_1_optional_reference_switch.html" alt="OptionalReferenceSwitch< std::is_reference< armnn::ConstTensor >::value, armnn::ConstTensor >" shape="rect" coords="953,168,1896,192"/> +<area href="classarmnn_1_1_optional_reference_switch.html" alt="OptionalReferenceSwitch< std::is_reference< armnn::DynamicQuantizationVisitor >::value, armnn::DynamicQuantizationVisitor >" shape="rect" coords="953,224,1896,248"/> +<area href="classarmnn_1_1_optional_reference_switch.html" alt="OptionalReferenceSwitch< std::is_reference< armnnTfLiteParser::ITfLiteParser::TfLiteParserOptions >::value, armnnTfLiteParser::ITfLiteParser::TfLiteParserOptions >" shape="rect" coords="953,280,1896,304"/> +<area href="classarmnn_1_1_optional_reference_switch.html" alt="OptionalReferenceSwitch< std::is_reference< int32_t >::value, int32_t >" shape="rect" coords="953,336,1896,360"/> +<area href="classarmnn_1_1_optional_reference_switch.html" alt="OptionalReferenceSwitch< std::is_reference< T >::value, T >" shape="rect" coords="953,392,1896,416"/> +<area href="classarmnn_1_1_optional_reference_switch.html" alt="OptionalReferenceSwitch< std::is_reference< unsigned int >::value, unsigned int >" shape="rect" coords="953,448,1896,472"/> +</map> + </div></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:ac2bde2f7113f72440ad3638eeb4d06f6"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_optional_base.html#ac2bde2f7113f72440ad3638eeb4d06f6">OptionalBase</a> () noexcept</td></tr> +<tr class="separator:ac2bde2f7113f72440ad3638eeb4d06f6"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a86b749ce2c4bc627fa8a1fcfaf0e314f"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_optional_base.html#a86b749ce2c4bc627fa8a1fcfaf0e314f">has_value</a> () const noexcept</td></tr> +<tr class="separator:a86b749ce2c4bc627fa8a1fcfaf0e314f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a420e60e9788bfa3b52aa3aab72ea3a5e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_optional_base.html#a420e60e9788bfa3b52aa3aab72ea3a5e">operator bool</a> () const noexcept</td></tr> +<tr class="separator:a420e60e9788bfa3b52aa3aab72ea3a5e"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a> +Protected Member Functions</h2></td></tr> +<tr class="memitem:a50b53f38c96fdf12c90890d2dfbb8719"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_optional_base.html#a50b53f38c96fdf12c90890d2dfbb8719">OptionalBase</a> (bool hasValue) noexcept</td></tr> +<tr class="separator:a50b53f38c96fdf12c90890d2dfbb8719"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a> +Protected Attributes</h2></td></tr> +<tr class="memitem:a53e87efb7e1b2df3dc4420dafaf2ee7e"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_optional_base.html#a53e87efb7e1b2df3dc4420dafaf2ee7e">m_HasValue</a></td></tr> +<tr class="separator:a53e87efb7e1b2df3dc4420dafaf2ee7e"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"> +<p class="definition">Definition at line <a class="el" href="_optional_8hpp_source.html#l00045">45</a> of file <a class="el" href="_optional_8hpp_source.html">Optional.hpp</a>.</p> +</div><h2 class="groupheader">Constructor & Destructor Documentation</h2> +<a id="ac2bde2f7113f72440ad3638eeb4d06f6"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ac2bde2f7113f72440ad3638eeb4d06f6">◆ </a></span>OptionalBase() <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="classarmnn_1_1_optional_base.html">OptionalBase</a> </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 class="mlabel">noexcept</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p class="definition">Definition at line <a class="el" href="_optional_8hpp_source.html#l00048">48</a> of file <a class="el" href="_optional_8hpp_source.html">Optional.hpp</a>.</p> +<div class="fragment"><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  : <a class="code" href="classarmnn_1_1_optional_base.html#a53e87efb7e1b2df3dc4420dafaf2ee7e">m_HasValue</a>{<span class="keyword">false</span>}</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  {</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  }</div><div class="ttc" id="classarmnn_1_1_optional_base_html_a53e87efb7e1b2df3dc4420dafaf2ee7e"><div class="ttname"><a href="classarmnn_1_1_optional_base.html#a53e87efb7e1b2df3dc4420dafaf2ee7e">armnn::OptionalBase::m_HasValue</a></div><div class="ttdeci">bool m_HasValue</div><div class="ttdef"><b>Definition:</b> <a href="_optional_8hpp_source.html#l00072">Optional.hpp:72</a></div></div> +</div><!-- fragment --> +</div> +</div> +<a id="a50b53f38c96fdf12c90890d2dfbb8719"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a50b53f38c96fdf12c90890d2dfbb8719">◆ </a></span>OptionalBase() <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="classarmnn_1_1_optional_base.html">OptionalBase</a> </td> + <td>(</td> + <td class="paramtype">bool </td> + <td class="paramname"><em>hasValue</em></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">noexcept</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p class="definition">Definition at line <a class="el" href="_optional_8hpp_source.html#l00067">67</a> of file <a class="el" href="_optional_8hpp_source.html">Optional.hpp</a>.</p> +<div class="fragment"><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  : <a class="code" href="classarmnn_1_1_optional_base.html#a53e87efb7e1b2df3dc4420dafaf2ee7e">m_HasValue</a>{hasValue}</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  {</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  }</div><div class="ttc" id="classarmnn_1_1_optional_base_html_a53e87efb7e1b2df3dc4420dafaf2ee7e"><div class="ttname"><a href="classarmnn_1_1_optional_base.html#a53e87efb7e1b2df3dc4420dafaf2ee7e">armnn::OptionalBase::m_HasValue</a></div><div class="ttdeci">bool m_HasValue</div><div class="ttdef"><b>Definition:</b> <a href="_optional_8hpp_source.html#l00072">Optional.hpp:72</a></div></div> +</div><!-- fragment --> +</div> +</div> +<h2 class="groupheader">Member Function Documentation</h2> +<a id="a86b749ce2c4bc627fa8a1fcfaf0e314f"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a86b749ce2c4bc627fa8a1fcfaf0e314f">◆ </a></span>has_value()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">bool has_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 class="mlabel">noexcept</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p class="definition">Definition at line <a class="el" href="_optional_8hpp_source.html#l00053">53</a> of file <a class="el" href="_optional_8hpp_source.html">Optional.hpp</a>.</p> + +<p class="reference">Referenced by <a class="el" href="_network_8cpp_source.html#l01023">Network::AddConcatLayer()</a>, <a class="el" href="_network_8cpp_source.html#l01067">Network::AddConvolution2dLayer()</a>, <a class="el" href="_network_8cpp_source.html#l00970">Network::AddElementwiseUnaryLayer()</a>, <a class="el" href="_network_8cpp_source.html#l01507">Network::AddTransposeConvolution2dLayer()</a>, <a class="el" href="_optional_test_8cpp_source.html#l00029">BOOST_AUTO_TEST_CASE()</a>, <a class="el" href="_test_layer_visitor_8cpp_source.html#l00051">TestLayerVisitor::CheckOptionalConstTensors()</a>, <a class="el" href="_counter_directory_8cpp_source.html#l00534">CounterDirectory::Clear()</a>, <a class="el" href="_workload_data_8cpp_source.html#l00025">armnn::GetBiasDataType()</a>, <a class="el" href="_ref_layer_support_8cpp_source.html#l00410">RefLayerSupport::IsConvolution2dSupported()</a>, <a class="el" href="_ref_layer_support_8cpp_source.html#l00538">RefLayerSupport::IsDepthwiseConvolutionSupported()</a>, <a class="el" href="_ref_layer_support_8cpp_source.html#l01846">RefLayerSupport::IsTransposeConvolution2dSupported()</a>, <a class="el" href="_optional_8hpp_source.html#l00115">OptionalReferenceSwitch< std::is_reference< int32_t >::value, int32_t >::operator=()</a>, <a class="el" href="_optional_8hpp_source.html#l00221">OptionalReferenceSwitch< true, T >::operator=()</a>, <a class="el" href="_optional_8hpp_source.html#l00287">Optional< armnnTfLiteParser::ITfLiteParser::TfLiteParserOptions >::operator==()</a>, <a class="el" href="_periodic_counter_selection_command_handler_8hpp_source.html#l00035">PeriodicCounterSelectionCommandHandler::PeriodicCounterSelectionCommandHandler()</a>, <a class="el" href="_counter_directory_8cpp_source.html#l00021">CounterDirectory::RegisterCategory()</a>, <a class="el" href="_counter_directory_8cpp_source.html#l00276">CounterDirectory::RegisterCounter()</a>, <a class="el" href="_counter_directory_8cpp_source.html#l00180">CounterDirectory::RegisterCounterSet()</a>, <a class="el" href="_counter_directory_8cpp_source.html#l00084">CounterDirectory::RegisterDevice()</a>, <a class="el" href="_profiling_test_utils_8cpp_source.html#l00228">VerifyTimelineEntityBinaryPacket()</a>, <a class="el" href="_profiling_test_utils_8cpp_source.html#l00278">VerifyTimelineEventBinaryPacket()</a>, <a class="el" href="_profiling_test_utils_8cpp_source.html#l00028">VerifyTimelineLabelBinaryPacket()</a>, <a class="el" href="_profiling_test_utils_8cpp_source.html#l00129">VerifyTimelineRelationshipBinaryPacket()</a>, <a class="el" href="_quantizer_visitor_8cpp_source.html#l00215">QuantizerVisitor::VisitConvolution2dLayer()</a>, <a class="el" href="_serializer_8cpp_source.html#l00296">SerializerVisitor::VisitConvolution2dLayer()</a>, <a class="el" href="_quantizer_visitor_8cpp_source.html#l00250">QuantizerVisitor::VisitDepthwiseConvolution2dLayer()</a>, <a class="el" href="_serializer_8cpp_source.html#l00353">SerializerVisitor::VisitDepthwiseConvolution2dLayer()</a>, <a class="el" href="_quantizer_visitor_8cpp_source.html#l00285">QuantizerVisitor::VisitFullyConnectedLayer()</a>, <a class="el" href="_quantizer_visitor_8cpp_source.html#l00536">QuantizerVisitor::VisitTransposeConvolution2dLayer()</a>, and <a class="el" href="_serializer_8cpp_source.html#l01265">SerializerVisitor::VisitTransposeConvolution2dLayer()</a>.</p> +<div class="fragment"><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  {</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keywordflow">return</span> <a class="code" href="classarmnn_1_1_optional_base.html#a53e87efb7e1b2df3dc4420dafaf2ee7e">m_HasValue</a>;</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  }</div><div class="ttc" id="classarmnn_1_1_optional_base_html_a53e87efb7e1b2df3dc4420dafaf2ee7e"><div class="ttname"><a href="classarmnn_1_1_optional_base.html#a53e87efb7e1b2df3dc4420dafaf2ee7e">armnn::OptionalBase::m_HasValue</a></div><div class="ttdeci">bool m_HasValue</div><div class="ttdef"><b>Definition:</b> <a href="_optional_8hpp_source.html#l00072">Optional.hpp:72</a></div></div> +</div><!-- fragment --> +</div> +</div> +<a id="a420e60e9788bfa3b52aa3aab72ea3a5e"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a420e60e9788bfa3b52aa3aab72ea3a5e">◆ </a></span>operator bool()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">operator bool </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 class="mlabel">explicit</span><span class="mlabel">noexcept</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>Conversion to bool, so can be used in if-statements and similar contexts expecting a bool. Note this is explicit so that it doesn't get implicitly converted to a bool in unwanted cases, for example "Optional<TypeA> == Optional<TypeB>" should not compile. </p> + +<p class="definition">Definition at line <a class="el" href="_optional_8hpp_source.html#l00061">61</a> of file <a class="el" href="_optional_8hpp_source.html">Optional.hpp</a>.</p> +<div class="fragment"><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  {</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keywordflow">return</span> <a class="code" href="classarmnn_1_1_optional_base.html#a86b749ce2c4bc627fa8a1fcfaf0e314f">has_value</a>();</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  }</div><div class="ttc" id="classarmnn_1_1_optional_base_html_a86b749ce2c4bc627fa8a1fcfaf0e314f"><div class="ttname"><a href="classarmnn_1_1_optional_base.html#a86b749ce2c4bc627fa8a1fcfaf0e314f">armnn::OptionalBase::has_value</a></div><div class="ttdeci">bool has_value() const noexcept</div><div class="ttdef"><b>Definition:</b> <a href="_optional_8hpp_source.html#l00053">Optional.hpp:53</a></div></div> +</div><!-- fragment --> +</div> +</div> +<h2 class="groupheader">Member Data Documentation</h2> +<a id="a53e87efb7e1b2df3dc4420dafaf2ee7e"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a53e87efb7e1b2df3dc4420dafaf2ee7e">◆ </a></span>m_HasValue</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">bool m_HasValue</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">protected</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p class="definition">Definition at line <a class="el" href="_optional_8hpp_source.html#l00072">72</a> of file <a class="el" href="_optional_8hpp_source.html">Optional.hpp</a>.</p> + +</div> +</div> +<hr/>The documentation for this class was generated from the following file:<ul> +<li>include/armnn/<a class="el" href="_optional_8hpp_source.html">Optional.hpp</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="namespacearmnn.html">armnn</a></li><li class="navelem"><a class="el" href="classarmnn_1_1_optional_base.html">OptionalBase</a></li> + <li class="footer">Generated on Fri Mar 13 2020 16:07:04 for ArmNN by + <a href="http://www.doxygen.org/index.html"> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li> + </ul> +</div> +</body> +</html> |