Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ComputeLibrary / 575c81f38edecaa662f3ee45d04ad8efded4fa81 / . / documentation / _error_8h.xhtml
blob: 4e95bbec527129416224880ec30efe75ade5fd2c [file] [log] [blame]
Jenkins514be652019-02-28 12:25:18 +0000[diff] [blame]1<!-- HTML header for doxygen 1.8.15-->
2<!-- Remember to use version doxygen 1.8.15 +-->
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]3<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4<html xmlns="http://www.w3.org/1999/xhtml">
5<head>
6<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
7<meta http-equiv="X-UA-Compatible" content="IE=9"/>
Jenkins514be652019-02-28 12:25:18 +0000[diff] [blame]8<meta name="generator" content="Doxygen 1.8.15"/>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]9<meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines -->
10<title>Compute Library: arm_compute/core/Error.h File Reference</title>
11<link href="tabs.css" rel="stylesheet" type="text/css"/>
12<script type="text/javascript" src="jquery.js"></script>
13<script type="text/javascript" src="dynsections.js"></script>
14<link href="navtree.css" rel="stylesheet" type="text/css"/>
15<script type="text/javascript" src="resize.js"></script>
16<script type="text/javascript" src="navtreedata.js"></script>
17<script type="text/javascript" src="navtree.js"></script>
18<script type="text/javascript">
Jenkins514be652019-02-28 12:25:18 +0000[diff] [blame]19/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]20 $(document).ready(initResizable);
Jenkins514be652019-02-28 12:25:18 +0000[diff] [blame]21/* @license-end */</script>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]22<link href="search/search.css" rel="stylesheet" type="text/css"/>
23<script type="text/javascript" src="search/searchdata.js"></script>
24<script type="text/javascript" src="search/search.js"></script>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]25<script type="text/x-mathjax-config">
26 MathJax.Hub.Config({
27 extensions: ["tex2jax.js"],
28 jax: ["input/TeX","output/HTML-CSS"],
29});
Jenkins514be652019-02-28 12:25:18 +0000[diff] [blame]30</script><script type="text/javascript" async="async" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]31<link href="doxygen.css" rel="stylesheet" type="text/css" />
Jenkins514be652019-02-28 12:25:18 +0000[diff] [blame]32<link href="stylesheet.css" rel="stylesheet" type="text/css"/>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]33</head>
34<body>
35<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
36<div id="titlearea">
37<table cellspacing="0" cellpadding="0">
38 <tbody>
39 <tr style="height: 56px;">
Jenkins514be652019-02-28 12:25:18 +0000[diff] [blame]40 <img alt="Compute Library" src="https://raw.githubusercontent.com/ARM-software/ComputeLibrary/gh-pages/ACL_logo.png" style="max-width: 100%;margin-top: 15px;margin-left: 10px"/>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]41 <td style="padding-left: 0.5em;">
Jenkins514be652019-02-28 12:25:18 +0000[diff] [blame]42 <div id="projectname">
Jenkins575c81f2020-03-05 16:07:35 +0000[diff] [blame^]43 &#160;<span id="projectnumber">20.02.1</span>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]44 </div>
45 </td>
46 </tr>
47 </tbody>
48</table>
49</div>
50<!-- end header part -->
Jenkins514be652019-02-28 12:25:18 +0000[diff] [blame]51<!-- Generated by Doxygen 1.8.15 -->
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]52<script type="text/javascript">
Jenkins514be652019-02-28 12:25:18 +0000[diff] [blame]53/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]54var searchBox = new SearchBox("searchBox", "search",false,'Search');
Jenkins514be652019-02-28 12:25:18 +0000[diff] [blame]55/* @license-end */
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]56</script>
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]57<script type="text/javascript" src="menudata.js"></script>
58<script type="text/javascript" src="menu.js"></script>
59<script type="text/javascript">
Jenkins514be652019-02-28 12:25:18 +0000[diff] [blame]60/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]61$(function() {
62 initMenu('',true,false,'search.php','Search');
63 $(document).ready(function() { init_search(); });
64});
Jenkins514be652019-02-28 12:25:18 +0000[diff] [blame]65/* @license-end */</script>
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]66<div id="main-nav"></div>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]67</div><!-- top -->
68<div id="side-nav" class="ui-resizable side-nav-resizable">
69 <div id="nav-tree">
70 <div id="nav-tree-contents">
71 <div id="nav-sync" class="sync"></div>
72 </div>
73 </div>
74 <div id="splitbar" style="-moz-user-select:none;"
75 class="ui-resizable-handle">
76 </div>
77</div>
78<script type="text/javascript">
Jenkins514be652019-02-28 12:25:18 +0000[diff] [blame]79/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]80$(document).ready(function(){initNavTree('_error_8h.xhtml','');});
Jenkins514be652019-02-28 12:25:18 +0000[diff] [blame]81/* @license-end */
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]82</script>
83<div id="doc-content">
84<!-- window showing the filter options -->
85<div id="MSearchSelectWindow"
86 onmouseover="return searchBox.OnSearchSelectShow()"
87 onmouseout="return searchBox.OnSearchSelectHide()"
88 onkeydown="return searchBox.OnSearchSelectKey(event)">
89</div>
90
91<!-- iframe showing the search results (closed by default) -->
92<div id="MSearchResultsWindow">
93<iframe src="javascript:void(0)" frameborder="0"
94 name="MSearchResults" id="MSearchResults">
95</iframe>
96</div>
97
98<div class="header">
99 <div class="summary">
100<a href="#nested-classes">Data Structures</a> &#124;
101<a href="#namespaces">Namespaces</a> &#124;
102<a href="#define-members">Macros</a> &#124;
103<a href="#enum-members">Enumerations</a> &#124;
104<a href="#func-members">Functions</a> </div>
105 <div class="headertitle">
106<div class="title">Error.h File Reference</div> </div>
107</div><!--header-->
108<div class="contents">
Jenkins0e205f72019-11-28 16:53:35 +0000[diff] [blame]109<div class="textblock"><code>#include &lt;array&gt;</code><br />
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]110<code>#include &lt;string&gt;</code><br />
111</div>
112<p><a href="_error_8h_source.xhtml">Go to the source code of this file.</a></p>
113<table class="memberdecls">
114<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
115Data Structures</h2></td></tr>
116<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_status.xhtml">Status</a></td></tr>
Jenkins514be652019-02-28 12:25:18 +0000[diff] [blame]117<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classarm__compute_1_1_status.xhtml" title="Status class.">Status</a> class. <a href="classarm__compute_1_1_status.xhtml#details">More...</a><br /></td></tr>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]118<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
119</table><table class="memberdecls">
120<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
121Namespaces</h2></td></tr>
122<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>
Jenkins36ccc902020-02-21 11:10:48 +0000[diff] [blame]123<tr class="memdesc:namespacearm__compute"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copyright (c) 2017-2020 ARM Limited. <br /></td></tr>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]124<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
125</table><table class="memberdecls">
126<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
127Macros</h2></td></tr>
Jenkins52ba29e2018-08-29 15:32:11 +0000[diff] [blame]128<tr class="memitem:a6dc630a6ae9cc063b3924bcea8dee9d6"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_error_8h.xhtml#a6dc630a6ae9cc063b3924bcea8dee9d6">ARM_COMPUTE_UNUSED</a>(...)&#160;&#160;&#160;::<a class="el" href="namespacearm__compute.xhtml#a053a24bb37402fa4b4d8d5963976ba17">arm_compute::ignore_unused</a>(__VA_ARGS__)</td></tr>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]129<tr class="memdesc:a6dc630a6ae9cc063b3924bcea8dee9d6"><td class="mdescLeft">&#160;</td><td class="mdescRight">To avoid unused variables warnings. <a href="#a6dc630a6ae9cc063b3924bcea8dee9d6">More...</a><br /></td></tr>
130<tr class="separator:a6dc630a6ae9cc063b3924bcea8dee9d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
Jenkins0e205f72019-11-28 16:53:35 +0000[diff] [blame]131<tr class="memitem:af1b8ff8eb557a2ad11272f1505f45d34"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_error_8h.xhtml#af1b8ff8eb557a2ad11272f1505f45d34">ARM_COMPUTE_CREATE_ERROR</a>(error_code, msg)&#160;&#160;&#160;<a class="el" href="namespacearm__compute.xhtml#af9b3e9f3ef6409e72c71aeacebf58f3b">arm_compute::create_error_msg</a>(error_code, __func__, __FILE__, __LINE__, msg)</td></tr>
132<tr class="memdesc:af1b8ff8eb557a2ad11272f1505f45d34"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates an error with a given message. <a href="#af1b8ff8eb557a2ad11272f1505f45d34">More...</a><br /></td></tr>
133<tr class="separator:af1b8ff8eb557a2ad11272f1505f45d34"><td class="memSeparator" colspan="2">&#160;</td></tr>
134<tr class="memitem:a1f6cdb912f3c70a81f27c62ff3f1c569"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_error_8h.xhtml#a1f6cdb912f3c70a81f27c62ff3f1c569">ARM_COMPUTE_CREATE_ERROR_LOC</a>(error_code, func, file, line, msg)&#160;&#160;&#160;<a class="el" href="namespacearm__compute.xhtml#af9b3e9f3ef6409e72c71aeacebf58f3b">arm_compute::create_error_msg</a>(error_code, func, file, line, msg)</td></tr>
135<tr class="memdesc:a1f6cdb912f3c70a81f27c62ff3f1c569"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates an error on location with a given message. <a href="#a1f6cdb912f3c70a81f27c62ff3f1c569">More...</a><br /></td></tr>
136<tr class="separator:a1f6cdb912f3c70a81f27c62ff3f1c569"><td class="memSeparator" colspan="2">&#160;</td></tr>
137<tr class="memitem:abf8348c7af1cedc02945cc7bffe511e4"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_error_8h.xhtml#abf8348c7af1cedc02945cc7bffe511e4">ARM_COMPUTE_CREATE_ERROR_LOC_VAR</a>(error_code, func, file, line, msg, ...)</td></tr>
138<tr class="memdesc:abf8348c7af1cedc02945cc7bffe511e4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates an error on location with a given message. <a href="#abf8348c7af1cedc02945cc7bffe511e4">More...</a><br /></td></tr>
139<tr class="separator:abf8348c7af1cedc02945cc7bffe511e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]140<tr class="memitem:a9561091f3566e78ad3aa39259bc4126a"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_error_8h.xhtml#a9561091f3566e78ad3aa39259bc4126a">ARM_COMPUTE_RETURN_ERROR_MSG</a>(...)</td></tr>
141<tr class="memdesc:a9561091f3566e78ad3aa39259bc4126a"><td class="mdescLeft">&#160;</td><td class="mdescRight">An error is returned with the given description. <a href="#a9561091f3566e78ad3aa39259bc4126a">More...</a><br /></td></tr>
142<tr class="separator:a9561091f3566e78ad3aa39259bc4126a"><td class="memSeparator" colspan="2">&#160;</td></tr>
143<tr class="memitem:a8a1e1c105f0bdaf37db408c7cfcb77a4"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_error_8h.xhtml#a8a1e1c105f0bdaf37db408c7cfcb77a4">ARM_COMPUTE_RETURN_ON_ERROR</a>(status)</td></tr>
144<tr class="memdesc:a8a1e1c105f0bdaf37db408c7cfcb77a4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if a status contains an error and returns it. <a href="#a8a1e1c105f0bdaf37db408c7cfcb77a4">More...</a><br /></td></tr>
145<tr class="separator:a8a1e1c105f0bdaf37db408c7cfcb77a4"><td class="memSeparator" colspan="2">&#160;</td></tr>
146<tr class="memitem:a51e206ee52bcfb358919ee478d9fdc47"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_error_8h.xhtml#a51e206ee52bcfb358919ee478d9fdc47">ARM_COMPUTE_THROW_ON_ERROR</a>(error)&#160;&#160;&#160;error.throw_if_error();</td></tr>
147<tr class="memdesc:a51e206ee52bcfb358919ee478d9fdc47"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if an error value is valid if not throws an exception with the error. <a href="#a51e206ee52bcfb358919ee478d9fdc47">More...</a><br /></td></tr>
148<tr class="separator:a51e206ee52bcfb358919ee478d9fdc47"><td class="memSeparator" colspan="2">&#160;</td></tr>
Jenkins0e205f72019-11-28 16:53:35 +0000[diff] [blame]149<tr class="memitem:ab7f9a52dc65a6a76f1576d99828fa1ea"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_error_8h.xhtml#ab7f9a52dc65a6a76f1576d99828fa1ea">ARM_COMPUTE_RETURN_ERROR_ON_MSG_VAR</a>(cond, msg, ...)</td></tr>
150<tr class="memdesc:ab7f9a52dc65a6a76f1576d99828fa1ea"><td class="mdescLeft">&#160;</td><td class="mdescRight">If the condition is true, an error is returned. <a href="#ab7f9a52dc65a6a76f1576d99828fa1ea">More...</a><br /></td></tr>
151<tr class="separator:ab7f9a52dc65a6a76f1576d99828fa1ea"><td class="memSeparator" colspan="2">&#160;</td></tr>
152<tr class="memitem:a1c69762a42ab8add645d0a949b6f4b1f"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_error_8h.xhtml#a1c69762a42ab8add645d0a949b6f4b1f">ARM_COMPUTE_RETURN_ERROR_ON_MSG</a>(cond, msg)</td></tr>
153<tr class="memdesc:a1c69762a42ab8add645d0a949b6f4b1f"><td class="mdescLeft">&#160;</td><td class="mdescRight">If the condition is true, an error is returned. <a href="#a1c69762a42ab8add645d0a949b6f4b1f">More...</a><br /></td></tr>
154<tr class="separator:a1c69762a42ab8add645d0a949b6f4b1f"><td class="memSeparator" colspan="2">&#160;</td></tr>
155<tr class="memitem:a5e3e8db314706c6f3d822bafa3d8d761"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_error_8h.xhtml#a5e3e8db314706c6f3d822bafa3d8d761">ARM_COMPUTE_RETURN_ERROR_ON_LOC_MSG_VAR</a>(cond, func, file, line, msg, ...)</td></tr>
156<tr class="memdesc:a5e3e8db314706c6f3d822bafa3d8d761"><td class="mdescLeft">&#160;</td><td class="mdescRight">If the condition is true, an error is thrown. <a href="#a5e3e8db314706c6f3d822bafa3d8d761">More...</a><br /></td></tr>
157<tr class="separator:a5e3e8db314706c6f3d822bafa3d8d761"><td class="memSeparator" colspan="2">&#160;</td></tr>
158<tr class="memitem:a3cbe27c31092df3dc1fa26c75f47e047"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_error_8h.xhtml#a3cbe27c31092df3dc1fa26c75f47e047">ARM_COMPUTE_RETURN_ERROR_ON_LOC_MSG</a>(cond, func, file, line, msg)</td></tr>
159<tr class="memdesc:a3cbe27c31092df3dc1fa26c75f47e047"><td class="mdescLeft">&#160;</td><td class="mdescRight">If the condition is true, an error is thrown. <a href="#a3cbe27c31092df3dc1fa26c75f47e047">More...</a><br /></td></tr>
160<tr class="separator:a3cbe27c31092df3dc1fa26c75f47e047"><td class="memSeparator" colspan="2">&#160;</td></tr>
161<tr class="memitem:a206d6e247e0957ac3dee45d27756fc25"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_error_8h.xhtml#a206d6e247e0957ac3dee45d27756fc25">ARM_COMPUTE_RETURN_ERROR_ON</a>(cond)&#160;&#160;&#160;<a class="el" href="_error_8h.xhtml#a1c69762a42ab8add645d0a949b6f4b1f">ARM_COMPUTE_RETURN_ERROR_ON_MSG</a>(cond, #cond)</td></tr>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]162<tr class="memdesc:a206d6e247e0957ac3dee45d27756fc25"><td class="mdescLeft">&#160;</td><td class="mdescRight">If the condition is true, an error is returned. <a href="#a206d6e247e0957ac3dee45d27756fc25">More...</a><br /></td></tr>
163<tr class="separator:a206d6e247e0957ac3dee45d27756fc25"><td class="memSeparator" colspan="2">&#160;</td></tr>
Jenkins0e205f72019-11-28 16:53:35 +0000[diff] [blame]164<tr class="memitem:aab9171b209dda7cc9bb560486674c9f6"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_error_8h.xhtml#aab9171b209dda7cc9bb560486674c9f6">ARM_COMPUTE_RETURN_ERROR_ON_LOC</a>(cond, func, file, line)&#160;&#160;&#160;<a class="el" href="_error_8h.xhtml#a3cbe27c31092df3dc1fa26c75f47e047">ARM_COMPUTE_RETURN_ERROR_ON_LOC_MSG</a>(cond, func, file, line, #cond)</td></tr>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]165<tr class="memdesc:aab9171b209dda7cc9bb560486674c9f6"><td class="mdescLeft">&#160;</td><td class="mdescRight">If the condition is true, an error is returned. <a href="#aab9171b209dda7cc9bb560486674c9f6">More...</a><br /></td></tr>
166<tr class="separator:aab9171b209dda7cc9bb560486674c9f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
Jenkins0e205f72019-11-28 16:53:35 +0000[diff] [blame]167<tr class="memitem:adfd4354a6e0f46eddd353913a1470219"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_error_8h.xhtml#adfd4354a6e0f46eddd353913a1470219">ARM_COMPUTE_THROW_ERROR</a>(func, file, line, msg)</td></tr>
168<tr class="memdesc:adfd4354a6e0f46eddd353913a1470219"><td class="mdescLeft">&#160;</td><td class="mdescRight">Print the given message then throw an std::runtime_error. <a href="#adfd4354a6e0f46eddd353913a1470219">More...</a><br /></td></tr>
169<tr class="separator:adfd4354a6e0f46eddd353913a1470219"><td class="memSeparator" colspan="2">&#160;</td></tr>
170<tr class="memitem:a86513cce33cfea9d3dd6eac3366b8253"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_error_8h.xhtml#a86513cce33cfea9d3dd6eac3366b8253">ARM_COMPUTE_THROW_ERROR_VAR</a>(func, file, line, msg, ...)</td></tr>
171<tr class="memdesc:a86513cce33cfea9d3dd6eac3366b8253"><td class="mdescLeft">&#160;</td><td class="mdescRight">Print the given message then throw an std::runtime_error. <a href="#a86513cce33cfea9d3dd6eac3366b8253">More...</a><br /></td></tr>
172<tr class="separator:a86513cce33cfea9d3dd6eac3366b8253"><td class="memSeparator" colspan="2">&#160;</td></tr>
173<tr class="memitem:abd040a16dc0dbc75733e07aff93048a8"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_error_8h.xhtml#abd040a16dc0dbc75733e07aff93048a8">ARM_COMPUTE_ERROR_VAR</a>(msg, ...)&#160;&#160;&#160;<a class="el" href="_error_8h.xhtml#a86513cce33cfea9d3dd6eac3366b8253">ARM_COMPUTE_THROW_ERROR_VAR</a>(__func__, __FILE__, __LINE__, msg, __VA_ARGS__)</td></tr>
174<tr class="memdesc:abd040a16dc0dbc75733e07aff93048a8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Print the given message then throw an std::runtime_error. <a href="#abd040a16dc0dbc75733e07aff93048a8">More...</a><br /></td></tr>
175<tr class="separator:abd040a16dc0dbc75733e07aff93048a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
176<tr class="memitem:a7cf8d8b669b8f7b05680230be30d60f4"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_error_8h.xhtml#a7cf8d8b669b8f7b05680230be30d60f4">ARM_COMPUTE_ERROR</a>(msg)&#160;&#160;&#160;<a class="el" href="_error_8h.xhtml#adfd4354a6e0f46eddd353913a1470219">ARM_COMPUTE_THROW_ERROR</a>(__func__, __FILE__, __LINE__, msg)</td></tr>
177<tr class="memdesc:a7cf8d8b669b8f7b05680230be30d60f4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Print the given message then throw an std::runtime_error. <a href="#a7cf8d8b669b8f7b05680230be30d60f4">More...</a><br /></td></tr>
178<tr class="separator:a7cf8d8b669b8f7b05680230be30d60f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
179<tr class="memitem:a6b97423ad86a4a64ec1838d6135282cb"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_error_8h.xhtml#a6b97423ad86a4a64ec1838d6135282cb">ARM_COMPUTE_ERROR_LOC_VAR</a>(func, file, line, msg, ...)&#160;&#160;&#160;<a class="el" href="_error_8h.xhtml#a86513cce33cfea9d3dd6eac3366b8253">ARM_COMPUTE_THROW_ERROR_VAR</a>(func, file, line, msg, __VA_ARGS__)</td></tr>
180<tr class="memdesc:a6b97423ad86a4a64ec1838d6135282cb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Print the given message then throw an std::runtime_error. <a href="#a6b97423ad86a4a64ec1838d6135282cb">More...</a><br /></td></tr>
181<tr class="separator:a6b97423ad86a4a64ec1838d6135282cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
182<tr class="memitem:a94b64f1b45be794e8304c238e90be6b0"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_error_8h.xhtml#a94b64f1b45be794e8304c238e90be6b0">ARM_COMPUTE_ERROR_LOC</a>(func, file, line, msg)&#160;&#160;&#160;<a class="el" href="_error_8h.xhtml#adfd4354a6e0f46eddd353913a1470219">ARM_COMPUTE_THROW_ERROR</a>(func, file, line, msg)</td></tr>
183<tr class="memdesc:a94b64f1b45be794e8304c238e90be6b0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Print the given message then throw an std::runtime_error. <a href="#a94b64f1b45be794e8304c238e90be6b0">More...</a><br /></td></tr>
184<tr class="separator:a94b64f1b45be794e8304c238e90be6b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
185<tr class="memitem:a292b758f9eba8b487d71eae4b37326fc"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_error_8h.xhtml#a292b758f9eba8b487d71eae4b37326fc">ARM_COMPUTE_EXIT_ON_MSG</a>(cond, msg)</td></tr>
186<tr class="memdesc:a292b758f9eba8b487d71eae4b37326fc"><td class="mdescLeft">&#160;</td><td class="mdescRight">If the condition is true, the given message is printed and program exits. <a href="#a292b758f9eba8b487d71eae4b37326fc">More...</a><br /></td></tr>
187<tr class="separator:a292b758f9eba8b487d71eae4b37326fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
188<tr class="memitem:ac75ba282eb0cacd31fd4c6e6a47dbbc8"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_error_8h.xhtml#ac75ba282eb0cacd31fd4c6e6a47dbbc8">ARM_COMPUTE_EXIT_ON_MSG_VAR</a>(cond, msg, ...)</td></tr>
189<tr class="memdesc:ac75ba282eb0cacd31fd4c6e6a47dbbc8"><td class="mdescLeft">&#160;</td><td class="mdescRight">If the condition is true, the given message is printed and program exits. <a href="#ac75ba282eb0cacd31fd4c6e6a47dbbc8">More...</a><br /></td></tr>
190<tr class="separator:ac75ba282eb0cacd31fd4c6e6a47dbbc8"><td class="memSeparator" colspan="2">&#160;</td></tr>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]191<tr class="memitem:a938dcd406ce611ef5345ad2531cdb948"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_error_8h.xhtml#a938dcd406ce611ef5345ad2531cdb948">ARM_COMPUTE_ERROR_THROW_ON</a>(status)</td></tr>
192<tr class="separator:a938dcd406ce611ef5345ad2531cdb948"><td class="memSeparator" colspan="2">&#160;</td></tr>
Jenkins0e205f72019-11-28 16:53:35 +0000[diff] [blame]193<tr class="memitem:a0b0eb3235749a2909dc5a101afe59a1b"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_error_8h.xhtml#a0b0eb3235749a2909dc5a101afe59a1b">ARM_COMPUTE_ERROR_ON_MSG</a>(cond, msg)</td></tr>
194<tr class="separator:a0b0eb3235749a2909dc5a101afe59a1b"><td class="memSeparator" colspan="2">&#160;</td></tr>
195<tr class="memitem:acaa348bf0c7eb9493c72092b7293d45f"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_error_8h.xhtml#acaa348bf0c7eb9493c72092b7293d45f">ARM_COMPUTE_ERROR_ON_MSG_VAR</a>(cond, msg, ...)</td></tr>
196<tr class="separator:acaa348bf0c7eb9493c72092b7293d45f"><td class="memSeparator" colspan="2">&#160;</td></tr>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]197<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>
198<tr class="separator:a1b62e396a1789909dadda61ea4cda96f"><td class="memSeparator" colspan="2">&#160;</td></tr>
199<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>
200<tr class="separator:a50048c593c53405cca5b0d69dfe25554"><td class="memSeparator" colspan="2">&#160;</td></tr>
Jenkins0e205f72019-11-28 16:53:35 +0000[diff] [blame]201<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#a0b0eb3235749a2909dc5a101afe59a1b">ARM_COMPUTE_ERROR_ON_MSG</a>(cond, #cond)</td></tr>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]202<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>
203<tr class="separator:a54a6080c9f4df1f908e57a9bbb46f5da"><td class="memSeparator" colspan="2">&#160;</td></tr>
Jenkins0e205f72019-11-28 16:53:35 +0000[diff] [blame]204<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, &quot;%s&quot;, #cond)</td></tr>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]205<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>
206<tr class="separator:ac90c3bce005225cbaa4a43740917bb58"><td class="memSeparator" colspan="2">&#160;</td></tr>
Jenkins514be652019-02-28 12:25:18 +0000[diff] [blame]207<tr class="memitem:ad5518fdae84a33ce6fbed540c6e89479"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_error_8h.xhtml#ad5518fdae84a33ce6fbed540c6e89479">ARM_COMPUTE_THROW</a>(ex)&#160;&#160;&#160;throw(ex)</td></tr>
208<tr class="separator:ad5518fdae84a33ce6fbed540c6e89479"><td class="memSeparator" colspan="2">&#160;</td></tr>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]209</table><table class="memberdecls">
210<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
211Enumerations</h2></td></tr>
212<tr class="memitem:a59e56af19e754a6aa26a612ebf91d05f"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearm__compute.xhtml#a59e56af19e754a6aa26a612ebf91d05f">ErrorCode</a> { <a class="el" href="namespacearm__compute.xhtml#a59e56af19e754a6aa26a612ebf91d05fae0aa021e21dddbd6d8cecec71e9cf564">OK</a>,
Jenkins52ba29e2018-08-29 15:32:11 +0000[diff] [blame]213<a class="el" href="namespacearm__compute.xhtml#a59e56af19e754a6aa26a612ebf91d05fa62be47fdd89da032cf78dfce82239579">RUNTIME_ERROR</a>,
214<a class="el" href="namespacearm__compute.xhtml#a59e56af19e754a6aa26a612ebf91d05fa0ffe8be9137815d1266845a195c053c7">UNSUPPORTED_EXTENSION_USE</a>
Jenkins514be652019-02-28 12:25:18 +0000[diff] [blame]215 }</td></tr>
216<tr class="memdesc:a59e56af19e754a6aa26a612ebf91d05f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Available error codes. <a href="namespacearm__compute.xhtml#a59e56af19e754a6aa26a612ebf91d05f">More...</a><br /></td></tr>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]217<tr class="separator:a59e56af19e754a6aa26a612ebf91d05f"><td class="memSeparator" colspan="2">&#160;</td></tr>
218</table><table class="memberdecls">
219<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
220Functions</h2></td></tr>
221<tr class="memitem:a053a24bb37402fa4b4d8d5963976ba17"><td class="memTemplParams" colspan="2">template&lt;typename... T&gt; </td></tr>
222<tr class="memitem:a053a24bb37402fa4b4d8d5963976ba17"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacearm__compute.xhtml#a053a24bb37402fa4b4d8d5963976ba17">ignore_unused</a> (T &amp;&amp;...)</td></tr>
223<tr class="memdesc:a053a24bb37402fa4b4d8d5963976ba17"><td class="mdescLeft">&#160;</td><td class="mdescRight">Ignores unused arguments. <a href="namespacearm__compute.xhtml#a053a24bb37402fa4b4d8d5963976ba17">More...</a><br /></td></tr>
224<tr class="separator:a053a24bb37402fa4b4d8d5963976ba17"><td class="memSeparator" colspan="2">&#160;</td></tr>
Jenkins0e205f72019-11-28 16:53:35 +0000[diff] [blame]225<tr class="memitem:a49cdbfceec3cb9949d00dbd1a17c5604"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_status.xhtml">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearm__compute.xhtml#a49cdbfceec3cb9949d00dbd1a17c5604">create_error</a> (<a class="el" href="namespacearm__compute.xhtml#a59e56af19e754a6aa26a612ebf91d05f">ErrorCode</a> error_code, std::string msg)</td></tr>
226<tr class="memdesc:a49cdbfceec3cb9949d00dbd1a17c5604"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates an error containing the error message. <a href="namespacearm__compute.xhtml#a49cdbfceec3cb9949d00dbd1a17c5604">More...</a><br /></td></tr>
227<tr class="separator:a49cdbfceec3cb9949d00dbd1a17c5604"><td class="memSeparator" colspan="2">&#160;</td></tr>
228<tr class="memitem:af9b3e9f3ef6409e72c71aeacebf58f3b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_status.xhtml">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearm__compute.xhtml#af9b3e9f3ef6409e72c71aeacebf58f3b">create_error_msg</a> (<a class="el" href="namespacearm__compute.xhtml#a59e56af19e754a6aa26a612ebf91d05f">ErrorCode</a> error_code, const char *func, const char *file, int line, const char *msg)</td></tr>
229<tr class="memdesc:af9b3e9f3ef6409e72c71aeacebf58f3b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates an error and the error message. <a href="namespacearm__compute.xhtml#af9b3e9f3ef6409e72c71aeacebf58f3b">More...</a><br /></td></tr>
230<tr class="separator:af9b3e9f3ef6409e72c71aeacebf58f3b"><td class="memSeparator" colspan="2">&#160;</td></tr>
231<tr class="memitem:a61e7f5901fd23f6009db8eac1a400be9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearm__compute.xhtml#a61e7f5901fd23f6009db8eac1a400be9">throw_error</a> (<a class="el" href="classarm__compute_1_1_status.xhtml">Status</a> err)</td></tr>
232<tr class="memdesc:a61e7f5901fd23f6009db8eac1a400be9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Throw an std::runtime_error. <a href="namespacearm__compute.xhtml#a61e7f5901fd23f6009db8eac1a400be9">More...</a><br /></td></tr>
233<tr class="separator:a61e7f5901fd23f6009db8eac1a400be9"><td class="memSeparator" colspan="2">&#160;</td></tr>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]234</table>
235<h2 class="groupheader">Macro Definition Documentation</h2>
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]236<a id="a50048c593c53405cca5b0d69dfe25554"></a>
237<h2 class="memtitle"><span class="permalink"><a href="#a50048c593c53405cca5b0d69dfe25554">&#9670;&nbsp;</a></span>ARM_COMPUTE_CONST_ON_ERROR</h2>
238
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]239<div class="memitem">
240<div class="memproto">
241 <table class="memname">
242 <tr>
243 <td class="memname">#define ARM_COMPUTE_CONST_ON_ERROR</td>
244 <td>(</td>
245 <td class="paramtype">&#160;</td>
246 <td class="paramname">cond, </td>
247 </tr>
248 <tr>
249 <td class="paramkey"></td>
250 <td></td>
251 <td class="paramtype">&#160;</td>
252 <td class="paramname">val, </td>
253 </tr>
254 <tr>
255 <td class="paramkey"></td>
256 <td></td>
257 <td class="paramtype">&#160;</td>
258 <td class="paramname">msg&#160;</td>
259 </tr>
260 <tr>
261 <td></td>
262 <td>)</td>
263 <td></td><td>&#160;&#160;&#160;val</td>
264 </tr>
265 </table>
266</div><div class="memdoc">
267
Jenkins0e205f72019-11-28 16:53:35 +0000[diff] [blame]268<p class="definition">Definition at line <a class="el" href="_error_8h_source.xhtml#l00459">459</a> of file <a class="el" href="_error_8h_source.xhtml">Error.h</a>.</p>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]269
270</div>
271</div>
Jenkins0e205f72019-11-28 16:53:35 +0000[diff] [blame]272<a id="af1b8ff8eb557a2ad11272f1505f45d34"></a>
273<h2 class="memtitle"><span class="permalink"><a href="#af1b8ff8eb557a2ad11272f1505f45d34">&#9670;&nbsp;</a></span>ARM_COMPUTE_CREATE_ERROR</h2>
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]274
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]275<div class="memitem">
276<div class="memproto">
277 <table class="memname">
278 <tr>
279 <td class="memname">#define ARM_COMPUTE_CREATE_ERROR</td>
280 <td>(</td>
281 <td class="paramtype">&#160;</td>
282 <td class="paramname">error_code, </td>
283 </tr>
284 <tr>
285 <td class="paramkey"></td>
286 <td></td>
287 <td class="paramtype">&#160;</td>
Jenkins0e205f72019-11-28 16:53:35 +0000[diff] [blame]288 <td class="paramname">msg&#160;</td>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]289 </tr>
290 <tr>
291 <td></td>
292 <td>)</td>
Jenkins0e205f72019-11-28 16:53:35 +0000[diff] [blame]293 <td></td><td>&#160;&#160;&#160;<a class="el" href="namespacearm__compute.xhtml#af9b3e9f3ef6409e72c71aeacebf58f3b">arm_compute::create_error_msg</a>(error_code, __func__, __FILE__, __LINE__, msg)</td>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]294 </tr>
295 </table>
296</div><div class="memdoc">
297
298<p>Creates an error with a given message. </p>
299<dl class="params"><dt>Parameters</dt><dd>
300 <table class="params">
301 <tr><td class="paramdir">[in]</td><td class="paramname">error_code</td><td>Error code. </td></tr>
Jenkins0e205f72019-11-28 16:53:35 +0000[diff] [blame]302 <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to encapsulate. </td></tr>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]303 </table>
304 </dd>
305</dl>
306
Jenkins0e205f72019-11-28 16:53:35 +0000[diff] [blame]307<p class="definition">Definition at line <a class="el" href="_error_8h_source.xhtml#l00159">159</a> of file <a class="el" href="_error_8h_source.xhtml">Error.h</a>.</p>
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]308
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]309</div>
310</div>
Jenkins0e205f72019-11-28 16:53:35 +0000[diff] [blame]311<a id="a1f6cdb912f3c70a81f27c62ff3f1c569"></a>
312<h2 class="memtitle"><span class="permalink"><a href="#a1f6cdb912f3c70a81f27c62ff3f1c569">&#9670;&nbsp;</a></span>ARM_COMPUTE_CREATE_ERROR_LOC</h2>
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]313
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]314<div class="memitem">
315<div class="memproto">
316 <table class="memname">
317 <tr>
318 <td class="memname">#define ARM_COMPUTE_CREATE_ERROR_LOC</td>
319 <td>(</td>
320 <td class="paramtype">&#160;</td>
321 <td class="paramname">error_code, </td>
322 </tr>
323 <tr>
324 <td class="paramkey"></td>
325 <td></td>
326 <td class="paramtype">&#160;</td>
327 <td class="paramname">func, </td>
328 </tr>
329 <tr>
330 <td class="paramkey"></td>
331 <td></td>
332 <td class="paramtype">&#160;</td>
333 <td class="paramname">file, </td>
334 </tr>
335 <tr>
336 <td class="paramkey"></td>
337 <td></td>
338 <td class="paramtype">&#160;</td>
339 <td class="paramname">line, </td>
340 </tr>
341 <tr>
342 <td class="paramkey"></td>
343 <td></td>
344 <td class="paramtype">&#160;</td>
Jenkins0e205f72019-11-28 16:53:35 +0000[diff] [blame]345 <td class="paramname">msg&#160;</td>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]346 </tr>
347 <tr>
348 <td></td>
349 <td>)</td>
Jenkins0e205f72019-11-28 16:53:35 +0000[diff] [blame]350 <td></td><td>&#160;&#160;&#160;<a class="el" href="namespacearm__compute.xhtml#af9b3e9f3ef6409e72c71aeacebf58f3b">arm_compute::create_error_msg</a>(error_code, func, file, line, msg)</td>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]351 </tr>
352 </table>
353</div><div class="memdoc">
354
355<p>Creates an error on location with a given message. </p>
356<dl class="params"><dt>Parameters</dt><dd>
357 <table class="params">
358 <tr><td class="paramdir">[in]</td><td class="paramname">error_code</td><td>Error code. </td></tr>
359 <tr><td class="paramdir">[in]</td><td class="paramname">func</td><td>Function in which the error occurred. </td></tr>
360 <tr><td class="paramdir">[in]</td><td class="paramname">file</td><td>File in which the error occurred. </td></tr>
361 <tr><td class="paramdir">[in]</td><td class="paramname">line</td><td>Line in which the error occurred. </td></tr>
Jenkins0e205f72019-11-28 16:53:35 +0000[diff] [blame]362 <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to display before aborting. </td></tr>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]363 </table>
364 </dd>
365</dl>
366
Jenkins0e205f72019-11-28 16:53:35 +0000[diff] [blame]367<p class="definition">Definition at line <a class="el" href="_error_8h_source.xhtml#l00169">169</a> of file <a class="el" href="_error_8h_source.xhtml">Error.h</a>.</p>
Jenkins52ba29e2018-08-29 15:32:11 +0000[diff] [blame]368
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]369</div>
370</div>
Jenkins0e205f72019-11-28 16:53:35 +0000[diff] [blame]371<a id="abf8348c7af1cedc02945cc7bffe511e4"></a>
372<h2 class="memtitle"><span class="permalink"><a href="#abf8348c7af1cedc02945cc7bffe511e4">&#9670;&nbsp;</a></span>ARM_COMPUTE_CREATE_ERROR_LOC_VAR</h2>
373
374<div class="memitem">
375<div class="memproto">
376 <table class="memname">
377 <tr>
378 <td class="memname">#define ARM_COMPUTE_CREATE_ERROR_LOC_VAR</td>
379 <td>(</td>
380 <td class="paramtype">&#160;</td>
381 <td class="paramname">error_code, </td>
382 </tr>
383 <tr>
384 <td class="paramkey"></td>
385 <td></td>
386 <td class="paramtype">&#160;</td>
387 <td class="paramname">func, </td>
388 </tr>
389 <tr>
390 <td class="paramkey"></td>
391 <td></td>
392 <td class="paramtype">&#160;</td>
393 <td class="paramname">file, </td>
394 </tr>
395 <tr>
396 <td class="paramkey"></td>
397 <td></td>
398 <td class="paramtype">&#160;</td>
399 <td class="paramname">line, </td>
400 </tr>
401 <tr>
402 <td class="paramkey"></td>
403 <td></td>
404 <td class="paramtype">&#160;</td>
405 <td class="paramname">msg, </td>
406 </tr>
407 <tr>
408 <td class="paramkey"></td>
409 <td></td>
410 <td class="paramtype">&#160;</td>
411 <td class="paramname"><em>...</em>&#160;</td>
412 </tr>
413 <tr>
414 <td></td>
415 <td>)</td>
416 <td></td><td></td>
417 </tr>
418 </table>
419</div><div class="memdoc">
420<b>Value:</b><div class="fragment"><div class="line"><span class="keywordflow">do</span> \</div><div class="line"> { \</div><div class="line"> std::array&lt;char, 512&gt; out{ 0 }; \</div><div class="line"> int <a class="code" href="src_2core_2_c_l_2cl__kernels_2_helpers_8h.xhtml#a009469e4d9b8fce3b6d5e97d2077827d">offset</a> = <a class="code" href="namespacearm__compute_1_1support_1_1cpp11.xhtml#a9429515817425d10f4b662eaa069cc5c">snprintf</a>(out.data(), out.size(), <span class="stringliteral">&quot;in %s %s:%d: &quot;</span>, func, file, line); \</div><div class="line"> snprintf(out.data() + <a class="code" href="src_2core_2_c_l_2cl__kernels_2_helpers_8h.xhtml#a009469e4d9b8fce3b6d5e97d2077827d">offset</a>, out.size() - <a class="code" href="src_2core_2_c_l_2cl__kernels_2_helpers_8h.xhtml#a009469e4d9b8fce3b6d5e97d2077827d">offset</a>, msg, __VA_ARGS__); <a class="code" href="namespacearm__compute.xhtml#a49cdbfceec3cb9949d00dbd1a17c5604">\</a></div><div class="line"><a class="code" href="namespacearm__compute.xhtml#a49cdbfceec3cb9949d00dbd1a17c5604"> arm_compute::create_error</a>(error_code, std::string(out.data())); \</div><div class="line"> } <span class="keywordflow">while</span>(<span class="keyword">false</span>)</div><div class="ttc" id="src_2core_2_c_l_2cl__kernels_2_helpers_8h_xhtml_a009469e4d9b8fce3b6d5e97d2077827d"><div class="ttname"><a href="src_2core_2_c_l_2cl__kernels_2_helpers_8h.xhtml#a009469e4d9b8fce3b6d5e97d2077827d">offset</a></div><div class="ttdeci">__global uchar * offset(const Image *img, int x, int y)</div><div class="ttdoc">Get the pointer position of a Image.</div><div class="ttdef"><b>Definition:</b> <a href="src_2core_2_c_l_2cl__kernels_2_helpers_8h_source.xhtml#l00510">helpers.h:510</a></div></div>
421<div class="ttc" id="namespacearm__compute_xhtml_a49cdbfceec3cb9949d00dbd1a17c5604"><div class="ttname"><a href="namespacearm__compute.xhtml#a49cdbfceec3cb9949d00dbd1a17c5604">arm_compute::create_error</a></div><div class="ttdeci">Status create_error(ErrorCode error_code, std::string msg)</div><div class="ttdoc">Creates an error containing the error message.</div><div class="ttdef"><b>Definition:</b> <a href="_error_8cpp_source.xhtml#l00034">Error.cpp:34</a></div></div>
422<div class="ttc" id="namespacearm__compute_1_1support_1_1cpp11_xhtml_a9429515817425d10f4b662eaa069cc5c"><div class="ttname"><a href="namespacearm__compute_1_1support_1_1cpp11.xhtml#a9429515817425d10f4b662eaa069cc5c">arm_compute::support::cpp11::snprintf</a></div><div class="ttdeci">int snprintf(char *s, std::size_t n, const char *fmt, Ts &amp;&amp;... args)</div><div class="ttdoc">Loads the data from the given location, converts them to character string equivalents and writes the ...</div><div class="ttdef"><b>Definition:</b> <a href="_toolchain_support_8h_source.xhtml#l00387">ToolchainSupport.h:387</a></div></div>
423</div><!-- fragment -->
424<p>Creates an error on location with a given message. </p>
425<p>Accepts a message format and a variable list of arguments matching the format description.</p>
426<dl class="params"><dt>Parameters</dt><dd>
427 <table class="params">
428 <tr><td class="paramdir">[in]</td><td class="paramname">error_code</td><td>Error code. </td></tr>
429 <tr><td class="paramdir">[in]</td><td class="paramname">func</td><td>Function in which the error occurred. </td></tr>
430 <tr><td class="paramdir">[in]</td><td class="paramname">file</td><td>File in which the error occurred. </td></tr>
431 <tr><td class="paramdir">[in]</td><td class="paramname">line</td><td>Line in which the error occurred. </td></tr>
432 <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Error description message format. </td></tr>
433 <tr><td class="paramdir">[in]</td><td class="paramname">...</td><td>List of arguments matching the format description. </td></tr>
434 </table>
435 </dd>
436</dl>
437
438<p class="definition">Definition at line <a class="el" href="_error_8h_source.xhtml#l00181">181</a> of file <a class="el" href="_error_8h_source.xhtml">Error.h</a>.</p>
439
440</div>
441</div>
442<a id="a7cf8d8b669b8f7b05680230be30d60f4"></a>
443<h2 class="memtitle"><span class="permalink"><a href="#a7cf8d8b669b8f7b05680230be30d60f4">&#9670;&nbsp;</a></span>ARM_COMPUTE_ERROR</h2>
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]444
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]445<div class="memitem">
446<div class="memproto">
447 <table class="memname">
448 <tr>
449 <td class="memname">#define ARM_COMPUTE_ERROR</td>
450 <td>(</td>
451 <td class="paramtype">&#160;</td>
Jenkins0e205f72019-11-28 16:53:35 +0000[diff] [blame]452 <td class="paramname">msg</td><td>)</td>
453 <td>&#160;&#160;&#160;<a class="el" href="_error_8h.xhtml#adfd4354a6e0f46eddd353913a1470219">ARM_COMPUTE_THROW_ERROR</a>(__func__, __FILE__, __LINE__, msg)</td>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]454 </tr>
455 </table>
456</div><div class="memdoc">
457
458<p>Print the given message then throw an std::runtime_error. </p>
459<dl class="params"><dt>Parameters</dt><dd>
460 <table class="params">
Jenkins0e205f72019-11-28 16:53:35 +0000[diff] [blame]461 <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to display. </td></tr>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]462 </table>
463 </dd>
464</dl>
465
Jenkins0e205f72019-11-28 16:53:35 +0000[diff] [blame]466<p class="definition">Definition at line <a class="el" href="_error_8h_source.xhtml#l00352">352</a> of file <a class="el" href="_error_8h_source.xhtml">Error.h</a>.</p>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]467
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]468</div>
469</div>
Jenkins0e205f72019-11-28 16:53:35 +0000[diff] [blame]470<a id="a94b64f1b45be794e8304c238e90be6b0"></a>
471<h2 class="memtitle"><span class="permalink"><a href="#a94b64f1b45be794e8304c238e90be6b0">&#9670;&nbsp;</a></span>ARM_COMPUTE_ERROR_LOC</h2>
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]472
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]473<div class="memitem">
474<div class="memproto">
475 <table class="memname">
476 <tr>
477 <td class="memname">#define ARM_COMPUTE_ERROR_LOC</td>
478 <td>(</td>
479 <td class="paramtype">&#160;</td>
480 <td class="paramname">func, </td>
481 </tr>
482 <tr>
483 <td class="paramkey"></td>
484 <td></td>
485 <td class="paramtype">&#160;</td>
486 <td class="paramname">file, </td>
487 </tr>
488 <tr>
489 <td class="paramkey"></td>
490 <td></td>
491 <td class="paramtype">&#160;</td>
492 <td class="paramname">line, </td>
493 </tr>
494 <tr>
495 <td class="paramkey"></td>
496 <td></td>
497 <td class="paramtype">&#160;</td>
Jenkins0e205f72019-11-28 16:53:35 +0000[diff] [blame]498 <td class="paramname">msg&#160;</td>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]499 </tr>
500 <tr>
501 <td></td>
502 <td>)</td>
Jenkins0e205f72019-11-28 16:53:35 +0000[diff] [blame]503 <td></td><td>&#160;&#160;&#160;<a class="el" href="_error_8h.xhtml#adfd4354a6e0f46eddd353913a1470219">ARM_COMPUTE_THROW_ERROR</a>(func, file, line, msg)</td>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]504 </tr>
505 </table>
506</div><div class="memdoc">
507
508<p>Print the given message then throw an std::runtime_error. </p>
509<dl class="params"><dt>Parameters</dt><dd>
510 <table class="params">
511 <tr><td class="paramdir">[in]</td><td class="paramname">func</td><td>Function in which the error occurred. </td></tr>
512 <tr><td class="paramdir">[in]</td><td class="paramname">file</td><td>File in which the error occurred. </td></tr>
513 <tr><td class="paramdir">[in]</td><td class="paramname">line</td><td>Line in which the error occurred. </td></tr>
Jenkins0e205f72019-11-28 16:53:35 +0000[diff] [blame]514 <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to display. </td></tr>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]515 </table>
516 </dd>
517</dl>
518
Jenkins0e205f72019-11-28 16:53:35 +0000[diff] [blame]519<p class="definition">Definition at line <a class="el" href="_error_8h_source.xhtml#l00372">372</a> of file <a class="el" href="_error_8h_source.xhtml">Error.h</a>.</p>
520
521</div>
522</div>
523<a id="a6b97423ad86a4a64ec1838d6135282cb"></a>
524<h2 class="memtitle"><span class="permalink"><a href="#a6b97423ad86a4a64ec1838d6135282cb">&#9670;&nbsp;</a></span>ARM_COMPUTE_ERROR_LOC_VAR</h2>
525
526<div class="memitem">
527<div class="memproto">
528 <table class="memname">
529 <tr>
530 <td class="memname">#define ARM_COMPUTE_ERROR_LOC_VAR</td>
531 <td>(</td>
532 <td class="paramtype">&#160;</td>
533 <td class="paramname">func, </td>
534 </tr>
535 <tr>
536 <td class="paramkey"></td>
537 <td></td>
538 <td class="paramtype">&#160;</td>
539 <td class="paramname">file, </td>
540 </tr>
541 <tr>
542 <td class="paramkey"></td>
543 <td></td>
544 <td class="paramtype">&#160;</td>
545 <td class="paramname">line, </td>
546 </tr>
547 <tr>
548 <td class="paramkey"></td>
549 <td></td>
550 <td class="paramtype">&#160;</td>
551 <td class="paramname">msg, </td>
552 </tr>
553 <tr>
554 <td class="paramkey"></td>
555 <td></td>
556 <td class="paramtype">&#160;</td>
557 <td class="paramname"><em>...</em>&#160;</td>
558 </tr>
559 <tr>
560 <td></td>
561 <td>)</td>
562 <td></td><td>&#160;&#160;&#160;<a class="el" href="_error_8h.xhtml#a86513cce33cfea9d3dd6eac3366b8253">ARM_COMPUTE_THROW_ERROR_VAR</a>(func, file, line, msg, __VA_ARGS__)</td>
563 </tr>
564 </table>
565</div><div class="memdoc">
566
567<p>Print the given message then throw an std::runtime_error. </p>
568<p>Accepts a message format and a variable list of arguments matching the format description.</p>
569<dl class="params"><dt>Parameters</dt><dd>
570 <table class="params">
571 <tr><td class="paramdir">[in]</td><td class="paramname">func</td><td>Function in which the error occurred. </td></tr>
572 <tr><td class="paramdir">[in]</td><td class="paramname">file</td><td>File in which the error occurred. </td></tr>
573 <tr><td class="paramdir">[in]</td><td class="paramname">line</td><td>Line in which the error occurred. </td></tr>
574 <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Error description message format. </td></tr>
575 <tr><td class="paramdir">[in]</td><td class="paramname">...</td><td>List of arguments matching the format description. </td></tr>
576 </table>
577 </dd>
578</dl>
579
580<p class="definition">Definition at line <a class="el" href="_error_8h_source.xhtml#l00363">363</a> of file <a class="el" href="_error_8h_source.xhtml">Error.h</a>.</p>
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]581
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]582</div>
583</div>
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]584<a id="a54a6080c9f4df1f908e57a9bbb46f5da"></a>
585<h2 class="memtitle"><span class="permalink"><a href="#a54a6080c9f4df1f908e57a9bbb46f5da">&#9670;&nbsp;</a></span>ARM_COMPUTE_ERROR_ON</h2>
586
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]587<div class="memitem">
588<div class="memproto">
589 <table class="memname">
590 <tr>
591 <td class="memname">#define ARM_COMPUTE_ERROR_ON</td>
592 <td>(</td>
593 <td class="paramtype">&#160;</td>
594 <td class="paramname">cond</td><td>)</td>
Jenkins0e205f72019-11-28 16:53:35 +0000[diff] [blame]595 <td>&#160;&#160;&#160;<a class="el" href="_error_8h.xhtml#a0b0eb3235749a2909dc5a101afe59a1b">ARM_COMPUTE_ERROR_ON_MSG</a>(cond, #cond)</td>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]596 </tr>
597 </table>
598</div><div class="memdoc">
599
600<p>If the condition is true then an error message is printed and an exception thrown. </p>
601<dl class="params"><dt>Parameters</dt><dd>
602 <table class="params">
603 <tr><td class="paramdir">[in]</td><td class="paramname">cond</td><td>Condition to evaluate. </td></tr>
604 </table>
605 </dd>
606</dl>
607
Jenkins0e205f72019-11-28 16:53:35 +0000[diff] [blame]608<p class="definition">Definition at line <a class="el" href="_error_8h_source.xhtml#l00466">466</a> of file <a class="el" href="_error_8h_source.xhtml">Error.h</a>.</p>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]609
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]610</div>
611</div>
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]612<a id="ac90c3bce005225cbaa4a43740917bb58"></a>
613<h2 class="memtitle"><span class="permalink"><a href="#ac90c3bce005225cbaa4a43740917bb58">&#9670;&nbsp;</a></span>ARM_COMPUTE_ERROR_ON_LOC</h2>
614
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]615<div class="memitem">
616<div class="memproto">
617 <table class="memname">
618 <tr>
619 <td class="memname">#define ARM_COMPUTE_ERROR_ON_LOC</td>
620 <td>(</td>
621 <td class="paramtype">&#160;</td>
622 <td class="paramname">cond, </td>
623 </tr>
624 <tr>
625 <td class="paramkey"></td>
626 <td></td>
627 <td class="paramtype">&#160;</td>
628 <td class="paramname">func, </td>
629 </tr>
630 <tr>
631 <td class="paramkey"></td>
632 <td></td>
633 <td class="paramtype">&#160;</td>
634 <td class="paramname">file, </td>
635 </tr>
636 <tr>
637 <td class="paramkey"></td>
638 <td></td>
639 <td class="paramtype">&#160;</td>
640 <td class="paramname">line&#160;</td>
641 </tr>
642 <tr>
643 <td></td>
644 <td>)</td>
Jenkins0e205f72019-11-28 16:53:35 +0000[diff] [blame]645 <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, &quot;%s&quot;, #cond)</td>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]646 </tr>
647 </table>
648</div><div class="memdoc">
649
650<p>If the condition is true then an error message is printed and an exception thrown. </p>
651<dl class="params"><dt>Parameters</dt><dd>
652 <table class="params">
653 <tr><td class="paramdir">[in]</td><td class="paramname">cond</td><td>Condition to evaluate. </td></tr>
654 <tr><td class="paramdir">[in]</td><td class="paramname">func</td><td>Function in which the error occurred. </td></tr>
655 <tr><td class="paramdir">[in]</td><td class="paramname">file</td><td>File in which the error occurred. </td></tr>
656 <tr><td class="paramdir">[in]</td><td class="paramname">line</td><td>Line in which the error occurred. </td></tr>
657 </table>
658 </dd>
659</dl>
660
Jenkins0e205f72019-11-28 16:53:35 +0000[diff] [blame]661<p class="definition">Definition at line <a class="el" href="_error_8h_source.xhtml#l00476">476</a> of file <a class="el" href="_error_8h_source.xhtml">Error.h</a>.</p>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]662
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]663</div>
664</div>
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]665<a id="a1b62e396a1789909dadda61ea4cda96f"></a>
666<h2 class="memtitle"><span class="permalink"><a href="#a1b62e396a1789909dadda61ea4cda96f">&#9670;&nbsp;</a></span>ARM_COMPUTE_ERROR_ON_LOC_MSG</h2>
667
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]668<div class="memitem">
669<div class="memproto">
670 <table class="memname">
671 <tr>
672 <td class="memname">#define ARM_COMPUTE_ERROR_ON_LOC_MSG</td>
673 <td>(</td>
674 <td class="paramtype">&#160;</td>
675 <td class="paramname">cond, </td>
676 </tr>
677 <tr>
678 <td class="paramkey"></td>
679 <td></td>
680 <td class="paramtype">&#160;</td>
681 <td class="paramname">func, </td>
682 </tr>
683 <tr>
684 <td class="paramkey"></td>
685 <td></td>
686 <td class="paramtype">&#160;</td>
687 <td class="paramname">file, </td>
688 </tr>
689 <tr>
690 <td class="paramkey"></td>
691 <td></td>
692 <td class="paramtype">&#160;</td>
693 <td class="paramname">line, </td>
694 </tr>
695 <tr>
696 <td class="paramkey"></td>
697 <td></td>
698 <td class="paramtype">&#160;</td>
699 <td class="paramname"><em>...</em>&#160;</td>
700 </tr>
701 <tr>
702 <td></td>
703 <td>)</td>
704 <td></td><td></td>
705 </tr>
706 </table>
707</div><div class="memdoc">
708
Jenkins0e205f72019-11-28 16:53:35 +0000[diff] [blame]709<p class="definition">Definition at line <a class="el" href="_error_8h_source.xhtml#l00458">458</a> of file <a class="el" href="_error_8h_source.xhtml">Error.h</a>.</p>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]710
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]711</div>
712</div>
Jenkins0e205f72019-11-28 16:53:35 +0000[diff] [blame]713<a id="a0b0eb3235749a2909dc5a101afe59a1b"></a>
714<h2 class="memtitle"><span class="permalink"><a href="#a0b0eb3235749a2909dc5a101afe59a1b">&#9670;&nbsp;</a></span>ARM_COMPUTE_ERROR_ON_MSG</h2>
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]715
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]716<div class="memitem">
717<div class="memproto">
718 <table class="memname">
719 <tr>
720 <td class="memname">#define ARM_COMPUTE_ERROR_ON_MSG</td>
721 <td>(</td>
722 <td class="paramtype">&#160;</td>
723 <td class="paramname">cond, </td>
724 </tr>
725 <tr>
726 <td class="paramkey"></td>
727 <td></td>
728 <td class="paramtype">&#160;</td>
Jenkins0e205f72019-11-28 16:53:35 +0000[diff] [blame]729 <td class="paramname">msg&#160;</td>
730 </tr>
731 <tr>
732 <td></td>
733 <td>)</td>
734 <td></td><td></td>
735 </tr>
736 </table>
737</div><div class="memdoc">
738
739<p class="definition">Definition at line <a class="el" href="_error_8h_source.xhtml#l00456">456</a> of file <a class="el" href="_error_8h_source.xhtml">Error.h</a>.</p>
740
741</div>
742</div>
743<a id="acaa348bf0c7eb9493c72092b7293d45f"></a>
744<h2 class="memtitle"><span class="permalink"><a href="#acaa348bf0c7eb9493c72092b7293d45f">&#9670;&nbsp;</a></span>ARM_COMPUTE_ERROR_ON_MSG_VAR</h2>
745
746<div class="memitem">
747<div class="memproto">
748 <table class="memname">
749 <tr>
750 <td class="memname">#define ARM_COMPUTE_ERROR_ON_MSG_VAR</td>
751 <td>(</td>
752 <td class="paramtype">&#160;</td>
753 <td class="paramname">cond, </td>
754 </tr>
755 <tr>
756 <td class="paramkey"></td>
757 <td></td>
758 <td class="paramtype">&#160;</td>
759 <td class="paramname">msg, </td>
760 </tr>
761 <tr>
762 <td class="paramkey"></td>
763 <td></td>
764 <td class="paramtype">&#160;</td>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]765 <td class="paramname"><em>...</em>&#160;</td>
766 </tr>
767 <tr>
768 <td></td>
769 <td>)</td>
770 <td></td><td></td>
771 </tr>
772 </table>
773</div><div class="memdoc">
774
Jenkins0e205f72019-11-28 16:53:35 +0000[diff] [blame]775<p class="definition">Definition at line <a class="el" href="_error_8h_source.xhtml#l00457">457</a> of file <a class="el" href="_error_8h_source.xhtml">Error.h</a>.</p>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]776
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]777</div>
778</div>
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]779<a id="a938dcd406ce611ef5345ad2531cdb948"></a>
780<h2 class="memtitle"><span class="permalink"><a href="#a938dcd406ce611ef5345ad2531cdb948">&#9670;&nbsp;</a></span>ARM_COMPUTE_ERROR_THROW_ON</h2>
781
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]782<div class="memitem">
783<div class="memproto">
784 <table class="memname">
785 <tr>
786 <td class="memname">#define ARM_COMPUTE_ERROR_THROW_ON</td>
787 <td>(</td>
788 <td class="paramtype">&#160;</td>
789 <td class="paramname">status</td><td>)</td>
790 <td></td>
791 </tr>
792 </table>
793</div><div class="memdoc">
794
Jenkins0e205f72019-11-28 16:53:35 +0000[diff] [blame]795<p class="definition">Definition at line <a class="el" href="_error_8h_source.xhtml#l00455">455</a> of file <a class="el" href="_error_8h_source.xhtml">Error.h</a>.</p>
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]796
Jenkins52ba29e2018-08-29 15:32:11 +0000[diff] [blame]797</div>
798</div>
Jenkins0e205f72019-11-28 16:53:35 +0000[diff] [blame]799<a id="abd040a16dc0dbc75733e07aff93048a8"></a>
800<h2 class="memtitle"><span class="permalink"><a href="#abd040a16dc0dbc75733e07aff93048a8">&#9670;&nbsp;</a></span>ARM_COMPUTE_ERROR_VAR</h2>
801
802<div class="memitem">
803<div class="memproto">
804 <table class="memname">
805 <tr>
806 <td class="memname">#define ARM_COMPUTE_ERROR_VAR</td>
807 <td>(</td>
808 <td class="paramtype">&#160;</td>
809 <td class="paramname">msg, </td>
810 </tr>
811 <tr>
812 <td class="paramkey"></td>
813 <td></td>
814 <td class="paramtype">&#160;</td>
815 <td class="paramname"><em>...</em>&#160;</td>
816 </tr>
817 <tr>
818 <td></td>
819 <td>)</td>
820 <td></td><td>&#160;&#160;&#160;<a class="el" href="_error_8h.xhtml#a86513cce33cfea9d3dd6eac3366b8253">ARM_COMPUTE_THROW_ERROR_VAR</a>(__func__, __FILE__, __LINE__, msg, __VA_ARGS__)</td>
821 </tr>
822 </table>
823</div><div class="memdoc">
824
825<p>Print the given message then throw an std::runtime_error. </p>
826<p>Accepts a message format and a variable list of arguments matching the format description.</p>
827<dl class="params"><dt>Parameters</dt><dd>
828 <table class="params">
829 <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Error description message format. </td></tr>
830 <tr><td class="paramdir">[in]</td><td class="paramname">...</td><td>List of arguments matching the format description. </td></tr>
831 </table>
832 </dd>
833</dl>
834
835<p class="definition">Definition at line <a class="el" href="_error_8h_source.xhtml#l00346">346</a> of file <a class="el" href="_error_8h_source.xhtml">Error.h</a>.</p>
836
837</div>
838</div>
839<a id="a292b758f9eba8b487d71eae4b37326fc"></a>
840<h2 class="memtitle"><span class="permalink"><a href="#a292b758f9eba8b487d71eae4b37326fc">&#9670;&nbsp;</a></span>ARM_COMPUTE_EXIT_ON_MSG</h2>
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]841
Jenkins52ba29e2018-08-29 15:32:11 +0000[diff] [blame]842<div class="memitem">
843<div class="memproto">
844 <table class="memname">
845 <tr>
846 <td class="memname">#define ARM_COMPUTE_EXIT_ON_MSG</td>
847 <td>(</td>
848 <td class="paramtype">&#160;</td>
849 <td class="paramname">cond, </td>
850 </tr>
851 <tr>
852 <td class="paramkey"></td>
853 <td></td>
854 <td class="paramtype">&#160;</td>
Jenkins0e205f72019-11-28 16:53:35 +0000[diff] [blame]855 <td class="paramname">msg&#160;</td>
856 </tr>
857 <tr>
858 <td></td>
859 <td>)</td>
860 <td></td><td></td>
861 </tr>
862 </table>
863</div><div class="memdoc">
864<b>Value:</b><div class="fragment"><div class="line"><span class="keywordflow">do</span> \</div><div class="line"> { \</div><div class="line"> if(cond) \</div><div class="line"> { \</div><div class="line"> ARM_COMPUTE_ERROR(msg); \</div><div class="line"> } \</div><div class="line"> } <span class="keywordflow">while</span>(<span class="keyword">false</span>)</div></div><!-- fragment -->
865<p>If the condition is true, the given message is printed and program exits. </p>
866<dl class="params"><dt>Parameters</dt><dd>
867 <table class="params">
868 <tr><td class="paramdir">[in]</td><td class="paramname">cond</td><td>Condition to evaluate. </td></tr>
869 <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to display. </td></tr>
870 </table>
871 </dd>
872</dl>
873
874<p class="definition">Definition at line <a class="el" href="_error_8h_source.xhtml#l00379">379</a> of file <a class="el" href="_error_8h_source.xhtml">Error.h</a>.</p>
875
876</div>
877</div>
878<a id="ac75ba282eb0cacd31fd4c6e6a47dbbc8"></a>
879<h2 class="memtitle"><span class="permalink"><a href="#ac75ba282eb0cacd31fd4c6e6a47dbbc8">&#9670;&nbsp;</a></span>ARM_COMPUTE_EXIT_ON_MSG_VAR</h2>
880
881<div class="memitem">
882<div class="memproto">
883 <table class="memname">
884 <tr>
885 <td class="memname">#define ARM_COMPUTE_EXIT_ON_MSG_VAR</td>
886 <td>(</td>
887 <td class="paramtype">&#160;</td>
888 <td class="paramname">cond, </td>
889 </tr>
890 <tr>
891 <td class="paramkey"></td>
892 <td></td>
893 <td class="paramtype">&#160;</td>
894 <td class="paramname">msg, </td>
895 </tr>
896 <tr>
897 <td class="paramkey"></td>
898 <td></td>
899 <td class="paramtype">&#160;</td>
Jenkins52ba29e2018-08-29 15:32:11 +0000[diff] [blame]900 <td class="paramname"><em>...</em>&#160;</td>
901 </tr>
902 <tr>
903 <td></td>
904 <td>)</td>
905 <td></td><td></td>
906 </tr>
907 </table>
908</div><div class="memdoc">
Jenkins0e205f72019-11-28 16:53:35 +0000[diff] [blame]909<b>Value:</b><div class="fragment"><div class="line"><span class="keywordflow">do</span> \</div><div class="line"> { \</div><div class="line"> if(cond) \</div><div class="line"> { \</div><div class="line"> ARM_COMPUTE_ERROR_VAR(msg, __VA_ARGS__); \</div><div class="line"> } \</div><div class="line"> } <span class="keywordflow">while</span>(<span class="keyword">false</span>)</div></div><!-- fragment -->
Jenkins52ba29e2018-08-29 15:32:11 +0000[diff] [blame]910<p>If the condition is true, the given message is printed and program exits. </p>
Jenkins0e205f72019-11-28 16:53:35 +0000[diff] [blame]911<p>Accepts a message format and a variable list of arguments matching the format description.</p>
Jenkins52ba29e2018-08-29 15:32:11 +0000[diff] [blame]912<dl class="params"><dt>Parameters</dt><dd>
913 <table class="params">
914 <tr><td class="paramdir">[in]</td><td class="paramname">cond</td><td>Condition to evaluate. </td></tr>
Jenkins0e205f72019-11-28 16:53:35 +0000[diff] [blame]915 <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Error description message format. </td></tr>
916 <tr><td class="paramdir">[in]</td><td class="paramname">...</td><td>List of arguments matching the format description. </td></tr>
Jenkins52ba29e2018-08-29 15:32:11 +0000[diff] [blame]917 </table>
918 </dd>
919</dl>
920
Jenkins0e205f72019-11-28 16:53:35 +0000[diff] [blame]921<p class="definition">Definition at line <a class="el" href="_error_8h_source.xhtml#l00395">395</a> of file <a class="el" href="_error_8h_source.xhtml">Error.h</a>.</p>
Jenkins52ba29e2018-08-29 15:32:11 +0000[diff] [blame]922
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]923</div>
924</div>
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]925<a id="a9561091f3566e78ad3aa39259bc4126a"></a>
926<h2 class="memtitle"><span class="permalink"><a href="#a9561091f3566e78ad3aa39259bc4126a">&#9670;&nbsp;</a></span>ARM_COMPUTE_RETURN_ERROR_MSG</h2>
927
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]928<div class="memitem">
929<div class="memproto">
930 <table class="memname">
931 <tr>
932 <td class="memname">#define ARM_COMPUTE_RETURN_ERROR_MSG</td>
933 <td>(</td>
934 <td class="paramtype">&#160;</td>
935 <td class="paramname"><em>...</em></td><td>)</td>
936 <td></td>
937 </tr>
938 </table>
939</div><div class="memdoc">
Jenkins0e205f72019-11-28 16:53:35 +0000[diff] [blame]940<b>Value:</b><div class="fragment"><div class="line"><span class="keywordflow">do</span> \</div><div class="line"> { \</div><div class="line"> return <a class="code" href="_error_8h.xhtml#af1b8ff8eb557a2ad11272f1505f45d34">ARM_COMPUTE_CREATE_ERROR</a>(<a class="code" href="namespacearm__compute.xhtml#a59e56af19e754a6aa26a612ebf91d05fa62be47fdd89da032cf78dfce82239579">arm_compute::ErrorCode::RUNTIME_ERROR</a>, __VA_ARGS__); \</div><div class="line"> } <span class="keywordflow">while</span>(<span class="keyword">false</span>)</div><div class="ttc" id="namespacearm__compute_xhtml_a59e56af19e754a6aa26a612ebf91d05fa62be47fdd89da032cf78dfce82239579"><div class="ttname"><a href="namespacearm__compute.xhtml#a59e56af19e754a6aa26a612ebf91d05fa62be47fdd89da032cf78dfce82239579">arm_compute::ErrorCode::RUNTIME_ERROR</a></div><div class="ttdoc">Generic runtime error.</div></div>
941<div class="ttc" id="_error_8h_xhtml_af1b8ff8eb557a2ad11272f1505f45d34"><div class="ttname"><a href="_error_8h.xhtml#af1b8ff8eb557a2ad11272f1505f45d34">ARM_COMPUTE_CREATE_ERROR</a></div><div class="ttdeci">#define ARM_COMPUTE_CREATE_ERROR(error_code, msg)</div><div class="ttdoc">Creates an error with a given message.</div><div class="ttdef"><b>Definition:</b> <a href="_error_8h_source.xhtml#l00159">Error.h:159</a></div></div>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]942</div><!-- fragment -->
943<p>An error is returned with the given description. </p>
944<dl class="params"><dt>Parameters</dt><dd>
945 <table class="params">
946 <tr><td class="paramdir">[in]</td><td class="paramname">...</td><td>Error description message. </td></tr>
947 </table>
948 </dd>
949</dl>
950
Jenkins0e205f72019-11-28 16:53:35 +0000[diff] [blame]951<p class="definition">Definition at line <a class="el" href="_error_8h_source.xhtml#l00194">194</a> of file <a class="el" href="_error_8h_source.xhtml">Error.h</a>.</p>
Jenkins52ba29e2018-08-29 15:32:11 +0000[diff] [blame]952
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]953</div>
954</div>
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]955<a id="a206d6e247e0957ac3dee45d27756fc25"></a>
956<h2 class="memtitle"><span class="permalink"><a href="#a206d6e247e0957ac3dee45d27756fc25">&#9670;&nbsp;</a></span>ARM_COMPUTE_RETURN_ERROR_ON</h2>
957
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]958<div class="memitem">
959<div class="memproto">
960 <table class="memname">
961 <tr>
962 <td class="memname">#define ARM_COMPUTE_RETURN_ERROR_ON</td>
963 <td>(</td>
964 <td class="paramtype">&#160;</td>
965 <td class="paramname">cond</td><td>)</td>
Jenkins0e205f72019-11-28 16:53:35 +0000[diff] [blame]966 <td>&#160;&#160;&#160;<a class="el" href="_error_8h.xhtml#a1c69762a42ab8add645d0a949b6f4b1f">ARM_COMPUTE_RETURN_ERROR_ON_MSG</a>(cond, #cond)</td>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]967 </tr>
968 </table>
969</div><div class="memdoc">
970
971<p>If the condition is true, an error is returned. </p>
972<dl class="params"><dt>Parameters</dt><dd>
973 <table class="params">
974 <tr><td class="paramdir">[in]</td><td class="paramname">cond</td><td>Condition to evaluate </td></tr>
975 </table>
976 </dd>
977</dl>
978
Jenkins0e205f72019-11-28 16:53:35 +0000[diff] [blame]979<p class="definition">Definition at line <a class="el" href="_error_8h_source.xhtml#l00296">296</a> of file <a class="el" href="_error_8h_source.xhtml">Error.h</a>.</p>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]980
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]981</div>
982</div>
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]983<a id="aab9171b209dda7cc9bb560486674c9f6"></a>
984<h2 class="memtitle"><span class="permalink"><a href="#aab9171b209dda7cc9bb560486674c9f6">&#9670;&nbsp;</a></span>ARM_COMPUTE_RETURN_ERROR_ON_LOC</h2>
985
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]986<div class="memitem">
987<div class="memproto">
988 <table class="memname">
989 <tr>
990 <td class="memname">#define ARM_COMPUTE_RETURN_ERROR_ON_LOC</td>
991 <td>(</td>
992 <td class="paramtype">&#160;</td>
993 <td class="paramname">cond, </td>
994 </tr>
995 <tr>
996 <td class="paramkey"></td>
997 <td></td>
998 <td class="paramtype">&#160;</td>
999 <td class="paramname">func, </td>
1000 </tr>
1001 <tr>
1002 <td class="paramkey"></td>
1003 <td></td>
1004 <td class="paramtype">&#160;</td>
1005 <td class="paramname">file, </td>
1006 </tr>
1007 <tr>
1008 <td class="paramkey"></td>
1009 <td></td>
1010 <td class="paramtype">&#160;</td>
1011 <td class="paramname">line&#160;</td>
1012 </tr>
1013 <tr>
1014 <td></td>
1015 <td>)</td>
Jenkins0e205f72019-11-28 16:53:35 +0000[diff] [blame]1016 <td></td><td>&#160;&#160;&#160;<a class="el" href="_error_8h.xhtml#a3cbe27c31092df3dc1fa26c75f47e047">ARM_COMPUTE_RETURN_ERROR_ON_LOC_MSG</a>(cond, func, file, line, #cond)</td>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]1017 </tr>
1018 </table>
1019</div><div class="memdoc">
1020
1021<p>If the condition is true, an error is returned. </p>
1022<dl class="params"><dt>Parameters</dt><dd>
1023 <table class="params">
1024 <tr><td class="paramdir">[in]</td><td class="paramname">cond</td><td>Condition to evaluate. </td></tr>
1025 <tr><td class="paramdir">[in]</td><td class="paramname">func</td><td>Function in which the error occurred. </td></tr>
1026 <tr><td class="paramdir">[in]</td><td class="paramname">file</td><td>File in which the error occurred. </td></tr>
1027 <tr><td class="paramdir">[in]</td><td class="paramname">line</td><td>Line in which the error occurred. </td></tr>
1028 </table>
1029 </dd>
1030</dl>
1031
Jenkins0e205f72019-11-28 16:53:35 +0000[diff] [blame]1032<p class="definition">Definition at line <a class="el" href="_error_8h_source.xhtml#l00306">306</a> of file <a class="el" href="_error_8h_source.xhtml">Error.h</a>.</p>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]1033
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]1034</div>
1035</div>
Jenkins0e205f72019-11-28 16:53:35 +0000[diff] [blame]1036<a id="a3cbe27c31092df3dc1fa26c75f47e047"></a>
1037<h2 class="memtitle"><span class="permalink"><a href="#a3cbe27c31092df3dc1fa26c75f47e047">&#9670;&nbsp;</a></span>ARM_COMPUTE_RETURN_ERROR_ON_LOC_MSG</h2>
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]1038
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]1039<div class="memitem">
1040<div class="memproto">
1041 <table class="memname">
1042 <tr>
1043 <td class="memname">#define ARM_COMPUTE_RETURN_ERROR_ON_LOC_MSG</td>
1044 <td>(</td>
1045 <td class="paramtype">&#160;</td>
1046 <td class="paramname">cond, </td>
1047 </tr>
1048 <tr>
1049 <td class="paramkey"></td>
1050 <td></td>
1051 <td class="paramtype">&#160;</td>
1052 <td class="paramname">func, </td>
1053 </tr>
1054 <tr>
1055 <td class="paramkey"></td>
1056 <td></td>
1057 <td class="paramtype">&#160;</td>
1058 <td class="paramname">file, </td>
1059 </tr>
1060 <tr>
1061 <td class="paramkey"></td>
1062 <td></td>
1063 <td class="paramtype">&#160;</td>
1064 <td class="paramname">line, </td>
1065 </tr>
1066 <tr>
1067 <td class="paramkey"></td>
1068 <td></td>
1069 <td class="paramtype">&#160;</td>
Jenkins0e205f72019-11-28 16:53:35 +0000[diff] [blame]1070 <td class="paramname">msg&#160;</td>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]1071 </tr>
1072 <tr>
1073 <td></td>
1074 <td>)</td>
1075 <td></td><td></td>
1076 </tr>
1077 </table>
1078</div><div class="memdoc">
Jenkins0e205f72019-11-28 16:53:35 +0000[diff] [blame]1079<b>Value:</b><div class="fragment"><div class="line"><span class="keywordflow">do</span> \</div><div class="line"> { \</div><div class="line"> if(cond) \</div><div class="line"> { \</div><div class="line"> return <a class="code" href="namespacearm__compute.xhtml#af9b3e9f3ef6409e72c71aeacebf58f3b">arm_compute::create_error_msg</a>(ErrorCode::RUNTIME_ERROR, func, file, line, msg); \</div><div class="line"> } \</div><div class="line"> } <span class="keywordflow">while</span>(<span class="keyword">false</span>)</div><div class="ttc" id="namespacearm__compute_xhtml_af9b3e9f3ef6409e72c71aeacebf58f3b"><div class="ttname"><a href="namespacearm__compute.xhtml#af9b3e9f3ef6409e72c71aeacebf58f3b">arm_compute::create_error_msg</a></div><div class="ttdeci">Status create_error_msg(ErrorCode error_code, const char *func, const char *file, int line, const char *msg)</div><div class="ttdoc">Creates an error and the error message.</div><div class="ttdef"><b>Definition:</b> <a href="_error_8cpp_source.xhtml#l00039">Error.cpp:39</a></div></div>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]1080</div><!-- fragment -->
1081<p>If the condition is true, an error is thrown. </p>
1082<dl class="params"><dt>Parameters</dt><dd>
1083 <table class="params">
1084 <tr><td class="paramdir">[in]</td><td class="paramname">cond</td><td>Condition to evaluate. </td></tr>
1085 <tr><td class="paramdir">[in]</td><td class="paramname">func</td><td>Function in which the error occurred. </td></tr>
1086 <tr><td class="paramdir">[in]</td><td class="paramname">file</td><td>File in which the error occurred. </td></tr>
1087 <tr><td class="paramdir">[in]</td><td class="paramname">line</td><td>Line in which the error occurred. </td></tr>
Jenkins0e205f72019-11-28 16:53:35 +0000[diff] [blame]1088 <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to display. </td></tr>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]1089 </table>
1090 </dd>
1091</dl>
1092
Jenkins0e205f72019-11-28 16:53:35 +0000[diff] [blame]1093<p class="definition">Definition at line <a class="el" href="_error_8h_source.xhtml#l00283">283</a> of file <a class="el" href="_error_8h_source.xhtml">Error.h</a>.</p>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]1094
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]1095</div>
1096</div>
Jenkins0e205f72019-11-28 16:53:35 +0000[diff] [blame]1097<a id="a5e3e8db314706c6f3d822bafa3d8d761"></a>
1098<h2 class="memtitle"><span class="permalink"><a href="#a5e3e8db314706c6f3d822bafa3d8d761">&#9670;&nbsp;</a></span>ARM_COMPUTE_RETURN_ERROR_ON_LOC_MSG_VAR</h2>
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]1099
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]1100<div class="memitem">
1101<div class="memproto">
1102 <table class="memname">
1103 <tr>
Jenkins0e205f72019-11-28 16:53:35 +0000[diff] [blame]1104 <td class="memname">#define ARM_COMPUTE_RETURN_ERROR_ON_LOC_MSG_VAR</td>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]1105 <td>(</td>
1106 <td class="paramtype">&#160;</td>
1107 <td class="paramname">cond, </td>
1108 </tr>
1109 <tr>
1110 <td class="paramkey"></td>
1111 <td></td>
1112 <td class="paramtype">&#160;</td>
Jenkins0e205f72019-11-28 16:53:35 +0000[diff] [blame]1113 <td class="paramname">func, </td>
1114 </tr>
1115 <tr>
1116 <td class="paramkey"></td>
1117 <td></td>
1118 <td class="paramtype">&#160;</td>
1119 <td class="paramname">file, </td>
1120 </tr>
1121 <tr>
1122 <td class="paramkey"></td>
1123 <td></td>
1124 <td class="paramtype">&#160;</td>
1125 <td class="paramname">line, </td>
1126 </tr>
1127 <tr>
1128 <td class="paramkey"></td>
1129 <td></td>
1130 <td class="paramtype">&#160;</td>
1131 <td class="paramname">msg, </td>
1132 </tr>
1133 <tr>
1134 <td class="paramkey"></td>
1135 <td></td>
1136 <td class="paramtype">&#160;</td>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]1137 <td class="paramname"><em>...</em>&#160;</td>
1138 </tr>
1139 <tr>
1140 <td></td>
1141 <td>)</td>
1142 <td></td><td></td>
1143 </tr>
1144 </table>
1145</div><div class="memdoc">
Jenkins0e205f72019-11-28 16:53:35 +0000[diff] [blame]1146<b>Value:</b><div class="fragment"><div class="line"><span class="keywordflow">do</span> \</div><div class="line"> { \</div><div class="line"> if(cond) \</div><div class="line"> { \</div><div class="line"> std::array&lt;char, 512&gt; out{ 0 }; \</div><div class="line"> int <a class="code" href="src_2core_2_c_l_2cl__kernels_2_helpers_8h.xhtml#a009469e4d9b8fce3b6d5e97d2077827d">offset</a> = <a class="code" href="namespacearm__compute_1_1support_1_1cpp11.xhtml#a9429515817425d10f4b662eaa069cc5c">snprintf</a>(out.data(), out.size(), <span class="stringliteral">&quot;in %s %s:%d: &quot;</span>, func, file, line); \</div><div class="line"> snprintf(out.data() + <a class="code" href="src_2core_2_c_l_2cl__kernels_2_helpers_8h.xhtml#a009469e4d9b8fce3b6d5e97d2077827d">offset</a>, out.size() - <a class="code" href="src_2core_2_c_l_2cl__kernels_2_helpers_8h.xhtml#a009469e4d9b8fce3b6d5e97d2077827d">offset</a>, msg, __VA_ARGS__); \</div><div class="line"> return <a class="code" href="namespacearm__compute.xhtml#a49cdbfceec3cb9949d00dbd1a17c5604">arm_compute::create_error</a>(ErrorCode::RUNTIME_ERROR, std::string(out.data())); \</div><div class="line"> } \</div><div class="line"> } <span class="keywordflow">while</span>(<span class="keyword">false</span>)</div><div class="ttc" id="src_2core_2_c_l_2cl__kernels_2_helpers_8h_xhtml_a009469e4d9b8fce3b6d5e97d2077827d"><div class="ttname"><a href="src_2core_2_c_l_2cl__kernels_2_helpers_8h.xhtml#a009469e4d9b8fce3b6d5e97d2077827d">offset</a></div><div class="ttdeci">__global uchar * offset(const Image *img, int x, int y)</div><div class="ttdoc">Get the pointer position of a Image.</div><div class="ttdef"><b>Definition:</b> <a href="src_2core_2_c_l_2cl__kernels_2_helpers_8h_source.xhtml#l00510">helpers.h:510</a></div></div>
1147<div class="ttc" id="namespacearm__compute_xhtml_a49cdbfceec3cb9949d00dbd1a17c5604"><div class="ttname"><a href="namespacearm__compute.xhtml#a49cdbfceec3cb9949d00dbd1a17c5604">arm_compute::create_error</a></div><div class="ttdeci">Status create_error(ErrorCode error_code, std::string msg)</div><div class="ttdoc">Creates an error containing the error message.</div><div class="ttdef"><b>Definition:</b> <a href="_error_8cpp_source.xhtml#l00034">Error.cpp:34</a></div></div>
1148<div class="ttc" id="namespacearm__compute_1_1support_1_1cpp11_xhtml_a9429515817425d10f4b662eaa069cc5c"><div class="ttname"><a href="namespacearm__compute_1_1support_1_1cpp11.xhtml#a9429515817425d10f4b662eaa069cc5c">arm_compute::support::cpp11::snprintf</a></div><div class="ttdeci">int snprintf(char *s, std::size_t n, const char *fmt, Ts &amp;&amp;... args)</div><div class="ttdoc">Loads the data from the given location, converts them to character string equivalents and writes the ...</div><div class="ttdef"><b>Definition:</b> <a href="_toolchain_support_8h_source.xhtml#l00387">ToolchainSupport.h:387</a></div></div>
1149</div><!-- fragment -->
1150<p>If the condition is true, an error is thrown. </p>
1151<p>Accepts a message format and a variable list of arguments matching the format description.</p>
1152<dl class="params"><dt>Parameters</dt><dd>
1153 <table class="params">
1154 <tr><td class="paramdir">[in]</td><td class="paramname">cond</td><td>Condition to evaluate. </td></tr>
1155 <tr><td class="paramdir">[in]</td><td class="paramname">func</td><td>Function in which the error occurred. </td></tr>
1156 <tr><td class="paramdir">[in]</td><td class="paramname">file</td><td>File in which the error occurred. </td></tr>
1157 <tr><td class="paramdir">[in]</td><td class="paramname">line</td><td>Line in which the error occurred. </td></tr>
1158 <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Error description message format. </td></tr>
1159 <tr><td class="paramdir">[in]</td><td class="paramname">...</td><td>List of arguments matching the format description. </td></tr>
1160 </table>
1161 </dd>
1162</dl>
1163
1164<p class="definition">Definition at line <a class="el" href="_error_8h_source.xhtml#l00263">263</a> of file <a class="el" href="_error_8h_source.xhtml">Error.h</a>.</p>
1165
1166</div>
1167</div>
1168<a id="a1c69762a42ab8add645d0a949b6f4b1f"></a>
1169<h2 class="memtitle"><span class="permalink"><a href="#a1c69762a42ab8add645d0a949b6f4b1f">&#9670;&nbsp;</a></span>ARM_COMPUTE_RETURN_ERROR_ON_MSG</h2>
1170
1171<div class="memitem">
1172<div class="memproto">
1173 <table class="memname">
1174 <tr>
1175 <td class="memname">#define ARM_COMPUTE_RETURN_ERROR_ON_MSG</td>
1176 <td>(</td>
1177 <td class="paramtype">&#160;</td>
1178 <td class="paramname">cond, </td>
1179 </tr>
1180 <tr>
1181 <td class="paramkey"></td>
1182 <td></td>
1183 <td class="paramtype">&#160;</td>
1184 <td class="paramname">msg&#160;</td>
1185 </tr>
1186 <tr>
1187 <td></td>
1188 <td>)</td>
1189 <td></td><td></td>
1190 </tr>
1191 </table>
1192</div><div class="memdoc">
1193<b>Value:</b><div class="fragment"><div class="line"><span class="keywordflow">do</span> \</div><div class="line"> { \</div><div class="line"> if(cond) \</div><div class="line"> { \</div><div class="line"> return <a class="code" href="namespacearm__compute.xhtml#af9b3e9f3ef6409e72c71aeacebf58f3b">arm_compute::create_error_msg</a>(<a class="code" href="namespacearm__compute.xhtml#a59e56af19e754a6aa26a612ebf91d05fa62be47fdd89da032cf78dfce82239579">arm_compute::ErrorCode::RUNTIME_ERROR</a>, __func__, __FILE__, __LINE__, msg); \</div><div class="line"> } \</div><div class="line"> } <span class="keywordflow">while</span>(<span class="keyword">false</span>)</div><div class="ttc" id="namespacearm__compute_xhtml_af9b3e9f3ef6409e72c71aeacebf58f3b"><div class="ttname"><a href="namespacearm__compute.xhtml#af9b3e9f3ef6409e72c71aeacebf58f3b">arm_compute::create_error_msg</a></div><div class="ttdeci">Status create_error_msg(ErrorCode error_code, const char *func, const char *file, int line, const char *msg)</div><div class="ttdoc">Creates an error and the error message.</div><div class="ttdef"><b>Definition:</b> <a href="_error_8cpp_source.xhtml#l00039">Error.cpp:39</a></div></div>
Jenkins514be652019-02-28 12:25:18 +0000[diff] [blame]1194<div class="ttc" id="namespacearm__compute_xhtml_a59e56af19e754a6aa26a612ebf91d05fa62be47fdd89da032cf78dfce82239579"><div class="ttname"><a href="namespacearm__compute.xhtml#a59e56af19e754a6aa26a612ebf91d05fa62be47fdd89da032cf78dfce82239579">arm_compute::ErrorCode::RUNTIME_ERROR</a></div><div class="ttdoc">Generic runtime error.</div></div>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]1195</div><!-- fragment -->
1196<p>If the condition is true, an error is returned. </p>
1197<dl class="params"><dt>Parameters</dt><dd>
1198 <table class="params">
1199 <tr><td class="paramdir">[in]</td><td class="paramname">cond</td><td>Condition to evaluate. </td></tr>
Jenkins0e205f72019-11-28 16:53:35 +0000[diff] [blame]1200 <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Error description message </td></tr>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]1201 </table>
1202 </dd>
1203</dl>
1204
Jenkins0e205f72019-11-28 16:53:35 +0000[diff] [blame]1205<p class="definition">Definition at line <a class="el" href="_error_8h_source.xhtml#l00244">244</a> of file <a class="el" href="_error_8h_source.xhtml">Error.h</a>.</p>
1206
1207</div>
1208</div>
1209<a id="ab7f9a52dc65a6a76f1576d99828fa1ea"></a>
1210<h2 class="memtitle"><span class="permalink"><a href="#ab7f9a52dc65a6a76f1576d99828fa1ea">&#9670;&nbsp;</a></span>ARM_COMPUTE_RETURN_ERROR_ON_MSG_VAR</h2>
1211
1212<div class="memitem">
1213<div class="memproto">
1214 <table class="memname">
1215 <tr>
1216 <td class="memname">#define ARM_COMPUTE_RETURN_ERROR_ON_MSG_VAR</td>
1217 <td>(</td>
1218 <td class="paramtype">&#160;</td>
1219 <td class="paramname">cond, </td>
1220 </tr>
1221 <tr>
1222 <td class="paramkey"></td>
1223 <td></td>
1224 <td class="paramtype">&#160;</td>
1225 <td class="paramname">msg, </td>
1226 </tr>
1227 <tr>
1228 <td class="paramkey"></td>
1229 <td></td>
1230 <td class="paramtype">&#160;</td>
1231 <td class="paramname"><em>...</em>&#160;</td>
1232 </tr>
1233 <tr>
1234 <td></td>
1235 <td>)</td>
1236 <td></td><td></td>
1237 </tr>
1238 </table>
1239</div><div class="memdoc">
1240<b>Value:</b><div class="fragment"><div class="line"><span class="keywordflow">do</span> \</div><div class="line"> { \</div><div class="line"> if(cond) \</div><div class="line"> { \</div><div class="line"> std::array&lt;char, 512&gt; out{ 0 }; \</div><div class="line"> int <a class="code" href="src_2core_2_c_l_2cl__kernels_2_helpers_8h.xhtml#a009469e4d9b8fce3b6d5e97d2077827d">offset</a> = <a class="code" href="namespacearm__compute_1_1support_1_1cpp11.xhtml#a9429515817425d10f4b662eaa069cc5c">snprintf</a>(out.data(), out.size(), <span class="stringliteral">&quot;in %s %s:%d: &quot;</span>, __func__, __FILE__, __LINE__); \</div><div class="line"> snprintf(out.data() + <a class="code" href="src_2core_2_c_l_2cl__kernels_2_helpers_8h.xhtml#a009469e4d9b8fce3b6d5e97d2077827d">offset</a>, out.size() - <a class="code" href="src_2core_2_c_l_2cl__kernels_2_helpers_8h.xhtml#a009469e4d9b8fce3b6d5e97d2077827d">offset</a>, msg, __VA_ARGS__); \</div><div class="line"> return <a class="code" href="namespacearm__compute.xhtml#a49cdbfceec3cb9949d00dbd1a17c5604">arm_compute::create_error</a>(<a class="code" href="namespacearm__compute.xhtml#a59e56af19e754a6aa26a612ebf91d05fa62be47fdd89da032cf78dfce82239579">arm_compute::ErrorCode::RUNTIME_ERROR</a>, std::string(out.data())); \</div><div class="line"> } \</div><div class="line"> } <span class="keywordflow">while</span>(<span class="keyword">false</span>)</div><div class="ttc" id="src_2core_2_c_l_2cl__kernels_2_helpers_8h_xhtml_a009469e4d9b8fce3b6d5e97d2077827d"><div class="ttname"><a href="src_2core_2_c_l_2cl__kernels_2_helpers_8h.xhtml#a009469e4d9b8fce3b6d5e97d2077827d">offset</a></div><div class="ttdeci">__global uchar * offset(const Image *img, int x, int y)</div><div class="ttdoc">Get the pointer position of a Image.</div><div class="ttdef"><b>Definition:</b> <a href="src_2core_2_c_l_2cl__kernels_2_helpers_8h_source.xhtml#l00510">helpers.h:510</a></div></div>
1241<div class="ttc" id="namespacearm__compute_xhtml_a59e56af19e754a6aa26a612ebf91d05fa62be47fdd89da032cf78dfce82239579"><div class="ttname"><a href="namespacearm__compute.xhtml#a59e56af19e754a6aa26a612ebf91d05fa62be47fdd89da032cf78dfce82239579">arm_compute::ErrorCode::RUNTIME_ERROR</a></div><div class="ttdoc">Generic runtime error.</div></div>
1242<div class="ttc" id="namespacearm__compute_xhtml_a49cdbfceec3cb9949d00dbd1a17c5604"><div class="ttname"><a href="namespacearm__compute.xhtml#a49cdbfceec3cb9949d00dbd1a17c5604">arm_compute::create_error</a></div><div class="ttdeci">Status create_error(ErrorCode error_code, std::string msg)</div><div class="ttdoc">Creates an error containing the error message.</div><div class="ttdef"><b>Definition:</b> <a href="_error_8cpp_source.xhtml#l00034">Error.cpp:34</a></div></div>
1243<div class="ttc" id="namespacearm__compute_1_1support_1_1cpp11_xhtml_a9429515817425d10f4b662eaa069cc5c"><div class="ttname"><a href="namespacearm__compute_1_1support_1_1cpp11.xhtml#a9429515817425d10f4b662eaa069cc5c">arm_compute::support::cpp11::snprintf</a></div><div class="ttdeci">int snprintf(char *s, std::size_t n, const char *fmt, Ts &amp;&amp;... args)</div><div class="ttdoc">Loads the data from the given location, converts them to character string equivalents and writes the ...</div><div class="ttdef"><b>Definition:</b> <a href="_toolchain_support_8h_source.xhtml#l00387">ToolchainSupport.h:387</a></div></div>
1244</div><!-- fragment -->
1245<p>If the condition is true, an error is returned. </p>
1246<p>Accepts a message format and a variable list of arguments matching the format description.</p>
1247<dl class="params"><dt>Parameters</dt><dd>
1248 <table class="params">
1249 <tr><td class="paramdir">[in]</td><td class="paramname">cond</td><td>Condition to evaluate. </td></tr>
1250 <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Error description message format. </td></tr>
1251 <tr><td class="paramdir">[in]</td><td class="paramname">...</td><td>List of arguments matching the format description. </td></tr>
1252 </table>
1253 </dd>
1254</dl>
1255
1256<p class="definition">Definition at line <a class="el" href="_error_8h_source.xhtml#l00227">227</a> of file <a class="el" href="_error_8h_source.xhtml">Error.h</a>.</p>
Jenkins52ba29e2018-08-29 15:32:11 +0000[diff] [blame]1257
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]1258</div>
1259</div>
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]1260<a id="a8a1e1c105f0bdaf37db408c7cfcb77a4"></a>
1261<h2 class="memtitle"><span class="permalink"><a href="#a8a1e1c105f0bdaf37db408c7cfcb77a4">&#9670;&nbsp;</a></span>ARM_COMPUTE_RETURN_ON_ERROR</h2>
1262
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]1263<div class="memitem">
1264<div class="memproto">
1265 <table class="memname">
1266 <tr>
1267 <td class="memname">#define ARM_COMPUTE_RETURN_ON_ERROR</td>
1268 <td>(</td>
1269 <td class="paramtype">&#160;</td>
1270 <td class="paramname">status</td><td>)</td>
1271 <td></td>
1272 </tr>
1273 </table>
1274</div><div class="memdoc">
1275<b>Value:</b><div class="fragment"><div class="line"><span class="keywordflow">do</span> \</div><div class="line"> { \</div><div class="line"> if(!<span class="keywordtype">bool</span>(status)) \</div><div class="line"> { \</div><div class="line"> return status; \</div><div class="line"> } \</div><div class="line"> } <span class="keywordflow">while</span>(<span class="keyword">false</span>)</div></div><!-- fragment -->
1276<p>Checks if a status contains an error and returns it. </p>
1277<dl class="params"><dt>Parameters</dt><dd>
1278 <table class="params">
1279 <tr><td class="paramdir">[in]</td><td class="paramname">status</td><td>Status value to check </td></tr>
1280 </table>
1281 </dd>
1282</dl>
1283
Jenkins0e205f72019-11-28 16:53:35 +0000[diff] [blame]1284<p class="definition">Definition at line <a class="el" href="_error_8h_source.xhtml#l00204">204</a> of file <a class="el" href="_error_8h_source.xhtml">Error.h</a>.</p>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]1285
Jenkins514be652019-02-28 12:25:18 +0000[diff] [blame]1286</div>
1287</div>
1288<a id="ad5518fdae84a33ce6fbed540c6e89479"></a>
1289<h2 class="memtitle"><span class="permalink"><a href="#ad5518fdae84a33ce6fbed540c6e89479">&#9670;&nbsp;</a></span>ARM_COMPUTE_THROW</h2>
1290
1291<div class="memitem">
1292<div class="memproto">
1293 <table class="memname">
1294 <tr>
1295 <td class="memname">#define ARM_COMPUTE_THROW</td>
1296 <td>(</td>
1297 <td class="paramtype">&#160;</td>
1298 <td class="paramname">ex</td><td>)</td>
1299 <td>&#160;&#160;&#160;throw(ex)</td>
1300 </tr>
1301 </table>
1302</div><div class="memdoc">
1303
Jenkins0e205f72019-11-28 16:53:35 +0000[diff] [blame]1304<p class="definition">Definition at line <a class="el" href="_error_8h_source.xhtml#l00480">480</a> of file <a class="el" href="_error_8h_source.xhtml">Error.h</a>.</p>
1305
1306</div>
1307</div>
1308<a id="adfd4354a6e0f46eddd353913a1470219"></a>
1309<h2 class="memtitle"><span class="permalink"><a href="#adfd4354a6e0f46eddd353913a1470219">&#9670;&nbsp;</a></span>ARM_COMPUTE_THROW_ERROR</h2>
1310
1311<div class="memitem">
1312<div class="memproto">
1313 <table class="memname">
1314 <tr>
1315 <td class="memname">#define ARM_COMPUTE_THROW_ERROR</td>
1316 <td>(</td>
1317 <td class="paramtype">&#160;</td>
1318 <td class="paramname">func, </td>
1319 </tr>
1320 <tr>
1321 <td class="paramkey"></td>
1322 <td></td>
1323 <td class="paramtype">&#160;</td>
1324 <td class="paramname">file, </td>
1325 </tr>
1326 <tr>
1327 <td class="paramkey"></td>
1328 <td></td>
1329 <td class="paramtype">&#160;</td>
1330 <td class="paramname">line, </td>
1331 </tr>
1332 <tr>
1333 <td class="paramkey"></td>
1334 <td></td>
1335 <td class="paramtype">&#160;</td>
1336 <td class="paramname">msg&#160;</td>
1337 </tr>
1338 <tr>
1339 <td></td>
1340 <td>)</td>
1341 <td></td><td></td>
1342 </tr>
1343 </table>
1344</div><div class="memdoc">
1345<b>Value:</b><div class="fragment"><div class="line"><span class="keywordflow">do</span> \</div><div class="line"> { <a class="code" href="namespacearm__compute.xhtml#a61e7f5901fd23f6009db8eac1a400be9">\</a></div><div class="line"><a class="code" href="namespacearm__compute.xhtml#a61e7f5901fd23f6009db8eac1a400be9"> arm_compute::throw_error</a>(<a class="code" href="namespacearm__compute.xhtml#af9b3e9f3ef6409e72c71aeacebf58f3b">arm_compute::create_error_msg</a>(<a class="code" href="namespacearm__compute.xhtml#a59e56af19e754a6aa26a612ebf91d05fa62be47fdd89da032cf78dfce82239579">arm_compute::ErrorCode::RUNTIME_ERROR</a>, func, file, line, msg)); \</div><div class="line"> } <span class="keywordflow">while</span>(<span class="keyword">false</span>)</div><div class="ttc" id="namespacearm__compute_xhtml_af9b3e9f3ef6409e72c71aeacebf58f3b"><div class="ttname"><a href="namespacearm__compute.xhtml#af9b3e9f3ef6409e72c71aeacebf58f3b">arm_compute::create_error_msg</a></div><div class="ttdeci">Status create_error_msg(ErrorCode error_code, const char *func, const char *file, int line, const char *msg)</div><div class="ttdoc">Creates an error and the error message.</div><div class="ttdef"><b>Definition:</b> <a href="_error_8cpp_source.xhtml#l00039">Error.cpp:39</a></div></div>
1346<div class="ttc" id="namespacearm__compute_xhtml_a61e7f5901fd23f6009db8eac1a400be9"><div class="ttname"><a href="namespacearm__compute.xhtml#a61e7f5901fd23f6009db8eac1a400be9">arm_compute::throw_error</a></div><div class="ttdeci">void throw_error(Status err)</div><div class="ttdoc">Throw an std::runtime_error.</div><div class="ttdef"><b>Definition:</b> <a href="_error_8cpp_source.xhtml#l00046">Error.cpp:46</a></div></div>
1347<div class="ttc" id="namespacearm__compute_xhtml_a59e56af19e754a6aa26a612ebf91d05fa62be47fdd89da032cf78dfce82239579"><div class="ttname"><a href="namespacearm__compute.xhtml#a59e56af19e754a6aa26a612ebf91d05fa62be47fdd89da032cf78dfce82239579">arm_compute::ErrorCode::RUNTIME_ERROR</a></div><div class="ttdoc">Generic runtime error.</div></div>
1348</div><!-- fragment -->
1349<p>Print the given message then throw an std::runtime_error. </p>
1350<dl class="params"><dt>Parameters</dt><dd>
1351 <table class="params">
1352 <tr><td class="paramdir">[in]</td><td class="paramname">func</td><td>Function in which the error occurred. </td></tr>
1353 <tr><td class="paramdir">[in]</td><td class="paramname">file</td><td>File in which the error occurred. </td></tr>
1354 <tr><td class="paramdir">[in]</td><td class="paramname">line</td><td>Line in which the error occurred. </td></tr>
1355 <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to display. </td></tr>
1356 </table>
1357 </dd>
1358</dl>
1359
1360<p class="definition">Definition at line <a class="el" href="_error_8h_source.xhtml#l00316">316</a> of file <a class="el" href="_error_8h_source.xhtml">Error.h</a>.</p>
1361
1362</div>
1363</div>
1364<a id="a86513cce33cfea9d3dd6eac3366b8253"></a>
1365<h2 class="memtitle"><span class="permalink"><a href="#a86513cce33cfea9d3dd6eac3366b8253">&#9670;&nbsp;</a></span>ARM_COMPUTE_THROW_ERROR_VAR</h2>
1366
1367<div class="memitem">
1368<div class="memproto">
1369 <table class="memname">
1370 <tr>
1371 <td class="memname">#define ARM_COMPUTE_THROW_ERROR_VAR</td>
1372 <td>(</td>
1373 <td class="paramtype">&#160;</td>
1374 <td class="paramname">func, </td>
1375 </tr>
1376 <tr>
1377 <td class="paramkey"></td>
1378 <td></td>
1379 <td class="paramtype">&#160;</td>
1380 <td class="paramname">file, </td>
1381 </tr>
1382 <tr>
1383 <td class="paramkey"></td>
1384 <td></td>
1385 <td class="paramtype">&#160;</td>
1386 <td class="paramname">line, </td>
1387 </tr>
1388 <tr>
1389 <td class="paramkey"></td>
1390 <td></td>
1391 <td class="paramtype">&#160;</td>
1392 <td class="paramname">msg, </td>
1393 </tr>
1394 <tr>
1395 <td class="paramkey"></td>
1396 <td></td>
1397 <td class="paramtype">&#160;</td>
1398 <td class="paramname"><em>...</em>&#160;</td>
1399 </tr>
1400 <tr>
1401 <td></td>
1402 <td>)</td>
1403 <td></td><td></td>
1404 </tr>
1405 </table>
1406</div><div class="memdoc">
1407<b>Value:</b><div class="fragment"><div class="line"><span class="keywordflow">do</span> \</div><div class="line"> { \</div><div class="line"> std::array&lt;char, 512&gt; out{ 0 }; \</div><div class="line"> int <a class="code" href="src_2core_2_c_l_2cl__kernels_2_helpers_8h.xhtml#a009469e4d9b8fce3b6d5e97d2077827d">offset</a> = <a class="code" href="namespacearm__compute_1_1support_1_1cpp11.xhtml#a9429515817425d10f4b662eaa069cc5c">snprintf</a>(out.data(), out.size(), <span class="stringliteral">&quot;in %s %s:%d: &quot;</span>, func, file, line); \</div><div class="line"> snprintf(out.data() + <a class="code" href="src_2core_2_c_l_2cl__kernels_2_helpers_8h.xhtml#a009469e4d9b8fce3b6d5e97d2077827d">offset</a>, out.size() - <a class="code" href="src_2core_2_c_l_2cl__kernels_2_helpers_8h.xhtml#a009469e4d9b8fce3b6d5e97d2077827d">offset</a>, msg, __VA_ARGS__); <a class="code" href="namespacearm__compute.xhtml#a61e7f5901fd23f6009db8eac1a400be9">\</a></div><div class="line"><a class="code" href="namespacearm__compute.xhtml#a61e7f5901fd23f6009db8eac1a400be9"> arm_compute::throw_error</a>(<a class="code" href="classarm__compute_1_1_status.xhtml">arm_compute::Status</a>(<a class="code" href="namespacearm__compute.xhtml#a59e56af19e754a6aa26a612ebf91d05fa62be47fdd89da032cf78dfce82239579">arm_compute::ErrorCode::RUNTIME_ERROR</a>, std::string(out.data()))); \</div><div class="line"> } <span class="keywordflow">while</span>(<span class="keyword">false</span>)</div><div class="ttc" id="src_2core_2_c_l_2cl__kernels_2_helpers_8h_xhtml_a009469e4d9b8fce3b6d5e97d2077827d"><div class="ttname"><a href="src_2core_2_c_l_2cl__kernels_2_helpers_8h.xhtml#a009469e4d9b8fce3b6d5e97d2077827d">offset</a></div><div class="ttdeci">__global uchar * offset(const Image *img, int x, int y)</div><div class="ttdoc">Get the pointer position of a Image.</div><div class="ttdef"><b>Definition:</b> <a href="src_2core_2_c_l_2cl__kernels_2_helpers_8h_source.xhtml#l00510">helpers.h:510</a></div></div>
1408<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#l00052">Error.h:52</a></div></div>
1409<div class="ttc" id="namespacearm__compute_xhtml_a61e7f5901fd23f6009db8eac1a400be9"><div class="ttname"><a href="namespacearm__compute.xhtml#a61e7f5901fd23f6009db8eac1a400be9">arm_compute::throw_error</a></div><div class="ttdeci">void throw_error(Status err)</div><div class="ttdoc">Throw an std::runtime_error.</div><div class="ttdef"><b>Definition:</b> <a href="_error_8cpp_source.xhtml#l00046">Error.cpp:46</a></div></div>
1410<div class="ttc" id="namespacearm__compute_xhtml_a59e56af19e754a6aa26a612ebf91d05fa62be47fdd89da032cf78dfce82239579"><div class="ttname"><a href="namespacearm__compute.xhtml#a59e56af19e754a6aa26a612ebf91d05fa62be47fdd89da032cf78dfce82239579">arm_compute::ErrorCode::RUNTIME_ERROR</a></div><div class="ttdoc">Generic runtime error.</div></div>
1411<div class="ttc" id="namespacearm__compute_1_1support_1_1cpp11_xhtml_a9429515817425d10f4b662eaa069cc5c"><div class="ttname"><a href="namespacearm__compute_1_1support_1_1cpp11.xhtml#a9429515817425d10f4b662eaa069cc5c">arm_compute::support::cpp11::snprintf</a></div><div class="ttdeci">int snprintf(char *s, std::size_t n, const char *fmt, Ts &amp;&amp;... args)</div><div class="ttdoc">Loads the data from the given location, converts them to character string equivalents and writes the ...</div><div class="ttdef"><b>Definition:</b> <a href="_toolchain_support_8h_source.xhtml#l00387">ToolchainSupport.h:387</a></div></div>
1412</div><!-- fragment -->
1413<p>Print the given message then throw an std::runtime_error. </p>
1414<p>Accepts a message format and a variable list of arguments matching the format description.</p>
1415<dl class="params"><dt>Parameters</dt><dd>
1416 <table class="params">
1417 <tr><td class="paramdir">[in]</td><td class="paramname">func</td><td>Function in which the error occurred. </td></tr>
1418 <tr><td class="paramdir">[in]</td><td class="paramname">file</td><td>File in which the error occurred. </td></tr>
1419 <tr><td class="paramdir">[in]</td><td class="paramname">line</td><td>Line in which the error occurred. </td></tr>
1420 <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Error description message format. </td></tr>
1421 <tr><td class="paramdir">[in]</td><td class="paramname">...</td><td>List of arguments matching the format description. </td></tr>
1422 </table>
1423 </dd>
1424</dl>
1425
1426<p class="definition">Definition at line <a class="el" href="_error_8h_source.xhtml#l00331">331</a> of file <a class="el" href="_error_8h_source.xhtml">Error.h</a>.</p>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]1427
1428</div>
1429</div>
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]1430<a id="a51e206ee52bcfb358919ee478d9fdc47"></a>
1431<h2 class="memtitle"><span class="permalink"><a href="#a51e206ee52bcfb358919ee478d9fdc47">&#9670;&nbsp;</a></span>ARM_COMPUTE_THROW_ON_ERROR</h2>
1432
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]1433<div class="memitem">
1434<div class="memproto">
1435 <table class="memname">
1436 <tr>
1437 <td class="memname">#define ARM_COMPUTE_THROW_ON_ERROR</td>
1438 <td>(</td>
1439 <td class="paramtype">&#160;</td>
1440 <td class="paramname">error</td><td>)</td>
1441 <td>&#160;&#160;&#160;error.throw_if_error();</td>
1442 </tr>
1443 </table>
1444</div><div class="memdoc">
1445
1446<p>Checks if an error value is valid if not throws an exception with the error. </p>
1447<dl class="params"><dt>Parameters</dt><dd>
1448 <table class="params">
1449 <tr><td class="paramdir">[in]</td><td class="paramname">error</td><td>Error value to check. </td></tr>
1450 </table>
1451 </dd>
1452</dl>
1453
Jenkins0e205f72019-11-28 16:53:35 +0000[diff] [blame]1454<p class="definition">Definition at line <a class="el" href="_error_8h_source.xhtml#l00217">217</a> of file <a class="el" href="_error_8h_source.xhtml">Error.h</a>.</p>
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]1455
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]1456</div>
1457</div>
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]1458<a id="a6dc630a6ae9cc063b3924bcea8dee9d6"></a>
1459<h2 class="memtitle"><span class="permalink"><a href="#a6dc630a6ae9cc063b3924bcea8dee9d6">&#9670;&nbsp;</a></span>ARM_COMPUTE_UNUSED</h2>
1460
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]1461<div class="memitem">
1462<div class="memproto">
1463 <table class="memname">
1464 <tr>
1465 <td class="memname">#define ARM_COMPUTE_UNUSED</td>
1466 <td>(</td>
1467 <td class="paramtype">&#160;</td>
1468 <td class="paramname"><em>...</em></td><td>)</td>
Jenkins52ba29e2018-08-29 15:32:11 +0000[diff] [blame]1469 <td>&#160;&#160;&#160;::<a class="el" href="namespacearm__compute.xhtml#a053a24bb37402fa4b4d8d5963976ba17">arm_compute::ignore_unused</a>(__VA_ARGS__)</td>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]1470 </tr>
1471 </table>
1472</div><div class="memdoc">
1473
1474<p>To avoid unused variables warnings. </p>
1475<p>This is useful if for example a variable is only used in debug builds and generates a warning in release builds.</p>
1476<dl class="params"><dt>Parameters</dt><dd>
1477 <table class="params">
1478 <tr><td class="paramdir">[in]</td><td class="paramname">...</td><td>Variables which are unused. </td></tr>
1479 </table>
1480 </dd>
1481</dl>
1482
Jenkins0e205f72019-11-28 16:53:35 +0000[diff] [blame]1483<p class="definition">Definition at line <a class="el" href="_error_8h_source.xhtml#l00152">152</a> of file <a class="el" href="_error_8h_source.xhtml">Error.h</a>.</p>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]1484
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]1485</div>
1486</div>
1487</div><!-- contents -->
1488</div><!-- doc-content -->
1489<!-- start footer part -->
1490<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
1491 <ul>
1492 <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>
Jenkins575c81f2020-03-05 16:07:35 +0000[diff] [blame^]1493 <li class="footer">Generated on Thu Mar 5 2020 16:07:06 for Compute Library by
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]1494 <a href="http://www.doxygen.org/index.html">
Jenkins514be652019-02-28 12:25:18 +0000[diff] [blame]1495 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.15 </li>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]1496 </ul>
1497</div>
1498</body>
1499</html>