documentation/classarm__compute_1_1test_1_1validation_1_1_relative_tolerance.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.6"/>
   8 <meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines -->
   9 <title>Compute Library: RelativeTolerance&lt; T &gt; Class Template 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="navtree.js"></script>
  16 <script type="text/javascript">
  17   $(document).ready(initResizable);
  18   $(window).load(resizeHeight);
  19 </script>
  20 <link href="search/search.css" rel="stylesheet" type="text/css"/>
  21 <script type="text/javascript" src="search/search.js"></script>
  22 <script type="text/javascript">
  23   $(document).ready(function() { searchBox.OnSelectItem(0); });
  24 </script>
  25 <script type="text/x-mathjax-config">
  26   MathJax.Hub.Config({
  27     extensions: ["tex2jax.js"],
  28     jax: ["input/TeX","output/HTML-CSS"],
  29 });
  30 </script><script src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
  31 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  32 </head>
  33 <body>
  34 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  35 <div id="titlearea">
  36 <table cellspacing="0" cellpadding="0">
  37  <tbody>
  38  <tr style="height: 56px;">
  39   <td style="padding-left: 0.5em;">
  40    <div id="projectname">Compute Library
  41    &#160;<span id="projectnumber">17.09</span>
  42    </div>
  43   </td>
  44  </tr>
  45  </tbody>
  46 </table>
  47 </div>
  48 <!-- end header part -->
  49 <!-- Generated by Doxygen 1.8.6 -->
  50 <script type="text/javascript">
  51 var searchBox = new SearchBox("searchBox", "search",false,'Search');
  52 </script>
  53   <div id="navrow1" class="tabs">
  54     <ul class="tablist">
  55       <li><a href="index.xhtml"><span>Main&#160;Page</span></a></li>
  56       <li><a href="pages.xhtml"><span>Related&#160;Pages</span></a></li>
  57       <li><a href="namespaces.xhtml"><span>Namespaces</span></a></li>
  58       <li class="current"><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
  59       <li><a href="files.xhtml"><span>Files</span></a></li>
  60       <li>
  61         <div id="MSearchBox" class="MSearchBoxInactive">
  62         <span class="left">
  63           <img id="MSearchSelect" src="search/mag_sel.png"
  64                onmouseover="return searchBox.OnSearchSelectShow()"
  65                onmouseout="return searchBox.OnSearchSelectHide()"
  66                alt=""/>
  67           <input type="text" id="MSearchField" value="Search" accesskey="S"
  68                onfocus="searchBox.OnSearchFieldFocus(true)"
  69                onblur="searchBox.OnSearchFieldFocus(false)"
  70                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  71           </span><span class="right">
  72             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  73           </span>
  74         </div>
  75       </li>
  76     </ul>
  77   </div>
  78   <div id="navrow2" class="tabs2">
  79     <ul class="tablist">
  80       <li><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
  81       <li><a href="classes.xhtml"><span>Data&#160;Structure&#160;Index</span></a></li>
  82       <li><a href="inherits.xhtml"><span>Class&#160;Hierarchy</span></a></li>
  83       <li><a href="functions.xhtml"><span>Data&#160;Fields</span></a></li>
  84     </ul>
  85   </div>
  86 </div><!-- top -->
  87 <div id="side-nav" class="ui-resizable side-nav-resizable">
  88   <div id="nav-tree">
  89     <div id="nav-tree-contents">
  90       <div id="nav-sync" class="sync"></div>
  91     </div>
  92   </div>
  93   <div id="splitbar" style="-moz-user-select:none;"
  94        class="ui-resizable-handle">
  95   </div>
  96 </div>
  97 <script type="text/javascript">
  98 $(document).ready(function(){initNavTree('classarm__compute_1_1test_1_1validation_1_1_relative_tolerance.xhtml','');});
  99 </script>
 100 <div id="doc-content">
 101 <!-- window showing the filter options -->
 102 <div id="MSearchSelectWindow"
 103      onmouseover="return searchBox.OnSearchSelectShow()"
 104      onmouseout="return searchBox.OnSearchSelectHide()"
 105      onkeydown="return searchBox.OnSearchSelectKey(event)">
 106 <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark">&#160;</span>Pages</a></div>
 107
 108 <!-- iframe showing the search results (closed by default) -->
 109 <div id="MSearchResultsWindow">
 110 <iframe src="javascript:void(0)" frameborder="0"
 111         name="MSearchResults" id="MSearchResults">
 112 </iframe>
 113 </div>
 114
 115 <div class="header">
 116   <div class="summary">
 117 <a href="#pub-types">Public Types</a> &#124;
 118 <a href="#pub-methods">Public Member Functions</a>  </div>
 119   <div class="headertitle">
 120 <div class="title">RelativeTolerance&lt; T &gt; Class Template Reference</div>  </div>
 121 </div><!--header-->
 122 <div class="contents">
 123
 124 <p>Class reprensenting a relative tolerance value.
 125  <a href="classarm__compute_1_1test_1_1validation_1_1_relative_tolerance.xhtml#details">More...</a></p>
 126
 127 <p><code>#include &lt;<a class="el" href="_validation_8h_source.xhtml">Validation.h</a>&gt;</code></p>
 128 <table class="memberdecls">
 129 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
 130 Public Types</h2></td></tr>
 131 <tr class="memitem:afb9ded5f49336ae503bb9f2035ea902b"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1test_1_1validation_1_1_relative_tolerance.xhtml#afb9ded5f49336ae503bb9f2035ea902b">value_type</a> = T</td></tr>
 132 <tr class="memdesc:afb9ded5f49336ae503bb9f2035ea902b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Underlying type.  <a href="#afb9ded5f49336ae503bb9f2035ea902b">More...</a><br/></td></tr>
 133 <tr class="separator:afb9ded5f49336ae503bb9f2035ea902b"><td class="memSeparator" colspan="2">&#160;</td></tr>
 134 </table><table class="memberdecls">
 135 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
 136 Public Member Functions</h2></td></tr>
 137 <tr class="memitem:afba8d635945ce2a2787199919de28572"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1test_1_1validation_1_1_relative_tolerance.xhtml#afba8d635945ce2a2787199919de28572">RelativeTolerance</a> ()=default</td></tr>
 138 <tr class="separator:afba8d635945ce2a2787199919de28572"><td class="memSeparator" colspan="2">&#160;</td></tr>
 139 <tr class="memitem:a646bf2ba26847ea66d436ae933883c73"><td class="memItemLeft" align="right" valign="top">constexpr&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1test_1_1validation_1_1_relative_tolerance.xhtml#a646bf2ba26847ea66d436ae933883c73">RelativeTolerance</a> (<a class="el" href="classarm__compute_1_1test_1_1validation_1_1_relative_tolerance.xhtml#afb9ded5f49336ae503bb9f2035ea902b">value_type</a> <a class="el" href="hwc_8hpp.xhtml#a0f61d63b009d0880a89c843bd50d8d76">value</a>)</td></tr>
 140 <tr class="memdesc:a646bf2ba26847ea66d436ae933883c73"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a646bf2ba26847ea66d436ae933883c73">More...</a><br/></td></tr>
 141 <tr class="separator:a646bf2ba26847ea66d436ae933883c73"><td class="memSeparator" colspan="2">&#160;</td></tr>
 142 <tr class="memitem:aa32031050812b305a8db5fc4fa334754"><td class="memItemLeft" align="right" valign="top">constexpr&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1test_1_1validation_1_1_relative_tolerance.xhtml#aa32031050812b305a8db5fc4fa334754">operator value_type</a> () const </td></tr>
 143 <tr class="memdesc:aa32031050812b305a8db5fc4fa334754"><td class="mdescLeft">&#160;</td><td class="mdescRight">Implicit conversion to the underlying type.  <a href="#aa32031050812b305a8db5fc4fa334754">More...</a><br/></td></tr>
 144 <tr class="separator:aa32031050812b305a8db5fc4fa334754"><td class="memSeparator" colspan="2">&#160;</td></tr>
 145 </table>
 146 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 147 <div class="textblock"><h3>template&lt;typename T&gt;<br/>
 148 class arm_compute::test::validation::RelativeTolerance&lt; T &gt;</h3>
 149
 150 <p>Class reprensenting a relative tolerance value. </p>
 151
 152 <p>Definition at line <a class="el" href="_validation_8h_source.xhtml#l00083">83</a> of file <a class="el" href="_validation_8h_source.xhtml">Validation.h</a>.</p>
 153 </div><h2 class="groupheader">Member Typedef Documentation</h2>
 154 <a class="anchor" id="afb9ded5f49336ae503bb9f2035ea902b"></a>
 155 <div class="memitem">
 156 <div class="memproto">
 157       <table class="memname">
 158         <tr>
 159           <td class="memname">using <a class="el" href="classarm__compute_1_1test_1_1validation_1_1_relative_tolerance.xhtml#afb9ded5f49336ae503bb9f2035ea902b">value_type</a> =  T</td>
 160         </tr>
 161       </table>
 162 </div><div class="memdoc">
 163
 164 <p>Underlying type. </p>
 165
 166 <p>Definition at line <a class="el" href="_validation_8h_source.xhtml#l00087">87</a> of file <a class="el" href="_validation_8h_source.xhtml">Validation.h</a>.</p>
 167
 168 </div>
 169 </div>
 170 <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 171 <a class="anchor" id="afba8d635945ce2a2787199919de28572"></a>
 172 <div class="memitem">
 173 <div class="memproto">
 174 <table class="mlabels">
 175   <tr>
 176   <td class="mlabels-left">
 177       <table class="memname">
 178         <tr>
 179           <td class="memname"><a class="el" href="classarm__compute_1_1test_1_1validation_1_1_relative_tolerance.xhtml">RelativeTolerance</a> </td>
 180           <td>(</td>
 181           <td class="paramname"></td><td>)</td>
 182           <td></td>
 183         </tr>
 184       </table>
 185   </td>
 186   <td class="mlabels-right">
 187 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
 188   </tr>
 189 </table>
 190 </div><div class="memdoc">
 191
 192 </div>
 193 </div>
 194 <a class="anchor" id="a646bf2ba26847ea66d436ae933883c73"></a>
 195 <div class="memitem">
 196 <div class="memproto">
 197 <table class="mlabels">
 198   <tr>
 199   <td class="mlabels-left">
 200       <table class="memname">
 201         <tr>
 202           <td class="memname">constexpr <a class="el" href="classarm__compute_1_1test_1_1validation_1_1_relative_tolerance.xhtml">RelativeTolerance</a> </td>
 203           <td>(</td>
 204           <td class="paramtype"><a class="el" href="classarm__compute_1_1test_1_1validation_1_1_relative_tolerance.xhtml#afb9ded5f49336ae503bb9f2035ea902b">value_type</a>&#160;</td>
 205           <td class="paramname"><em>value</em></td><td>)</td>
 206           <td></td>
 207         </tr>
 208       </table>
 209   </td>
 210   <td class="mlabels-right">
 211 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span>  </td>
 212   </tr>
 213 </table>
 214 </div><div class="memdoc">
 215
 216 <p>Constructor. </p>
 217 <dl class="params"><dt>Parameters</dt><dd>
 218   <table class="params">
 219     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>Relative tolerance value. </td></tr>
 220   </table>
 221   </dd>
 222 </dl>
 223
 224 <p>Definition at line <a class="el" href="_validation_8h_source.xhtml#l00099">99</a> of file <a class="el" href="_validation_8h_source.xhtml">Validation.h</a>.</p>
 225 <div class="fragment"><div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;        : _value{ <a class="code" href="hwc_8hpp.xhtml#a0f61d63b009d0880a89c843bd50d8d76">value</a> }</div>
 226 <div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;    {</div>
 227 <div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;    }</div>
 228 <div class="ttc" id="hwc_8hpp_xhtml_a0f61d63b009d0880a89c843bd50d8d76"><div class="ttname"><a href="hwc_8hpp.xhtml#a0f61d63b009d0880a89c843bd50d8d76">value</a></div><div class="ttdeci">void * value</div><div class="ttdef"><b>Definition:</b> <a href="hwc_8hpp_source.xhtml#l00269">hwc.hpp:269</a></div></div>
 229 </div><!-- fragment -->
 230 </div>
 231 </div>
 232 <h2 class="groupheader">Member Function Documentation</h2>
 233 <a class="anchor" id="aa32031050812b305a8db5fc4fa334754"></a>
 234 <div class="memitem">
 235 <div class="memproto">
 236 <table class="mlabels">
 237   <tr>
 238   <td class="mlabels-left">
 239       <table class="memname">
 240         <tr>
 241           <td class="memname">constexpr operator <a class="el" href="classarm__compute_1_1test_1_1validation_1_1_relative_tolerance.xhtml#afb9ded5f49336ae503bb9f2035ea902b">value_type</a> </td>
 242           <td>(</td>
 243           <td class="paramname"></td><td>)</td>
 244           <td> const</td>
 245         </tr>
 246       </table>
 247   </td>
 248   <td class="mlabels-right">
 249 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 250   </tr>
 251 </table>
 252 </div><div class="memdoc">
 253
 254 <p>Implicit conversion to the underlying type. </p>
 255
 256 <p>Definition at line <a class="el" href="_validation_8h_source.xhtml#l00105">105</a> of file <a class="el" href="_validation_8h_source.xhtml">Validation.h</a>.</p>
 257 <div class="fragment"><div class="line"><a name="l00106"></a><span class="lineno">  106</span>&#160;    {</div>
 258 <div class="line"><a name="l00107"></a><span class="lineno">  107</span>&#160;        <span class="keywordflow">return</span> _value;</div>
 259 <div class="line"><a name="l00108"></a><span class="lineno">  108</span>&#160;    }</div>
 260 </div><!-- fragment -->
 261 </div>
 262 </div>
 263 <hr/>The documentation for this class was generated from the following file:<ul>
 264 <li>tests/validation/<a class="el" href="_validation_8h_source.xhtml">Validation.h</a></li>
 265 </ul>
 266 </div><!-- contents -->
 267 </div><!-- doc-content -->
 268 <!-- start footer part -->
 269 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 270   <ul>
 271     <li class="navelem"><a class="el" href="namespacearm__compute.xhtml">arm_compute</a></li><li class="navelem"><a class="el" href="namespacearm__compute_1_1test.xhtml">test</a></li><li class="navelem"><a class="el" href="namespacearm__compute_1_1test_1_1validation.xhtml">validation</a></li><li class="navelem"><a class="el" href="classarm__compute_1_1test_1_1validation_1_1_relative_tolerance.xhtml">RelativeTolerance</a></li>
 272     <li class="footer">Generated on Thu Sep 28 2017 14:38:00 for Compute Library by
 273     <a href="http://www.doxygen.org/index.html">
 274     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>
 275   </ul>
 276 </div>
 277 </body>
 278 </html>