Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ComputeLibrary / 514be65ad8d3340f53fd9591035352ed285811ba / . / documentation / _error_8h.xhtml
blob: 713f5afa59a69b919c8048b7ec82d217cf24867f [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">
43 &#160;<span id="projectnumber">19.02</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">
109<div class="textblock"><code>#include &lt;stdarg.h&gt;</code><br />
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>
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]123<tr class="memdesc:namespacearm__compute"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copyright (c) 2017-2018 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>
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]131<tr class="memitem:a046fbca6a9505ce038bc02830c739fed"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_error_8h.xhtml#a046fbca6a9505ce038bc02830c739fed">ARM_COMPUTE_CREATE_ERROR</a>(error_code, ...)&#160;&#160;&#160;::<a class="el" href="namespacearm__compute.xhtml#a439338e8e5a7c76a079aca52e16cff79">arm_compute::create_error</a>(error_code, __func__, __FILE__, __LINE__, __VA_ARGS__)</td></tr>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]132<tr class="memdesc:a046fbca6a9505ce038bc02830c739fed"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates an error with a given message. <a href="#a046fbca6a9505ce038bc02830c739fed">More...</a><br /></td></tr>
133<tr class="separator:a046fbca6a9505ce038bc02830c739fed"><td class="memSeparator" colspan="2">&#160;</td></tr>
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]134<tr class="memitem:ac00c754f27b1201dd72c74b73239ff47"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_error_8h.xhtml#ac00c754f27b1201dd72c74b73239ff47">ARM_COMPUTE_CREATE_ERROR_LOC</a>(error_code, func, file, line, ...)&#160;&#160;&#160;::<a class="el" href="namespacearm__compute.xhtml#a439338e8e5a7c76a079aca52e16cff79">arm_compute::create_error</a>(error_code, func, file, line, __VA_ARGS__)</td></tr>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]135<tr class="memdesc:ac00c754f27b1201dd72c74b73239ff47"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates an error on location with a given message. <a href="#ac00c754f27b1201dd72c74b73239ff47">More...</a><br /></td></tr>
136<tr class="separator:ac00c754f27b1201dd72c74b73239ff47"><td class="memSeparator" colspan="2">&#160;</td></tr>
137<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>
138<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>
139<tr class="separator:a9561091f3566e78ad3aa39259bc4126a"><td class="memSeparator" colspan="2">&#160;</td></tr>
140<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>
141<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>
142<tr class="separator:a8a1e1c105f0bdaf37db408c7cfcb77a4"><td class="memSeparator" colspan="2">&#160;</td></tr>
143<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>
144<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>
145<tr class="separator:a51e206ee52bcfb358919ee478d9fdc47"><td class="memSeparator" colspan="2">&#160;</td></tr>
146<tr class="memitem:a86084036bd3851575ef871ad5bf079a7"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_error_8h.xhtml#a86084036bd3851575ef871ad5bf079a7">ARM_COMPUTE_RETURN_ERROR_ON_MSG</a>(cond, ...)</td></tr>
147<tr class="memdesc:a86084036bd3851575ef871ad5bf079a7"><td class="mdescLeft">&#160;</td><td class="mdescRight">If the condition is true, an error is returned. <a href="#a86084036bd3851575ef871ad5bf079a7">More...</a><br /></td></tr>
148<tr class="separator:a86084036bd3851575ef871ad5bf079a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
149<tr class="memitem:ab4ebbfbeedd9d66614ddbfdb14199cbf"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_error_8h.xhtml#ab4ebbfbeedd9d66614ddbfdb14199cbf">ARM_COMPUTE_RETURN_ERROR_ON_LOC_MSG</a>(cond, func, file, line, ...)</td></tr>
150<tr class="memdesc:ab4ebbfbeedd9d66614ddbfdb14199cbf"><td class="mdescLeft">&#160;</td><td class="mdescRight">If the condition is true, an error is thrown. <a href="#ab4ebbfbeedd9d66614ddbfdb14199cbf">More...</a><br /></td></tr>
151<tr class="separator:ab4ebbfbeedd9d66614ddbfdb14199cbf"><td class="memSeparator" colspan="2">&#160;</td></tr>
152<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#a86084036bd3851575ef871ad5bf079a7">ARM_COMPUTE_RETURN_ERROR_ON_MSG</a>(cond, #cond)</td></tr>
153<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>
154<tr class="separator:a206d6e247e0957ac3dee45d27756fc25"><td class="memSeparator" colspan="2">&#160;</td></tr>
155<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#ab4ebbfbeedd9d66614ddbfdb14199cbf">ARM_COMPUTE_RETURN_ERROR_ON_LOC_MSG</a>(cond, func, file, line, #cond)</td></tr>
156<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>
157<tr class="separator:aab9171b209dda7cc9bb560486674c9f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]158<tr class="memitem:a05b19c75afe9c24200a62b9724734bbd"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_error_8h.xhtml#a05b19c75afe9c24200a62b9724734bbd">ARM_COMPUTE_ERROR</a>(...)&#160;&#160;&#160;::<a class="el" href="namespacearm__compute.xhtml#a0768178b90a30994784fd28c5a89323f">arm_compute::error</a>(__func__, __FILE__, __LINE__, __VA_ARGS__)</td></tr>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]159<tr class="memdesc:a05b19c75afe9c24200a62b9724734bbd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Print the given message then throw an std::runtime_error. <a href="#a05b19c75afe9c24200a62b9724734bbd">More...</a><br /></td></tr>
160<tr class="separator:a05b19c75afe9c24200a62b9724734bbd"><td class="memSeparator" colspan="2">&#160;</td></tr>
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]161<tr class="memitem:af93757c5021d1802b094dfbead459391"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_error_8h.xhtml#af93757c5021d1802b094dfbead459391">ARM_COMPUTE_ERROR_LOC</a>(func, file, line, ...)&#160;&#160;&#160;::<a class="el" href="namespacearm__compute.xhtml#a0768178b90a30994784fd28c5a89323f">arm_compute::error</a>(func, file, line, __VA_ARGS__)</td></tr>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]162<tr class="memdesc:af93757c5021d1802b094dfbead459391"><td class="mdescLeft">&#160;</td><td class="mdescRight">Print the given message then throw an std::runtime_error. <a href="#af93757c5021d1802b094dfbead459391">More...</a><br /></td></tr>
163<tr class="separator:af93757c5021d1802b094dfbead459391"><td class="memSeparator" colspan="2">&#160;</td></tr>
Jenkins52ba29e2018-08-29 15:32:11 +0000[diff] [blame]164<tr class="memitem:ad39a3601153da57978bb5124ace35d36"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_error_8h.xhtml#ad39a3601153da57978bb5124ace35d36">ARM_COMPUTE_EXIT_ON_MSG</a>(cond, ...)</td></tr>
165<tr class="memdesc:ad39a3601153da57978bb5124ace35d36"><td class="mdescLeft">&#160;</td><td class="mdescRight">If the condition is true, the given message is printed and program exits. <a href="#ad39a3601153da57978bb5124ace35d36">More...</a><br /></td></tr>
166<tr class="separator:ad39a3601153da57978bb5124ace35d36"><td class="memSeparator" colspan="2">&#160;</td></tr>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]167<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>
168<tr class="separator:a938dcd406ce611ef5345ad2531cdb948"><td class="memSeparator" colspan="2">&#160;</td></tr>
169<tr class="memitem:a5bbdcf574d3f5e412fa6a1117911e67b"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_error_8h.xhtml#a5bbdcf574d3f5e412fa6a1117911e67b">ARM_COMPUTE_ERROR_ON_MSG</a>(cond, ...)</td></tr>
170<tr class="separator:a5bbdcf574d3f5e412fa6a1117911e67b"><td class="memSeparator" colspan="2">&#160;</td></tr>
171<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>
172<tr class="separator:a1b62e396a1789909dadda61ea4cda96f"><td class="memSeparator" colspan="2">&#160;</td></tr>
173<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>
174<tr class="separator:a50048c593c53405cca5b0d69dfe25554"><td class="memSeparator" colspan="2">&#160;</td></tr>
175<tr class="memitem:a54a6080c9f4df1f908e57a9bbb46f5da"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_error_8h.xhtml#a54a6080c9f4df1f908e57a9bbb46f5da">ARM_COMPUTE_ERROR_ON</a>(cond)&#160;&#160;&#160;<a class="el" href="_error_8h.xhtml#a5bbdcf574d3f5e412fa6a1117911e67b">ARM_COMPUTE_ERROR_ON_MSG</a>(cond, #cond)</td></tr>
176<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>
177<tr class="separator:a54a6080c9f4df1f908e57a9bbb46f5da"><td class="memSeparator" colspan="2">&#160;</td></tr>
178<tr class="memitem:ac90c3bce005225cbaa4a43740917bb58"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_error_8h.xhtml#ac90c3bce005225cbaa4a43740917bb58">ARM_COMPUTE_ERROR_ON_LOC</a>(cond, func, file, line)&#160;&#160;&#160;<a class="el" href="_error_8h.xhtml#a1b62e396a1789909dadda61ea4cda96f">ARM_COMPUTE_ERROR_ON_LOC_MSG</a>(cond, func, file, line, #cond)</td></tr>
179<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>
180<tr class="separator:ac90c3bce005225cbaa4a43740917bb58"><td class="memSeparator" colspan="2">&#160;</td></tr>
Jenkins514be652019-02-28 12:25:18 +0000[diff] [blame^]181<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>
182<tr class="separator:ad5518fdae84a33ce6fbed540c6e89479"><td class="memSeparator" colspan="2">&#160;</td></tr>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]183</table><table class="memberdecls">
184<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
185Enumerations</h2></td></tr>
186<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]187<a class="el" href="namespacearm__compute.xhtml#a59e56af19e754a6aa26a612ebf91d05fa62be47fdd89da032cf78dfce82239579">RUNTIME_ERROR</a>,
188<a class="el" href="namespacearm__compute.xhtml#a59e56af19e754a6aa26a612ebf91d05fa0ffe8be9137815d1266845a195c053c7">UNSUPPORTED_EXTENSION_USE</a>
Jenkins514be652019-02-28 12:25:18 +0000[diff] [blame^]189 }</td></tr>
190<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]191<tr class="separator:a59e56af19e754a6aa26a612ebf91d05f"><td class="memSeparator" colspan="2">&#160;</td></tr>
192</table><table class="memberdecls">
193<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
194Functions</h2></td></tr>
195<tr class="memitem:a053a24bb37402fa4b4d8d5963976ba17"><td class="memTemplParams" colspan="2">template&lt;typename... T&gt; </td></tr>
196<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>
197<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>
198<tr class="separator:a053a24bb37402fa4b4d8d5963976ba17"><td class="memSeparator" colspan="2">&#160;</td></tr>
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]199<tr class="memitem:aee087c8a7edb0fb5b7e75b9037e34cf7"><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#aee087c8a7edb0fb5b7e75b9037e34cf7">create_error_va_list</a> (<a class="el" href="namespacearm__compute.xhtml#a59e56af19e754a6aa26a612ebf91d05f">ErrorCode</a> error_code, const char *function, const char *file, const int line, const char *msg, va_list args)</td></tr>
200<tr class="memdesc:aee087c8a7edb0fb5b7e75b9037e34cf7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates an error containing the error message from variable argument list. <a href="namespacearm__compute.xhtml#aee087c8a7edb0fb5b7e75b9037e34cf7">More...</a><br /></td></tr>
201<tr class="separator:aee087c8a7edb0fb5b7e75b9037e34cf7"><td class="memSeparator" colspan="2">&#160;</td></tr>
202<tr class="memitem:a439338e8e5a7c76a079aca52e16cff79"><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#a439338e8e5a7c76a079aca52e16cff79">create_error</a> (<a class="el" href="namespacearm__compute.xhtml#a59e56af19e754a6aa26a612ebf91d05f">ErrorCode</a> error_code, const char *function, const char *file, const int line, const char *msg,...)</td></tr>
203<tr class="memdesc:a439338e8e5a7c76a079aca52e16cff79"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates an error containing the error message. <a href="namespacearm__compute.xhtml#a439338e8e5a7c76a079aca52e16cff79">More...</a><br /></td></tr>
204<tr class="separator:a439338e8e5a7c76a079aca52e16cff79"><td class="memSeparator" colspan="2">&#160;</td></tr>
205<tr class="memitem:a0768178b90a30994784fd28c5a89323f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearm__compute.xhtml#a0768178b90a30994784fd28c5a89323f">error</a> (const char *function, const char *file, const int line, const char *msg,...)</td></tr>
206<tr class="memdesc:a0768178b90a30994784fd28c5a89323f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Print an error message then throw an std::runtime_error. <a href="namespacearm__compute.xhtml#a0768178b90a30994784fd28c5a89323f">More...</a><br /></td></tr>
207<tr class="separator:a0768178b90a30994784fd28c5a89323f"><td class="memSeparator" colspan="2">&#160;</td></tr>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]208</table>
209<h2 class="groupheader">Macro Definition Documentation</h2>
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]210<a id="a50048c593c53405cca5b0d69dfe25554"></a>
211<h2 class="memtitle"><span class="permalink"><a href="#a50048c593c53405cca5b0d69dfe25554">&#9670;&nbsp;</a></span>ARM_COMPUTE_CONST_ON_ERROR</h2>
212
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]213<div class="memitem">
214<div class="memproto">
215 <table class="memname">
216 <tr>
217 <td class="memname">#define ARM_COMPUTE_CONST_ON_ERROR</td>
218 <td>(</td>
219 <td class="paramtype">&#160;</td>
220 <td class="paramname">cond, </td>
221 </tr>
222 <tr>
223 <td class="paramkey"></td>
224 <td></td>
225 <td class="paramtype">&#160;</td>
226 <td class="paramname">val, </td>
227 </tr>
228 <tr>
229 <td class="paramkey"></td>
230 <td></td>
231 <td class="paramtype">&#160;</td>
232 <td class="paramname">msg&#160;</td>
233 </tr>
234 <tr>
235 <td></td>
236 <td>)</td>
237 <td></td><td>&#160;&#160;&#160;val</td>
238 </tr>
239 </table>
240</div><div class="memdoc">
241
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]242<p class="definition">Definition at line <a class="el" href="_error_8h_source.xhtml#l00330">330</a> of file <a class="el" href="_error_8h_source.xhtml">Error.h</a>.</p>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]243
244</div>
245</div>
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]246<a id="a046fbca6a9505ce038bc02830c739fed"></a>
247<h2 class="memtitle"><span class="permalink"><a href="#a046fbca6a9505ce038bc02830c739fed">&#9670;&nbsp;</a></span>ARM_COMPUTE_CREATE_ERROR</h2>
248
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]249<div class="memitem">
250<div class="memproto">
251 <table class="memname">
252 <tr>
253 <td class="memname">#define ARM_COMPUTE_CREATE_ERROR</td>
254 <td>(</td>
255 <td class="paramtype">&#160;</td>
256 <td class="paramname">error_code, </td>
257 </tr>
258 <tr>
259 <td class="paramkey"></td>
260 <td></td>
261 <td class="paramtype">&#160;</td>
262 <td class="paramname"><em>...</em>&#160;</td>
263 </tr>
264 <tr>
265 <td></td>
266 <td>)</td>
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]267 <td></td><td>&#160;&#160;&#160;::<a class="el" href="namespacearm__compute.xhtml#a439338e8e5a7c76a079aca52e16cff79">arm_compute::create_error</a>(error_code, __func__, __FILE__, __LINE__, __VA_ARGS__)</td>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]268 </tr>
269 </table>
270</div><div class="memdoc">
271
272<p>Creates an error with a given message. </p>
273<dl class="params"><dt>Parameters</dt><dd>
274 <table class="params">
275 <tr><td class="paramdir">[in]</td><td class="paramname">error_code</td><td>Error code. </td></tr>
276 <tr><td class="paramdir">[in]</td><td class="paramname">...</td><td>Message to encapsulate. </td></tr>
277 </table>
278 </dd>
279</dl>
280
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]281<p class="definition">Definition at line <a class="el" href="_error_8h_source.xhtml#l00167">167</a> of file <a class="el" href="_error_8h_source.xhtml">Error.h</a>.</p>
282
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]283</div>
284</div>
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]285<a id="ac00c754f27b1201dd72c74b73239ff47"></a>
286<h2 class="memtitle"><span class="permalink"><a href="#ac00c754f27b1201dd72c74b73239ff47">&#9670;&nbsp;</a></span>ARM_COMPUTE_CREATE_ERROR_LOC</h2>
287
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]288<div class="memitem">
289<div class="memproto">
290 <table class="memname">
291 <tr>
292 <td class="memname">#define ARM_COMPUTE_CREATE_ERROR_LOC</td>
293 <td>(</td>
294 <td class="paramtype">&#160;</td>
295 <td class="paramname">error_code, </td>
296 </tr>
297 <tr>
298 <td class="paramkey"></td>
299 <td></td>
300 <td class="paramtype">&#160;</td>
301 <td class="paramname">func, </td>
302 </tr>
303 <tr>
304 <td class="paramkey"></td>
305 <td></td>
306 <td class="paramtype">&#160;</td>
307 <td class="paramname">file, </td>
308 </tr>
309 <tr>
310 <td class="paramkey"></td>
311 <td></td>
312 <td class="paramtype">&#160;</td>
313 <td class="paramname">line, </td>
314 </tr>
315 <tr>
316 <td class="paramkey"></td>
317 <td></td>
318 <td class="paramtype">&#160;</td>
319 <td class="paramname"><em>...</em>&#160;</td>
320 </tr>
321 <tr>
322 <td></td>
323 <td>)</td>
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]324 <td></td><td>&#160;&#160;&#160;::<a class="el" href="namespacearm__compute.xhtml#a439338e8e5a7c76a079aca52e16cff79">arm_compute::create_error</a>(error_code, func, file, line, __VA_ARGS__)</td>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]325 </tr>
326 </table>
327</div><div class="memdoc">
328
329<p>Creates an error on location with a given message. </p>
330<dl class="params"><dt>Parameters</dt><dd>
331 <table class="params">
332 <tr><td class="paramdir">[in]</td><td class="paramname">error_code</td><td>Error code. </td></tr>
333 <tr><td class="paramdir">[in]</td><td class="paramname">func</td><td>Function in which the error occurred. </td></tr>
334 <tr><td class="paramdir">[in]</td><td class="paramname">file</td><td>File in which the error occurred. </td></tr>
335 <tr><td class="paramdir">[in]</td><td class="paramname">line</td><td>Line in which the error occurred. </td></tr>
336 <tr><td class="paramdir">[in]</td><td class="paramname">...</td><td>Message to display before aborting. </td></tr>
337 </table>
338 </dd>
339</dl>
340
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]341<p class="definition">Definition at line <a class="el" href="_error_8h_source.xhtml#l00177">177</a> of file <a class="el" href="_error_8h_source.xhtml">Error.h</a>.</p>
Jenkins52ba29e2018-08-29 15:32:11 +0000[diff] [blame]342
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]343</div>
344</div>
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]345<a id="a05b19c75afe9c24200a62b9724734bbd"></a>
346<h2 class="memtitle"><span class="permalink"><a href="#a05b19c75afe9c24200a62b9724734bbd">&#9670;&nbsp;</a></span>ARM_COMPUTE_ERROR</h2>
347
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]348<div class="memitem">
349<div class="memproto">
350 <table class="memname">
351 <tr>
352 <td class="memname">#define ARM_COMPUTE_ERROR</td>
353 <td>(</td>
354 <td class="paramtype">&#160;</td>
355 <td class="paramname"><em>...</em></td><td>)</td>
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]356 <td>&#160;&#160;&#160;::<a class="el" href="namespacearm__compute.xhtml#a0768178b90a30994784fd28c5a89323f">arm_compute::error</a>(__func__, __FILE__, __LINE__, __VA_ARGS__)</td>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]357 </tr>
358 </table>
359</div><div class="memdoc">
360
361<p>Print the given message then throw an std::runtime_error. </p>
362<dl class="params"><dt>Parameters</dt><dd>
363 <table class="params">
364 <tr><td class="paramdir">[in]</td><td class="paramname">...</td><td>Message to display before aborting. </td></tr>
365 </table>
366 </dd>
367</dl>
368
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]369<p class="definition">Definition at line <a class="el" href="_error_8h_source.xhtml#l00261">261</a> of file <a class="el" href="_error_8h_source.xhtml">Error.h</a>.</p>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]370
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]371</div>
372</div>
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]373<a id="af93757c5021d1802b094dfbead459391"></a>
374<h2 class="memtitle"><span class="permalink"><a href="#af93757c5021d1802b094dfbead459391">&#9670;&nbsp;</a></span>ARM_COMPUTE_ERROR_LOC</h2>
375
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]376<div class="memitem">
377<div class="memproto">
378 <table class="memname">
379 <tr>
380 <td class="memname">#define ARM_COMPUTE_ERROR_LOC</td>
381 <td>(</td>
382 <td class="paramtype">&#160;</td>
383 <td class="paramname">func, </td>
384 </tr>
385 <tr>
386 <td class="paramkey"></td>
387 <td></td>
388 <td class="paramtype">&#160;</td>
389 <td class="paramname">file, </td>
390 </tr>
391 <tr>
392 <td class="paramkey"></td>
393 <td></td>
394 <td class="paramtype">&#160;</td>
395 <td class="paramname">line, </td>
396 </tr>
397 <tr>
398 <td class="paramkey"></td>
399 <td></td>
400 <td class="paramtype">&#160;</td>
401 <td class="paramname"><em>...</em>&#160;</td>
402 </tr>
403 <tr>
404 <td></td>
405 <td>)</td>
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]406 <td></td><td>&#160;&#160;&#160;::<a class="el" href="namespacearm__compute.xhtml#a0768178b90a30994784fd28c5a89323f">arm_compute::error</a>(func, file, line, __VA_ARGS__)</td>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]407 </tr>
408 </table>
409</div><div class="memdoc">
410
411<p>Print the given message then throw an std::runtime_error. </p>
412<dl class="params"><dt>Parameters</dt><dd>
413 <table class="params">
414 <tr><td class="paramdir">[in]</td><td class="paramname">func</td><td>Function in which the error occurred. </td></tr>
415 <tr><td class="paramdir">[in]</td><td class="paramname">file</td><td>File in which the error occurred. </td></tr>
416 <tr><td class="paramdir">[in]</td><td class="paramname">line</td><td>Line in which the error occurred. </td></tr>
417 <tr><td class="paramdir">[in]</td><td class="paramname">...</td><td>Message to display before aborting. </td></tr>
418 </table>
419 </dd>
420</dl>
421
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]422<p class="definition">Definition at line <a class="el" href="_error_8h_source.xhtml#l00270">270</a> of file <a class="el" href="_error_8h_source.xhtml">Error.h</a>.</p>
423
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]424</div>
425</div>
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]426<a id="a54a6080c9f4df1f908e57a9bbb46f5da"></a>
427<h2 class="memtitle"><span class="permalink"><a href="#a54a6080c9f4df1f908e57a9bbb46f5da">&#9670;&nbsp;</a></span>ARM_COMPUTE_ERROR_ON</h2>
428
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]429<div class="memitem">
430<div class="memproto">
431 <table class="memname">
432 <tr>
433 <td class="memname">#define ARM_COMPUTE_ERROR_ON</td>
434 <td>(</td>
435 <td class="paramtype">&#160;</td>
436 <td class="paramname">cond</td><td>)</td>
437 <td>&#160;&#160;&#160;<a class="el" href="_error_8h.xhtml#a5bbdcf574d3f5e412fa6a1117911e67b">ARM_COMPUTE_ERROR_ON_MSG</a>(cond, #cond)</td>
438 </tr>
439 </table>
440</div><div class="memdoc">
441
442<p>If the condition is true then an error message is printed and an exception thrown. </p>
443<dl class="params"><dt>Parameters</dt><dd>
444 <table class="params">
445 <tr><td class="paramdir">[in]</td><td class="paramname">cond</td><td>Condition to evaluate. </td></tr>
446 </table>
447 </dd>
448</dl>
449
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]450<p class="definition">Definition at line <a class="el" href="_error_8h_source.xhtml#l00337">337</a> of file <a class="el" href="_error_8h_source.xhtml">Error.h</a>.</p>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]451
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]452</div>
453</div>
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]454<a id="ac90c3bce005225cbaa4a43740917bb58"></a>
455<h2 class="memtitle"><span class="permalink"><a href="#ac90c3bce005225cbaa4a43740917bb58">&#9670;&nbsp;</a></span>ARM_COMPUTE_ERROR_ON_LOC</h2>
456
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]457<div class="memitem">
458<div class="memproto">
459 <table class="memname">
460 <tr>
461 <td class="memname">#define ARM_COMPUTE_ERROR_ON_LOC</td>
462 <td>(</td>
463 <td class="paramtype">&#160;</td>
464 <td class="paramname">cond, </td>
465 </tr>
466 <tr>
467 <td class="paramkey"></td>
468 <td></td>
469 <td class="paramtype">&#160;</td>
470 <td class="paramname">func, </td>
471 </tr>
472 <tr>
473 <td class="paramkey"></td>
474 <td></td>
475 <td class="paramtype">&#160;</td>
476 <td class="paramname">file, </td>
477 </tr>
478 <tr>
479 <td class="paramkey"></td>
480 <td></td>
481 <td class="paramtype">&#160;</td>
482 <td class="paramname">line&#160;</td>
483 </tr>
484 <tr>
485 <td></td>
486 <td>)</td>
487 <td></td><td>&#160;&#160;&#160;<a class="el" href="_error_8h.xhtml#a1b62e396a1789909dadda61ea4cda96f">ARM_COMPUTE_ERROR_ON_LOC_MSG</a>(cond, func, file, line, #cond)</td>
488 </tr>
489 </table>
490</div><div class="memdoc">
491
492<p>If the condition is true then an error message is printed and an exception thrown. </p>
493<dl class="params"><dt>Parameters</dt><dd>
494 <table class="params">
495 <tr><td class="paramdir">[in]</td><td class="paramname">cond</td><td>Condition to evaluate. </td></tr>
496 <tr><td class="paramdir">[in]</td><td class="paramname">func</td><td>Function in which the error occurred. </td></tr>
497 <tr><td class="paramdir">[in]</td><td class="paramname">file</td><td>File in which the error occurred. </td></tr>
498 <tr><td class="paramdir">[in]</td><td class="paramname">line</td><td>Line in which the error occurred. </td></tr>
499 </table>
500 </dd>
501</dl>
502
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]503<p class="definition">Definition at line <a class="el" href="_error_8h_source.xhtml#l00347">347</a> of file <a class="el" href="_error_8h_source.xhtml">Error.h</a>.</p>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]504
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]505</div>
506</div>
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]507<a id="a1b62e396a1789909dadda61ea4cda96f"></a>
508<h2 class="memtitle"><span class="permalink"><a href="#a1b62e396a1789909dadda61ea4cda96f">&#9670;&nbsp;</a></span>ARM_COMPUTE_ERROR_ON_LOC_MSG</h2>
509
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]510<div class="memitem">
511<div class="memproto">
512 <table class="memname">
513 <tr>
514 <td class="memname">#define ARM_COMPUTE_ERROR_ON_LOC_MSG</td>
515 <td>(</td>
516 <td class="paramtype">&#160;</td>
517 <td class="paramname">cond, </td>
518 </tr>
519 <tr>
520 <td class="paramkey"></td>
521 <td></td>
522 <td class="paramtype">&#160;</td>
523 <td class="paramname">func, </td>
524 </tr>
525 <tr>
526 <td class="paramkey"></td>
527 <td></td>
528 <td class="paramtype">&#160;</td>
529 <td class="paramname">file, </td>
530 </tr>
531 <tr>
532 <td class="paramkey"></td>
533 <td></td>
534 <td class="paramtype">&#160;</td>
535 <td class="paramname">line, </td>
536 </tr>
537 <tr>
538 <td class="paramkey"></td>
539 <td></td>
540 <td class="paramtype">&#160;</td>
541 <td class="paramname"><em>...</em>&#160;</td>
542 </tr>
543 <tr>
544 <td></td>
545 <td>)</td>
546 <td></td><td></td>
547 </tr>
548 </table>
549</div><div class="memdoc">
550
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]551<p class="definition">Definition at line <a class="el" href="_error_8h_source.xhtml#l00329">329</a> of file <a class="el" href="_error_8h_source.xhtml">Error.h</a>.</p>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]552
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]553</div>
554</div>
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]555<a id="a5bbdcf574d3f5e412fa6a1117911e67b"></a>
556<h2 class="memtitle"><span class="permalink"><a href="#a5bbdcf574d3f5e412fa6a1117911e67b">&#9670;&nbsp;</a></span>ARM_COMPUTE_ERROR_ON_MSG</h2>
557
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]558<div class="memitem">
559<div class="memproto">
560 <table class="memname">
561 <tr>
562 <td class="memname">#define ARM_COMPUTE_ERROR_ON_MSG</td>
563 <td>(</td>
564 <td class="paramtype">&#160;</td>
565 <td class="paramname">cond, </td>
566 </tr>
567 <tr>
568 <td class="paramkey"></td>
569 <td></td>
570 <td class="paramtype">&#160;</td>
571 <td class="paramname"><em>...</em>&#160;</td>
572 </tr>
573 <tr>
574 <td></td>
575 <td>)</td>
576 <td></td><td></td>
577 </tr>
578 </table>
579</div><div class="memdoc">
580
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]581<p class="definition">Definition at line <a class="el" href="_error_8h_source.xhtml#l00328">328</a> of file <a class="el" href="_error_8h_source.xhtml">Error.h</a>.</p>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]582
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]583</div>
584</div>
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]585<a id="a938dcd406ce611ef5345ad2531cdb948"></a>
586<h2 class="memtitle"><span class="permalink"><a href="#a938dcd406ce611ef5345ad2531cdb948">&#9670;&nbsp;</a></span>ARM_COMPUTE_ERROR_THROW_ON</h2>
587
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]588<div class="memitem">
589<div class="memproto">
590 <table class="memname">
591 <tr>
592 <td class="memname">#define ARM_COMPUTE_ERROR_THROW_ON</td>
593 <td>(</td>
594 <td class="paramtype">&#160;</td>
595 <td class="paramname">status</td><td>)</td>
596 <td></td>
597 </tr>
598 </table>
599</div><div class="memdoc">
600
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]601<p class="definition">Definition at line <a class="el" href="_error_8h_source.xhtml#l00327">327</a> of file <a class="el" href="_error_8h_source.xhtml">Error.h</a>.</p>
602
Jenkins52ba29e2018-08-29 15:32:11 +0000[diff] [blame]603</div>
604</div>
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]605<a id="ad39a3601153da57978bb5124ace35d36"></a>
606<h2 class="memtitle"><span class="permalink"><a href="#ad39a3601153da57978bb5124ace35d36">&#9670;&nbsp;</a></span>ARM_COMPUTE_EXIT_ON_MSG</h2>
607
Jenkins52ba29e2018-08-29 15:32:11 +0000[diff] [blame]608<div class="memitem">
609<div class="memproto">
610 <table class="memname">
611 <tr>
612 <td class="memname">#define ARM_COMPUTE_EXIT_ON_MSG</td>
613 <td>(</td>
614 <td class="paramtype">&#160;</td>
615 <td class="paramname">cond, </td>
616 </tr>
617 <tr>
618 <td class="paramkey"></td>
619 <td></td>
620 <td class="paramtype">&#160;</td>
621 <td class="paramname"><em>...</em>&#160;</td>
622 </tr>
623 <tr>
624 <td></td>
625 <td>)</td>
626 <td></td><td></td>
627 </tr>
628 </table>
629</div><div class="memdoc">
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]630<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(__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]631<p>If the condition is true, the given message is printed and program exits. </p>
632<dl class="params"><dt>Parameters</dt><dd>
633 <table class="params">
634 <tr><td class="paramdir">[in]</td><td class="paramname">cond</td><td>Condition to evaluate. </td></tr>
635 <tr><td class="paramdir">[in]</td><td class="paramname">...</td><td>Message to print if cond is false. </td></tr>
636 </table>
637 </dd>
638</dl>
639
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]640<p class="definition">Definition at line <a class="el" href="_error_8h_source.xhtml#l00277">277</a> of file <a class="el" href="_error_8h_source.xhtml">Error.h</a>.</p>
Jenkins52ba29e2018-08-29 15:32:11 +0000[diff] [blame]641
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]642</div>
643</div>
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]644<a id="a9561091f3566e78ad3aa39259bc4126a"></a>
645<h2 class="memtitle"><span class="permalink"><a href="#a9561091f3566e78ad3aa39259bc4126a">&#9670;&nbsp;</a></span>ARM_COMPUTE_RETURN_ERROR_MSG</h2>
646
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]647<div class="memitem">
648<div class="memproto">
649 <table class="memname">
650 <tr>
651 <td class="memname">#define ARM_COMPUTE_RETURN_ERROR_MSG</td>
652 <td>(</td>
653 <td class="paramtype">&#160;</td>
654 <td class="paramname"><em>...</em></td><td>)</td>
655 <td></td>
656 </tr>
657 </table>
658</div><div class="memdoc">
Jenkins514be652019-02-28 12:25:18 +0000[diff] [blame^]659<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#a046fbca6a9505ce038bc02830c739fed">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="_error_8h_xhtml_a046fbca6a9505ce038bc02830c739fed"><div class="ttname"><a href="_error_8h.xhtml#a046fbca6a9505ce038bc02830c739fed">ARM_COMPUTE_CREATE_ERROR</a></div><div class="ttdeci">#define ARM_COMPUTE_CREATE_ERROR(error_code,...)</div><div class="ttdoc">Creates an error with a given message.</div><div class="ttdef"><b>Definition:</b> <a href="_error_8h_source.xhtml#l00167">Error.h:167</a></div></div>
660<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]661</div><!-- fragment -->
662<p>An error is returned with the given description. </p>
663<dl class="params"><dt>Parameters</dt><dd>
664 <table class="params">
665 <tr><td class="paramdir">[in]</td><td class="paramname">...</td><td>Error description message. </td></tr>
666 </table>
667 </dd>
668</dl>
669
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]670<p class="definition">Definition at line <a class="el" href="_error_8h_source.xhtml#l00183">183</a> of file <a class="el" href="_error_8h_source.xhtml">Error.h</a>.</p>
Jenkins52ba29e2018-08-29 15:32:11 +0000[diff] [blame]671
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]672</div>
673</div>
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]674<a id="a206d6e247e0957ac3dee45d27756fc25"></a>
675<h2 class="memtitle"><span class="permalink"><a href="#a206d6e247e0957ac3dee45d27756fc25">&#9670;&nbsp;</a></span>ARM_COMPUTE_RETURN_ERROR_ON</h2>
676
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]677<div class="memitem">
678<div class="memproto">
679 <table class="memname">
680 <tr>
681 <td class="memname">#define ARM_COMPUTE_RETURN_ERROR_ON</td>
682 <td>(</td>
683 <td class="paramtype">&#160;</td>
684 <td class="paramname">cond</td><td>)</td>
685 <td>&#160;&#160;&#160;<a class="el" href="_error_8h.xhtml#a86084036bd3851575ef871ad5bf079a7">ARM_COMPUTE_RETURN_ERROR_ON_MSG</a>(cond, #cond)</td>
686 </tr>
687 </table>
688</div><div class="memdoc">
689
690<p>If the condition is true, an error is returned. </p>
691<dl class="params"><dt>Parameters</dt><dd>
692 <table class="params">
693 <tr><td class="paramdir">[in]</td><td class="paramname">cond</td><td>Condition to evaluate </td></tr>
694 </table>
695 </dd>
696</dl>
697
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]698<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>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]699
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]700</div>
701</div>
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]702<a id="aab9171b209dda7cc9bb560486674c9f6"></a>
703<h2 class="memtitle"><span class="permalink"><a href="#aab9171b209dda7cc9bb560486674c9f6">&#9670;&nbsp;</a></span>ARM_COMPUTE_RETURN_ERROR_ON_LOC</h2>
704
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]705<div class="memitem">
706<div class="memproto">
707 <table class="memname">
708 <tr>
709 <td class="memname">#define ARM_COMPUTE_RETURN_ERROR_ON_LOC</td>
710 <td>(</td>
711 <td class="paramtype">&#160;</td>
712 <td class="paramname">cond, </td>
713 </tr>
714 <tr>
715 <td class="paramkey"></td>
716 <td></td>
717 <td class="paramtype">&#160;</td>
718 <td class="paramname">func, </td>
719 </tr>
720 <tr>
721 <td class="paramkey"></td>
722 <td></td>
723 <td class="paramtype">&#160;</td>
724 <td class="paramname">file, </td>
725 </tr>
726 <tr>
727 <td class="paramkey"></td>
728 <td></td>
729 <td class="paramtype">&#160;</td>
730 <td class="paramname">line&#160;</td>
731 </tr>
732 <tr>
733 <td></td>
734 <td>)</td>
735 <td></td><td>&#160;&#160;&#160;<a class="el" href="_error_8h.xhtml#ab4ebbfbeedd9d66614ddbfdb14199cbf">ARM_COMPUTE_RETURN_ERROR_ON_LOC_MSG</a>(cond, func, file, line, #cond)</td>
736 </tr>
737 </table>
738</div><div class="memdoc">
739
740<p>If the condition is true, an error is returned. </p>
741<dl class="params"><dt>Parameters</dt><dd>
742 <table class="params">
743 <tr><td class="paramdir">[in]</td><td class="paramname">cond</td><td>Condition to evaluate. </td></tr>
744 <tr><td class="paramdir">[in]</td><td class="paramname">func</td><td>Function in which the error occurred. </td></tr>
745 <tr><td class="paramdir">[in]</td><td class="paramname">file</td><td>File in which the error occurred. </td></tr>
746 <tr><td class="paramdir">[in]</td><td class="paramname">line</td><td>Line in which the error occurred. </td></tr>
747 </table>
748 </dd>
749</dl>
750
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]751<p class="definition">Definition at line <a class="el" href="_error_8h_source.xhtml#l00254">254</a> of file <a class="el" href="_error_8h_source.xhtml">Error.h</a>.</p>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]752
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]753</div>
754</div>
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]755<a id="ab4ebbfbeedd9d66614ddbfdb14199cbf"></a>
756<h2 class="memtitle"><span class="permalink"><a href="#ab4ebbfbeedd9d66614ddbfdb14199cbf">&#9670;&nbsp;</a></span>ARM_COMPUTE_RETURN_ERROR_ON_LOC_MSG</h2>
757
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]758<div class="memitem">
759<div class="memproto">
760 <table class="memname">
761 <tr>
762 <td class="memname">#define ARM_COMPUTE_RETURN_ERROR_ON_LOC_MSG</td>
763 <td>(</td>
764 <td class="paramtype">&#160;</td>
765 <td class="paramname">cond, </td>
766 </tr>
767 <tr>
768 <td class="paramkey"></td>
769 <td></td>
770 <td class="paramtype">&#160;</td>
771 <td class="paramname">func, </td>
772 </tr>
773 <tr>
774 <td class="paramkey"></td>
775 <td></td>
776 <td class="paramtype">&#160;</td>
777 <td class="paramname">file, </td>
778 </tr>
779 <tr>
780 <td class="paramkey"></td>
781 <td></td>
782 <td class="paramtype">&#160;</td>
783 <td class="paramname">line, </td>
784 </tr>
785 <tr>
786 <td class="paramkey"></td>
787 <td></td>
788 <td class="paramtype">&#160;</td>
789 <td class="paramname"><em>...</em>&#160;</td>
790 </tr>
791 <tr>
792 <td></td>
793 <td>)</td>
794 <td></td><td></td>
795 </tr>
796 </table>
797</div><div class="memdoc">
Jenkins514be652019-02-28 12:25:18 +0000[diff] [blame^]798<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="_error_8h.xhtml#ac00c754f27b1201dd72c74b73239ff47">ARM_COMPUTE_CREATE_ERROR_LOC</a>(<a class="code" href="namespacearm__compute.xhtml#a59e56af19e754a6aa26a612ebf91d05fa62be47fdd89da032cf78dfce82239579">arm_compute::ErrorCode::RUNTIME_ERROR</a>, func, file, line, __VA_ARGS__); \</div><div class="line"> } \</div><div class="line"> } <span class="keywordflow">while</span>(<span class="keyword">false</span>)</div><div class="ttc" id="_error_8h_xhtml_ac00c754f27b1201dd72c74b73239ff47"><div class="ttname"><a href="_error_8h.xhtml#ac00c754f27b1201dd72c74b73239ff47">ARM_COMPUTE_CREATE_ERROR_LOC</a></div><div class="ttdeci">#define ARM_COMPUTE_CREATE_ERROR_LOC(error_code, func, file, line,...)</div><div class="ttdoc">Creates an error on location with a given message.</div><div class="ttdef"><b>Definition:</b> <a href="_error_8h_source.xhtml#l00177">Error.h:177</a></div></div>
799<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]800</div><!-- fragment -->
801<p>If the condition is true, an error is thrown. </p>
802<dl class="params"><dt>Parameters</dt><dd>
803 <table class="params">
804 <tr><td class="paramdir">[in]</td><td class="paramname">cond</td><td>Condition to evaluate. </td></tr>
805 <tr><td class="paramdir">[in]</td><td class="paramname">func</td><td>Function in which the error occurred. </td></tr>
806 <tr><td class="paramdir">[in]</td><td class="paramname">file</td><td>File in which the error occurred. </td></tr>
807 <tr><td class="paramdir">[in]</td><td class="paramname">line</td><td>Line in which the error occurred. </td></tr>
808 <tr><td class="paramdir">[in]</td><td class="paramname">...</td><td>Error description message. </td></tr>
809 </table>
810 </dd>
811</dl>
812
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]813<p class="definition">Definition at line <a class="el" href="_error_8h_source.xhtml#l00231">231</a> of file <a class="el" href="_error_8h_source.xhtml">Error.h</a>.</p>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]814
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]815</div>
816</div>
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]817<a id="a86084036bd3851575ef871ad5bf079a7"></a>
818<h2 class="memtitle"><span class="permalink"><a href="#a86084036bd3851575ef871ad5bf079a7">&#9670;&nbsp;</a></span>ARM_COMPUTE_RETURN_ERROR_ON_MSG</h2>
819
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]820<div class="memitem">
821<div class="memproto">
822 <table class="memname">
823 <tr>
824 <td class="memname">#define ARM_COMPUTE_RETURN_ERROR_ON_MSG</td>
825 <td>(</td>
826 <td class="paramtype">&#160;</td>
827 <td class="paramname">cond, </td>
828 </tr>
829 <tr>
830 <td class="paramkey"></td>
831 <td></td>
832 <td class="paramtype">&#160;</td>
833 <td class="paramname"><em>...</em>&#160;</td>
834 </tr>
835 <tr>
836 <td></td>
837 <td>)</td>
838 <td></td><td></td>
839 </tr>
840 </table>
841</div><div class="memdoc">
Jenkins514be652019-02-28 12:25:18 +0000[diff] [blame^]842<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="_error_8h.xhtml#a046fbca6a9505ce038bc02830c739fed">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"> } \</div><div class="line"> } <span class="keywordflow">while</span>(<span class="keyword">false</span>)</div><div class="ttc" id="_error_8h_xhtml_a046fbca6a9505ce038bc02830c739fed"><div class="ttname"><a href="_error_8h.xhtml#a046fbca6a9505ce038bc02830c739fed">ARM_COMPUTE_CREATE_ERROR</a></div><div class="ttdeci">#define ARM_COMPUTE_CREATE_ERROR(error_code,...)</div><div class="ttdoc">Creates an error with a given message.</div><div class="ttdef"><b>Definition:</b> <a href="_error_8h_source.xhtml#l00167">Error.h:167</a></div></div>
843<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]844</div><!-- fragment -->
845<p>If the condition is true, an error is returned. </p>
846<dl class="params"><dt>Parameters</dt><dd>
847 <table class="params">
848 <tr><td class="paramdir">[in]</td><td class="paramname">cond</td><td>Condition to evaluate. </td></tr>
849 <tr><td class="paramdir">[in]</td><td class="paramname">...</td><td>Error description message </td></tr>
850 </table>
851 </dd>
852</dl>
853
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]854<p class="definition">Definition at line <a class="el" href="_error_8h_source.xhtml#l00214">214</a> of file <a class="el" href="_error_8h_source.xhtml">Error.h</a>.</p>
Jenkins52ba29e2018-08-29 15:32:11 +0000[diff] [blame]855
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]856</div>
857</div>
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]858<a id="a8a1e1c105f0bdaf37db408c7cfcb77a4"></a>
859<h2 class="memtitle"><span class="permalink"><a href="#a8a1e1c105f0bdaf37db408c7cfcb77a4">&#9670;&nbsp;</a></span>ARM_COMPUTE_RETURN_ON_ERROR</h2>
860
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]861<div class="memitem">
862<div class="memproto">
863 <table class="memname">
864 <tr>
865 <td class="memname">#define ARM_COMPUTE_RETURN_ON_ERROR</td>
866 <td>(</td>
867 <td class="paramtype">&#160;</td>
868 <td class="paramname">status</td><td>)</td>
869 <td></td>
870 </tr>
871 </table>
872</div><div class="memdoc">
873<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 -->
874<p>Checks if a status contains an error and returns it. </p>
875<dl class="params"><dt>Parameters</dt><dd>
876 <table class="params">
877 <tr><td class="paramdir">[in]</td><td class="paramname">status</td><td>Status value to check </td></tr>
878 </table>
879 </dd>
880</dl>
881
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]882<p class="definition">Definition at line <a class="el" href="_error_8h_source.xhtml#l00193">193</a> of file <a class="el" href="_error_8h_source.xhtml">Error.h</a>.</p>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]883
Jenkins514be652019-02-28 12:25:18 +0000[diff] [blame^]884</div>
885</div>
886<a id="ad5518fdae84a33ce6fbed540c6e89479"></a>
887<h2 class="memtitle"><span class="permalink"><a href="#ad5518fdae84a33ce6fbed540c6e89479">&#9670;&nbsp;</a></span>ARM_COMPUTE_THROW</h2>
888
889<div class="memitem">
890<div class="memproto">
891 <table class="memname">
892 <tr>
893 <td class="memname">#define ARM_COMPUTE_THROW</td>
894 <td>(</td>
895 <td class="paramtype">&#160;</td>
896 <td class="paramname">ex</td><td>)</td>
897 <td>&#160;&#160;&#160;throw(ex)</td>
898 </tr>
899 </table>
900</div><div class="memdoc">
901
902<p class="definition">Definition at line <a class="el" href="_error_8h_source.xhtml#l00351">351</a> of file <a class="el" href="_error_8h_source.xhtml">Error.h</a>.</p>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]903
904</div>
905</div>
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]906<a id="a51e206ee52bcfb358919ee478d9fdc47"></a>
907<h2 class="memtitle"><span class="permalink"><a href="#a51e206ee52bcfb358919ee478d9fdc47">&#9670;&nbsp;</a></span>ARM_COMPUTE_THROW_ON_ERROR</h2>
908
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]909<div class="memitem">
910<div class="memproto">
911 <table class="memname">
912 <tr>
913 <td class="memname">#define ARM_COMPUTE_THROW_ON_ERROR</td>
914 <td>(</td>
915 <td class="paramtype">&#160;</td>
916 <td class="paramname">error</td><td>)</td>
917 <td>&#160;&#160;&#160;error.throw_if_error();</td>
918 </tr>
919 </table>
920</div><div class="memdoc">
921
922<p>Checks if an error value is valid if not throws an exception with the error. </p>
923<dl class="params"><dt>Parameters</dt><dd>
924 <table class="params">
925 <tr><td class="paramdir">[in]</td><td class="paramname">error</td><td>Error value to check. </td></tr>
926 </table>
927 </dd>
928</dl>
929
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]930<p class="definition">Definition at line <a class="el" href="_error_8h_source.xhtml#l00206">206</a> of file <a class="el" href="_error_8h_source.xhtml">Error.h</a>.</p>
931
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]932</div>
933</div>
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]934<a id="a6dc630a6ae9cc063b3924bcea8dee9d6"></a>
935<h2 class="memtitle"><span class="permalink"><a href="#a6dc630a6ae9cc063b3924bcea8dee9d6">&#9670;&nbsp;</a></span>ARM_COMPUTE_UNUSED</h2>
936
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]937<div class="memitem">
938<div class="memproto">
939 <table class="memname">
940 <tr>
941 <td class="memname">#define ARM_COMPUTE_UNUSED</td>
942 <td>(</td>
943 <td class="paramtype">&#160;</td>
944 <td class="paramname"><em>...</em></td><td>)</td>
Jenkins52ba29e2018-08-29 15:32:11 +0000[diff] [blame]945 <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]946 </tr>
947 </table>
948</div><div class="memdoc">
949
950<p>To avoid unused variables warnings. </p>
951<p>This is useful if for example a variable is only used in debug builds and generates a warning in release builds.</p>
952<dl class="params"><dt>Parameters</dt><dd>
953 <table class="params">
954 <tr><td class="paramdir">[in]</td><td class="paramname">...</td><td>Variables which are unused. </td></tr>
955 </table>
956 </dd>
957</dl>
958
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]959<p class="definition">Definition at line <a class="el" href="_error_8h_source.xhtml#l00160">160</a> of file <a class="el" href="_error_8h_source.xhtml">Error.h</a>.</p>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]960
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]961</div>
962</div>
963</div><!-- contents -->
964</div><!-- doc-content -->
965<!-- start footer part -->
966<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
967 <ul>
968 <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>
Jenkins514be652019-02-28 12:25:18 +0000[diff] [blame^]969 <li class="footer">Generated on Thu Feb 28 2019 12:24:55 for Compute Library by
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]970 <a href="http://www.doxygen.org/index.html">
Jenkins514be652019-02-28 12:25:18 +0000[diff] [blame^]971 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.15 </li>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]972 </ul>
973</div>
974</body>
975</html>