documentation/classarm__compute_1_1detail_1_1compare__dimension.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: compare_dimension&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="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_1detail_1_1compare__dimension.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">compare_dimension&lt; T &gt; Class Template Reference</div>  </div>
 122 </div><!--header-->
 123 <div class="contents">
 124
 125 <p>Function to compare two <a class="el" href="classarm__compute_1_1_dimensions.xhtml">Dimensions</a> objects and throw an error on mismatch.
 126  <a href="classarm__compute_1_1detail_1_1compare__dimension.xhtml#details">More...</a></p>
 127
 128 <p><code>#include &lt;<a class="el" href="_validate_8h_source.xhtml">Validate.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:afe99c6d8da678f7dce4e4a58ad1e0175"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1detail_1_1compare__dimension.xhtml#afe99c6d8da678f7dce4e4a58ad1e0175">compare_dimension</a> (const <a class="el" href="classarm__compute_1_1_dimensions.xhtml">Dimensions</a>&lt; T &gt; &amp;dim, const char *function, const char *file, int line)</td></tr>
 133 <tr class="memdesc:afe99c6d8da678f7dce4e4a58ad1e0175"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct a comparison function.  <a href="#afe99c6d8da678f7dce4e4a58ad1e0175">More...</a><br /></td></tr>
 134 <tr class="separator:afe99c6d8da678f7dce4e4a58ad1e0175"><td class="memSeparator" colspan="2">&#160;</td></tr>
 135 <tr class="memitem:a90462712db283368a62956b9b38aa6a5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_status.xhtml">arm_compute::Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1detail_1_1compare__dimension.xhtml#a90462712db283368a62956b9b38aa6a5">operator()</a> (const <a class="el" href="classarm__compute_1_1_dimensions.xhtml">Dimensions</a>&lt; T &gt; &amp;dim)</td></tr>
 136 <tr class="memdesc:a90462712db283368a62956b9b38aa6a5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compare the given object against the stored one.  <a href="#a90462712db283368a62956b9b38aa6a5">More...</a><br /></td></tr>
 137 <tr class="separator:a90462712db283368a62956b9b38aa6a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
 138 </table>
 139 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 140 <div class="textblock"><h3>template&lt;typename T&gt;<br />
 141 class arm_compute::detail::compare_dimension&lt; T &gt;</h3>
 142
 143 <p>Function to compare two <a class="el" href="classarm__compute_1_1_dimensions.xhtml">Dimensions</a> objects and throw an error on mismatch. </p>
 144 <dl class="params"><dt>Parameters</dt><dd>
 145   <table class="params">
 146     <tr><td class="paramdir">[in]</td><td class="paramname">dim</td><td>Object to compare against. </td></tr>
 147     <tr><td class="paramdir">[in]</td><td class="paramname">function</td><td>Function in which the error occurred. </td></tr>
 148     <tr><td class="paramdir">[in]</td><td class="paramname">file</td><td>File in which the error occurred. </td></tr>
 149     <tr><td class="paramdir">[in]</td><td class="paramname">line</td><td>Line in which the error occurred. </td></tr>
 150   </table>
 151   </dd>
 152 </dl>
 153
 154 <p>Definition at line <a class="el" href="_validate_8h_source.xhtml#l00072">72</a> of file <a class="el" href="_validate_8h_source.xhtml">Validate.h</a>.</p>
 155 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 156 <a class="anchor" id="afe99c6d8da678f7dce4e4a58ad1e0175"></a>
 157 <div class="memitem">
 158 <div class="memproto">
 159 <table class="mlabels">
 160   <tr>
 161   <td class="mlabels-left">
 162       <table class="memname">
 163         <tr>
 164           <td class="memname"><a class="el" href="classarm__compute_1_1detail_1_1compare__dimension.xhtml">compare_dimension</a> </td>
 165           <td>(</td>
 166           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_dimensions.xhtml">Dimensions</a>&lt; T &gt; &amp;&#160;</td>
 167           <td class="paramname"><em>dim</em>, </td>
 168         </tr>
 169         <tr>
 170           <td class="paramkey"></td>
 171           <td></td>
 172           <td class="paramtype">const char *&#160;</td>
 173           <td class="paramname"><em>function</em>, </td>
 174         </tr>
 175         <tr>
 176           <td class="paramkey"></td>
 177           <td></td>
 178           <td class="paramtype">const char *&#160;</td>
 179           <td class="paramname"><em>file</em>, </td>
 180         </tr>
 181         <tr>
 182           <td class="paramkey"></td>
 183           <td></td>
 184           <td class="paramtype">int&#160;</td>
 185           <td class="paramname"><em>line</em>&#160;</td>
 186         </tr>
 187         <tr>
 188           <td></td>
 189           <td>)</td>
 190           <td></td><td></td>
 191         </tr>
 192       </table>
 193   </td>
 194   <td class="mlabels-right">
 195 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 196   </tr>
 197 </table>
 198 </div><div class="memdoc">
 199
 200 <p>Construct a comparison function. </p>
 201 <dl class="params"><dt>Parameters</dt><dd>
 202   <table class="params">
 203     <tr><td class="paramdir">[in]</td><td class="paramname">dim</td><td><a class="el" href="classarm__compute_1_1_dimensions.xhtml" title="Dimensions with dimensionality. ">Dimensions</a> to compare. </td></tr>
 204     <tr><td class="paramdir">[in]</td><td class="paramname">function</td><td>Source function. Used for error reporting. </td></tr>
 205     <tr><td class="paramdir">[in]</td><td class="paramname">file</td><td>Source code file. Used for error reporting. </td></tr>
 206     <tr><td class="paramdir">[in]</td><td class="paramname">line</td><td>Source code line. Used for error reporting. </td></tr>
 207   </table>
 208   </dd>
 209 </dl>
 210
 211 <p>Definition at line <a class="el" href="_validate_8h_source.xhtml#l00082">82</a> of file <a class="el" href="_validate_8h_source.xhtml">Validate.h</a>.</p>
 212 <div class="fragment"><div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;        : _dim{ dim }, _function{ <span class="keyword">function</span> }, _file{ file }, _line{ line }</div><div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;    {</div><div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;    }</div></div><!-- fragment -->
 213 </div>
 214 </div>
 215 <h2 class="groupheader">Member Function Documentation</h2>
 216 <a class="anchor" id="a90462712db283368a62956b9b38aa6a5"></a>
 217 <div class="memitem">
 218 <div class="memproto">
 219 <table class="mlabels">
 220   <tr>
 221   <td class="mlabels-left">
 222       <table class="memname">
 223         <tr>
 224           <td class="memname"><a class="el" href="classarm__compute_1_1_status.xhtml">arm_compute::Status</a> operator() </td>
 225           <td>(</td>
 226           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_dimensions.xhtml">Dimensions</a>&lt; T &gt; &amp;&#160;</td>
 227           <td class="paramname"><em>dim</em></td><td>)</td>
 228           <td></td>
 229         </tr>
 230       </table>
 231   </td>
 232   <td class="mlabels-right">
 233 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 234   </tr>
 235 </table>
 236 </div><div class="memdoc">
 237
 238 <p>Compare the given object against the stored one. </p>
 239 <dl class="params"><dt>Parameters</dt><dd>
 240   <table class="params">
 241     <tr><td class="paramdir">[in]</td><td class="paramname">dim</td><td>To be compared object.</td></tr>
 242   </table>
 243   </dd>
 244 </dl>
 245 <dl class="section return"><dt>Returns</dt><dd>a status. </dd></dl>
 246
 247 <p>Definition at line <a class="el" href="_validate_8h_source.xhtml#l00093">93</a> of file <a class="el" href="_validate_8h_source.xhtml">Validate.h</a>.</p>
 248
 249 <p>References <a class="el" href="_error_8h_source.xhtml#l00230">ARM_COMPUTE_RETURN_ERROR_ON_LOC_MSG</a>, and <a class="el" href="_validate_8h_source.xhtml#l00051">arm_compute::detail::have_different_dimensions()</a>.</p>
 250 <div class="fragment"><div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;    {</div><div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;        <a class="code" href="_error_8h.xhtml#ab4ebbfbeedd9d66614ddbfdb14199cbf">ARM_COMPUTE_RETURN_ERROR_ON_LOC_MSG</a>(<a class="code" href="namespacearm__compute_1_1detail.xhtml#a45d610a8bc262f7007c934293361e888">have_different_dimensions</a>(_dim, dim, 0), _function, _file, _line,</div><div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;                                            <span class="stringliteral">&quot;Objects have different dimensions&quot;</span>);</div><div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;        <span class="keywordflow">return</span> <a class="code" href="classarm__compute_1_1_status.xhtml">arm_compute::Status</a>{};</div><div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;    }</div><div class="ttc" id="_error_8h_xhtml_ab4ebbfbeedd9d66614ddbfdb14199cbf"><div class="ttname"><a href="_error_8h.xhtml#ab4ebbfbeedd9d66614ddbfdb14199cbf">ARM_COMPUTE_RETURN_ERROR_ON_LOC_MSG</a></div><div class="ttdeci">#define ARM_COMPUTE_RETURN_ERROR_ON_LOC_MSG(cond, func, file, line,...)</div><div class="ttdoc">If the condition is true, an error is thrown. </div><div class="ttdef"><b>Definition:</b> <a href="_error_8h_source.xhtml#l00230">Error.h:230</a></div></div>
 251 <div class="ttc" id="classarm__compute_1_1_status_xhtml"><div class="ttname"><a href="classarm__compute_1_1_status.xhtml">arm_compute::Status</a></div><div class="ttdoc">Status class. </div><div class="ttdef"><b>Definition:</b> <a href="_error_8h_source.xhtml#l00051">Error.h:51</a></div></div>
 252 <div class="ttc" id="namespacearm__compute_1_1detail_xhtml_a45d610a8bc262f7007c934293361e888"><div class="ttname"><a href="namespacearm__compute_1_1detail.xhtml#a45d610a8bc262f7007c934293361e888">arm_compute::detail::have_different_dimensions</a></div><div class="ttdeci">bool have_different_dimensions(const Dimensions&lt; T &gt; &amp;dim1, const Dimensions&lt; T &gt; &amp;dim2, unsigned int upper_dim)</div><div class="ttdef"><b>Definition:</b> <a href="_validate_8h_source.xhtml#l00051">Validate.h:51</a></div></div>
 253 </div><!-- fragment -->
 254 </div>
 255 </div>
 256 <hr/>The documentation for this class was generated from the following file:<ul>
 257 <li>arm_compute/core/<a class="el" href="_validate_8h_source.xhtml">Validate.h</a></li>
 258 </ul>
 259 </div><!-- contents -->
 260 </div><!-- doc-content -->
 261 <!-- start footer part -->
 262 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 263   <ul>
 264     <li class="navelem"><a class="el" href="namespacearm__compute.xhtml">arm_compute</a></li><li class="navelem"><a class="el" href="namespacearm__compute_1_1detail.xhtml">detail</a></li><li class="navelem"><a class="el" href="classarm__compute_1_1detail_1_1compare__dimension.xhtml">compare_dimension</a></li>
 265     <li class="footer">Generated on Wed May 23 2018 11:36:43 for Compute Library by
 266     <a href="http://www.doxygen.org/index.html">
 267     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
 268   </ul>
 269 </div>
 270 </body>
 271 </html>