arm_compute v17.06
[platform/upstream/armcl.git] / documentation / _error_8h.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: arm_compute/core/Error.h File 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">v17.06</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><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
61       <li class="current"><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="files.xhtml"><span>File&#160;List</span></a></li>
83       <li><a href="globals.xhtml"><span>Globals</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('_error_8h.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 </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="#namespaces">Namespaces</a> &#124;
118 <a href="#define-members">Macros</a> &#124;
119 <a href="#func-members">Functions</a>  </div>
120   <div class="headertitle">
121 <div class="title">Error.h File Reference</div>  </div>
122 </div><!--header-->
123 <div class="contents">
124
125 <p><a href="_error_8h_source.xhtml">Go to the source code of this file.</a></p>
126 <table class="memberdecls">
127 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
128 Namespaces</h2></td></tr>
129 <tr class="memitem:namespacearm__compute"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearm__compute.xhtml">arm_compute</a></td></tr>
130 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
131 </table><table class="memberdecls">
132 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
133 Macros</h2></td></tr>
134 <tr class="memitem:a05b19c75afe9c24200a62b9724734bbd"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_error_8h.xhtml#a05b19c75afe9c24200a62b9724734bbd">ARM_COMPUTE_ERROR</a>(...)&#160;&#160;&#160;::<a class="el" href="namespacearm__compute.xhtml#a568b0fbfa3d903099d9c9f7b6acf188d">arm_compute::error</a>(__func__, __FILE__, __LINE__, __VA_ARGS__)</td></tr>
135 <tr class="memdesc:a05b19c75afe9c24200a62b9724734bbd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Print the given message then throw an std::runtime_error.  <a href="#a05b19c75afe9c24200a62b9724734bbd">More...</a><br /></td></tr>
136 <tr class="separator:a05b19c75afe9c24200a62b9724734bbd"><td class="memSeparator" colspan="2">&#160;</td></tr>
137 <tr class="memitem:af93757c5021d1802b094dfbead459391"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_error_8h.xhtml#af93757c5021d1802b094dfbead459391">ARM_COMPUTE_ERROR_LOC</a>(func,  file,  line, ...)&#160;&#160;&#160;::<a class="el" href="namespacearm__compute.xhtml#a568b0fbfa3d903099d9c9f7b6acf188d">arm_compute::error</a>(func, file, line, __VA_ARGS__)</td></tr>
138 <tr class="memdesc:af93757c5021d1802b094dfbead459391"><td class="mdescLeft">&#160;</td><td class="mdescRight">Print the given message then throw an std::runtime_error.  <a href="#af93757c5021d1802b094dfbead459391">More...</a><br /></td></tr>
139 <tr class="separator:af93757c5021d1802b094dfbead459391"><td class="memSeparator" colspan="2">&#160;</td></tr>
140 <tr class="memitem:a4103adbb45806b2f2002d44b91d0d206"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_error_8h.xhtml#a4103adbb45806b2f2002d44b91d0d206">ARM_COMPUTE_UNUSED</a>(var)&#160;&#160;&#160;(void)(var)</td></tr>
141 <tr class="memdesc:a4103adbb45806b2f2002d44b91d0d206"><td class="mdescLeft">&#160;</td><td class="mdescRight">To avoid unused variables warnings.  <a href="#a4103adbb45806b2f2002d44b91d0d206">More...</a><br /></td></tr>
142 <tr class="separator:a4103adbb45806b2f2002d44b91d0d206"><td class="memSeparator" colspan="2">&#160;</td></tr>
143 <tr class="memitem:a8a89ba1af4a8a70df25753e354d41641"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_error_8h.xhtml#a8a89ba1af4a8a70df25753e354d41641">ARM_COMPUTE_INFO_ON_MSG</a>(cond, ...)</td></tr>
144 <tr class="separator:a8a89ba1af4a8a70df25753e354d41641"><td class="memSeparator" colspan="2">&#160;</td></tr>
145 <tr class="memitem:ae0ebdb75cd00c490fadb20f25b67ec90"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_error_8h.xhtml#ae0ebdb75cd00c490fadb20f25b67ec90">ARM_COMPUTE_INFO</a>(...)</td></tr>
146 <tr class="separator:ae0ebdb75cd00c490fadb20f25b67ec90"><td class="memSeparator" colspan="2">&#160;</td></tr>
147 <tr class="memitem:a5bbdcf574d3f5e412fa6a1117911e67b"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_error_8h.xhtml#a5bbdcf574d3f5e412fa6a1117911e67b">ARM_COMPUTE_ERROR_ON_MSG</a>(cond, ...)</td></tr>
148 <tr class="separator:a5bbdcf574d3f5e412fa6a1117911e67b"><td class="memSeparator" colspan="2">&#160;</td></tr>
149 <tr class="memitem:a1b62e396a1789909dadda61ea4cda96f"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_error_8h.xhtml#a1b62e396a1789909dadda61ea4cda96f">ARM_COMPUTE_ERROR_ON_LOC_MSG</a>(cond,  func,  file,  line, ...)</td></tr>
150 <tr class="separator:a1b62e396a1789909dadda61ea4cda96f"><td class="memSeparator" colspan="2">&#160;</td></tr>
151 <tr class="memitem:a50048c593c53405cca5b0d69dfe25554"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_error_8h.xhtml#a50048c593c53405cca5b0d69dfe25554">ARM_COMPUTE_CONST_ON_ERROR</a>(cond,  val,  msg)&#160;&#160;&#160;val</td></tr>
152 <tr class="separator:a50048c593c53405cca5b0d69dfe25554"><td class="memSeparator" colspan="2">&#160;</td></tr>
153 <tr class="memitem:a54a6080c9f4df1f908e57a9bbb46f5da"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_error_8h.xhtml#a54a6080c9f4df1f908e57a9bbb46f5da">ARM_COMPUTE_ERROR_ON</a>(cond)&#160;&#160;&#160;<a class="el" href="_error_8h.xhtml#a5bbdcf574d3f5e412fa6a1117911e67b">ARM_COMPUTE_ERROR_ON_MSG</a>(cond, #cond)</td></tr>
154 <tr class="memdesc:a54a6080c9f4df1f908e57a9bbb46f5da"><td class="mdescLeft">&#160;</td><td class="mdescRight">If the condition is true then an error message is printed and an exception thrown.  <a href="#a54a6080c9f4df1f908e57a9bbb46f5da">More...</a><br /></td></tr>
155 <tr class="separator:a54a6080c9f4df1f908e57a9bbb46f5da"><td class="memSeparator" colspan="2">&#160;</td></tr>
156 <tr class="memitem:ac90c3bce005225cbaa4a43740917bb58"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_error_8h.xhtml#ac90c3bce005225cbaa4a43740917bb58">ARM_COMPUTE_ERROR_ON_LOC</a>(cond,  func,  file,  line)&#160;&#160;&#160;<a class="el" href="_error_8h.xhtml#a1b62e396a1789909dadda61ea4cda96f">ARM_COMPUTE_ERROR_ON_LOC_MSG</a>(cond, func, file, line, #cond)</td></tr>
157 <tr class="memdesc:ac90c3bce005225cbaa4a43740917bb58"><td class="mdescLeft">&#160;</td><td class="mdescRight">If the condition is true then an error message is printed and an exception thrown.  <a href="#ac90c3bce005225cbaa4a43740917bb58">More...</a><br /></td></tr>
158 <tr class="separator:ac90c3bce005225cbaa4a43740917bb58"><td class="memSeparator" colspan="2">&#160;</td></tr>
159 </table><table class="memberdecls">
160 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
161 Functions</h2></td></tr>
162 <tr class="memitem:a568b0fbfa3d903099d9c9f7b6acf188d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearm__compute.xhtml#a568b0fbfa3d903099d9c9f7b6acf188d">error</a> (const char *function, const char *file, const int line, const char *msg,...)</td></tr>
163 <tr class="memdesc:a568b0fbfa3d903099d9c9f7b6acf188d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Print an error message then throw an std::runtime_error.  <a href="namespacearm__compute.xhtml#a568b0fbfa3d903099d9c9f7b6acf188d">More...</a><br /></td></tr>
164 <tr class="separator:a568b0fbfa3d903099d9c9f7b6acf188d"><td class="memSeparator" colspan="2">&#160;</td></tr>
165 <tr class="memitem:a5930b66fce0674d707fbf4f2dfcacc8f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearm__compute.xhtml#a5930b66fce0674d707fbf4f2dfcacc8f">debug</a> (const char *function, const char *file, const int line, const char *msg,...)</td></tr>
166 <tr class="memdesc:a5930b66fce0674d707fbf4f2dfcacc8f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Print a debug message.  <a href="namespacearm__compute.xhtml#a5930b66fce0674d707fbf4f2dfcacc8f">More...</a><br /></td></tr>
167 <tr class="separator:a5930b66fce0674d707fbf4f2dfcacc8f"><td class="memSeparator" colspan="2">&#160;</td></tr>
168 </table>
169 <h2 class="groupheader">Macro Definition Documentation</h2>
170 <a class="anchor" id="a50048c593c53405cca5b0d69dfe25554"></a>
171 <div class="memitem">
172 <div class="memproto">
173       <table class="memname">
174         <tr>
175           <td class="memname">#define ARM_COMPUTE_CONST_ON_ERROR</td>
176           <td>(</td>
177           <td class="paramtype">&#160;</td>
178           <td class="paramname">cond, </td>
179         </tr>
180         <tr>
181           <td class="paramkey"></td>
182           <td></td>
183           <td class="paramtype">&#160;</td>
184           <td class="paramname">val, </td>
185         </tr>
186         <tr>
187           <td class="paramkey"></td>
188           <td></td>
189           <td class="paramtype">&#160;</td>
190           <td class="paramname">msg&#160;</td>
191         </tr>
192         <tr>
193           <td></td>
194           <td>)</td>
195           <td></td><td>&#160;&#160;&#160;val</td>
196         </tr>
197       </table>
198 </div><div class="memdoc">
199
200 <p>Definition at line <a class="el" href="_error_8h_source.xhtml#l00117">117</a> of file <a class="el" href="_error_8h_source.xhtml">Error.h</a>.</p>
201
202 </div>
203 </div>
204 <a class="anchor" id="a05b19c75afe9c24200a62b9724734bbd"></a>
205 <div class="memitem">
206 <div class="memproto">
207       <table class="memname">
208         <tr>
209           <td class="memname">#define ARM_COMPUTE_ERROR</td>
210           <td>(</td>
211           <td class="paramtype">&#160;</td>
212           <td class="paramname"><em>...</em></td><td>)</td>
213           <td>&#160;&#160;&#160;::<a class="el" href="namespacearm__compute.xhtml#a568b0fbfa3d903099d9c9f7b6acf188d">arm_compute::error</a>(__func__, __FILE__, __LINE__, __VA_ARGS__)</td>
214         </tr>
215       </table>
216 </div><div class="memdoc">
217
218 <p>Print the given message then throw an std::runtime_error. </p>
219 <dl class="params"><dt>Parameters</dt><dd>
220   <table class="params">
221     <tr><td class="paramdir">[in]</td><td class="paramname">...</td><td>Message to display before aborting. </td></tr>
222   </table>
223   </dd>
224 </dl>
225
226 <p>Definition at line <a class="el" href="_error_8h_source.xhtml#l00031">31</a> of file <a class="el" href="_error_8h_source.xhtml">Error.h</a>.</p>
227
228 <p>Referenced by <a class="el" href="_tensor_operations_8h_source.xhtml#l00296">arm_compute::test::validation::tensor_operations::accumulate_squared()</a>, <a class="el" href="_tensor_operations_8h_source.xhtml#l00314">arm_compute::test::validation::tensor_operations::accumulate_weighted()</a>, <a class="el" href="_tensor_operations_8h_source.xhtml#l00686">arm_compute::test::validation::tensor_operations::activation_layer()</a>, <a class="el" href="_reference_8cpp_source.xhtml#l00555">Reference::compute_reference_fixed_point_operation()</a>, <a class="el" href="_reference_8cpp_source.xhtml#l00499">Reference::compute_reference_pooling_layer()</a>, <a class="el" href="arm__compute_2core_2_utils_8h_source.xhtml#l00099">arm_compute::data_size_from_type()</a>, <a class="el" href="arm__compute_2core_2_utils_8h_source.xhtml#l00201">arm_compute::data_type_from_format()</a>, <a class="el" href="_tensor_operations_8h_source.xhtml#l00414">arm_compute::test::validation::tensor_operations::depth_convert()</a>, <a class="el" href="arm__compute_2core_2_utils_8h_source.xhtml#l00172">arm_compute::element_size_from_data_type()</a>, <a class="el" href="utils_2_utils_8h_source.xhtml#l00142">PPMLoader::fill_image()</a>, <a class="el" href="_tensor_library_8h_source.xhtml#l00437">TensorLibrary::fill_tensor_uniform()</a>, <a class="el" href="_tensor_operations_8h_source.xhtml#l01319">arm_compute::test::validation::tensor_operations::fixed_point_operation()</a>, <a class="el" href="_tensor_factory_8h_source.xhtml#l00058">TensorFactory::get_tensor()</a>, <a class="el" href="_v_x_helpers_8h_source.xhtml#l00043">arm_compute::test::validation::vx::get_vximage_format()</a>, <a class="el" href="_raw_tensor_8cpp_source.xhtml#l00124">RawTensor::num_channels()</a>, <a class="el" href="arm__compute_2core_2_utils_8h_source.xhtml#l00289">arm_compute::num_planes_from_format()</a>, <a class="el" href="utils_2_utils_8h_source.xhtml#l00094">PPMLoader::open()</a>, <a class="el" href="_tensor_visitors_8h_source.xhtml#l00168">fixed_point_pixel_wise_multiplication_visitor::operator()()</a>, <a class="el" href="_tensor_visitors_8h_source.xhtml#l00354">fixed_point_operation_visitor::operator()()</a>, <a class="el" href="_type_printer_8h_source.xhtml#l00069">arm_compute::operator&lt;&lt;()</a>, <a class="el" href="arm__compute_2core_2_utils_8h_source.xhtml#l00134">arm_compute::pixel_size_from_format()</a>, <a class="el" href="_tensor_operations_8h_source.xhtml#l00579">arm_compute::test::validation::tensor_operations::pixel_wise_multiplication()</a>, <a class="el" href="arm__compute_2core_2_utils_8h_source.xhtml#l00242">arm_compute::plane_idx_from_channel()</a>, <a class="el" href="utils_2_utils_8h_source.xhtml#l00245">arm_compute::utils::save_to_ppm()</a>, <a class="el" href="tests_2_utils_8h_source.xhtml#l00526">arm_compute::test::store_value_with_data_type()</a>, and <a class="el" href="_tensor_operations_8h_source.xhtml#l00651">arm_compute::test::validation::tensor_operations::threshold()</a>.</p>
229
230 </div>
231 </div>
232 <a class="anchor" id="af93757c5021d1802b094dfbead459391"></a>
233 <div class="memitem">
234 <div class="memproto">
235       <table class="memname">
236         <tr>
237           <td class="memname">#define ARM_COMPUTE_ERROR_LOC</td>
238           <td>(</td>
239           <td class="paramtype">&#160;</td>
240           <td class="paramname">func, </td>
241         </tr>
242         <tr>
243           <td class="paramkey"></td>
244           <td></td>
245           <td class="paramtype">&#160;</td>
246           <td class="paramname">file, </td>
247         </tr>
248         <tr>
249           <td class="paramkey"></td>
250           <td></td>
251           <td class="paramtype">&#160;</td>
252           <td class="paramname">line, </td>
253         </tr>
254         <tr>
255           <td class="paramkey"></td>
256           <td></td>
257           <td class="paramtype">&#160;</td>
258           <td class="paramname"><em>...</em>&#160;</td>
259         </tr>
260         <tr>
261           <td></td>
262           <td>)</td>
263           <td></td><td>&#160;&#160;&#160;::<a class="el" href="namespacearm__compute.xhtml#a568b0fbfa3d903099d9c9f7b6acf188d">arm_compute::error</a>(func, file, line, __VA_ARGS__)</td>
264         </tr>
265       </table>
266 </div><div class="memdoc">
267
268 <p>Print the given message then throw an std::runtime_error. </p>
269 <dl class="params"><dt>Parameters</dt><dd>
270   <table class="params">
271     <tr><td class="paramdir">[in]</td><td class="paramname">func</td><td>Function in which the error occurred. </td></tr>
272     <tr><td class="paramdir">[in]</td><td class="paramname">file</td><td>File in which the error occurred. </td></tr>
273     <tr><td class="paramdir">[in]</td><td class="paramname">line</td><td>Line in which the error occurred. </td></tr>
274     <tr><td class="paramdir">[in]</td><td class="paramname">...</td><td>Message to display before aborting. </td></tr>
275   </table>
276   </dd>
277 </dl>
278
279 <p>Definition at line <a class="el" href="_error_8h_source.xhtml#l00040">40</a> of file <a class="el" href="_error_8h_source.xhtml">Error.h</a>.</p>
280
281 </div>
282 </div>
283 <a class="anchor" id="a54a6080c9f4df1f908e57a9bbb46f5da"></a>
284 <div class="memitem">
285 <div class="memproto">
286       <table class="memname">
287         <tr>
288           <td class="memname">#define ARM_COMPUTE_ERROR_ON</td>
289           <td>(</td>
290           <td class="paramtype">&#160;</td>
291           <td class="paramname">cond</td><td>)</td>
292           <td>&#160;&#160;&#160;<a class="el" href="_error_8h.xhtml#a5bbdcf574d3f5e412fa6a1117911e67b">ARM_COMPUTE_ERROR_ON_MSG</a>(cond, #cond)</td>
293         </tr>
294       </table>
295 </div><div class="memdoc">
296
297 <p>If the condition is true then an error message is printed and an exception thrown. </p>
298 <dl class="params"><dt>Parameters</dt><dd>
299   <table class="params">
300     <tr><td class="paramdir">[in]</td><td class="paramname">cond</td><td>Condition to evaluate </td></tr>
301   </table>
302   </dd>
303 </dl>
304
305 <p>Definition at line <a class="el" href="_error_8h_source.xhtml#l00124">124</a> of file <a class="el" href="_error_8h_source.xhtml">Error.h</a>.</p>
306
307 <p>Referenced by <a class="el" href="_i_access_window_8h_source.xhtml#l00217">AccessWindowHorizontal::AccessWindowHorizontal()</a>, <a class="el" href="_i_access_window_8h_source.xhtml#l00132">AccessWindowRectangle::AccessWindowRectangle()</a>, <a class="el" href="_i_access_window_8h_source.xhtml#l00196">AccessWindowVertical::AccessWindowVertical()</a>, <a class="el" href="_reference_c_p_p_8cpp_source.xhtml#l00068">ReferenceCPP::accumulate()</a>, <a class="el" href="_reference_c_p_p_8cpp_source.xhtml#l00077">ReferenceCPP::accumulate_squared()</a>, <a class="el" href="_reference_c_p_p_8cpp_source.xhtml#l00086">ReferenceCPP::accumulate_weighted()</a>, <a class="el" href="_window_8inl_source.xhtml#l00053">Window::adjust()</a>, <a class="el" href="_i_access_window_8h_source.xhtml#l00047">arm_compute::adjust_down()</a>, <a class="el" href="_i_access_window_8h_source.xhtml#l00063">arm_compute::adjust_up()</a>, <a class="el" href="_i_array_8h_source.xhtml#l00117">IArray&lt; NELKInternalKeypoint &gt;::at()</a>, <a class="el" href="_sub_tensor_info_8h_source.xhtml#l00086">SubTensorInfo::auto_padding()</a>, <a class="el" href="_reference_c_p_p_8cpp_source.xhtml#l00113">ReferenceCPP::bitwise_and()</a>, <a class="el" href="_reference_c_p_p_8cpp_source.xhtml#l00143">ReferenceCPP::bitwise_not()</a>, <a class="el" href="_reference_c_p_p_8cpp_source.xhtml#l00123">ReferenceCPP::bitwise_or()</a>, <a class="el" href="_reference_c_p_p_8cpp_source.xhtml#l00133">ReferenceCPP::bitwise_xor()</a>, <a class="el" href="_reference_c_p_p_8cpp_source.xhtml#l00152">ReferenceCPP::box3x3()</a>, <a class="el" href="arm__compute_2core_2_utils_8h_source.xhtml#l00043">arm_compute::ceil_to_multiple()</a>, <a class="el" href="_c_l_array_8h_source.xhtml#l00075">CLArray&lt; T &gt;::cl_buffer()</a>, <a class="el" href="_dimensions_8h_source.xhtml#l00125">Dimensions&lt; size_t &gt;::collapse()</a>, <a class="el" href="_n_e_color_convert_helper_8inl_source.xhtml#l00550">arm_compute::colorconvert_iyuv_to_nv12()</a>, <a class="el" href="_n_e_color_convert_helper_8inl_source.xhtml#l00445">arm_compute::colorconvert_iyuv_to_rgb()</a>, <a class="el" href="_n_e_color_convert_helper_8inl_source.xhtml#l00737">arm_compute::colorconvert_iyuv_to_yuv4()</a>, <a class="el" href="_n_e_color_convert_helper_8inl_source.xhtml#l00591">arm_compute::colorconvert_nv12_to_iyuv()</a>, <a class="el" href="_n_e_color_convert_helper_8inl_source.xhtml#l00389">arm_compute::colorconvert_nv12_to_rgb()</a>, <a class="el" href="_n_e_color_convert_helper_8inl_source.xhtml#l00686">arm_compute::colorconvert_nv12_to_yuv4()</a>, <a class="el" href="_n_e_color_convert_helper_8inl_source.xhtml#l00825">arm_compute::colorconvert_rgb_to_iyuv()</a>, <a class="el" href="_n_e_color_convert_helper_8inl_source.xhtml#l00789">arm_compute::colorconvert_rgb_to_nv12()</a>, <a class="el" href="_n_e_color_convert_helper_8inl_source.xhtml#l00303">arm_compute::colorconvert_rgb_to_rgbx()</a>, <a class="el" href="_n_e_color_convert_helper_8inl_source.xhtml#l00862">arm_compute::colorconvert_rgb_to_yuv4()</a>, <a class="el" href="_n_e_color_convert_helper_8inl_source.xhtml#l00327">arm_compute::colorconvert_rgbx_to_rgb()</a>, <a class="el" href="_n_e_color_convert_helper_8inl_source.xhtml#l00633">arm_compute::colorconvert_yuyv_to_iyuv()</a>, <a class="el" href="_n_e_color_convert_helper_8inl_source.xhtml#l00502">arm_compute::colorconvert_yuyv_to_nv12()</a>, <a class="el" href="_n_e_color_convert_helper_8inl_source.xhtml#l00351">arm_compute::colorconvert_yuyv_to_rgb()</a>, <a class="el" href="_sub_tensor_info_8h_source.xhtml#l00131">SubTensorInfo::data_type()</a>, <a class="el" href="_helpers_8inl_source.xhtml#l00032">arm_compute::delta_bilinear_c1u8()</a>, <a class="el" href="_sub_tensor_info_8h_source.xhtml#l00112">SubTensorInfo::element_size()</a>, <a class="el" href="utils_2_utils_8h_source.xhtml#l00142">PPMLoader::fill_image()</a>, <a class="el" href="_tensor_library_8h_source.xhtml#l00524">TensorLibrary::fill_tensor_uniform()</a>, <a class="el" href="_tensor_operations_8h_source.xhtml#l00617">arm_compute::test::validation::tensor_operations::fixed_point_pixel_wise_multiplication()</a>, <a class="el" href="_sub_tensor_info_8h_source.xhtml#l00107">SubTensorInfo::fixed_point_position()</a>, <a class="el" href="arm__compute_2core_2_utils_8h_source.xhtml#l00051">arm_compute::floor_to_multiple()</a>, <a class="el" href="_sub_tensor_info_8h_source.xhtml#l00136">SubTensorInfo::format()</a>, <a class="el" href="_tensor_operations_8h_source.xhtml#l00899">arm_compute::test::validation::tensor_operations::fully_connected_layer()</a>, <a class="el" href="_sub_tensor_info_8h_source.xhtml#l00151">SubTensorInfo::has_padding()</a>, <a class="el" href="_helpers_8inl_source.xhtml#l00215">Iterator::increment()</a>, <a class="el" href="utils_2_utils_8h_source.xhtml#l00125">PPMLoader::init_image()</a>, <a class="el" href="_reference_c_p_p_8cpp_source.xhtml#l00060">ReferenceCPP::integral_image()</a>, <a class="el" href="_sub_tensor_info_8h_source.xhtml#l00156">SubTensorInfo::is_resizable()</a>, <a class="el" href="_helpers_8inl_source.xhtml#l00189">Iterator::Iterator()</a>, <a class="el" href="_sub_tensor_info_8h_source.xhtml#l00121">SubTensorInfo::num_channels()</a>, <a class="el" href="_sub_tensor_info_8h_source.xhtml#l00101">SubTensorInfo::offset_first_element_in_bytes()</a>, <a class="el" href="utils_2_utils_8h_source.xhtml#l00094">PPMLoader::open()</a>, <a class="el" href="_dimensions_8h_source.xhtml#l00103">Dimensions&lt; size_t &gt;::operator[]()</a>, <a class="el" href="_sub_tensor_info_8h_source.xhtml#l00146">SubTensorInfo::padding()</a>, <a class="el" href="_helpers_8inl_source.xhtml#l00081">arm_compute::pixel_area_c1u8_clamp()</a>, <a class="el" href="_helpers_8inl_source.xhtml#l00052">arm_compute::pixel_bilinear_c1u8()</a>, <a class="el" href="_helpers_8inl_source.xhtml#l00065">arm_compute::pixel_bilinear_c1u8_clamp()</a>, <a class="el" href="_i_array_8h_source.xhtml#l00078">IArray&lt; NELKInternalKeypoint &gt;::push_back()</a>, <a class="el" href="_helpers_8inl_source.xhtml#l00237">Iterator::reset()</a>, <a class="el" href="_i_array_8h_source.xhtml#l00128">IArray&lt; NELKInternalKeypoint &gt;::resize()</a>, <a class="el" href="utils_2_utils_8h_source.xhtml#l00245">arm_compute::utils::save_to_ppm()</a>, <a class="el" href="_window_8inl_source.xhtml#l00068">Window::scale()</a>, <a class="el" href="_dimensions_8h_source.xhtml#l00074">Dimensions&lt; size_t &gt;::set()</a>, <a class="el" href="_tensor_shape_8h_source.xhtml#l00074">TensorShape::set()</a>, <a class="el" href="_window_8inl_source.xhtml#l00040">Window::set()</a>, <a class="el" href="_sub_tensor_info_8h_source.xhtml#l00065">SubTensorInfo::set_data_type()</a>, <a class="el" href="_window_8inl_source.xhtml#l00077">Window::set_dimension_step()</a>, <a class="el" href="_sub_tensor_info_8h_source.xhtml#l00080">SubTensorInfo::set_fixed_point_position()</a>, <a class="el" href="_sub_tensor_info_8h_source.xhtml#l00075">SubTensorInfo::set_format()</a>, <a class="el" href="_sub_tensor_info_8h_source.xhtml#l00161">SubTensorInfo::set_is_resizable()</a>, <a class="el" href="_sub_tensor_info_8h_source.xhtml#l00070">SubTensorInfo::set_num_channels()</a>, <a class="el" href="_sub_tensor_info_8h_source.xhtml#l00170">SubTensorInfo::set_valid_region()</a>, <a class="el" href="tests_2_utils_8h_source.xhtml#l00466">arm_compute::test::shape_to_valid_region_undefined_border()</a>, <a class="el" href="_window_8inl_source.xhtml#l00046">Window::shift()</a>, <a class="el" href="_window_8inl_source.xhtml#l00100">Window::split_window()</a>, <a class="el" href="_sub_tensor_info_8h_source.xhtml#l00096">SubTensorInfo::strides_in_bytes()</a>, <a class="el" href="_sub_tensor_info_8h_source.xhtml#l00126">SubTensorInfo::tensor_shape()</a>, <a class="el" href="_reference_c_p_p_8cpp_source.xhtml#l00199">ReferenceCPP::threshold()</a>, <a class="el" href="_sub_tensor_info_8h_source.xhtml#l00141">SubTensorInfo::total_size()</a>, and <a class="el" href="_window_8inl_source.xhtml#l00083">Window::validate()</a>.</p>
308
309 </div>
310 </div>
311 <a class="anchor" id="ac90c3bce005225cbaa4a43740917bb58"></a>
312 <div class="memitem">
313 <div class="memproto">
314       <table class="memname">
315         <tr>
316           <td class="memname">#define ARM_COMPUTE_ERROR_ON_LOC</td>
317           <td>(</td>
318           <td class="paramtype">&#160;</td>
319           <td class="paramname">cond, </td>
320         </tr>
321         <tr>
322           <td class="paramkey"></td>
323           <td></td>
324           <td class="paramtype">&#160;</td>
325           <td class="paramname">func, </td>
326         </tr>
327         <tr>
328           <td class="paramkey"></td>
329           <td></td>
330           <td class="paramtype">&#160;</td>
331           <td class="paramname">file, </td>
332         </tr>
333         <tr>
334           <td class="paramkey"></td>
335           <td></td>
336           <td class="paramtype">&#160;</td>
337           <td class="paramname">line&#160;</td>
338         </tr>
339         <tr>
340           <td></td>
341           <td>)</td>
342           <td></td><td>&#160;&#160;&#160;<a class="el" href="_error_8h.xhtml#a1b62e396a1789909dadda61ea4cda96f">ARM_COMPUTE_ERROR_ON_LOC_MSG</a>(cond, func, file, line, #cond)</td>
343         </tr>
344       </table>
345 </div><div class="memdoc">
346
347 <p>If the condition is true then an error message is printed and an exception thrown. </p>
348 <dl class="params"><dt>Parameters</dt><dd>
349   <table class="params">
350     <tr><td class="paramdir">[in]</td><td class="paramname">cond</td><td>Condition to evaluate </td></tr>
351     <tr><td class="paramdir">[in]</td><td class="paramname">func</td><td>Function in which the error occurred. </td></tr>
352     <tr><td class="paramdir">[in]</td><td class="paramname">file</td><td>File in which the error occurred. </td></tr>
353     <tr><td class="paramdir">[in]</td><td class="paramname">line</td><td>Line in which the error occurred. </td></tr>
354   </table>
355   </dd>
356 </dl>
357
358 <p>Definition at line <a class="el" href="_error_8h_source.xhtml#l00134">134</a> of file <a class="el" href="_error_8h_source.xhtml">Error.h</a>.</p>
359
360 <p>Referenced by <a class="el" href="_validate_8h_source.xhtml#l00436">arm_compute::error_on_channel_not_in()</a>, <a class="el" href="_validate_8h_source.xhtml#l00371">arm_compute::error_on_data_type_not_in()</a>, <a class="el" href="_validate_8h_source.xhtml#l00340">arm_compute::error_on_format_not_in()</a>, <a class="el" href="_validate_8h_source.xhtml#l00226">arm_compute::error_on_mismatching_shapes()</a>, and <a class="el" href="_validate_8h_source.xhtml#l00105">arm_compute::error_on_nullptr()</a>.</p>
361
362 </div>
363 </div>
364 <a class="anchor" id="a1b62e396a1789909dadda61ea4cda96f"></a>
365 <div class="memitem">
366 <div class="memproto">
367       <table class="memname">
368         <tr>
369           <td class="memname">#define ARM_COMPUTE_ERROR_ON_LOC_MSG</td>
370           <td>(</td>
371           <td class="paramtype">&#160;</td>
372           <td class="paramname">cond, </td>
373         </tr>
374         <tr>
375           <td class="paramkey"></td>
376           <td></td>
377           <td class="paramtype">&#160;</td>
378           <td class="paramname">func, </td>
379         </tr>
380         <tr>
381           <td class="paramkey"></td>
382           <td></td>
383           <td class="paramtype">&#160;</td>
384           <td class="paramname">file, </td>
385         </tr>
386         <tr>
387           <td class="paramkey"></td>
388           <td></td>
389           <td class="paramtype">&#160;</td>
390           <td class="paramname">line, </td>
391         </tr>
392         <tr>
393           <td class="paramkey"></td>
394           <td></td>
395           <td class="paramtype">&#160;</td>
396           <td class="paramname"><em>...</em>&#160;</td>
397         </tr>
398         <tr>
399           <td></td>
400           <td>)</td>
401           <td></td><td></td>
402         </tr>
403       </table>
404 </div><div class="memdoc">
405
406 <p>Definition at line <a class="el" href="_error_8h_source.xhtml#l00116">116</a> of file <a class="el" href="_error_8h_source.xhtml">Error.h</a>.</p>
407
408 <p>Referenced by <a class="el" href="_validate_8h_source.xhtml#l00403">arm_compute::error_on_data_type_channel_not_in()</a>, <a class="el" href="_validate_8h_source.xhtml#l00371">arm_compute::error_on_data_type_not_in()</a>, <a class="el" href="_validate_8h_source.xhtml#l00340">arm_compute::error_on_format_not_in()</a>, <a class="el" href="_validate_8h_source.xhtml#l00257">arm_compute::error_on_mismatching_data_types()</a>, <a class="el" href="_validate_8h_source.xhtml#l00293">arm_compute::error_on_mismatching_fixed_point()</a>, <a class="el" href="_validate_8h_source.xhtml#l00526">arm_compute::error_on_mismatching_fixed_point_position()</a>, <a class="el" href="_validate_8h_source.xhtml#l00226">arm_compute::error_on_mismatching_shapes()</a>, <a class="el" href="_validate_8h_source.xhtml#l00549">arm_compute::error_on_value_not_representable_in_fixed_point()</a>, and <a class="el" href="_validate_8h_source.xhtml#l00084">compare_dimension&lt; T &gt;::operator()()</a>.</p>
409
410 </div>
411 </div>
412 <a class="anchor" id="a5bbdcf574d3f5e412fa6a1117911e67b"></a>
413 <div class="memitem">
414 <div class="memproto">
415       <table class="memname">
416         <tr>
417           <td class="memname">#define ARM_COMPUTE_ERROR_ON_MSG</td>
418           <td>(</td>
419           <td class="paramtype">&#160;</td>
420           <td class="paramname">cond, </td>
421         </tr>
422         <tr>
423           <td class="paramkey"></td>
424           <td></td>
425           <td class="paramtype">&#160;</td>
426           <td class="paramname"><em>...</em>&#160;</td>
427         </tr>
428         <tr>
429           <td></td>
430           <td>)</td>
431           <td></td><td></td>
432         </tr>
433       </table>
434 </div><div class="memdoc">
435
436 <p>Definition at line <a class="el" href="_error_8h_source.xhtml#l00115">115</a> of file <a class="el" href="_error_8h_source.xhtml">Error.h</a>.</p>
437
438 <p>Referenced by <a class="el" href="tests_2_utils_8h_source.xhtml#l00640">arm_compute::test::coord2index()</a>, <a class="el" href="utils_2_utils_8h_source.xhtml#l00142">PPMLoader::fill_image()</a>, <a class="el" href="_tensor_operations_8h_source.xhtml#l00617">arm_compute::test::validation::tensor_operations::fixed_point_pixel_wise_multiplication()</a>, <a class="el" href="tests_2_utils_8h_source.xhtml#l00611">arm_compute::test::index2coord()</a>, <a class="el" href="tests_2_utils_8h_source.xhtml#l00658">arm_compute::test::is_in_valid_region()</a>, <a class="el" href="utils_2_utils_8h_source.xhtml#l00094">PPMLoader::open()</a>, <a class="el" href="utils_2_utils_8cpp_source.xhtml#l00140">arm_compute::utils::parse_ppm_header()</a>, and <a class="el" href="_c_l_2_g_e_m_m_8h_source.xhtml#l00047">GEMM&lt; DataSet, TensorType, Accessor, Function, data_type &gt;::SetUp()</a>.</p>
439
440 </div>
441 </div>
442 <a class="anchor" id="ae0ebdb75cd00c490fadb20f25b67ec90"></a>
443 <div class="memitem">
444 <div class="memproto">
445       <table class="memname">
446         <tr>
447           <td class="memname">#define ARM_COMPUTE_INFO</td>
448           <td>(</td>
449           <td class="paramtype">&#160;</td>
450           <td class="paramname"><em>...</em></td><td>)</td>
451           <td></td>
452         </tr>
453       </table>
454 </div><div class="memdoc">
455
456 <p>Definition at line <a class="el" href="_error_8h_source.xhtml#l00072">72</a> of file <a class="el" href="_error_8h_source.xhtml">Error.h</a>.</p>
457
458 </div>
459 </div>
460 <a class="anchor" id="a8a89ba1af4a8a70df25753e354d41641"></a>
461 <div class="memitem">
462 <div class="memproto">
463       <table class="memname">
464         <tr>
465           <td class="memname">#define ARM_COMPUTE_INFO_ON_MSG</td>
466           <td>(</td>
467           <td class="paramtype">&#160;</td>
468           <td class="paramname">cond, </td>
469         </tr>
470         <tr>
471           <td class="paramkey"></td>
472           <td></td>
473           <td class="paramtype">&#160;</td>
474           <td class="paramname"><em>...</em>&#160;</td>
475         </tr>
476         <tr>
477           <td></td>
478           <td>)</td>
479           <td></td><td></td>
480         </tr>
481       </table>
482 </div><div class="memdoc">
483
484 <p>Definition at line <a class="el" href="_error_8h_source.xhtml#l00071">71</a> of file <a class="el" href="_error_8h_source.xhtml">Error.h</a>.</p>
485
486 </div>
487 </div>
488 <a class="anchor" id="a4103adbb45806b2f2002d44b91d0d206"></a>
489 <div class="memitem">
490 <div class="memproto">
491       <table class="memname">
492         <tr>
493           <td class="memname">#define ARM_COMPUTE_UNUSED</td>
494           <td>(</td>
495           <td class="paramtype">&#160;</td>
496           <td class="paramname">var</td><td>)</td>
497           <td>&#160;&#160;&#160;(void)(var)</td>
498         </tr>
499       </table>
500 </div><div class="memdoc">
501
502 <p>To avoid unused variables warnings. </p>
503 <p>This is useful if for example a variable is only used in debug builds and generates a warning in release builds.</p>
504 <dl class="params"><dt>Parameters</dt><dd>
505   <table class="params">
506     <tr><td class="paramdir">[in]</td><td class="paramname">var</td><td>Variable which is unused </td></tr>
507   </table>
508   </dd>
509 </dl>
510
511 <p>Definition at line <a class="el" href="_error_8h_source.xhtml#l00049">49</a> of file <a class="el" href="_error_8h_source.xhtml">Error.h</a>.</p>
512
513 <p>Referenced by <a class="el" href="_validate_8h_source.xhtml#l00436">arm_compute::error_on_channel_not_in()</a>, <a class="el" href="_validate_8h_source.xhtml#l00403">arm_compute::error_on_data_type_channel_not_in()</a>, <a class="el" href="_validate_8h_source.xhtml#l00371">arm_compute::error_on_data_type_not_in()</a>, <a class="el" href="_validate_8h_source.xhtml#l00340">arm_compute::error_on_format_not_in()</a>, <a class="el" href="_validate_8h_source.xhtml#l00257">arm_compute::error_on_mismatching_data_types()</a>, <a class="el" href="_validate_8h_source.xhtml#l00188">arm_compute::error_on_mismatching_dimensions()</a>, <a class="el" href="_validate_8h_source.xhtml#l00293">arm_compute::error_on_mismatching_fixed_point()</a>, <a class="el" href="_validate_8h_source.xhtml#l00526">arm_compute::error_on_mismatching_fixed_point_position()</a>, <a class="el" href="_validate_8h_source.xhtml#l00226">arm_compute::error_on_mismatching_shapes()</a>, <a class="el" href="_validate_8h_source.xhtml#l00549">arm_compute::error_on_value_not_representable_in_fixed_point()</a>, <a class="el" href="utils_2_utils_8h_source.xhtml#l00142">PPMLoader::fill_image()</a>, <a class="el" href="neon__cnn_8cpp_source.xhtml#l00032">main_cnn()</a>, <a class="el" href="neon__copy__objects_8cpp_source.xhtml#l00035">main_neon_copy_objects()</a>, and <a class="el" href="utils_2_utils_8cpp_source.xhtml#l00140">arm_compute::utils::parse_ppm_header()</a>.</p>
514
515 </div>
516 </div>
517 </div><!-- contents -->
518 </div><!-- doc-content -->
519 <!-- start footer part -->
520 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
521   <ul>
522     <li class="navelem"><a class="el" href="dir_214608ef36d61442cb2b0c1c4e9a7def.xhtml">arm_compute</a></li><li class="navelem"><a class="el" href="dir_1fb090f0c6070330bfaccc4236d3ca0d.xhtml">core</a></li><li class="navelem"><a class="el" href="_error_8h.xhtml">Error.h</a></li>
523     <li class="footer">Generated on Fri Jun 23 2017 15:44:34 for Compute Library by
524     <a href="http://www.doxygen.org/index.html">
525     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
526   </ul>
527 </div>
528 </body>
529 </html>