blob: 5ca14a381b5b6f306a1259f03462546adafb9e2c [file] [log] [blame]
<!-- HTML header for doxygen 1.8.15-->
<!-- Remember to use version doxygen 1.8.15 +-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.15"/>
<meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines -->
<title>Compute Library: arm_compute/core/Error.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script><script type="text/javascript" async="async" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="stylesheet.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<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"/>
<td style="padding-left: 0.5em;">
<div id="projectname">
&#160;<span id="projectnumber">19.08</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('_error_8h.xhtml','');});
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#namespaces">Namespaces</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Error.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;stdarg.h&gt;</code><br />
<code>#include &lt;string&gt;</code><br />
</div>
<p><a href="_error_8h_source.xhtml">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<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>
<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>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
Namespaces</h2></td></tr>
<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>
<tr class="memdesc:namespacearm__compute"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copyright (c) 2017-2018 ARM Limited. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<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>
<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>
<tr class="separator:a6dc630a6ae9cc063b3924bcea8dee9d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<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>
<tr class="separator:a046fbca6a9505ce038bc02830c739fed"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<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>
<tr class="separator:ac00c754f27b1201dd72c74b73239ff47"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<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>
<tr class="separator:a9561091f3566e78ad3aa39259bc4126a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<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>
<tr class="separator:a8a1e1c105f0bdaf37db408c7cfcb77a4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<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>
<tr class="separator:a51e206ee52bcfb358919ee478d9fdc47"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<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>
<tr class="separator:a86084036bd3851575ef871ad5bf079a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<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>
<tr class="separator:ab4ebbfbeedd9d66614ddbfdb14199cbf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<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>
<tr class="separator:a206d6e247e0957ac3dee45d27756fc25"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<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>
<tr class="separator:aab9171b209dda7cc9bb560486674c9f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<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>
<tr class="separator:a05b19c75afe9c24200a62b9724734bbd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<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>
<tr class="separator:af93757c5021d1802b094dfbead459391"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<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>
<tr class="separator:ad39a3601153da57978bb5124ace35d36"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:a938dcd406ce611ef5345ad2531cdb948"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:a5bbdcf574d3f5e412fa6a1117911e67b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:a1b62e396a1789909dadda61ea4cda96f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:a50048c593c53405cca5b0d69dfe25554"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<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>
<tr class="separator:a54a6080c9f4df1f908e57a9bbb46f5da"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<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>
<tr class="separator:ac90c3bce005225cbaa4a43740917bb58"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:ad5518fdae84a33ce6fbed540c6e89479"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<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>,
<a class="el" href="namespacearm__compute.xhtml#a59e56af19e754a6aa26a612ebf91d05fa62be47fdd89da032cf78dfce82239579">RUNTIME_ERROR</a>,
<a class="el" href="namespacearm__compute.xhtml#a59e56af19e754a6aa26a612ebf91d05fa0ffe8be9137815d1266845a195c053c7">UNSUPPORTED_EXTENSION_USE</a>
}</td></tr>
<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>
<tr class="separator:a59e56af19e754a6aa26a612ebf91d05f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a053a24bb37402fa4b4d8d5963976ba17"><td class="memTemplParams" colspan="2">template&lt;typename... T&gt; </td></tr>
<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>
<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>
<tr class="separator:a053a24bb37402fa4b4d8d5963976ba17"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<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>
<tr class="separator:aee087c8a7edb0fb5b7e75b9037e34cf7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<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>
<tr class="separator:a439338e8e5a7c76a079aca52e16cff79"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<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>
<tr class="separator:a0768178b90a30994784fd28c5a89323f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a50048c593c53405cca5b0d69dfe25554"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a50048c593c53405cca5b0d69dfe25554">&#9670;&nbsp;</a></span>ARM_COMPUTE_CONST_ON_ERROR</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_COMPUTE_CONST_ON_ERROR</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">cond, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">val, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">msg&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>&#160;&#160;&#160;val</td>
</tr>
</table>
</div><div class="memdoc">
<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>
</div>
</div>
<a id="a046fbca6a9505ce038bc02830c739fed"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a046fbca6a9505ce038bc02830c739fed">&#9670;&nbsp;</a></span>ARM_COMPUTE_CREATE_ERROR</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_COMPUTE_CREATE_ERROR</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">error_code, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>...</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<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>
</tr>
</table>
</div><div class="memdoc">
<p>Creates an error with a given message. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">error_code</td><td>Error code. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">...</td><td>Message to encapsulate. </td></tr>
</table>
</dd>
</dl>
<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>
</div>
</div>
<a id="ac00c754f27b1201dd72c74b73239ff47"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac00c754f27b1201dd72c74b73239ff47">&#9670;&nbsp;</a></span>ARM_COMPUTE_CREATE_ERROR_LOC</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_COMPUTE_CREATE_ERROR_LOC</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">error_code, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">func, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">file, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">line, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>...</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<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>
</tr>
</table>
</div><div class="memdoc">
<p>Creates an error on location with a given message. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">error_code</td><td>Error code. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">func</td><td>Function in which the error occurred. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">file</td><td>File in which the error occurred. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">line</td><td>Line in which the error occurred. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">...</td><td>Message to display before aborting. </td></tr>
</table>
</dd>
</dl>
<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>
</div>
</div>
<a id="a05b19c75afe9c24200a62b9724734bbd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a05b19c75afe9c24200a62b9724734bbd">&#9670;&nbsp;</a></span>ARM_COMPUTE_ERROR</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_COMPUTE_ERROR</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>...</em></td><td>)</td>
<td>&#160;&#160;&#160;::<a class="el" href="namespacearm__compute.xhtml#a0768178b90a30994784fd28c5a89323f">arm_compute::error</a>(__func__, __FILE__, __LINE__, __VA_ARGS__)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Print the given message then throw an std::runtime_error. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">...</td><td>Message to display before aborting. </td></tr>
</table>
</dd>
</dl>
<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>
</div>
</div>
<a id="af93757c5021d1802b094dfbead459391"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af93757c5021d1802b094dfbead459391">&#9670;&nbsp;</a></span>ARM_COMPUTE_ERROR_LOC</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_COMPUTE_ERROR_LOC</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">func, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">file, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">line, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>...</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>&#160;&#160;&#160;::<a class="el" href="namespacearm__compute.xhtml#a0768178b90a30994784fd28c5a89323f">arm_compute::error</a>(func, file, line, __VA_ARGS__)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Print the given message then throw an std::runtime_error. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">func</td><td>Function in which the error occurred. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">file</td><td>File in which the error occurred. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">line</td><td>Line in which the error occurred. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">...</td><td>Message to display before aborting. </td></tr>
</table>
</dd>
</dl>
<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>
</div>
</div>
<a id="a54a6080c9f4df1f908e57a9bbb46f5da"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a54a6080c9f4df1f908e57a9bbb46f5da">&#9670;&nbsp;</a></span>ARM_COMPUTE_ERROR_ON</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_COMPUTE_ERROR_ON</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">cond</td><td>)</td>
<td>&#160;&#160;&#160;<a class="el" href="_error_8h.xhtml#a5bbdcf574d3f5e412fa6a1117911e67b">ARM_COMPUTE_ERROR_ON_MSG</a>(cond, #cond)</td>
</tr>
</table>
</div><div class="memdoc">
<p>If the condition is true then an error message is printed and an exception thrown. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">cond</td><td>Condition to evaluate. </td></tr>
</table>
</dd>
</dl>
<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>
</div>
</div>
<a id="ac90c3bce005225cbaa4a43740917bb58"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac90c3bce005225cbaa4a43740917bb58">&#9670;&nbsp;</a></span>ARM_COMPUTE_ERROR_ON_LOC</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_COMPUTE_ERROR_ON_LOC</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">cond, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">func, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">file, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">line&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<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>
</tr>
</table>
</div><div class="memdoc">
<p>If the condition is true then an error message is printed and an exception thrown. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">cond</td><td>Condition to evaluate. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">func</td><td>Function in which the error occurred. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">file</td><td>File in which the error occurred. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">line</td><td>Line in which the error occurred. </td></tr>
</table>
</dd>
</dl>
<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>
</div>
</div>
<a id="a1b62e396a1789909dadda61ea4cda96f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1b62e396a1789909dadda61ea4cda96f">&#9670;&nbsp;</a></span>ARM_COMPUTE_ERROR_ON_LOC_MSG</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_COMPUTE_ERROR_ON_LOC_MSG</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">cond, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">func, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">file, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">line, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>...</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<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>
</div>
</div>
<a id="a5bbdcf574d3f5e412fa6a1117911e67b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5bbdcf574d3f5e412fa6a1117911e67b">&#9670;&nbsp;</a></span>ARM_COMPUTE_ERROR_ON_MSG</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_COMPUTE_ERROR_ON_MSG</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">cond, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>...</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<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>
</div>
</div>
<a id="a938dcd406ce611ef5345ad2531cdb948"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a938dcd406ce611ef5345ad2531cdb948">&#9670;&nbsp;</a></span>ARM_COMPUTE_ERROR_THROW_ON</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_COMPUTE_ERROR_THROW_ON</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">status</td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<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>
</div>
</div>
<a id="ad39a3601153da57978bb5124ace35d36"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad39a3601153da57978bb5124ace35d36">&#9670;&nbsp;</a></span>ARM_COMPUTE_EXIT_ON_MSG</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_COMPUTE_EXIT_ON_MSG</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">cond, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>...</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<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 -->
<p>If the condition is true, the given message is printed and program exits. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">cond</td><td>Condition to evaluate. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">...</td><td>Message to print if cond is false. </td></tr>
</table>
</dd>
</dl>
<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>
</div>
</div>
<a id="a9561091f3566e78ad3aa39259bc4126a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9561091f3566e78ad3aa39259bc4126a">&#9670;&nbsp;</a></span>ARM_COMPUTE_RETURN_ERROR_MSG</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_COMPUTE_RETURN_ERROR_MSG</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>...</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<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>
<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>
</div><!-- fragment -->
<p>An error is returned with the given description. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">...</td><td>Error description message. </td></tr>
</table>
</dd>
</dl>
<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>
</div>
</div>
<a id="a206d6e247e0957ac3dee45d27756fc25"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a206d6e247e0957ac3dee45d27756fc25">&#9670;&nbsp;</a></span>ARM_COMPUTE_RETURN_ERROR_ON</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_COMPUTE_RETURN_ERROR_ON</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">cond</td><td>)</td>
<td>&#160;&#160;&#160;<a class="el" href="_error_8h.xhtml#a86084036bd3851575ef871ad5bf079a7">ARM_COMPUTE_RETURN_ERROR_ON_MSG</a>(cond, #cond)</td>
</tr>
</table>
</div><div class="memdoc">
<p>If the condition is true, an error is returned. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">cond</td><td>Condition to evaluate </td></tr>
</table>
</dd>
</dl>
<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>
</div>
</div>
<a id="aab9171b209dda7cc9bb560486674c9f6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aab9171b209dda7cc9bb560486674c9f6">&#9670;&nbsp;</a></span>ARM_COMPUTE_RETURN_ERROR_ON_LOC</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_COMPUTE_RETURN_ERROR_ON_LOC</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">cond, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">func, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">file, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">line&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<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>
</tr>
</table>
</div><div class="memdoc">
<p>If the condition is true, an error is returned. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">cond</td><td>Condition to evaluate. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">func</td><td>Function in which the error occurred. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">file</td><td>File in which the error occurred. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">line</td><td>Line in which the error occurred. </td></tr>
</table>
</dd>
</dl>
<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>
</div>
</div>
<a id="ab4ebbfbeedd9d66614ddbfdb14199cbf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab4ebbfbeedd9d66614ddbfdb14199cbf">&#9670;&nbsp;</a></span>ARM_COMPUTE_RETURN_ERROR_ON_LOC_MSG</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_COMPUTE_RETURN_ERROR_ON_LOC_MSG</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">cond, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">func, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">file, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">line, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>...</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<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>
<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>
</div><!-- fragment -->
<p>If the condition is true, an error is thrown. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">cond</td><td>Condition to evaluate. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">func</td><td>Function in which the error occurred. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">file</td><td>File in which the error occurred. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">line</td><td>Line in which the error occurred. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">...</td><td>Error description message. </td></tr>
</table>
</dd>
</dl>
<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>
</div>
</div>
<a id="a86084036bd3851575ef871ad5bf079a7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a86084036bd3851575ef871ad5bf079a7">&#9670;&nbsp;</a></span>ARM_COMPUTE_RETURN_ERROR_ON_MSG</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_COMPUTE_RETURN_ERROR_ON_MSG</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">cond, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>...</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<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>
<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>
</div><!-- fragment -->
<p>If the condition is true, an error is returned. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">cond</td><td>Condition to evaluate. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">...</td><td>Error description message </td></tr>
</table>
</dd>
</dl>
<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>
</div>
</div>
<a id="a8a1e1c105f0bdaf37db408c7cfcb77a4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8a1e1c105f0bdaf37db408c7cfcb77a4">&#9670;&nbsp;</a></span>ARM_COMPUTE_RETURN_ON_ERROR</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_COMPUTE_RETURN_ON_ERROR</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">status</td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<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 -->
<p>Checks if a status contains an error and returns it. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">status</td><td>Status value to check </td></tr>
</table>
</dd>
</dl>
<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>
</div>
</div>
<a id="ad5518fdae84a33ce6fbed540c6e89479"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad5518fdae84a33ce6fbed540c6e89479">&#9670;&nbsp;</a></span>ARM_COMPUTE_THROW</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_COMPUTE_THROW</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">ex</td><td>)</td>
<td>&#160;&#160;&#160;throw(ex)</td>
</tr>
</table>
</div><div class="memdoc">
<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>
</div>
</div>
<a id="a51e206ee52bcfb358919ee478d9fdc47"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a51e206ee52bcfb358919ee478d9fdc47">&#9670;&nbsp;</a></span>ARM_COMPUTE_THROW_ON_ERROR</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_COMPUTE_THROW_ON_ERROR</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">error</td><td>)</td>
<td>&#160;&#160;&#160;error.throw_if_error();</td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks if an error value is valid if not throws an exception with the error. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">error</td><td>Error value to check. </td></tr>
</table>
</dd>
</dl>
<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>
</div>
</div>
<a id="a6dc630a6ae9cc063b3924bcea8dee9d6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6dc630a6ae9cc063b3924bcea8dee9d6">&#9670;&nbsp;</a></span>ARM_COMPUTE_UNUSED</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_COMPUTE_UNUSED</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>...</em></td><td>)</td>
<td>&#160;&#160;&#160;::<a class="el" href="namespacearm__compute.xhtml#a053a24bb37402fa4b4d8d5963976ba17">arm_compute::ignore_unused</a>(__VA_ARGS__)</td>
</tr>
</table>
</div><div class="memdoc">
<p>To avoid unused variables warnings. </p>
<p>This is useful if for example a variable is only used in debug builds and generates a warning in release builds.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">...</td><td>Variables which are unused. </td></tr>
</table>
</dd>
</dl>
<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>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<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>
<li class="footer">Generated on Mon Sep 2 2019 11:47:28 for Compute Library by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.15 </li>
</ul>
</div>
</body>
</html>